dsktool 0.1.6 → 0.2.1

data/lib/DOSDisk.rb

@@ -99,10 +99,10 @@ class DOSDisk < DSK
 
 	def read_vtoc
 		vtoc_sector=get_sector(17,0)
-
 		catalog_sector=get_sector(vtoc_sector[01],vtoc_sector[02])
 		done=false
-		while !done 
+		while !done
+			break if catalog_sector.nil?
 			(0..6).each {|file_number|
 				file_descriptive_entry_start=11+file_number*35
 				file_descriptive_entry=catalog_sector[file_descriptive_entry_start..file_descriptive_entry_start+35]					
@@ -133,19 +133,19 @@ class DOSDisk < DSK
 							end
 						}
 					end
-
-					@files[filename]= case file_type_code
-						when 0x00 then TextFile.new(filename,locked,sector_count,contents)
-						when 0x01 then SCAsmFile.can_be_scasm_file(contents)? SCAsmFile.new(filename,locked,sector_count,contents): IntegerBasicFile.new(filename,locked,sector_count,contents)
-						when 0x02 then AppleSoftFile.new(filename,locked,sector_count,contents)
-						when 0x04 then BinaryFile.new(filename,locked,sector_count,contents)
-#						when 0x08 then "S"	#S type file
-#						when 0x10 then "R"	#RELOCATABLE object module file
-#						when 0x20 then "a"	#??
-#						when 0x40 then "b"	#??
-						else DOSFile.new(filename,locked,sector_count,contents,sprintf("$%02X",file_type_code))
+					if contents.length>0 then
+						@files[filename]= case file_type_code
+							when 0x00 then TextFile.new(filename,locked,sector_count,contents)
+							when 0x01 then SCAsmFile.can_be_scasm_file?(contents)? SCAsmFile.new(filename,locked,sector_count,contents): IntegerBasicFile.new(filename,locked,sector_count,contents)
+							when 0x02 then AppleSoftFile.new(filename,locked,sector_count,contents)
+							when 0x04 then BinaryFile.new(filename,locked,sector_count,contents)
+	#						when 0x08 then "S"	#S type file
+	#						when 0x10 then "R"	#RELOCATABLE object module file
+	#						when 0x20 then "a"	#??
+	#						when 0x40 then "b"	#??
+							else DOSFile.new(filename,locked,sector_count,contents,sprintf("$%02X",file_type_code))
+						end
 					end
-	
 				end
 			}
 			next_track=catalog_sector[1]		

data/lib/DOSFile.rb

@@ -327,6 +327,8 @@ private
 		s=""
 		while (index<length)
 			index+=2 #skip over the "next address" field
+			break if buffer[index].nil?
+			break if buffer[index+1].nil?
 			line_no=buffer[index]+buffer[index+1]*256
 			index+=2 #skip over the "line number" field
 			s+=sprintf("%u",line_no)
@@ -334,6 +336,7 @@ private
 			last_char_space=false
 			while (!done_line)			
 				b=buffer[index]
+				break if b.nil?
 				if b>=0x80 then
 					if !last_char_space then
 						s+=" "
@@ -388,7 +391,10 @@ class SCAsmFile < DOSFile
 		".asm"
 	end
 
-	def SCAsmFile.can_be_scasm_file(buffer)
+	def SCAsmFile.can_be_scasm_file?(buffer)
+		if buffer.length<2 then
+			return false
+		end
 		length=buffer[0]+buffer[1]*256
 		index=2
 		s=""

data/lib/DSK.rb

@@ -22,6 +22,11 @@ class DSK
 
 		(@file_bytes[0x11001]<=34) && (@file_bytes[0x11002]<=15) && (@file_bytes[0x11003]==3)
 	end
+
+	def	is_nadol?
+		# track $00, sector $02 , bytes $11 - "NADOL"
+		(@file_bytes[0x00211..0x00215]=="NADOL")
+	end
 
 
 	#create a new DSK structure (in memory, not on disk)
@@ -51,6 +56,12 @@ class DSK
 			require 'DOSDisk'
 			dsk=DOSDisk.new(file_bytes)
 		end
+		
+		if (dsk.is_nadol?) 
+			require 'NADOLDisk'
+			dsk=NADOLDisk.new(file_bytes)
+		end
+
 		dsk
 	end
 
@@ -63,47 +74,56 @@ class DSK
 		@files
 	end
 
-	#print to stdout a formatted hex dump of a single 256 byte sector
+	#return a formatted hex dump of a single 256 byte sector
 	def dump_sector(track,sector)
