dsktool 0.4.2 → 0.5.1

data/lib/CPMDisk.rb

@@ -0,0 +1,194 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+# Disk image with CPM File System
+#catalog  will be on track 2
+#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 used in last alloc. block 
+#$10..1F  Allocation map for this directory entry
+
+require 'CPMFile'
+class CPMDisk < DSK
+	attr_accessor :free_blocks,:free_directory_entries
+  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 get_block(block_no)
+    track_no= ((block_no/4)+3)%track_count
+    s=""
+    SECTORS_IN_BLOCK[block_no%4].each {|sector_no|s+=get_sector(track_no,sector_no)}
+    s
+  end
+
+  def set_block(block_no,contents)
+    raise "invalid block #{block_no} - length was #{contents.length}" unless contents.length==BLOCK_SIZE
+    track_no=(block_no/4)+3
+    0.upto(3) do |i|
+      sector_no=SECTORS_IN_BLOCK[block_no%4][i]
+      set_sector(track_no,sector_no,contents[(i*256),256])
+    end  
+  end
+  
+	def dump_catalog
+		s=""
+		files.keys.sort.each { |file_name|		
+			file=files[file_name]	
+			s<< sprintf("% 12s % 6d \n",file.full_filename,file.contents.length)
+		}
+		s
+	end
+  
+
+	def initialize(file_bytes,sector_order)    
+		super(file_bytes,sector_order)
+		self.read_catalog
+	end
+
+	def file_system
+		:cpm
+	end
+	
+  def make_file(filename,contents,file_options={})
+    return CPMFile.new(filename,contents)
+  end
+
+  
+  def delete_file(full_filename)
+    catalog=get_block(0)+get_block(1)
+    (partial_filename,file_ext)=CPMFile.split_filename(full_filename)
+    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 (partial_filename==dir_entry[0x01..0x08].gsub(' ','')) && (file_ext==dir_entry[0x09..0x0B].gsub(' ',''))      
+        #we found a matching filename, so set the 'user number' field to a 'blank' entry
+        catalog[dir_entry_start]=0xE5
+      end
+    end
+    
+    set_block(0,catalog[0,BLOCK_SIZE])
+    set_block(1,catalog[BLOCK_SIZE,BLOCK_SIZE])
+    self.read_catalog
+  end  
+  
+  def add_file(file)
+    raise "only CPMFiles may be added to CPM format disks!" unless file.kind_of?(CPMFile)
+    delete_file(file.full_filename) #so we can overwrite the file if it already exists  
+    
+    total_record_count=(file.contents.length/RECORD_SIZE.to_f).ceil
+    total_blocks_needed=(total_record_count/RECORDS_PER_BLOCK.to_f).ceil    
+    total_extents_needed=(total_blocks_needed/BLOCKS_PER_EXTENT.to_f).ceil
+    
+    raise "#{total_blocks_needed} free blocks required, only #{free_blocks.length} available" unless total_blocks_needed<=free_blocks.length
+    raise "#{total_extents_needed} free directory entries required, only #{free_directory_entries.length} available" unless total_extents_needed<=free_directory_entries.length
+    catalog=get_block(0)+get_block(1)
+    padded_file_contents=file.contents+(0x1A.chr*BLOCK_SIZE)
+    
+    0.upto(total_extents_needed-1) do |extent_no|
+      records_this_extent=(extent_no==(total_extents_needed-1) ? (total_record_count % RECORDS_PER_EXTENT):RECORDS_PER_EXTENT)
+      blocks_this_extent=(records_this_extent/RECORDS_PER_BLOCK.to_f).ceil
+      blocks_used=[0]*BLOCKS_PER_EXTENT
+      first_record_this_extent=extent_no*RECORDS_PER_EXTENT
+      contents_this_extent=padded_file_contents[(first_record_this_extent*RECORD_SIZE),blocks_this_extent*BLOCK_SIZE]
+      
+      0.upto(blocks_this_extent-1) do |block_no|
+          this_block=free_blocks[block_no+(extent_no*BLOCKS_PER_EXTENT)]
+          set_block(this_block,contents_this_extent[block_no*BLOCK_SIZE,BLOCK_SIZE])
+          blocks_used[block_no]=this_block
+      end
+      dir_entry_no=free_directory_entries[extent_no]
+      dir_entry_start=dir_entry_no*0x20
+      dir_entry=[0,file.filename,file.file_type,extent_no,0,0,records_this_extent,blocks_used].flatten.pack("CA8A3C4C16")
+      catalog[dir_entry_start..dir_entry_start+0x1F]=dir_entry
+    end
+    
+    set_block(0,catalog[0,BLOCK_SIZE])
+    set_block(1,catalog[BLOCK_SIZE,BLOCK_SIZE])
+    self.read_catalog
+
+  end
+  
+  
+	#reads the directory, and populate the "files" array with files
+  #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 read_catalog
+    @free_blocks=[]
+    @free_directory_entries=[]
+    @files={}
+    #first two blocks are where the catalog lives
+    (2..((track_count-3)*4)-1).each {|block| @free_blocks<<block}
+    catalog=get_block(0)+get_block(1)
+    #require 'DumpUtilities'
+    #puts DumpUtilities.hex_dump(catalog)
+    0.upto(63) do |dir_entry_no|
+      #puts 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(' ','')
+                
+        if (file_ext=="BAS") then
+          file=MBASICFile.new("#{file_name}.#{file_ext}",'')
+        else
+          file=CPMFile.new("#{file_name}.#{file_ext}",'')
+        end
+        if @files[file.full_filename].nil? then
+          @files[file.full_filename]=file 
+        end
+        s=""
+        0x10.upto(0x1f) do |i|
+          block=dir_entry[i]
+          @free_blocks.delete(block)
+          s+=get_block(block) unless block==0
+        end        
+        records_allocated=dir_entry[0x0F]
+        @files[file.full_filename].contents+=s[0,(records_allocated*128)]
+      else
+        @free_directory_entries<<dir_entry_no
+      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/CPMFile.rb

