html/classes/ForwardReferencing.html in eymiha_util-0.1.5 vs html/classes/ForwardReferencing.html in eymiha_util-0.1.6
- old
+ new
@@ -1,320 +1,320 @@
-<?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>Module: ForwardReferencing</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>Module</strong></td>
- <td class="class-name-in-header">ForwardReferencing</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../files/lib/forward_referencing_rb.html">
- lib/forward_referencing.rb
- </a>
- <br />
- </td>
- </tr>
-
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-The <a href="ForwardReferencing.html">ForwardReferencing</a> module can be
-mixed into a class to allow it to capture and resolve ForwardReferences.
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000030">continue_forward_reference_resolution</a>
- <a href="#M000027">create_forward_reference</a>
- <a href="#M000031">forward_reference_dependencies</a>
- <a href="#M000034">forward_references_clear</a>
- <a href="#M000033">forward_references_remaining</a>
- <a href="#M000032">forward_references_to_s</a>
- <a href="#M000028">remove_forward_reference</a>
- <a href="#M000029">resolve_forward_references</a>
- <a href="#M000026">start_forward_referencing</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">forward_references</td>
- <td class="context-item-value"> [R] </td>
- <td class="context-item-desc">
-An array containing the set of unresolved forward references.
-
-</td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000030" class="method-detail">
- <a name="M000030"></a>
-
- <div class="method-heading">
- <a href="ForwardReferencing.src/M000030.html" target="Code" class="method-signature"
- onclick="popupCode('ForwardReferencing.src/M000030.html');return false;">
- <span class="method-name">continue_forward_reference_resolution</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-To be called at the end of a section of code that could contain a forward
-reference, it will continue during normal processing and jump back to the
-<a href="ForwardReferencing.html#M000029">resolve_forward_references</a>
-method during resolution.
-</p>
- </div>
- </div>
-
- <div id="method-M000027" class="method-detail">
- <a name="M000027"></a>
-
- <div class="method-heading">
- <a href="ForwardReferencing.src/M000027.html" target="Code" class="method-signature"
- onclick="popupCode('ForwardReferencing.src/M000027.html');return false;">
- <span class="method-name">create_forward_reference</span><span class="method-args">(dependency=nil,context=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-To be called when a section of code that could contain a forward reference
-is entered. The method returns a newly created <a
-href="ForwardReference.html">ForwardReference</a> with the given dependency
-that can be jumped to during resolution.
-</p>
- </div>
- </div>
-
- <div id="method-M000031" class="method-detail">
- <a name="M000031"></a>
-
- <div class="method-heading">
- <a href="ForwardReferencing.src/M000031.html" target="Code" class="method-signature"
- onclick="popupCode('ForwardReferencing.src/M000031.html');return false;">
- <span class="method-name">forward_reference_dependencies</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns a hash of dependencies to arrays of the ForwardReferences that have
-them as dependencies.
-</p>
- </div>
- </div>
-
- <div id="method-M000034" class="method-detail">
- <a name="M000034"></a>
-
- <div class="method-heading">
- <a href="ForwardReferencing.src/M000034.html" target="Code" class="method-signature"
- onclick="popupCode('ForwardReferencing.src/M000034.html');return false;">
- <span class="method-name">forward_references_clear</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Remove the remaining unresolved forward references.
-</p>
- </div>
- </div>
-
- <div id="method-M000033" class="method-detail">
- <a name="M000033"></a>
-
- <div class="method-heading">
- <a href="ForwardReferencing.src/M000033.html" target="Code" class="method-signature"
- onclick="popupCode('ForwardReferencing.src/M000033.html');return false;">
- <span class="method-name">forward_references_remaining</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns the number of unresolved forward references.
-</p>
- </div>
- </div>
-
- <div id="method-M000032" class="method-detail">
- <a name="M000032"></a>
-
- <div class="method-heading">
- <a href="ForwardReferencing.src/M000032.html" target="Code" class="method-signature"
- onclick="popupCode('ForwardReferencing.src/M000032.html');return false;">
- <span class="method-name">forward_references_to_s</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns a string indicating the current state of <a
-href="ForwardReferencing.html">ForwardReferencing</a>.
-</p>
- </div>
- </div>
-
- <div id="method-M000028" class="method-detail">
- <a name="M000028"></a>
-
- <div class="method-heading">
- <a href="ForwardReferencing.src/M000028.html" target="Code" class="method-signature"
- onclick="popupCode('ForwardReferencing.src/M000028.html');return false;">
- <span class="method-name">remove_forward_reference</span><span class="method-args">(forward_reference=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-To be called when a section of code that could contain a forward reference
-has successfully been reached. It is used to remove the <a
-href="ForwardReference.html">ForwardReference</a> that was created at the
-start of the section, and asserts that a resolution was made.
-</p>
- </div>
- </div>
-
- <div id="method-M000029" class="method-detail">
- <a name="M000029"></a>
-
- <div class="method-heading">
- <a href="ForwardReferencing.src/M000029.html" target="Code" class="method-signature"
- onclick="popupCode('ForwardReferencing.src/M000029.html');return false;">
- <span class="method-name">resolve_forward_references</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-To be called to try to resolve any unresolved ForwardReferences by jumping
-to each in turn and retrying the code that caused it. This method repeats
-until nothing more is resolved. At that point unresolved forward reference
-may still exist, to be possibly resolved by another call to this method
-downstream. Prior to continuing to a forward reference, the
-establish_forward_reference context method is called with the context that
-was provided at the time the forward reference was created to give the
-receiver a chance to reset any transcient infromation.
-</p>
- </div>
- </div>
-
- <div id="method-M000026" class="method-detail">
- <a name="M000026"></a>
-
- <div class="method-heading">
- <a href="ForwardReferencing.src/M000026.html" target="Code" class="method-signature"
- onclick="popupCode('ForwardReferencing.src/M000026.html');return false;">
- <span class="method-name">start_forward_referencing</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-To be called from the initializer of the includer, this sets up the forward
-reference capture and resolution mechanisms.
-</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>
+<?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>Module: ForwardReferencing</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>Module</strong></td>
+ <td class="class-name-in-header">ForwardReferencing</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../files/lib/forward_referencing_rb.html">
+ lib/forward_referencing.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+The <a href="ForwardReferencing.html">ForwardReferencing</a> module can be
+mixed into a class to allow it to capture and resolve ForwardReferences.
+</p>
+
+ </div>
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000030">continue_forward_reference_resolution</a>
+ <a href="#M000027">create_forward_reference</a>
+ <a href="#M000031">forward_reference_dependencies</a>
+ <a href="#M000034">forward_references_clear</a>
+ <a href="#M000033">forward_references_remaining</a>
+ <a href="#M000032">forward_references_to_s</a>
+ <a href="#M000028">remove_forward_reference</a>
+ <a href="#M000029">resolve_forward_references</a>
+ <a href="#M000026">start_forward_referencing</a>
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+
+
+
+ <div id="attribute-list">
+ <h3 class="section-bar">Attributes</h3>
+
+ <div class="name-list">
+ <table>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">forward_references</td>
+ <td class="context-item-value"> [R] </td>
+ <td class="context-item-desc">
+An array containing the set of unresolved forward references.
+
+</td>
+ </tr>
+ </table>
+ </div>
+ </div>
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Instance methods</h3>
+
+ <div id="method-M000030" class="method-detail">
+ <a name="M000030"></a>
+
+ <div class="method-heading">
+ <a href="ForwardReferencing.src/M000030.html" target="Code" class="method-signature"
+ onclick="popupCode('ForwardReferencing.src/M000030.html');return false;">
+ <span class="method-name">continue_forward_reference_resolution</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+To be called at the end of a section of code that could contain a forward
+reference, it will continue during normal processing and jump back to the
+<a href="ForwardReferencing.html#M000029">resolve_forward_references</a>
+method during resolution.
+</p>
+ </div>
+ </div>
+
+ <div id="method-M000027" class="method-detail">
+ <a name="M000027"></a>
+
+ <div class="method-heading">
+ <a href="ForwardReferencing.src/M000027.html" target="Code" class="method-signature"
+ onclick="popupCode('ForwardReferencing.src/M000027.html');return false;">
+ <span class="method-name">create_forward_reference</span><span class="method-args">(dependency=nil,context=nil)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+To be called when a section of code that could contain a forward reference
+is entered. The method returns a newly created <a
+href="ForwardReference.html">ForwardReference</a> with the given dependency
+that can be jumped to during resolution.
+</p>
+ </div>
+ </div>
+
+ <div id="method-M000031" class="method-detail">
+ <a name="M000031"></a>
+
+ <div class="method-heading">
+ <a href="ForwardReferencing.src/M000031.html" target="Code" class="method-signature"
+ onclick="popupCode('ForwardReferencing.src/M000031.html');return false;">
+ <span class="method-name">forward_reference_dependencies</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Returns a hash of dependencies to arrays of the ForwardReferences that have
+them as dependencies.
+</p>
+ </div>
+ </div>
+
+ <div id="method-M000034" class="method-detail">
+ <a name="M000034"></a>
+
+ <div class="method-heading">
+ <a href="ForwardReferencing.src/M000034.html" target="Code" class="method-signature"
+ onclick="popupCode('ForwardReferencing.src/M000034.html');return false;">
+ <span class="method-name">forward_references_clear</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Remove the remaining unresolved forward references.
+</p>
+ </div>
+ </div>
+
+ <div id="method-M000033" class="method-detail">
+ <a name="M000033"></a>
+
+ <div class="method-heading">
+ <a href="ForwardReferencing.src/M000033.html" target="Code" class="method-signature"
+ onclick="popupCode('ForwardReferencing.src/M000033.html');return false;">
+ <span class="method-name">forward_references_remaining</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Returns the number of unresolved forward references.
+</p>
+ </div>
+ </div>
+
+ <div id="method-M000032" class="method-detail">
+ <a name="M000032"></a>
+
+ <div class="method-heading">
+ <a href="ForwardReferencing.src/M000032.html" target="Code" class="method-signature"
+ onclick="popupCode('ForwardReferencing.src/M000032.html');return false;">
+ <span class="method-name">forward_references_to_s</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Returns a string indicating the current state of <a
+href="ForwardReferencing.html">ForwardReferencing</a>.
+</p>
+ </div>
+ </div>
+
+ <div id="method-M000028" class="method-detail">
+ <a name="M000028"></a>
+
+ <div class="method-heading">
+ <a href="ForwardReferencing.src/M000028.html" target="Code" class="method-signature"
+ onclick="popupCode('ForwardReferencing.src/M000028.html');return false;">
+ <span class="method-name">remove_forward_reference</span><span class="method-args">(forward_reference=nil)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+To be called when a section of code that could contain a forward reference
+has successfully been reached. It is used to remove the <a
+href="ForwardReference.html">ForwardReference</a> that was created at the
+start of the section, and asserts that a resolution was made.
+</p>
+ </div>
+ </div>
+
+ <div id="method-M000029" class="method-detail">
+ <a name="M000029"></a>
+
+ <div class="method-heading">
+ <a href="ForwardReferencing.src/M000029.html" target="Code" class="method-signature"
+ onclick="popupCode('ForwardReferencing.src/M000029.html');return false;">
+ <span class="method-name">resolve_forward_references</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+To be called to try to resolve any unresolved ForwardReferences by jumping
+to each in turn and retrying the code that caused it. This method repeats
+until nothing more is resolved. At that point unresolved forward reference
+may still exist, to be possibly resolved by another call to this method
+downstream. Prior to continuing to a forward reference, the
+establish_forward_reference context method is called with the context that
+was provided at the time the forward reference was created to give the
+receiver a chance to reset any transcient infromation.
+</p>
+ </div>
+ </div>
+
+ <div id="method-M000026" class="method-detail">
+ <a name="M000026"></a>
+
+ <div class="method-heading">
+ <a href="ForwardReferencing.src/M000026.html" target="Code" class="method-signature"
+ onclick="popupCode('ForwardReferencing.src/M000026.html');return false;">
+ <span class="method-name">start_forward_referencing</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+To be called from the initializer of the includer, this sets up the forward
+reference capture and resolution mechanisms.
+</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>
\ No newline at end of file