-
-		start_byte=track*16*256+sector*256
-		s=@file_bytes[start_byte..start_byte+255]
-
-		print_hline
-		printf("TRACK: $%02X SECTOR $%02X\ OFFSET $%04X\n",track,sector,start_byte)
-		printf "\t"
-
-		(0..15).each {|x| printf("%02X ",x) }
-		puts
-		print_hline
+		start_byte=track.to_i*16*256+sector.to_i*256
+		s=hline
+		s<<sprintf("TRACK: $%02X SECTOR $%02X\ OFFSET $%04X\n",track,sector,start_byte)
+		s<< "\t"
+		sector_data=get_sector(track,sector)
+		(0..15).each {|x| s<<sprintf("%02X ",x) }
+		s<<"\n"
+		s<<hline
 		(0..15).each {|line_number|
 			 lhs=""
 			 rhs=""
 			 start_byte=line_number*16
-			 line=s[start_byte..start_byte+15]
+			 line=sector_data[start_byte..start_byte+15]
 			 line.each_byte {|byte|
-				  lhs+= sprintf("%02X ", byte)
-				  rhs+= (byte%128).chr.sub(/[\x00-\x1f]/,'.')
+				  lhs<< sprintf("%02X ", byte)
+				  rhs<< (byte%128).chr.sub(/[\x00-\x1f]/,'.')
 		 	}
-			 printf("%02X\t%s %s\n",start_byte,lhs,rhs)
+			s<<sprintf("%02X\t%s %s\n",start_byte,lhs,rhs)
 		}
+		s
+	end
 
+	#return a formatted hex dump of a single 256 byte sector
+	def disassemble_sector(track,sector)
+		require 'D65'
+		sector_data=get_sector(track,sector)
+		if (track==0) && (sector==0) then
+			return D65.disassemble(sector_data[1..255],0x801)
+		else
+			return D65.disassemble(sector_data)
+		end
 	end
 
-	#print to stdout a formatted hex dump of all sectors on all tracks
+	#return a formatted hex dump of all sectors on all tracks
 	def dump_disk
-	
+		s=""
 		(0..34).each {|track|
 			(0..15).each {|sector|
-				dump_sector(track,sector)
+				s<<dump_sector(track,sector)
 			}
 		}
+		s
 	end
 	
 private
 
-	def print_hline
-		puts "-"*79
+	def hline
+		"-"*79+"\n"
 	end
 
 

data/lib/NADOLDisk.rb

@@ -0,0 +1,97 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+# Disk image in NADOL format
+#
+#CATALOG will be at track $00, sector $03 to track $00, sector $09
+#each entry consists of $10 bytes, which are:
+# 00-0B - filename - if file is deleted, first byte will be FF
+# 0C-0D - filesize (low byte first)
+# 0E - track of track sector list sector
+# 0F - sector of track sector list sector
+
+#TRACK/SECTOR LIST FORMAT 
+# pairs of track/sectors in order. up to 128 entries [assumes that no file can be > 128 sectors]
+
+require 'NADOLFile'
+
+class NADOLDisk < DSK
+
+	def dump_catalog
+		files.each_value { |file|		
+			puts "#{sprintf('% 6d',file.contents.length)} #{file.filename}"
+		}
+	end
+
+	def initialize(file_bytes)
+		super(file_bytes)
+		self.read_catalog
+	end
+	
+	#reads the catalog, and populate the "files" array with files
+	#CATALOG will be at track $00, sector $03 to track $00, sector $09
+	#each entry consists of $10 bytes, which are:
+	# 00-0B - filename - if file is deleted, first byte will be FF
+	# 0C-0D - filesize (low byte first)
+	# 0E - track of track sector list sector
+	# 0F - sector of track sector list sector
+	def read_catalog
+		0x300.step(0x9FF,0x10) do |file_descriptive_entry_start|
+			file_descriptive_entry=@file_bytes[file_descriptive_entry_start..file_descriptive_entry_start+0x0F]
+			break if (file_descriptive_entry[0]==0xFF) # skip deleted files
+			filename=""
+			file_descriptive_entry[0..11].to_s.each_byte{|b| filename+=(b.%128).chr} #strip off high bit
+			filename.sub!(/ *$/,"") #strip off trailing spaces
+			full_sectors=file_descriptive_entry[0x0D]
+			bytes_in_last_sector=file_descriptive_entry[0x0C]
+			file_size=full_sectors*256+bytes_in_last_sector
+			if (file_size>0) then
+				contents=""					
+				ts_list_track_no=file_descriptive_entry[0x0E]
+				ts_list_sector_no=file_descriptive_entry[0x0F]
+				ts_list=get_sector(ts_list_track_no,ts_list_sector_no)
+				entry_number=0
+				while entry_number<full_sectors do						
+					data_track_no=ts_list[entry_number*2]
+					data_sector_no=ts_list[entry_number*2+1]
+					contents+=get_sector(data_track_no,data_sector_no)
+					entry_number+=1
+				end
+				if (bytes_in_last_sector>0) then
+					data_track_no=ts_list[entry_number*2]
+					data_sector_no=ts_list[entry_number*2+1]
+					contents+=get_sector(data_track_no,data_sector_no)[0..bytes_in_last_sector-1]
+				end	
+				if (NADOLTokenisedFile.can_be_nadol_tokenised_file?(contents)) then
+					@files[filename]= NADOLTokenisedFile.new(filename,contents)
+				else
+					@files[filename]= NADOLFile.new(filename,contents)
+				end
+			end
+		end
+	end
+end
+# == Author
+# Jonno Downes (jonno@jamtronix.com)
+#
+# == Copyright
+# Copyright (c) 2007 Jonno Downes (jonno@jamtronix.com)
+#
+#Permission is hereby granted, free of charge, to any person obtaining
+#a copy of this software and associated documentation files (the
+#"Software"), to deal in the Software without restriction, including
+#without limitation the rights to use, copy, modify, merge, publish,
+#distribute, sublicense, and/or sell copies of the Software, and to
+#permit persons to whom the Software is furnished to do so, subject to
+#the following conditions:
+
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/NADOLFile.rb

