dsktool 0.2.1 → 0.4.1

data/lib/ProDOSDisk.rb

@@ -0,0 +1,197 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'ProDOSFile'
+# Disk image in ProDOS format
+# for now, assumes 'ProDOS order'
+class ProDOSDisk < DSK
+	attr_accessor :volume_name
+	
+	#what is the last block on this disk?
+	def last_block
+		(self.track_count*8)-1
+	end
+	def dump_catalog
+		s=""
+		files.keys.sort.each { |file_name|		
+			file=files[file_name]
+			s<< "#{sprintf('% 6d',file.contents.length)}\t #{file.file_type} : $#{sprintf '%X',file.aux_type}\t#{file_name}\n"
+		}
+		s
+	end
+
+	def initialize(file_bytes,sector_order)
+		super(file_bytes,sector_order)
+		self.read_catalog
+	end
+
+	def file_system
+		:prodos
+	end
+
+
+	#concatenate all the blocks in the volume directory
+	#Volume Directory format is: (from "Beneath Apple ProDOS pp 4-10 - 4-12)
+	# FOR VOLUMES
+	# $00	 	STORAGE_TYPE/NAME_LENGTH
+	# $01-$0F	FILE_NAME 
+	# $10		RESERVED
+	# $11-$12	RESERVED
+	# $13-$14	RESERVED
+	# $15-$17	RESERVED
+	# $18-$1B	CREATION
+	# $1C		VERSION
+	# $1D		MIN_VERSION
+	# $1E		ACCESS
+	# $1F		ENTRY_LENGTH
+	# $20		ENTRIES_PER_BLOCK
+	# $21-$22	FILE_COUNT
+	# $23-$24	BIT_MAP_POINTER
+	# $25-$26	TOTAL_BLOCKS
+	#
+	# FOR FILES
+	# $00	 	STORAGE_TYPE/NAME_LENGTH
+	# $01-$0F	FILE_NAME 
+	# $10		FILE_TYPE
+	# $11-$12	KEY_POINTER
+	# $13-$14	BLOCKS_USED
+	# $15-$17	EOF
+	# $18-$1B	CREATION
+	# $1C		VERSION
+	# $1D		MIN_VERSION
+	# $1E		ACCESS
+	# $1F-$20	AUX_TYPE
+	# $21-$24	LAST_MOD
+	# $25-$26	HEADER_POINTER
+
+	def dump_block(block_no)
+		s=hline
+		s<<sprintf("BLOCK %03d\n",block_no)
+		s<< "\t"
+		block_data=get_block(block_no)
+		(0..15).each {|x| s<<sprintf("%02X ",x) }
+		s<<"\n"
+		s<<hline
+		(0..31).each {|line_number|
+			 lhs=""
+			 rhs=""
+			 start_byte=line_number*16
+			 line=block_data[start_byte..start_byte+15]
+			 line.each_byte {|byte|
+				  lhs<< sprintf("%02X ", byte)
+				  rhs<< (byte%128).chr.sub(/[\x00-\x1f]/,'.')
+		 	}
+			s<<sprintf("%03X\t%s %s\n",start_byte,lhs,rhs)
+		}
+		s
+	end
+
+	def read_catalog(starting_block=2,dir_path="")
+		next_block_no=starting_block
+		while (next_block_no!=0)
+			block=get_block(next_block_no)
+			offset=4
+			while (offset<(0x200-0x27))
+				directory_entry=block[offset..offset+0x27]
+				storage_type=directory_entry[0]>>4
+				name_length=directory_entry[0]%0x10
+				name=directory_entry[1..name_length]
+				file_type=directory_entry[0x10]
+				key_pointer=directory_entry[0x11]+directory_entry[0x12]*0x100
+				blocks_used=directory_entry[0x13]+directory_entry[0x14]*0x100
+				file_length=directory_entry[0x15]+directory_entry[0x16]*0x100+directory_entry[0x17]*0x10000
+				aux_type=directory_entry[0x1f]+directory_entry[0x20]*0x100
+				case storage_type
+					when 0x00 then
+						#nop
+					when 0x01 then  #it's a seedling
+						file_contents=get_block(key_pointer)
+						files[name]=ProDOSFile.new(name,file_contents,file_type,aux_type)
+					when 0x02 then  #it's a sapling
+						block_list=[]
+						index_block=get_block(key_pointer)
+						0.upto((file_length/0x200)) do |i|
+							block_list<<index_block[i]+(index_block[i+0x100]*0x100)
+						end
+						file_contents=""
+						block_list.each do |next_block_no|
+							if next_block_no==0 then
+								file_contents+="\x00"*0x200
+							elsif next_block_no>self.last_block then
+								STDERR<<"file #{name} attempted to read bad block # #{next_block_no}\n"
+								file_contents+="\x00"*0x200
+							else
+								file_contents+=get_block(next_block_no)
+							end
+						end
+						file_contents=file_contents[0..file_length-1]
+						files["#{dir_path}#{name}"]=ProDOSFile.new(name,file_contents,file_type,aux_type)						
+					when 0x03 then  #it's a tree
+						master_index_block=get_block(key_pointer)
+						block_list=[]
+						number_of_index_entries=1+(file_length/0x200)
+						number_of_index_blocks=1+(number_of_index_entries/0x100)
+						number_of_index_entries_in_last_block=number_of_index_entries-(number_of_index_blocks-1)*0x100
+						0.upto(number_of_index_blocks-1) do |i|
+							index_block_no=master_index_block[i]+master_index_block[i+0x100]*0x100
+							index_block=get_block(index_block_no)
+							if i==number_of_index_blocks-1 then 
+								entries_in_this_index_block=number_of_index_entries_in_last_block
+							else 
+								entries_in_this_index_block=256
+							end
+							0.upto(entries_in_this_index_block-1) do |j|
+								block_list<<index_block[j]+(index_block[j+0x100]*0x100)
+							end
+						end
+						file_contents=""
+						block_list.each do |next_block_no|
+							if next_block_no==0 then
+								file_contents+="\x00"*0x200
+							else
+								file_contents+=get_block(next_block_no)
+							end
+						end
+						file_contents=file_contents[0..file_length-1]
+						files["#{dir_path}#{name}"]=ProDOSFile.new(name,file_contents,file_type,aux_type)						
+					when 0x0D then 	#it's a subdirectory pointer
+						read_catalog(key_pointer,"#{dir_path}#{name}/")
+					when 0x0E then 	#it's a subdirectory header
+						#do nothing 
+					when 0x0F then 	#it's a volume						
+						@volume_name=name 
+					else 
+#						raise "unknown storage_type #{sprintf '%02X',storage_type}"
+						puts "skipping unknown storage_type #{sprintf '%02X',storage_type} for #{dir_path}#{name}"
+				end			
+				offset+=0x27
+			end
+			next_block_no=block[2]+block[3]*256
+		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/ProDOSFile.rb

