doc/classes/HostSystem.html in ripxplore-0.8.0 vs doc/classes/HostSystem.html in ripxplore-0.11.0

- old
+ new

@@ -1,449 +1,443 @@ -<?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: HostSystem</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">HostSystem</td> - </tr> - <tr class="top-aligned-row"> - <td><strong>In:</strong></td> - <td> - <a href="../files/lib/HostSystem_rb.html"> - lib/HostSystem.rb - </a> - <br /> - </td> - </tr> - - <tr class="top-aligned-row"> - <td><strong>Parent:</strong></td> - <td> - Object - </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,5,99,53" href="HostSystem.html" alt="HostSystem" /> -</map> -<img src="../dot/f_19.png" usemap="#map" border="0" alt="dot/f_19.png"> - </div> - - - - </div> - - <div id="method-list"> - <h3 class="section-bar">Methods</h3> - - <div class="name-list"> - <a href="#M000405">all_host_systems</a>&nbsp;&nbsp; - <a href="#M000418">default_background_colour</a>&nbsp;&nbsp; - <a href="#M000417">default_foreground_colour</a>&nbsp;&nbsp; - <a href="#M000412">default_screen_width</a>&nbsp;&nbsp; - <a href="#M000410">font_data</a>&nbsp;&nbsp; - <a href="#M000415">font_height</a>&nbsp;&nbsp; - <a href="#M000414">font_width</a>&nbsp;&nbsp; - <a href="#M000403">full_name</a>&nbsp;&nbsp; - <a href="#M000408">hex_dump</a>&nbsp;&nbsp; - <a href="#M000420">line_break_chars</a>&nbsp;&nbsp; - <a href="#M000413">max_screen_width</a>&nbsp;&nbsp; - <a href="#M000416">pixels_between_characters</a>&nbsp;&nbsp; - <a href="#M000404">possible_file_systems</a>&nbsp;&nbsp; - <a href="#M000407">s_to_ascii</a>&nbsp;&nbsp; - <a href="#M000411">screen_rows</a>&nbsp;&nbsp; - <a href="#M000409">start_track</a>&nbsp;&nbsp; - <a href="#M000406">to_ascii</a>&nbsp;&nbsp; - <a href="#M000419">to_screendump</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">MAX_SCREENDUMP_LINES</td> - <td>=</td> - <td class="context-item-value">200</td> - </tr> - </table> - </div> - </div> - - - - - - - <!-- if method_list --> - <div id="methods"> - <h3 class="section-bar">Public Class methods</h3> - - <div id="method-M000405" class="method-detail"> - <a name="M000405"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000405.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000405.html');return false;"> - <span class="method-name">all_host_systems</span><span class="method-args">()</span> - </a> - </div> - - <div class="method-description"> - </div> - </div> - - <div id="method-M000418" class="method-detail"> - <a name="M000418"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000418.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000418.html');return false;"> - <span class="method-name">default_background_colour</span><span class="method-args">()</span> - </a> - </div> - - <div class="method-description"> - <p> -default - should be overridden by each host system -</p> - </div> - </div> - - <div id="method-M000417" class="method-detail"> - <a name="M000417"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000417.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000417.html');return false;"> - <span class="method-name">default_foreground_colour</span><span class="method-args">()</span> - </a> - </div> - - <div class="method-description"> - <p> -default - should be overridden by each host system -</p> - </div> - </div> - - <div id="method-M000412" class="method-detail"> - <a name="M000412"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000412.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000412.html');return false;"> - <span class="method-name">default_screen_width</span><span class="method-args">()</span> - </a> - </div> - - <div class="method-description"> - <p> -default - should be overridden by each host system -</p> - </div> - </div> - - <div id="method-M000410" class="method-detail"> - <a name="M000410"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000410.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000410.html');return false;"> - <span class="method-name">font_data</span><span class="method-args">()</span> - </a> - </div> - - <div class="method-description"> - </div> - </div> - - <div id="method-M000415" class="method-detail"> - <a name="M000415"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000415.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000415.html');return false;"> - <span class="method-name">font_height</span><span class="method-args">()</span> - </a> - </div> - - <div class="method-description"> - <p> -default - should be overridden by each host system -</p> - </div> - </div> - - <div id="method-M000414" class="method-detail"> - <a name="M000414"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000414.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000414.html');return false;"> - <span class="method-name">font_width</span><span class="method-args">()</span> - </a> - </div> - - <div class="method-description"> - <p> -default - should be overridden by each host system -</p> - </div> - </div> - - <div id="method-M000403" class="method-detail"> - <a name="M000403"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000403.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000403.html');return false;"> - <span class="method-name">full_name</span><span class="method-args">()</span> - </a> - </div> - - <div class="method-description"> - <p> -each subclass should override this method with a 2-5 word description of -this host system -</p> - </div> - </div> - - <div id="method-M000408" class="method-detail"> - <a name="M000408"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000408.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000408.html');return false;"> - <span class="method-name">hex_dump</span><span class="method-args">(buffer)</span> - </a> - </div> - - <div class="method-description"> - <p> -given a buffer (e.g a sector or a file), produce a formatted hex dump which -includes chars converted to ASCII -</p> - </div> - </div> - - <div id="method-M000420" class="method-detail"> - <a name="M000420"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000420.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000420.html');return false;"> - <span class="method-name">line_break_chars</span><span class="method-args">()</span> - </a> - </div> - - <div class="method-description"> - </div> - </div> - - <div id="method-M000413" class="method-detail"> - <a name="M000413"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000413.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000413.html');return false;"> - <span class="method-name">max_screen_width</span><span class="method-args">()</span> - </a> - </div> - - <div class="method-description"> - </div> - </div> - - <div id="method-M000416" class="method-detail"> - <a name="M000416"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000416.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000416.html');return false;"> - <span class="method-name">pixels_between_characters</span><span class="method-args">()</span> - </a> - </div> - - <div class="method-description"> - <p> -default - should be overridden by each host system -</p> - </div> - </div> - - <div id="method-M000404" class="method-detail"> - <a name="M000404"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000404.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000404.html');return false;"> - <span class="method-name">possible_file_systems</span><span class="method-args">()</span> - </a> - </div> - - <div class="method-description"> - </div> - </div> - - <div id="method-M000407" class="method-detail"> - <a name="M000407"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000407.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000407.html');return false;"> - <span class="method-name">s_to_ascii</span><span class="method-args">(s)</span> - </a> - </div> - - <div class="method-description"> - </div> - </div> - - <div id="method-M000411" class="method-detail"> - <a name="M000411"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000411.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000411.html');return false;"> - <span class="method-name">screen_rows</span><span class="method-args">()</span> - </a> - </div> - - <div class="method-description"> - <p> -default - should be overridden by each host system -</p> - </div> - </div> - - <div id="method-M000409" class="method-detail"> - <a name="M000409"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000409.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000409.html');return false;"> - <span class="method-name">start_track</span><span class="method-args">()</span> - </a> - </div> - - <div class="method-description"> - <p> -does counting of tracks start at track 0 (e.g. Apple 2) or track 1 (e.g. <a -href="C64.html">C64</a>)? -</p> - </div> - </div> - - <div id="method-M000406" class="method-detail"> - <a name="M000406"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000406.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000406.html');return false;"> - <span class="method-name">to_ascii</span><span class="method-args">(byte)</span> - </a> - </div> - - <div class="method-description"> - <p> -each subclass should override <a -href="HostSystem.html#M000406">to_ascii</a> with a function that converts a -character in the native format to an ASCII equivalent -</p> - </div> - </div> - - <div id="method-M000419" class="method-detail"> - <a name="M000419"></a> - - <div class="method-heading"> - <a href="HostSystem.src/M000419.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000419.html');return false;"> - <span class="method-name">to_screendump</span><span class="method-args">(text,screen_width)</span> - </a> - </div> - - <div class="method-description"> - </div> - </div> - - - </div> - - - </div> - - -<div id="validator-badges"> - <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> -</div> - -</body> +<?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: HostSystem</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">HostSystem</td> + </tr> + <tr class="top-aligned-row"> + <td><strong>In:</strong></td> + <td> + <a href="../files/lib/HostSystem_rb.html"> + lib/HostSystem.rb + </a> + <br /> + </td> + </tr> + + <tr class="top-aligned-row"> + <td><strong>Parent:</strong></td> + <td> + Object + </td> + </tr> + </table> + </div> + <!-- banner header --> + + <div id="bodyContent"> + + + + <div id="contextContent"> + + + + </div> + + <div id="method-list"> + <h3 class="section-bar">Methods</h3> + + <div class="name-list"> + <a href="#M000465">all_host_systems</a>&nbsp;&nbsp; + <a href="#M000478">default_background_colour</a>&nbsp;&nbsp; + <a href="#M000477">default_foreground_colour</a>&nbsp;&nbsp; + <a href="#M000472">default_screen_width</a>&nbsp;&nbsp; + <a href="#M000470">font_data</a>&nbsp;&nbsp; + <a href="#M000475">font_height</a>&nbsp;&nbsp; + <a href="#M000474">font_width</a>&nbsp;&nbsp; + <a href="#M000463">full_name</a>&nbsp;&nbsp; + <a href="#M000468">hex_dump</a>&nbsp;&nbsp; + <a href="#M000480">line_break_chars</a>&nbsp;&nbsp; + <a href="#M000473">max_screen_width</a>&nbsp;&nbsp; + <a href="#M000476">pixels_between_characters</a>&nbsp;&nbsp; + <a href="#M000464">possible_file_systems</a>&nbsp;&nbsp; + <a href="#M000467">s_to_ascii</a>&nbsp;&nbsp; + <a href="#M000471">screen_rows</a>&nbsp;&nbsp; + <a href="#M000469">start_track</a>&nbsp;&nbsp; + <a href="#M000466">to_ascii</a>&nbsp;&nbsp; + <a href="#M000479">to_screendump</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">MAX_SCREENDUMP_LINES</td> + <td>=</td> + <td class="context-item-value">200</td> + </tr> + </table> + </div> + </div> + + + + + + + <!-- if method_list --> + <div id="methods"> + <h3 class="section-bar">Public Class methods</h3> + + <div id="method-M000465" class="method-detail"> + <a name="M000465"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000465.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000465.html');return false;"> + <span class="method-name">all_host_systems</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000478" class="method-detail"> + <a name="M000478"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000478.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000478.html');return false;"> + <span class="method-name">default_background_colour</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +default - should be overridden by each host system +</p> + </div> + </div> + + <div id="method-M000477" class="method-detail"> + <a name="M000477"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000477.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000477.html');return false;"> + <span class="method-name">default_foreground_colour</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +default - should be overridden by each host system +</p> + </div> + </div> + + <div id="method-M000472" class="method-detail"> + <a name="M000472"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000472.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000472.html');return false;"> + <span class="method-name">default_screen_width</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +default - should be overridden by each host system +</p> + </div> + </div> + + <div id="method-M000470" class="method-detail"> + <a name="M000470"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000470.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000470.html');return false;"> + <span class="method-name">font_data</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000475" class="method-detail"> + <a name="M000475"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000475.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000475.html');return false;"> + <span class="method-name">font_height</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +default - should be overridden by each host system +</p> + </div> + </div> + + <div id="method-M000474" class="method-detail"> + <a name="M000474"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000474.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000474.html');return false;"> + <span class="method-name">font_width</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +default - should be overridden by each host system +</p> + </div> + </div> + + <div id="method-M000463" class="method-detail"> + <a name="M000463"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000463.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000463.html');return false;"> + <span class="method-name">full_name</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +each subclass should override this method with a 2-5 word description of +this host system +</p> + </div> + </div> + + <div id="method-M000468" class="method-detail"> + <a name="M000468"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000468.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000468.html');return false;"> + <span class="method-name">hex_dump</span><span class="method-args">(buffer)</span> + </a> + </div> + + <div class="method-description"> + <p> +given a buffer (e.g a sector or a file), produce a formatted hex dump which +includes chars converted to ASCII +</p> + </div> + </div> + + <div id="method-M000480" class="method-detail"> + <a name="M000480"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000480.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000480.html');return false;"> + <span class="method-name">line_break_chars</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000473" class="method-detail"> + <a name="M000473"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000473.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000473.html');return false;"> + <span class="method-name">max_screen_width</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000476" class="method-detail"> + <a name="M000476"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000476.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000476.html');return false;"> + <span class="method-name">pixels_between_characters</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +default - should be overridden by each host system +</p> + </div> + </div> + + <div id="method-M000464" class="method-detail"> + <a name="M000464"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000464.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000464.html');return false;"> + <span class="method-name">possible_file_systems</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000467" class="method-detail"> + <a name="M000467"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000467.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000467.html');return false;"> + <span class="method-name">s_to_ascii</span><span class="method-args">(s)</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000471" class="method-detail"> + <a name="M000471"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000471.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000471.html');return false;"> + <span class="method-name">screen_rows</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +default - should be overridden by each host system +</p> + </div> + </div> + + <div id="method-M000469" class="method-detail"> + <a name="M000469"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000469.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000469.html');return false;"> + <span class="method-name">start_track</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +does counting of tracks start at track 0 (e.g. Apple 2) or track 1 (e.g. <a +href="C64.html">C64</a>)? +</p> + </div> + </div> + + <div id="method-M000466" class="method-detail"> + <a name="M000466"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000466.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000466.html');return false;"> + <span class="method-name">to_ascii</span><span class="method-args">(byte)</span> + </a> + </div> + + <div class="method-description"> + <p> +each subclass should override <a +href="HostSystem.html#M000466">to_ascii</a> with a function that converts a +character in the native format to an ASCII equivalent +</p> + </div> + </div> + + <div id="method-M000479" class="method-detail"> + <a name="M000479"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000479.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000479.html');return false;"> + <span class="method-name">to_screendump</span><span class="method-args">(text,screen_width)</span> + </a> + </div> + + <div class="method-description"> + </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> \ No newline at end of file