@@ -0,0 +1,344 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'DSKFile'
+require 'HGR'
+
+class CPMFile < DSKFile
+  attr_accessor :file_type
+  def CPMFile.split_filename(filename)
+    filename=~/^([^.]{0,8})(\.([^.]{0,3}))?$/ #filename should have 0-8 chars, then optionally a dot and up to 3 more chars.		
+    partial_filename=$1
+    ext=$3
+    ext="" if ext.nil?
+		return [partial_filename,ext]
+  end
+	def initialize(filename,contents)    
+		@filename,@file_type=CPMFile.split_filename(filename)
+    raise "invalid filename #{filename}" if @filename.nil?
+		@contents=contents    
+	end
+  
+  def full_filename
+    if @file_type=="" then
+      @filename
+    else      
+      "#{@filename}.#{@file_type}"
+    end
+  end
+    
+	def to_s
+    @contents.gsub(/\x1A*$/,'')
+	end
+  
+	def file_extension
+		return "."+@file_type.downcase
+	end
+
+	def can_be_picture?		
+		file_type==:foto && HGR.can_be_hgr_screen?(@contents)
+	end
+
+	def to_png(pallete_mode=:amber)
+		HGR.buffer_to_png(@contents,pallete_mode)
+	end
+end
+
+class MBASICFile<CPMFile
+  
+  #the CP/M MBASIC file format is very similar to the MS-DOS BASICA/GWBASIC formats, described at
+  #http://www.chebucto.ns.ca/~af380/GW-BASIC-tokens.html
+  
+  SINGLE_BYTE_TOKENS={
+	0x81=>'END',
+	0x82=>'FOR',
+	0x83=>'NEXT',
+	0x84=>'DATA',
+	0x85=>'INPUT',
+	0x86=>'DIM',
+	0x87=>'READ',
+	0x88=>'LET',
+	0x89=>'GOTO',
+	0x8A=>'RUN',
+	0x8B=>'IF',
+	0x8C=>'RESTORE',
+	0x8D=>'GOSUB',
+	0x8E=>'RETURN',
+	0x8F=>'REM',
+	0x90=>'STOP',
+	0x91=>'PRINT',
+	0x92=>'CLEAR',
+	0x93=>'LIST',
+	0x94=>'NEW',
+	0x95=>'ON',
+	0x96=>'DEF',
+	0x97=>'POKE',
+	0x98=>'CONT',
+	0x9B=>'LPRINT',
+	0x9C=>'LLIST',
+	0x9D=>'WIDTH',
+	0x9E=>'ELSE',
+	0x9F=>'TRACE',
+	0xA0=>'NOTRACE',
+	0xA1=>'SWAP',
+	0xA2=>'ERASE',
+	0xA3=>'EDIT',
+	0xA4=>'ERROR',
+	0xA5=>'RESUME',
+	0xA6=>'DEL',
+	0xA7=>'AUTO',
+	0xA8=>'RENUM',
+	0xA9=>'DEFSTR',
+	0xAA=>'DEFINT',
+	0xAB=>'DEFSNG',
+	0xAC=>'DEFDBL',
+	0xAD=>'LINE',
+	0xAE=>'POP',
+	0xAF=>'WHILE',
+	0xB0=>'WEND',
+	0xB1=>'CALL',
+	0xB2=>'WRITE',
+	0xB3=>'COMMON',
+	0xB4=>'CHAIN',
+	0xB5=>'OPTION',
+	0xB6=>'RANDOMIZE',
+	0xB7=>'SYSTEM',
+	0xB8=>'OPEN',
+	0xB9=>'FIELD',
+	0xBA=>'GET',
+	0xBB=>'PUT',
+	0xBC=>'CLOSE',
+	0xBD=>'LOAD',
+	0xBE=>'MERGE',
+	0xBF=>'FILES',
+	0xC0=>'NAME',
+	0xC1=>'KILL',
+	0xC2=>'LSET',
+	0xC3=>'RSET',
+	0xC4=>'SAVE',
+	0xC5=>'RESET',
+	0xC6=>'TEXT',
+	0xC7=>'HOME',
+	0xC8=>'VTAB',
+	0xC9=>'HTAB',
+	0xCA=>'INVERSE',
+	0xCB=>'NORMAL',
+	0xCC=>'GR',
+	0xCD=>'COLOR',
+	0xCE=>'HLIN',
+	0xCF=>'VLIN',
+	0xD0=>'PLOT',
+	0xD1=>'HGR',
+	0xD2=>'HPLOT',
+	0xD3=>'HCOLOR',
+	0xD4=>'BEEP',
+	0xD5=>'WAIT',
+	0xDD=>'TO',
+	0xDE=>'THEN',
+	0xDF=>'TAB(',
+	0xE0=>'STEP',
+	0xE1=>'USR',
+	0xE2=>'FN',
+	0xE3=>'SPC(',
+	0xE4=>'NOT',
+	0xE5=>'ERL',
+	0xE6=>'ERR',
+	0xE7=>'STRING$',
+	0xE8=>'USING',
+	0xE9=>'INSTR',
+	0xEA=>"'",
+	0xEB=>'VARPTR',
+	0xEC=>'SCRN',
+	0xED=>'HSCRN',
+	0xEE=>'INKEY$',
+	0xEF=>'>',
+	0xF0=>'=',
+	0xF1=>'<',
+	0xF2=>'+',
+	0xF3=>'-',
+	0xF4=>'*',
+	0xF5=>'/',
+	0xF6=>'^',
+	0xF7=>'AND',
+	0xF8=>'OR',
+	0xF9=>'XOR',
+	0xFA=>'EQV',
+	0xFB=>'IMP',
+	0xFC=>'MOD',
+	0xFD=>'\\',
+}
+DOUBLE_BYTE_TOKENS={
+	0x81=>'LEFT$',
+	0x82=>'RIGHT$',
+	0x83=>'MID$',
+	0x84=>'SGN',
+	0x85=>'INT',
+	0x87=>'SQR',
+	0x88=>'RND',
+	0x89=>'SIN',
+	0x8A=>'LOG',
+	0x8B=>'EXP',
+	0x8C=>'COS',
+	0x8D=>'TAN',
+	0x8E=>'ATN',
+	0x8F=>'FRE',
+	0x90=>'POS',
+	0x91=>'LEN',
+	0x92=>'STR$',
+	0x93=>'VAL',
+	0x94=>'ASC',
+	0x95=>'CHR$',
+	0x96=>'PEEK',
+	0x97=>'SPACE$',
+	0x98=>'OCT$',
+	0x99=>'HEX$',
+	0x9A=>'LPOS',
+	0x9B=>'CINT',
+	0x9C=>'CSNG',
+	0x9D=>'CDBL',
+	0x9E=>'FIX',
+	0xAA=>'CVI',
+	0xAB=>'CVS',
+	0xAC=>'CVD',
+	0xAE=>'EOF',
+	0xAF=>'LOC',
+	0xB0=>'LOF',
+	0xB1=>'MKI$',
+	0xB2=>'MKS$',
+	0xB3=>'MKD$',
+	0xB4=>'VPOS',
+	0xB5=>'PDL',
+	0xB6=>'BUTTON',
+}
+
+
+def to_s
+  if @contents[0]==0xFF then
+    buffer_as_gbasic(@contents)
+  else
+    @contents
+  end
+end
+
+def parse_bytes_as_float(bytes)
+	return 0.0 if bytes[0]==0
+	exponent=2**(bytes[0]-0x80)
+	first_byte=bytes[1]
+	sign=-1.0	#assume it's negative
+	if first_byte<0x80 then
+		sign=1.0
+		first_byte+=0x80
+	end	
+	mantissa=(first_byte/256.0)*sign
+	2.upto(bytes.length-1) do |i|
+		mantissa+=(bytes[i]/(256.0**i))
+	end
+	return sprintf("%8f",exponent*mantissa).to_f
+end
+
+
+def buffer_as_gbasic(buffer)
+	s=""
+	p=1
+	while(p<buffer.length) && (buffer[p]!=0)
+		p+=2	#skip the 2 byte pointer to the start of next line
+		line_number=buffer[p]+(buffer[p+1]<<8)
+		p+=2
+		s+= "#{line_number} "		
+		while(p<buffer.length) && (buffer[p]!=0)
+			c=buffer[p]
+			p+=1
+
+			if (c==0x3A) then 	#if its a ':'
+
+				if buffer[p]==0x9E then	#ELSE is actually stored as :ELSE
+					c=buffer[p]
+					p+=1
+				end
+				if buffer[p]==0x8F then	#' is actually stored as :REM'					
+					c=buffer[p+1]
+					p+=2
+				end
+			end
+			if c<0x20 then
+				case (c)
+					when 0x0B	#OCTAL CONSTANT
+						constant=buffer[p]+(buffer[p+1]<<8)
+						s+=sprintf("&O%o",constant)
+						p+=2
+
+					when 0x0C	#HEX CONSTANT
+						constant=buffer[p]+(buffer[p+1]<<8)
+						s+=sprintf("&H%X",constant)
+						p+=2
+					when 0x0E	#DECIMAL LINE NUMBER
+						constant=buffer[p]+(buffer[p+1]<<8)
+						s+=sprintf("%d",constant)
+						p+=2
+					when 0x0F	#one byte constant
+						constant=buffer[p]
+						s+=sprintf("%d",constant)
+						p+=1
+					when 0x11..0x1B	#packed constant 0..9
+						s+=sprintf("%d",c-0x11)
+					when 0x1C	#DECIMAL LINE NUMBER
+						constant=buffer[p]+(buffer[p+1]<<8)
+						s+=sprintf("%d",constant)
+						p+=2
+          when 0x1D #4 byte floating point
+          	constant=parse_bytes_as_float(buffer[p..p+3].reverse)
+            s+=constant.to_s
+            p+=4
+          when 0x1F #8 byte floating point
+          	constant=parse_bytes_as_float(buffer[p..p+7].reverse)
+            s+=constant.to_s
+            p+=8
+				end
+
+			elsif c<0x80 then
+				s+=c.chr
+			else
+
+				if c==0xFF then
+					
+					c=buffer[p]
+					p+=1
+					token=DOUBLE_BYTE_TOKENS[c]
+				else
+					token=SINGLE_BYTE_TOKENS[c]
+				end
+				s+=(token.nil?) ? sprintf("[%02X]",c):token
+
+			end
+		end
+		s+="\n"
+	p+=1
+	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.