@@ -0,0 +1,162 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'DSKFile'
+
+#ProDOS file
+class ProDOSFile < DSKFile
+	attr_accessor :file_type,:aux_type
+	
+	def initialize(filename,contents,file_type,aux_type)
+		raise "filename too long - #{filename}" unless filename.length<=15
+		@filename=filename
+		@contents=contents
+		@file_type=PRODOS_FILE_TYPES[file_type]
+		@file_type=sprintf('$%02X',file_type) if @file_type.nil?
+		@aux_type=aux_type
+	end
+#ProDOS file types from "Beneath Apple DOS pp 4-10 - 4-11)
+PRODOS_FILE_TYPES={		
+0x00=>"",      #"Typeless File"
+ 0x01=>"BAD",  #BAD blocks file
+ 0x02=>"PCD",  #Pascal CoDe file
+ 0x03=>"PTX",  #Pascal TeXt file
+ 0x04=>"TXT",  #ASCII text file
+ 0x05=>"PDA",  #Pascal DAta file
+ 0x06=>"BIN",  #BINary file
+ 0x07=>"CHR",  #CHaRacter font file
+ 0x08=>"PIC",  #PICture file
+ 0x09=>"BA3",  #Business BASIC (SOS) program file
+ 0x0A=>"DA3",  #Business BASIC (SOS) data file
+ 0x0B=>"WPD",  #Word Processor Document
+ 0x0F=>"DIR",  #subDIRectory file
+ 0x10=>"RPD",  #RPS data file
+ 0x11=>"RPI",  #RPS index file
+ 0x19=>"ADB",  #AppleWorks Database file
+ 0x1A=>"AWP",  #AppleWorks WordProcessing file
+ 0x1B=>"ASP",  #AppleWorks Spreadsheet file
+ 0x60=>"PRE",  #ProDOS preboot driver
+ 0x6B=>"NIO",  #PC Transporter BIOS and drivers
+ 0x6D=>"DVR",  #PC Transporter device drivers
+ 0x6F=>"HDV",  #MSDOS HardDisk Volume
+ 0xA0=>"WPF",  #WordPerfect document file
+ 0xA1=>"MAC",  #Macrofile
+ 0xA2=>"HLP",  #Help File
+ 0xA3=>"DAT",  #Data File
+ 0xA5=>"LEX",  #Spelling dictionary
+ 0xAC=>"ARC",  #General Purpose Archive file
+ 0xB0=>"SRC",  #ORCA/M & APW source file
+ 0xB1=>"OBJ",  #ORCA/M & APW object file
+ 0xB2=>"LIB",  #ORCA/M & APW library file
+ 0xB3=>"S16",  #ProDOS16 system file
+ 0xB4=>"RTL",  #ProDOS16 runtime library
+ 0xB5=>"EXE",  #APW shell command file
+ 0xB6=>"STR",  #ProDOS16 startup init file
+ 0xB7=>"TSF",  #ProDOS16 temporary init file
+ 0xB8=>"NDA",  #ProDOS16 new desk accessory
+ 0xB9=>"CDA",  #ProDOS16 classic desk accessory
+ 0xBA=>"TOL",  #ProDOS16 toolset file
+ 0xBB=>"DRV",  #ProDOS16 driver file
+ 0xBF=>"DOC",  #document file
+ 0xC0=>"PNT",  #//gs paint document
+ 0xC1=>"SCR",  #//gs screen file
+ 0xC8=>"FNT",  #Printer font file
+ 0xE0=>"LBR",  #Apple archive library file
+ 0xE2=>"ATI",  #Appletalk init file
+ 0xEF=>"PAS",  #ProDOS Pascal file
+ 0xF0=>"CMD",  #added command file
+ 0xF1=>"OVL",  #Overlay file
+ 0xF2=>"DBF",  #Database file
+ 0xF3=>"PAD",  #MouseWrite file
+ 0xF4=>"MCR",  #AE Pro macro file
+ 0xF5=>"ECP",  #ECP batch file
+ 0xF6=>"DSC",  #description file
+ 0xF7=>"TMP",  #temporary work file
+ 0xF8=>"RSX",  #linkable object module
+ 0xF9=>"IMG",  #ProDOS image file
+ 0xFA=>"INT",  #Integer BASIC program
+ 0xFB=>"IVR",  #Integer BASIC variables file
+ 0xFC=>"BAS",  #AppleSoft BASIC program
+ 0xFD=>"VAR",  #AppleSoft BASIC variables file
+ 0xFE=>"REL",  #ProDOS EDASM relocatable object module file
+ 0xFF=>"SYS",  #ProDOS8 system file}
+}
+	def file_extension
+		return "."+@file_type.downcase
+	end
+
+	def to_s
+		case @file_type
+		when "BAS" then
+			#applesoft detokeniser routine expects the first two bytes to be length of buffer
+			buffer_length=2+contents.length
+			buffer=(buffer_length%0x100).chr+(buffer_length/0x100).chr+contents
+			buffer_as_applesoft_file(buffer)
+		when "AWP" then
+			buffer_as_awp_file(contents)			
+		else
+			#strip of the high bits
+			s=""
+			@contents.each_byte{|b| s+=(b%0x80).chr.tr(0x0D.chr,"\n")}
+			s
+	end
+
+private
+	#AWP format defined in http://www.umich.edu/~archive/apple2/technotes/ftn/FTN.1A.xxxx
+	def buffer_as_awp_file(buffer)
+		s=""
+		i=300 #skip 300 byte header
+		i+=2 if buffer[183]>3 #skip the first invalid line if SFMInVers non-zero
+		while i<buffer.length-4 do
+			command_byte_0=buffer[i]
+			command_byte_1=buffer[i+1]
+			i+=2
+			if command_byte_1==0xD0 then #it's a carriage return line - do nothing
+			elsif command_byte_1>0xD0 then #it's a command line - do nothing
+			else #it's a text record
+				bytes_in_line=command_byte_0
+				control_byte=buffer[i+1]
+#				carriage_return_after_line=(control_byte>=0x80)
+				chars_remaining=control_byte%0x80
+				buffer[i+2..i+2+chars_remaining-1].each_byte do |b|
+					if b==0x16 then #tab char
+						s<<"\t"
+					elsif b==0x17 then
+						s<<" "
+					elsif b>=0x20 then
+						s<<b.chr
+					end
+				end
+				i+=bytes_in_line
+				s<<"\n"
+#				s<<"\n" if carriage_return_after_line 			
+			end
+		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.

