ripxplore 0.0.1

data/lib/RipXplore.rb

@@ -0,0 +1,77 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'open-uri'
+class RipXplore
+
+VERSION="0.0.1"
+
+private
+def RipXplore.require_files_in_subdir(dirname)
+  full_path=File.expand_path(dirname,File.dirname(__FILE__))
+  Dir.glob("#{full_path}/*.rb").sort.each {|f| require f}
+  Dir.foreach(full_path) do |f|
+    next if f=~/^\./ #skip anything that starts with a .
+    full_subdir_path=File.expand_path(f,full_path)    
+    RipXplore.require_files_in_subdir(full_subdir_path) if File.directory?(full_subdir_path)
+  end  
+end
+#load all plugins
+require 'HostSystem'
+RipXplore.require_files_in_subdir("host_systems")
+require 'ImageFormat'
+RipXplore.require_files_in_subdir("image_formats")
+require 'FileSystem'
+RipXplore.require_files_in_subdir("file_systems")
+require 'NativeFileType'
+RipXplore.require_files_in_subdir("native_file_types")
+require 'FileSystemImage'
+RipXplore.require_files_in_subdir("disassemblers")
+def RipXplore.supported_file_system_images
+  FileSystemImage.subclasses
+end    
+  
+def RipXplore.best_fit_from_file(file,filename=nil)
+
+  filename=file.path if filename.nil?
+  if !(filename=~/(.*)\.gz$/i).nil? then
+    require 'zlib'        
+      file_bytes=Zlib::GzipReader.new(file).read
+      filename=$1
+  else
+    file_bytes=file.read
+  end
+  FileSystemImage.best_fit(file_bytes,filename)
+end
+
+def  RipXplore.best_fit_from_filename(filename)  
+  file=open(filename,"rb")
+  RipXplore.best_fit_from_file(file,filename)  
+end
+end
+
+
+# == Author
+# Jonno Downes (jonno@jamtronix.com)
+#
+# == Copyright
+# Copyright (c) 2008 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/RipXploreLog.rb

