dsktool 0.1.1

data/bin/dsktool.rb

@@ -0,0 +1,157 @@
+#
+# dsktool
+#
+# == Synopsis
+#
+# Manipulate DSK format files
+#
+# == Usage
+#
+# dsktool.rb [switches] <filename.dsk>
+#  -c | --catalog               display catalog
+#  -l | --list FILENAME         monitor style listing (disassembles 65C02 opcodes)
+#  -e | --extract FILENAME      extract file by name (either to stdout, 
+#                               or file specified by --output)
+#  -h | --help                  display this message
+#  -o | --output FILENAME       specify name to save extracted file as
+#  -x | --explode               extract all files 
+#  -v | --version               show version number
+#
+# examples:
+#	dsktool -c DOS3MASTR.dsk
+#	dsktool -l FID DOS3MASTR.dsk
+#	dsktool -d fid -o fid.asm DOS3MASTR.dsk
+#	dsktool -e "COLOR DEMOSOFT" DOS3MASTR.dsk
+#	dsktool -e HELLO -o HELLO.bas DOS3MASTR.dsk
+#	dsktool -x DOS3MASTR.dsk
+#
+
+DSKTOOL_VERSION="0.1.1"
+
+require 'optparse'
+require 'rdoc/usage'
+
+#due to a bug in rdoc, tghe Usage won't work correctly when run from a gem executable
+# see http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/211297
+# Display usage from the given file
+def RDoc.usage_from_file(input_file, *args)
+	comment = File.open(input_file) do |file|
+		RDoc.find_comment(file)
+	end
+	comment = comment.gsub(/^\s*#/, '')
+
+	markup = SM::SimpleMarkup.new
+	flow_convertor = SM::ToFlow.new
+    
+	flow = markup.convert(comment, flow_convertor)
+
+	format = "plain"
+
+	unless args.empty?
+		flow = extract_sections(flow, args)
+	end
+
+	options = RI::Options.instance
+	if args = ENV["RI"]
+		options.parse(args.split)
+	end
+	formatter = options.formatter.new(options, "")
+	formatter.display_flow(flow)
+	exit
+end
+
+
+catalog=false
+explode=false
+output_filename=nil
+extract_filename=nil
+list_filename=nil
+explode_directory=nil
+opts=OptionParser.new
+opts.on("-h","--help") {RDoc::usage_from_file(__FILE__)}
+opts.on("-v","--version") do
+	puts "dsktool.rb "+DSKTOOL_VERSION
+	exit
+end
+opts.on("-c","--catalog") {catalog=true}
+opts.on("-x","--explode") {explode=true}
+opts.on("-l","--list FILENAME",String) {|val| list_filename=val.upcase}
+opts.on("-e","--extract FILENAME",String) {|val| extract_filename=val.upcase}
+opts.on("-o","--output FILENAME",String) {|val| output_filename=val}
+filename=opts.parse(ARGV)[0] rescue RDoc::usage_from_file(__FILE__,'Usage')
+RDoc::usage_from_file(__FILE__,'Usage') if (filename.nil?)
+
+#make sure the relevant folder with our libraries is in the require path
+lib_path=File.expand_path(File.dirname(__FILE__)+"//..//lib")
+$:.unshift(lib_path) unless $:.include?(lib_path)
+	
+require 'DSK'
+dsk=DSK.read(filename)
+output_file= case
+	when (output_filename.nil?) then STDOUT
+	else File.open(output_filename,"wb")
+end
+	
+if(catalog) then	
+	dsk.dump_catalog
+end
+
+if(explode) then
+	output_dir=filename.sub(/\.[^.]*$/,"")
+	if !(File.exists?(output_dir)) then
+		Dir.mkdir(output_dir)	
+	end
+			
+	dsk.files.each_value do |f|
+		output_filename=output_dir+"/"+f.filename+f.file_extension
+		File.open(output_filename,"wb") <<f
+	end
+end
+
+
+if (!extract_filename.nil?) then
+	file=dsk.files[extract_filename]
+	if file.nil? then
+		puts "'#{extract_filename}' not found in #{filename}"
+	else
+		output_file<<file
+	end
+end
+
+if (!list_filename.nil?) then
+	file=dsk.files[list_filename]
+	if file.nil? then
+		puts "'#{list_filename}' not found in #{filename}"
+	else
+		if file.instance_of?(BinaryFile)
+			output_file<<file.disassembly
+		else
+			puts "'#{list_filename}' is not a binary file"
+		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/doc/classes/AppleSoftFile.html

@@ -0,0 +1,215 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: AppleSoftFile</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">AppleSoftFile</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/DOSFile_rb.html">
+                lib/DOSFile.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="DOSFile.html">
+                DOSFile
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+    <div id="diagram">
+      <map id="map" name="map">
+  <area shape="RECT" coords="5,101,109,149"      href="IntegerBasicFile.html" alt="IntegerBasicFile">
+  <area shape="RECT" coords="133,101,227,149"      href="AppleSoftFile.html" alt="AppleSoftFile">
+  <area shape="RECT" coords="251,101,325,149"      href="BinaryFile.html" alt="BinaryFile">
+  <area shape="RECT" coords="197,5,269,53"      href="DOSFile.html" alt="DOSFile">
+  <area shape="RECT" coords="349,101,421,149"      href="TextFile.html" alt="TextFile">
+</map>
+<img src="../dot/f_3.png" usemap="#map" border=0 alt="TopLevel">
+    </div>
+
+    <div id="description">
+      <pre>
+ Adapted from FID.C -- a utility to browse Apple II .DSK image files by Paul Schlyter (pausch@saaf.se)
+</pre>
+<p>
+Applesoft file format:
+</p>
+<pre>
+ &lt;Length_of_file&gt; (16-bit little endian)
+ &lt;Line&gt;
+ ......
+ &lt;Line&gt;
+ where &lt;Line&gt; is:
+ &lt;Next addr&gt;  (16-bit little endian)
+ &lt;Line no&gt;    (16-bit little endian: 0-65535)
+ &lt;Tokens and/or characters&gt;
+ &lt;End-of-line marker: $00 $00 bytes&gt;
+</pre>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000012">file_extension</a>&nbsp;&nbsp;
+      <a href="#M000010">file_type</a>&nbsp;&nbsp;
+      <a href="#M000011">to_s</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">APPLESOFT_TOKENS</td>
+          <td>=</td>
+          <td class="context-item-value">[                &quot;END&quot;,&quot;FOR&quot;,&quot;NEXT&quot;,&quot;DATA&quot;,&quot;INPUT&quot;,&quot;DEL&quot;,&quot;DIM&quot;,&quot;READ&quot;,                 &quot;GR&quot;,&quot;TEXT&quot;,&quot;PR#&quot;,&quot;IN#&quot;,&quot;CALL&quot;,&quot;PLOT&quot;,&quot;HLIN&quot;,&quot;VLIN&quot;,                 &quot;HGR2&quot;,&quot;HGR&quot;,&quot;HCOLOR=&quot;,&quot;HPLOT&quot;,&quot;DRAW&quot;,&quot;XDRAW&quot;,&quot;HTAB&quot;,                 &quot;HOME&quot;,&quot;ROT=&quot;,&quot;SCALE=&quot;,&quot;SHLOAD&quot;,&quot;TRACE&quot;,&quot;NOTRACE&quot;,                 &quot;NORMAL&quot;,&quot;INVERSE&quot;,&quot;FLASH&quot;,&quot;COLOR=&quot;,&quot;POP&quot;,&quot;VTAB&quot;,                 &quot;HIMEM=&quot;,&quot;LOMEM=&quot;,&quot;ONERR&quot;,&quot;RESUME&quot;,&quot;RECALL&quot;,&quot;STORE&quot;,                 &quot;SPEED=&quot;,&quot;LET&quot;,&quot;GOTO&quot;,&quot;RUN&quot;,&quot;IF&quot;,&quot;RESTORE&quot;,&quot;&amp;&quot;,&quot;GOSUB&quot;,                 &quot;RETURN&quot;,&quot;REM&quot;,&quot;STOP&quot;,&quot;ON&quot;,&quot;WAIT&quot;,&quot;LOAD&quot;,&quot;SAVE&quot;,&quot;DEF&quot;,                 &quot;POKE&quot;,&quot;PRINT&quot;,&quot;CONT&quot;,&quot;LIST&quot;,&quot;CLEAR&quot;,&quot;GET&quot;,&quot;NEW&quot;,                 &quot;TAB(&quot;,&quot;TO&quot;,&quot;FN&quot;,&quot;SPC(&quot;,&quot;THEN&quot;,&quot;AT&quot;,&quot;NOT&quot;,&quot;STEP&quot;,&quot;+&quot;,                 &quot;-&quot;,&quot;*&quot;,&quot;/&quot;,&quot;^&quot;,&quot;AND&quot;,&quot;OR&quot;,&quot;&gt;&quot;,&quot;=&quot;,&quot;&lt;&quot;,&quot;SGN&quot;,&quot;INT&quot;,                 &quot;ABS&quot;,&quot;USR&quot;,&quot;FRE&quot;,&quot;SCRN(&quot;,&quot;PDL&quot;,&quot;POS&quot;,&quot;SQR&quot;,&quot;RND&quot;,                 &quot;LOG&quot;,&quot;EXP&quot;,&quot;COS&quot;,&quot;SIN&quot;,&quot;TAN&quot;,&quot;ATN&quot;,&quot;PEEK&quot;,&quot;LEN&quot;,                 &quot;STR$&quot;,&quot;VAL&quot;,&quot;ASC&quot;,&quot;CHR$&quot;, &quot;LEFT$&quot;,&quot;RIGHT$&quot;,&quot;MID$&quot;,&quot;?&quot;,                 &quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;,&quot;?&quot;</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
+
+        <div class="method-heading">
+          <a href="AppleSoftFile.src/M000012.html" target="Code" class="method-signature"
+            onclick="popupCode('AppleSoftFile.src/M000012.html');return false;">
+          <span class="method-name">file_extension</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
+
+        <div class="method-heading">
+          <a href="AppleSoftFile.src/M000010.html" target="Code" class="method-signature"
+            onclick="popupCode('AppleSoftFile.src/M000010.html');return false;">
+          <span class="method-name">file_type</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
+
+        <div class="method-heading">
+          <a href="AppleSoftFile.src/M000011.html" target="Code" class="method-signature"
+            onclick="popupCode('AppleSoftFile.src/M000011.html');return false;">
+          <span class="method-name">to_s</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+display file with all AppleSoft BASIC tokens expanded to ASCII
+</p>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/AppleSoftFile.src/M000005.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>file_type (AppleSoftFile)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/DOSFile.rb, line 53</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">file_type</span>
+                <span class="ruby-value str">&quot;A&quot;</span>
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/AppleSoftFile.src/M000006.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>to_s (AppleSoftFile)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/DOSFile.rb, line 57</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
+                <span class="ruby-identifier">buffer_as_applesoft_file</span>(<span class="ruby-ivar">@contents</span>)
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/AppleSoftFile.src/M000008.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>file_type (AppleSoftFile)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/DOSFile.rb, line 60</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">file_type</span>
+                <span class="ruby-value str">&quot;A&quot;</span>
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/AppleSoftFile.src/M000009.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>file_type (AppleSoftFile)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/DOSFile.rb, line 251</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">file_type</span>
+                <span class="ruby-value str">&quot;A&quot;</span>
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>