data/lib/a2_symbols.yaml

@@ -78,8 +78,8 @@
 0x3FD: NMI handler - byte 3
 0x3FE: IRQ vector address - (low byte)
 0x3FB: IRQ vector address - (high byte)
-0xC000: 80STOREOFF - Allow page2 to switch video page1 page2 
-0xC001: 80STOREON - Allow page2 to switch main & aux video memory 
+0xC000: KEYBOARD/CLR80COL - read = latched keyboard data, write=disable 80 column memory mapping
+0xC001: SET80COL - enable 80 column memory mapping
 0xC002: RAMRDOFF - Read enable main memory from $0200-$BFFF 
 0xC003: RAMDRON - Read enable aux memory from $0200-$BFFF 
 0xC004: RAMWRTOFF - Write enable main memory from $0200-$BFFF 

data/test/hgr_scanlines.rb

@@ -0,0 +1,194 @@
+absolute_scanlines=[
+0x0000,	#0
+0x0400,	#1
+0x0800,	#2
+0x0C00,	#3
+0x1000,	#4
+0x1400,	#5
+0x1800,	#6
+0x1C00,	#7
+0x0080,	#8
+0x0480,	#9
+0x0880,	#10
+0x0C80,	#11
+0x1080,	#12
+0x1480,	#13
+0x1880,	#14
+0x1C80,	#15
+0x0100,	#16
+0x0500,	#17
+0x0900,	#18
+0x0D00,	#19
+0x1100,	#20
+0x1500,	#21
+0x1900,	#22
+0x1D00,	#23
+0x0180,	#24
+0x0580,	#25
+0x0980,	#26
+0x0D80,	#27
+0x1180,	#28
+0x1580,	#29
+0x1980,	#30
+0x1D80,	#31
+0x0200,	#32
+0x0600,	#33
+0x0A00,	#34
+0x0E00,	#35
+0x1200,	#36
+0x1600,	#37
+0x1A00,	#38
+0x1E00,	#39
+0x0280,	#40
+0x0680,	#41
+0x0A80,	#42
+0x0E80,	#43
+0x1280,	#44
+0x1680,	#45
+0x1A80,	#46
+0x1E80,	#47
+0x0300,	#48
+0x0700,	#49
+0x0B00,	#50
+0x0F00,	#51
+0x1300,	#52
+0x1700,	#53
+0x1B00,	#54
+0x1F00,	#55
+0x0380,	#56
+0x0780,	#57
+0x0B80,	#58
+0x0F80,	#59
+0x1380,	#60
+0x1780,	#61
+0x1B80,	#62
+0x1F80,	#63
+0x0028,	#64
+0x0428,	#65
+0x0828,	#66
+0x0C28,	#67
+0x1028,	#68
+0x1428,	#69
+0x1828,	#70
+0x1C28,	#71
+0x00A8,	#72
+0x04A8,	#73
+0x08A8,	#74
+0x0CA8,	#75
+0x10A8,	#76
+0x14A8,	#77
+0x18A8,	#78
+0x1CA8,	#79
+0x0128,	#80
+0x0528,	#81
+0x0928,	#82
+0x0D28,	#83
+0x1128,	#84
+0x1528,	#85
+0x1928,	#86
+0x1D28,	#87
+0x01A8,	#88
+0x05A8,	#89
+0x09A8,	#90
+0x0DA8,	#91
+0x11A8,	#92
+0x15A8,	#93
+0x19A8,	#94
+0x1DA8,	#95
+0x0228,	#96
+0x0628,	#97
+0x0A28,	#98
+0x0E28,	#99
+0x1228,	#100
+0x1628,	#101
+0x1A28,	#102
+0x1E28,	#103
+0x02A8,	#104
+0x06A8,	#105
+0x0AA8,	#106
+0x0EA8,	#107
+0x12A8,	#108
+0x16A8,	#109
+0x1AA8,	#110
+0x1EA8,	#111
+0x0328,	#112
+0x0728,	#113
+0x0B28,	#114
+0x0F28,	#115
+0x1328,	#116
+0x1728,	#117
+0x1B28,	#118
+0x1F28,	#119
+0x03A8,	#120
+0x07A8,	#121
+0x0BA8,	#122
+0x0FA8,	#123
+0x13A8,	#124
+0x17A8,	#125
+0x1BA8,	#126
+0x1FA8,	#127
+0x0050,	#128
+0x0450,	#129
+0x0850,	#130
+0x0C50,	#131
+0x1050,	#132
+0x1450,	#133
+0x1850,	#134
+0x1C50,	#135
+0x00D0,	#136
+0x04D0,	#137
+0x08D0,	#138
+0x0CD0,	#139
+0x10D0,	#140
+0x14D0,	#141
+0x18D0,	#142
+0x1CD0,	#143
+0x0150,	#144
+0x0550,	#145
+0x0950,	#146
+0x0D50,	#147
+0x1150,	#148
+0x1550,	#149
+0x1950,	#150
+0x1D50,	#151
+0x01D0,	#152
+0x05D0,	#153
+0x09D0,	#154
+0x0DD0,	#155
+0x11D0,	#156
+0x15D0,	#157
+0x19D0,	#158
+0x1DD0,	#159
+0x0250,	#160
+0x0650,	#161
+0x0A50,	#162
+0x0E50,	#163
+0x1250,	#164
+0x1650,	#165
+0x1A50,	#166
+0x1E50,	#167
+0x02D0,	#168
+0x06D0,	#169
+0x0AD0,	#170
+0x0ED0,	#171
+0x12D0,	#172
+0x16D0,	#173
+0x1AD0,	#174
+0x1ED0,	#175
+0x0350,	#176
+0x0750,	#177
+0x0B50,	#178
+0x0F50,	#179
+0x1350,	#180
+0x1750,	#181
+0x1B50,	#182
+0x1F50,	#183
+0x03D0,	#184
+0x07D0,	#185
+0x0BD0,	#186
+0x0FD0,	#187
+0x13D0,	#188
+0x17D0,	#189
+0x1BD0,	#190
+0x1FD0,	#191
+]