doc/classes/NADOLDisk.html in dsktool-0.2.1 vs doc/classes/NADOLDisk.html in dsktool-0.4.1

- old
+ new

@@ -57,10 +57,14 @@ <td> <a href="../files/lib/NADOLDisk_rb.html"> lib/NADOLDisk.rb </a> <br /> + <a href="../files/test/backup/NADOLDisk_rb.html"> + test/backup/NADOLDisk.rb + </a> + <br /> </td> </tr> <tr class="top-aligned-row"> <td><strong>Parent:</strong></td> @@ -77,29 +81,41 @@ <div id="bodyContent"> <div id="contextContent"> - <div id="diagram"> - <map id="map" name="map"> - <area shape="RECT" coords="13,101,101,149" href="NADOLDisk.html" alt="NADOLDisk"> - <area shape="RECT" coords="21,5,93,53" href="DSK.html" alt="DSK"> -</map> -<img src="../dot/f_6.png" usemap="#map" border=0 alt="TopLevel"> - </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000021">dump_catalog</a>&nbsp;&nbsp; - <a href="#M000022">new</a>&nbsp;&nbsp; - <a href="#M000023">read_catalog</a>&nbsp;&nbsp; + <a href="#M000043">add_file</a>&nbsp;&nbsp; + <a href="#M000054">add_file</a>&nbsp;&nbsp; + <a href="#M000041">delete_file</a>&nbsp;&nbsp; + <a href="#M000052">delete_file</a>&nbsp;&nbsp; + <a href="#M000034">dump_catalog</a>&nbsp;&nbsp; + <a href="#M000045">dump_catalog</a>&nbsp;&nbsp; + <a href="#M000036">file_system</a>&nbsp;&nbsp; + <a href="#M000047">file_system</a>&nbsp;&nbsp; + <a href="#M000038">find_catalog_slot</a>&nbsp;&nbsp; + <a href="#M000049">find_catalog_slot</a>&nbsp;&nbsp; + <a href="#M000039">free_sector_list</a>&nbsp;&nbsp; + <a href="#M000050">free_sector_list</a>&nbsp;&nbsp; + <a href="#M000042">get_track_sector_list</a>&nbsp;&nbsp; + <a href="#M000053">get_track_sector_list</a>&nbsp;&nbsp; + <a href="#M000051">make_file</a>&nbsp;&nbsp; + <a href="#M000040">make_file</a>&nbsp;&nbsp; + <a href="#M000035">new</a>&nbsp;&nbsp; + <a href="#M000046">new</a>&nbsp;&nbsp; + <a href="#M000044">read_catalog</a>&nbsp;&nbsp; + <a href="#M000055">read_catalog</a>&nbsp;&nbsp; + <a href="#M000037">set_sector</a>&nbsp;&nbsp; + <a href="#M000048">set_sector</a>&nbsp;&nbsp; </div> </div> </div> @@ -117,46 +133,300 @@ <!-- if method_list --> <div id="methods"> <h3 class="section-bar">Public Class methods</h3> - <div id="method-M000022" class="method-detail"> - <a name="M000022"></a> + <div id="method-M000035" class="method-detail"> + <a name="M000035"></a> <div class="method-heading"> - <a href="NADOLDisk.src/M000022.html" target="Code" class="method-signature" - onclick="popupCode('NADOLDisk.src/M000022.html');return false;"> - <span class="method-name">new</span><span class="method-args">(file_bytes)</span> + <a href="NADOLDisk.src/M000035.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000035.html');return false;"> + <span class="method-name">new</span><span class="method-args">(file_bytes,sector_order)</span> </a> </div> <div class="method-description"> </div> </div> + <div id="method-M000046" class="method-detail"> + <a name="M000046"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000046.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000046.html');return false;"> + <span class="method-name">new</span><span class="method-args">(file_bytes,sector_order)</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + <h3 class="section-bar">Public Instance methods</h3> - <div id="method-M000021" class="method-detail"> - <a name="M000021"></a> + <div id="method-M000043" class="method-detail"> + <a name="M000043"></a> <div class="method-heading"> - <a href="NADOLDisk.src/M000021.html" target="Code" class="method-signature" - onclick="popupCode('NADOLDisk.src/M000021.html');return false;"> + <a href="NADOLDisk.src/M000043.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000043.html');return false;"> + <span class="method-name">add_file</span><span class="method-args">(file)</span> + </a> + </div> + + <div class="method-description"> + <p> +add a file to the in-memory image of this <a href="DSK.html">DSK</a> +</p> + </div> + </div> + + <div id="method-M000054" class="method-detail"> + <a name="M000054"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000054.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000054.html');return false;"> + <span class="method-name">add_file</span><span class="method-args">(file)</span> + </a> + </div> + + <div class="method-description"> + <p> +add a file to the in-memory image of this <a href="DSK.html">DSK</a> +</p> + </div> + </div> + + <div id="method-M000041" class="method-detail"> + <a name="M000041"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000041.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000041.html');return false;"> + <span class="method-name">delete_file</span><span class="method-args">(filename)</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000052" class="method-detail"> + <a name="M000052"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000052.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000052.html');return false;"> + <span class="method-name">delete_file</span><span class="method-args">(filename)</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000034" class="method-detail"> + <a name="M000034"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000034.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000034.html');return false;"> <span class="method-name">dump_catalog</span><span class="method-args">()</span> </a> </div> <div class="method-description"> </div> </div> - <div id="method-M000023" class="method-detail"> - <a name="M000023"></a> + <div id="method-M000045" class="method-detail"> + <a name="M000045"></a> <div class="method-heading"> - <a href="NADOLDisk.src/M000023.html" target="Code" class="method-signature" - onclick="popupCode('NADOLDisk.src/M000023.html');return false;"> + <a href="NADOLDisk.src/M000045.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000045.html');return false;"> + <span class="method-name">dump_catalog</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000036" class="method-detail"> + <a name="M000036"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000036.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000036.html');return false;"> + <span class="method-name">file_system</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000047" class="method-detail"> + <a name="M000047"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000047.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000047.html');return false;"> + <span class="method-name">file_system</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000038" class="method-detail"> + <a name="M000038"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000038.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000038.html');return false;"> + <span class="method-name">find_catalog_slot</span><span class="method-args">(filename)</span> + </a> + </div> + + <div class="method-description"> + <p> +iterate through the CATALOG to find either the named file or (if nil is +passed in) an empty slot +</p> + </div> + </div> + + <div id="method-M000049" class="method-detail"> + <a name="M000049"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000049.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000049.html');return false;"> + <span class="method-name">find_catalog_slot</span><span class="method-args">(filename)</span> + </a> + </div> + + <div class="method-description"> + <p> +iterate through the CATALOG to find either the named file or (if nil is +passed in) an empty slot +</p> + </div> + </div> + + <div id="method-M000039" class="method-detail"> + <a name="M000039"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000039.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000039.html');return false;"> + <span class="method-name">free_sector_list</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +iterate through the sector usage bitmap, return a list of [track,sector] +for sectors marked available +</p> + </div> + </div> + + <div id="method-M000050" class="method-detail"> + <a name="M000050"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000050.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000050.html');return false;"> + <span class="method-name">free_sector_list</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +iterate through the sector usage bitmap, return a list of [track,sector] +for sectors marked available +</p> + </div> + </div> + + <div id="method-M000042" class="method-detail"> + <a name="M000042"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000042.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000042.html');return false;"> + <span class="method-name">get_track_sector_list</span><span class="method-args">(ts_list_track_no,ts_list_sector_no)</span> + </a> + </div> + + <div class="method-description"> + <p> +given a track and sector, treat it as a track/sector list and return an +array containing track/sector pairs +</p> + </div> + </div> + + <div id="method-M000053" class="method-detail"> + <a name="M000053"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000053.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000053.html');return false;"> + <span class="method-name">get_track_sector_list</span><span class="method-args">(ts_list_track_no,ts_list_sector_no)</span> + </a> + </div> + + <div class="method-description"> + <p> +given a track and sector, treat it as a track/sector list and return an +array containing track/sector pairs +</p> + </div> + </div> + + <div id="method-M000051" class="method-detail"> + <a name="M000051"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000051.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000051.html');return false;"> + <span class="method-name">make_file</span><span class="method-args">(filename,contents,file_options={})</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000040" class="method-detail"> + <a name="M000040"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000040.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000040.html');return false;"> + <span class="method-name">make_file</span><span class="method-args">(filename,contents,file_options={})</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000044" class="method-detail"> + <a name="M000044"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000044.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000044.html');return false;"> <span class="method-name">read_catalog</span><span class="method-args">()</span> </a> </div> <div class="method-description"> @@ -169,9 +439,62 @@ 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 </pre> + </div> + </div> + + <div id="method-M000055" class="method-detail"> + <a name="M000055"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000055.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000055.html');return false;"> + <span class="method-name">read_catalog</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +reads the catalog, and populate the &quot;files&quot; array with files +CATALOG will be at track $00, sector $03 to track $00, sector $09 each +entry consists of $10 bytes, which are: +</p> +<pre> + 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 +</pre> + </div> + </div> + + <div id="method-M000037" class="method-detail"> + <a name="M000037"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000037.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000037.html');return false;"> + <span class="method-name">set_sector</span><span class="method-args">(track,sector,contents)</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000048" class="method-detail"> + <a name="M000048"></a> + + <div class="method-heading"> + <a href="NADOLDisk.src/M000048.html" target="Code" class="method-signature" + onclick="popupCode('NADOLDisk.src/M000048.html');return false;"> + <span class="method-name">set_sector</span><span class="method-args">(track,sector,contents)</span> + </a> + </div> + + <div class="method-description"> </div> </div> </div> \ No newline at end of file