@@ -0,0 +1,242 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'D65'
+
+#NADOL (Nibbles Away Disk Optimized Language) file
+class NADOLFile	
+	attr_accessor(:filename,:contents) 
+	def initialize(filename,contents)
+		@filename=filename
+		@contents=contents
+	end
+
+	def to_s
+		@contents
+	end
+
+	def file_extension
+		".bin"
+	end
+	def hex_dump
+		#assumes file is a multiple of 16 bytes, which it always should be
+		s=""
+		(0..(@contents.length/16)-1).each {|line_number|
+			 lhs=""
+			 rhs=""
+			 start_byte=line_number*16
+			 line=@contents[start_byte..start_byte+15]
+			 line.each_byte {|byte|
+				  lhs+= sprintf("%02X ", byte)
+				  rhs+= (byte%128).chr.sub(/[\x00-\x1f]/,'.')
+		 	}
+			s+=sprintf("%02X\t%s %s\n",start_byte,lhs,rhs)
+		}
+		s
+	end
+end
+
+#a file on a NADOL dsk that does not appear to be in NADOL tokenised format
+class NADOLBinaryFile<NADOLFile
+	def disassembly(start_address=0x8000) 
+		require 'D65'
+		D65.disassemble(@contents,start_address)
+	end
+end
+
+
+#file packed by the NADOL EDITOR application.
+#format is a series of  unnumbered lines, where each line has the following format:
+#  <Length>     (8-bit: including length byte, line no, contents, zero>
+#  <Tokens and/orCharacters>
+#  <Zero byte>  ($00, to mark the end of the S-C Asm source line)
+# each byte in the line is interpreted as follows:
+# $00 - end of line marker
+# $01 - $64 - NADOL tokens
+# $65-$70 - ??? unknown
+# $71 - $7f - 1 to F spaces
+# $80-$FF - ASCII character with high bit set
+class NADOLTokenisedFile < NADOLFile
+	NADOL_EDITOR_TOKENS = [
+	"?",		#00 (so we can use token as an index in to this array)
+	"READ(",	#01
+	"FREE(",	#02
+	"NOT(",	#03
+	"LENGTH(",	#04
+	"PDL(",	#05
+	"SIZEOF(",	#06
+	"LSCRN(",	#07
+	"HSCRN(",	#08
+	"CHECK(",	#09
+	"MAKE(",	#0a
+	"SCREEN(",	#0b
+	"HEXPACK ",#0c
+	"PROCEDURE ",#0d
+	"ENDPROC",	#0e
+	"FUNCTION ",#0f
+	"ENDFUNC",	#10
+	"IF ",	#11
+	"ELSE",	#12
+	"ENDIF",	#13
+	"WHILE ",	#14
+	"ENDWHILE",#15
+	"DEFINE ",	#16
+	"RESULT=",	#17
+	"PRINT",	#18
+	"PRINTHEX",#19
+	"PRINTBYTE",#1a
+	"LABEL ",	#1b
+	"GOTO ",	#1c
+	"INVERSE",	#1d
+	"NORMAL",	#1e
+	"FLASH",	#1f
+	"CASE ",	#20
+	"GOTOXY(",	#21
+	"CLEAR",	#22
+	"NEW",	#23
+	"HOME",	#24
+	"CLREOL",	#25
+	"CLREOP",	#26
+	"PRBLOCK(",#27
+	"STOP",	#28
+	"COPY(",	#29
+	"FILL(",	#2a
+	"MASK(",	#2b
+	"RSECT(",	#2c
+	"WSECT(",	#2d
+	"RBLOCK(",	#2e
+	"WBLOCK(",	#2f
+	"WTRACK(",	#30
+	"WSYNC(",	#31
+	"RECAL(",	#32
+	"DISPLAY(",#33
+	"RTRACK(",	#34
+	"RSYNC(",	#35
+	"BEEP(",	#36
+	"DISASM(",	#37
+	"TEXT",	#38
+	"FORMAT(",	#39
+	"SETFORMAT(",#3a
+	"WORKDRIVE ",#3b
+	"INIT ",	#3c
+	"LOAD ",	#3d
+	"SAVE ",	#3e
+	"CATALOG",	#3f
+	"DELETE ",	#40
+	"RENAME ",	#41
+	"PACK ",	#42
+	"CONVERT(",#43
+	"INPUT(",	#44
+	"LORES",	#45
+	"PLOT(",	#46
+	"HLINE(",	#47
+	"VLINE(",	#48
+	"COLOR=",	#49
+	"FIND(",	#4a
+	"HIRES",	#4b
+	"HCOLOR=",	#4c
+	"HPLOT",	#4d
+	"CALL(",	#4e
+	"PR#",	#4f
+	"IN#",	#50
+	"FILTER(",	#51
+	"LIST",	#52
+	"RUN",	#53
+	"AUXMOVE(",#54
+	"LCMOVE(",	#55
+	"DELAY(",	#56
+	"INTEGER",	#57
+	"BYTE",	#58
+	" AND ",	#59
+	" OR ",	#5a
+	" MOD ",	#5b
+	" XOR ",	#5c
+	" WITH ",	#5d
+	" TO ",	#5e
+	" AT ",	#5f
+	"TAB(",	#60
+	"ENDCASE",	#61
+	"MON:",	#62
+	"EDIT",	#63
+	"SAVE@"	#64
+]
+
+
+	#check whether a given series of bytes can be a valid NADOL tokenised file
+	#heuristics are:
+	# - bytes 
+	def  NADOLTokenisedFile.can_be_nadol_tokenised_file?(buffer)
+		r=true
+		i=0
+		while i<buffer.length
+			line_length=buffer[i]
+			if buffer[i+line_length-1]!=0 then
+				r=false
+				break
+			end
+			i+=line_length
+		end
+		r
+	end
+	
+	def to_s
+		NADOLTokenisedFile.buffer_as_tokenised_file(@contents)
+	end
+	def file_extension
+		".nad"
+	end
+
+	private
+	def  NADOLTokenisedFile.buffer_as_tokenised_file(buffer)
+		s=""
+		index=0
+		while (index<buffer.length)
+			line_length=buffer[index]
+			index+=1
+			end_of_line=index+line_length-2
+			while(index<end_of_line)
+				b=buffer[index]
+				if (b<=0x64) then
+					s+=NADOL_EDITOR_TOKENS[b]
+				elsif(b>0x70 and b<0x80) then
+					s+=" "*(b-0x70)
+				elsif(b>=0x80) then
+					s+=(b-0x80).chr
+				else
+					raise sprintf("unknown token %02X at offset %04X",b,index)
+				end
+				index+=1 #move to next char
+			end
+			index+=1 #skip over end-of-line marker
+			s+="\n"
+		end
+		s
+	end
+
+end
+
+
+# == Author
+# Jonno Downes (jonno@jamtronix.com)
+#
+# == Copyright
+# Copyright (c) 2007 Jonno Downes (jonno@jamtronix.com)
+#
+#Permission is hereby granted, free of charge, to any person obtaining
+#a copy of this software and associated documentation files (the
+#"Software"), to deal in the Software without restriction, including
+#without limitation the rights to use, copy, modify, merge, publish,
+#distribute, sublicense, and/or sell copies of the Software, and to
+#permit persons to whom the Software is furnished to do so, subject to
+#the following conditions:
+
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.