@@ -0,0 +1,63 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'logger'
+@@logger=Logger.new(STDERR)
+@@logger.level=Logger::WARN
+class RipXploreLog
+  
+  def RipXploreLog.debug_logging
+    @@logger.level=Logger::DEBUG
+  end
+  
+  def RipXploreLog.log_to(filename)
+    old_log_level=@@logger.level
+    @@logger=Logger.new(filename)
+    @@logger.level=old_log_level
+  end
+  
+  def RipXploreLog.log( message,severity=Logger::INFO, progname = nil) 
+    @@logger.add(severity,message,progname)
+  end
+  
+  #make some helper logging functions
+  [:debug,:info,:warn,:error,:fatal].each do |severity|
+    
+    severity_constant="Logger::#{severity.to_s.upcase}"
+    class_def=%{
+    def RipXploreLog.#{severity}(message,progname=nil)
+      RipXploreLog.log(message,#{severity_constant},progname)
+    end
+    }
+    eval class_def      
+  end
+  
+end
+
+
+
+
+# == Author
+# Jonno Downes (jonno@jamtronix.com)
+#
+# == Copyright
+# Copyright (c) 2008 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/SubclassTracking.rb

@@ -0,0 +1,11 @@
+#derived from http://ola-bini.blogspot.com/2007/07/objectspace-to-have-or-not-to-have.html
+module SubclassTracking
+def self.extended(klazz)
+  (class <<klazz; self; end).send :attr_accessor,  :subclasses
+  (class <<klazz; self; end).send :define_method, :inherited do |clzz|
+    klazz.subclasses << clzz
+    super
+  end
+  klazz.subclasses = []
+  end
+end

data/lib/disassemblers/D65.rb

@@ -0,0 +1,181 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+class D65
+# 6502 Disassembler with symbols
+# based on 6502disassembler.js : n. landsteiner, electronic tradion 2005; e-tradion.net
+
+unless defined?(OPCODES) then
+OPCODES= [
+	['BRK',:imp], ['ORA',:inx], ['???',:imp], ['???',:imp], #00..03
+	['TSB',:zpg], ['ORA',:zpg], ['ASL',:zpg], ['???',:imp], #04..07
+	['PHP',:imp], ['ORA',:imm], ['ASL',:acc], ['???',:imp], #08..0b
+	['TSB',:abs], ['ORA',:abs], ['ASL',:abs], ['???',:imp], #0c..0f
+	['BPL',:rel], ['ORA',:iny], ['ORA',:inz], ['???',:imp], #10..13
+	['TRB',:zpg], ['ORA',:zpx], ['ASL',:zpx], ['???',:imp], #14..17
+	['CLC',:imp], ['ORA',:aby], ['INC',:acc], ['???',:imp], #18..1B
+	['INC',:abs], ['ORA',:abx], ['ASL',:abx], ['???',:imp], #1c..1f
+	['JSR',:abs], ['AND',:inx], ['???',:imp], ['???',:imp], #20..23
+	['BIT',:zpg], ['AND',:zpg], ['ROL',:zpg], ['???',:imp], #24..27
+	['PLP',:imp], ['AND',:imm], ['ROL',:acc], ['???',:imp], #28..2b
+	['BIT',:abs], ['AND',:abs], ['ROL',:abs], ['???',:imp], #2c..2f
+	['BMI',:rel], ['AND',:iny], ['AND',:inz], ['???',:imp], #30..33
+	['BIT',:zpx], ['AND',:zpx], ['ROL',:zpx], ['???',:imp], #34..37
+	['SEC',:imp], ['AND',:aby], ['DEC',:acc], ['???',:imp], #38..3b
+	['BIT',:inx], ['AND',:abx], ['ROL',:abx], ['???',:imp], #3c..3f
+	['RTI',:imp], ['EOR',:inx], ['???',:imp], ['???',:imp], #40..43
+	['???',:imp], ['EOR',:zpg], ['LSR',:zpg], ['???',:imp], #44..47
+	['PHA',:imp], ['EOR',:imm], ['LSR',:acc], ['???',:imp], #48..4b
+	['JMP',:abs], ['EOR',:abs], ['LSR',:abs], ['???',:imp], #4c..4f
+	['BVC',:rel], ['EOR',:iny], ['EOR',:inz], ['???',:imp], #50..53
+	['???',:imp], ['EOR',:zpx], ['LSR',:zpx], ['???',:imp], #54..57
+	['CLI',:imp], ['EOR',:aby], ['PHY',:imp], ['???',:imp], #58..5b
+	['???',:imp], ['EOR',:abx], ['LSR',:abx], ['???',:imp], #5c..5f
+	['RTS',:imp], ['ADC',:inx], ['???',:imp], ['???',:imp], #60..63
+	['STZ',:zpg], ['ADC',:zpg], ['ROR',:zpg], ['???',:imp], #64..67
+	['PLA',:imp], ['ADC',:imm], ['ROR',:acc], ['???',:imp], #68..6b
+	['JMP',:ind], ['ADC',:abs], ['ROR',:abs], ['???',:imp], #6c..6f
+	['BVS',:rel], ['ADC',:iny], ['ADC',:inz], ['???',:imp], #70..73
+	['STZ',:zpx], ['ADC',:zpx], ['ROR',:zpx], ['???',:imp], #74..77
+	['SEI',:imp], ['ADC',:aby], ['PLY',:imp], ['???',:imp], #78..7b
+	['JMP',:inx], ['ADC',:abx], ['ROR',:abx], ['???',:imp], #7c..7f
+	['BRA',:rel], ['STA',:inx], ['???',:imp], ['???',:imp], #80..83
+	['STY',:zpg], ['STA',:zpg], ['STX',:zpg], ['???',:imp], #84..87
+	['DEY',:imp], ['BIT',:imm], ['TXA',:imp], ['???',:imp], #88..8b
+	['STY',:abs], ['STA',:abs], ['STX',:abs], ['???',:imp], #8c..8f
+	['BCC',:rel], ['STA',:iny], ['STA',:inz], ['???',:imp], #90..93
+	['STY',:zpx], ['STA',:zpx], ['STX',:zpy], ['???',:imp], #94..97
+	['TYA',:imp], ['STA',:aby], ['TXS',:imp], ['???',:imp], #98..9b
+	['STZ',:abs], ['STA',:abx], ['STZ',:abx], ['???',:imp], #9c..9f
+	['LDY',:imm], ['LDA',:inx], ['LDX',:imm], ['???',:imp], #a0..a3
+	['LDY',:zpg], ['LDA',:zpg], ['LDX',:zpg], ['???',:imp], #a4..a7
+	['TAY',:imp], ['LDA',:imm], ['TAX',:imp], ['???',:imp], #a8..ab
+	['LDY',:abs], ['LDA',:abs], ['LDX',:abs], ['???',:imp], #ab..af
+	['BCS',:rel], ['LDA',:iny], ['LDA',:inz], ['???',:imp], #b0..b3
+	['LDY',:zpx], ['LDA',:zpx], ['LDX',:zpy], ['???',:imp], #b4..b7
+	['CLV',:imp], ['LDA',:aby], ['TSX',:imp], ['???',:imp], #b8..bb
+	['LDY',:abx], ['LDA',:abx], ['LDX',:aby], ['???',:imp], #bc..bf
+	['CPY',:imm], ['CMP',:inx], ['???',:imp], ['???',:imp], #c0..c3
+	['CPY',:zpg], ['CMP',:zpg], ['DEC',:zpg], ['???',:imp], #c4..c7
+	['INY',:imp], ['CMP',:imm], ['DEX',:imp], ['???',:imp], #c8..cb
+	['CPY',:abs], ['CMP',:abs], ['DEC',:abs], ['???',:imp], #cc..cf
+	['BNE',:rel], ['CMP',:iny], ['CMP',:inz], ['???',:imp], #d0..d3
+	['???',:imp], ['CMP',:zpx], ['DEC',:zpx], ['???',:imp], #d4..d7
+	['CLD',:imp], ['CMP',:aby], ['PHX',:imp], ['???',:imp], #d8..db
+	['???',:imp], ['CMP',:abx], ['DEC',:abx], ['???',:imp], #db..df
+	['CPX',:imm], ['SBC',:inx], ['???',:imp], ['???',:imp], #e0..e3
+	['CPX',:zpg], ['SBC',:zpg], ['INC',:zpg], ['???',:imp], #e4..e7
+	['INX',:imp], ['SBC',:imm], ['NOP',:imp], ['???',:imp], #e8..eb
+	['CPX',:abs], ['SBC',:abs], ['INC',:abs], ['???',:imp], #ec..ef
+	['BEQ',:rel], ['SBC',:iny], ['SBC',:ind], ['???',:imp], #f0..f3
+	['???',:imp], ['SBC',:zpx], ['INC',:zpx], ['???',:imp], #f4..f7
+	['SED',:imp], ['SBC',:aby], ['PLX',:imp], ['???',:imp], #f8..fb
+	['???',:imp], ['SBC',:abx], ['INC',:abx], ['???',:imp]  #fc..ff
+]
+
+
+OPCODE_SIZE={
+	:imp,1,
+	:acc,1,
+	:imm,2,
+	:abs,3,
+	:abx,3,
+	:aby,3,
+	:zpg,2,
+	:zpx,2,
+	:zpy,2,
+	:ind,3,
+	:inx,2,
+	:iny,2,
+	:inz,2,
+	:rel,2
+} 
+	
+end
+
+  def self.make_printable(b)
+    if (b%0x80)>=0x20 then 
+      (b%0x80).chr
+    else
+      '.'
+    end
+  end
+  
+	def D65.disassemble(buffer,start_address=0,symbols={})
+	
+		index=0
+		s=""
+		while index<buffer.length
+			byte=buffer[index]
+			current_address=start_address+index
+			opcode_name=OPCODES[byte][0]
+			operand_type=OPCODES[byte][1]
+			next_byte=(index<buffer.length-1?buffer[index+1]:0)
+			next_word=(index<buffer.length-2?buffer[index+1]+buffer[index+2]*256:0)
+			operand_format,operand_address= case operand_type
+				when :imp then ['','']
+				when :acc then ["A",'']
+				when :imm then ["\#$%02X",next_byte]
+				when :abs then ["$%04X",next_word]
+				when :abx then ["$%04X,X",next_word]
+				when :aby then ["$%04X,Y",next_word]
+				when :zpg then ["$%02X",next_byte]
+				when :zpx then ["$%02X,X",next_byte]
+				when :zpy then ["$%02X,Y",next_byte]
+				when :ind then ["($%04X)",next_word]
+				when :inx then ["($%02X),X",next_byte]
+				when :iny then ["($%02X),Y",next_byte]
+				when :inz then ["($%02X)",next_byte]
+				when :rel then ["$%04X",(current_address+next_byte.chr.unpack("c")[0]+2)%0x10000]
+				else 
+					abort("unknown symbol #{operand_type}")
+			end
+			operand = sprintf(operand_format,operand_address)
+			opcode_size=OPCODE_SIZE[operand_type]
+			instruction_bytes=case opcode_size
+				when 1 then sprintf("%02X       | %s  |   ",byte,make_printable(byte))
+				when 2 then sprintf("%02X %02X    | %s%s |   ",byte,next_byte,make_printable(byte),make_printable(next_byte))
+				when 3 then sprintf("%02X %02X %02X | %s%s%s|   ",byte,next_byte,next_word>>8,make_printable(byte),make_printable(next_byte),make_printable(next_word>>8))
+			end
+
+			s<<sprintf("%04X:  %s %s %s  ; ",current_address,instruction_bytes,opcode_name,operand.ljust(10))
+      annotation=symbols[current_address] unless symbols.nil?
+      if annotation.nil? then
+        annotation=symbols[operand_address] unless symbols.nil?
+        if (annotation && (operand_type!=:imm)) then
+          s<<"  "+annotation.to_s
+        end
+      else
+          s<<"  @@"+annotation.to_s
+      end
+			s<< "\n"
+			index+=opcode_size
+		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/file_systems/AppleCPM.rb

@@ -0,0 +1,123 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+$:.unshift(File.dirname(__FILE__+"\\..")) unless
+	$:.include?(File.dirname(__FILE__+"\\..")) || $:.include?(File.expand_path(File.dirname(__FILE__+"\\..")))
+
+
+require 'FileSystem'
+class AppleCPM<FileSystem
+
+def self.host_system
+  Apple2
+end  
+
+def self.matching_score
+  20
+end
+
+  RECORD_SIZE=128
+  BLOCK_SIZE=1024
+  BLOCKS_PER_EXTENT=16
+  RECORDS_PER_BLOCK=BLOCK_SIZE/RECORD_SIZE
+  RECORDS_PER_EXTENT=RECORDS_PER_BLOCK*BLOCKS_PER_EXTENT
+  
+ SECTORS_IN_BLOCK=[
+    [0x00,0x06,0x0C,0x03],  #block 0
+    [0x09,0x0F,0x0E,0x05],  #block 1
+    [0x0B,0x02,0x08,0x07],  #block 2
+    [0x0D,0x04,0x0A,0x01]  #block 3
+  ]
+  
+  def self.get_block(file_system_image,block_no)
+    track_no= ((block_no/4)+3)%file_system_image.track_count
+    s=""
+    SECTORS_IN_BLOCK[block_no%4].each {|sector_no| s+=file_system_image.get_sector(track_no,sector_no)}
+    s
+  end
+
+
+  #look for a valid looking CPM directory on track 3.
+  #go through each sector in order, for each sector, look at every 32nd byte, and see if it is a valid 'user number' (i.e. a number from 00..0F). Stop looking when you see an 'E5'.
+  #if an invalid user number is found before an E5, then the disk is NOT a CPM disk
+  is_valid_file_system_if lambda {
+  is_valid=true
+  found_0xE5_byte=false
+  [0x0,0x6,0xC,0x3,0x9, 0xF,0xE,0x5].each do |sector_no|
+    sector=file_system_image.get_sector(3,sector_no)
+    if sector.nil? then
+      is_valid=false
+      break
+    end
+    [0x00,0x20,0x40,0x60,0x80,0xA0,0xC0,0xE0].each do |byte_number|        
+      if (sector[byte_number]>0x0F && sector[byte_number]!=0xe5 && sector[byte_number]!=0x1F) then
+        is_valid=false
+        break
+      end
+      if (sector[byte_number]==0xe5) then
+        found_0xE5_byte=true
+      end
+    end
+  end
+  is_valid && found_0xE5_byte
+}
+
+#CPM DIR looks like this:
+#$00        User number, or E5h if it's a free entry 
+#$01..0B   Filename + extension: 8+3 characters 
+#$0C..0D  Extent number of this entry 
+#$0E       ???
+#$0F       Number of 128-byte records allocated in this extant
+#$10..1F  Allocation map for this directory entry
+def self.files(file_system_image)
+  files=FileContainer.new
+  catalog=get_block(file_system_image,0)+get_block(file_system_image,1)
+  0.upto(63) do |dir_entry_no|
+    dir_entry_start=dir_entry_no*0x20
+    dir_entry=catalog[dir_entry_start..dir_entry_start+0x1F]      
+    if (dir_entry[0]<0x10) then
+      file_name=dir_entry[0x01..0x08].gsub(' ','')
+      file_ext=dir_entry[0x09..0x0B].gsub(' ','')
+      full_filename="#{file_name}.#{file_ext}"
+      files<<NativeFileType.best_fit(file_system_image,full_filename,'',file_ext)
+      if files[full_filename].nil? then
+        files<<file 
+      end
+      s=""
+      0x10.upto(0x1f) do |i|
+        block=dir_entry[i]
+        s+=get_block(file_system_image,block) unless block==0
+      end        
+      records_allocated=dir_entry[0x0F]
+      files[full_filename].contents+=s[0,(records_allocated*128)]
+    end
+  end    
+  files
+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/file_systems/AppleDos.rb

@@ -0,0 +1,211 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+$:.unshift(File.dirname(__FILE__+"\\..")) unless
+	$:.include?(File.dirname(__FILE__+"\\..")) || $:.include?(File.expand_path(File.dirname(__FILE__+"\\..")))
+
+
+require 'FileSystem'
+#
+# Disk image with a standard Apple DOS 3.3 VTOC at track $11, sector $00
+#
+#
+#VTOC : Volume Table of Contents (from Beneath Apple DOS pp 4-2 & 4-3)
+# 00    not used
+# 01    track number of first catalog sector
+# 02    sector number of first catalog sector
+# 03    release number of DOS used to INIT this disk
+# 04-05 not used
+# 06    Diskette volume number (1-254)
+# 07-26 not used
+# 27    maximum number of track/sector pairs which will fit in one file track/sector
+#	list sector (122 for 256 byte sectors)
+# 28-2F not used
+# 30    last track where sectors were allocated
+# 31    direction of track allocation (+1 or -1)
+# 32-33 not used
+# 34    number of tracks per diskette (normally 35)
+# 35    number of sectors per track (13 or 16)
+# 36-37 number of bytes per sector (LO/HI format)
+# 38-3B bit map of free sectors in track 0
+# 3C-3F bit map of free sectors in track 1
+# 40-43 bit map of free sectors in track 2
+#	...
+# BC-BF bit map of free sectors in track 33
+# CO-C3 bit map of free sectors in track 34
+# C4-FF bit maps for additional tracks if there are more than 35 tracks per diskette
+#
+#CATALOG (from Beneath Apple DOS p 4-6)
+# 00    Not Used
+# 01    track number of next catalog sector
+# 02    sector number of next catalog sector
+# 03-0A not used
+# 0B-2D First file descriptive entry
+# 2E-50 Second file descriptive entry
+# 51-73 Third file descriptive entry
+# 74-96 Fourth file descriptive entry
+# 97-B9 Fifth file descriptive entry
+# BA-DC Sixth file descriptive entry
+# DD-FF Seventh file descriptive entry
+#
+#FILE DESCRIPTIVE ENTRY (from Beneath Apple DOS p 4-6)
+# 00    Track of first track/sector list sector, if this is a deleted file this contains FF
+#	and the original track number is copied to the last byte of the file name (BYTE 20)
+#	If this byte contains a 00, the entry is assumed to never have been used and is
+#	available for use. (This means track 0 can never be used for data even if the DOS image
+#	is 'wiped' from the disk)
+#
+# 01    Sector of first track/sector list sector
+# 02    File type and flags:
+#	80+file type - file is locked
+#	00+file type - file is not locked
+#
+#	00 - TEXT file
+#	01 - INTEGER BASIC file
+#	02 - APPLESOFT BASIC file
+#	04 - BINARY file
+#	08 - S type file
+#	10 - RELOCATABLE object module file
+#	20 - a type file
+#	40 - b type file
+#
+# 03-20 File Name (30 characters)
+# 21-22 Length of file in sectors (LO/HI format)
+#
+#	
+#TRACK/SECTOR LIST FORMAT (from Beneath Apple DOS p 4-6)
+# 00	Not used
+# 01	Track number of next T/S list of one is needed or zero if no more t/s list
+# 02 	Sector number of next T/S list (if one is present)
+# 03-04	Not used
+# 05-06	Sector offset in file of the first sector described by this list
+# 07-oB	Not used
+# 0C-0D	Track and sector of first data sector or zeros
+# 0E-0F	Track and sector of second data sector or zeros
+# 10-FF	Up to 120 more track and sector pairs
+class AppleDos<FileSystem
+
+def self.host_system
+  Apple2
+end  
+
+#if the filesystem on a DSK is DOS, we don't have to worry about sector interleaves
+is_valid_file_system_if lambda {!file_system_image.image_format.is_a?(A2DskDosOrder)}
+
+# does this image have a standard Apple DOS 3.3 VTOC?
+# VTOC is at track 0x11, sector 0
+# bytes 1 & 2 are a track number, sector number and DOS version number
+# byte 27  is maximum number of track/sector pairs which will fit in one file track/sector list sector (122 for 256 byte sectors)
+# 35    number of sectors per track (16)
+# see if these are reasonable values
+is_valid_file_system_if lambda {
+  vtoc_sector=file_system_image.get_sector(AppleDos.vtoc_track_no,AppleDos.vtoc_sector_no)
+  (! vtoc_sector.nil?) &&  (vtoc_sector[01]<=34) && (vtoc_sector[02]<=15) && (vtoc_sector[0x27]==0x7A) && (vtoc_sector[0x35]==0x10) 
+}
+
+def self.vtoc_track_no
+  0x11
+end
+
+def self.vtoc_sector_no
+  0
+end
+
+def self.files(file_system_image)
+  files=FileContainer.new
+  vtoc_sector=file_system_image.get_sector(vtoc_track_no,vtoc_sector_no)
+  catalog_sector=file_system_image.get_sector(vtoc_sector[01],vtoc_sector[02])
+  done=false
+  visited_sectors={}
+  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,36]					
+      break if (file_descriptive_entry[0]==0xFF) # skip deleted files
+      filename=""
+      file_descriptive_entry[3..32].to_s.each_byte{|b| filename+=(b.%128).chr}
+      filename.gsub!(/ *$/,"") #strip off trailing spaces
+      filename.tr!("\x00-\x1f","\x40-\x5f") #convert non-printable chars to corresponding uppercase letter
+      locked=(file_descriptive_entry[2]>=0x80)
+      sector_count=file_descriptive_entry[0x21]+file_descriptive_entry[0x22]*256
+  
+      file_type_code=file_descriptive_entry[2]%0x80
+      
+      
+      if (sector_count>0) then
+        contents=""
+        ts_list_track_no=file_descriptive_entry[0]
+        ts_list_sector_no=file_descriptive_entry[1]
+        while (ts_list_track_no>0) && (ts_list_track_no<=0X22) && (ts_list_sector_no<=0x0f)
+          ts_list_sector=file_system_image.get_sector(ts_list_track_no,ts_list_sector_no)
+          ts_list_track_no=ts_list_sector[1]
+          ts_list_sector_no=ts_list_sector[2]
+
+          0x0C.step(0xff,2) {|i|						
+            data_track_no=ts_list_sector[i]
+            data_sector_no=ts_list_sector[i+1]
+            if (data_track_no>0) && (data_track_no<=0X22) && (data_sector_no<=0x0f) then
+              contents+=file_system_image.get_sector(data_track_no,data_sector_no)
+            end
+          }
+        end
+        if contents.length>0 then
+          files<<NativeFileType.best_fit(file_system_image,filename,contents,file_type_code)
+  #        @files<< case file_type_code
+#            when 0x00 then TextFile.new(filename,contents,locked)
+#            when 0x01 then SCAsmFile.can_be_scasm_file?(contents)? SCAsmFile.new(filename,contents,locked): IntegerBasicFile.new(filename,contents,locked)
+#            when 0x02 then AppleSoftFile.new(filename,contents,locked)
+#            when 0x04 then MusiCompFile.can_be_musicomp_file?(filename,contents)? MusiCompFile.new(filename,contents,locked): BinaryFile.new(filename,contents,locked)
+#						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,contents,locked,file_type_code)
+ #         end
+        end
+      end
+    }
+    next_track=catalog_sector[1]		
+    next_sector=catalog_sector[2]%0x10
+    if (next_track==0) &&( next_sector==0) then
+      done=true
+    else 
+      #check we haven't got into an endless loop
+      s="#{next_track}/#{next_sector}"
+      if (!visited_sectors[s].nil?) then
+        done=true
+      end
+      visited_sectors[s]=true
+      catalog_sector=file_system_image.get_sector(next_track,next_sector)
+    end
+  end
+  files
+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.