eymiha_util 0.1.5 → 0.1.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (58) hide show
  1. data/gem_package.rb +1 -1
  2. data/html/classes/BaseEnvelope.html +203 -203
  3. data/html/classes/BaseEnvelope.src/M000001.html +15 -15
  4. data/html/classes/BaseEnvelope.src/M000002.html +15 -15
  5. data/html/classes/BaseEnvelope.src/M000003.html +15 -15
  6. data/html/classes/Enum.html +133 -0
  7. data/html/classes/Envelope.html +328 -328
  8. data/html/classes/Envelope.src/M000016.html +15 -15
  9. data/html/classes/Envelope.src/M000017.html +15 -15
  10. data/html/classes/Envelope.src/M000018.html +15 -15
  11. data/html/classes/Envelope.src/M000019.html +15 -15
  12. data/html/classes/Envelope.src/M000020.html +15 -15
  13. data/html/classes/Envelope.src/M000021.html +15 -15
  14. data/html/classes/Envelope.src/M000023.html +15 -15
  15. data/html/classes/EnvelopeException.html +118 -118
  16. data/html/classes/ForwardReference.html +203 -203
  17. data/html/classes/ForwardReference.src/M000024.html +20 -20
  18. data/html/classes/ForwardReference.src/M000025.html +17 -17
  19. data/html/classes/ForwardReferencer.html +173 -173
  20. data/html/classes/ForwardReferencing.html +319 -319
  21. data/html/classes/ForwardReferencing.src/M000026.html +19 -19
  22. data/html/classes/ForwardReferencing.src/M000027.html +19 -19
  23. data/html/classes/ForwardReferencing.src/M000028.html +19 -19
  24. data/html/classes/ForwardReferencing.src/M000029.html +31 -31
  25. data/html/classes/ForwardReferencing.src/M000030.html +17 -17
  26. data/html/classes/ForwardReferencing.src/M000031.html +24 -24
  27. data/html/classes/ForwardReferencing.src/M000032.html +17 -17
  28. data/html/classes/ForwardReferencing.src/M000033.html +17 -17
  29. data/html/classes/ForwardReferencing.src/M000034.html +17 -17
  30. data/html/classes/Histogram.html +324 -324
  31. data/html/classes/Histogram.src/M000007.html +15 -15
  32. data/html/classes/Histogram.src/M000008.html +15 -15
  33. data/html/classes/Histogram.src/M000009.html +15 -15
  34. data/html/classes/Histogram.src/M000010.html +15 -15
  35. data/html/classes/Histogram.src/M000011.html +15 -15
  36. data/html/classes/Histogram.src/M000012.html +15 -15
  37. data/html/classes/Histogram.src/M000013.html +15 -15
  38. data/html/classes/Histogram.src/M000014.html +15 -15
  39. data/html/classes/Histogram.src/M000015.html +15 -15
  40. data/html/classes/HistogramException.html +117 -117
  41. data/html/classes/MethodicHash.html +221 -221
  42. data/html/classes/MethodicHash.src/M000004.html +15 -15
  43. data/html/classes/MethodicHash.src/M000005.html +15 -15
  44. data/html/classes/MethodicHash.src/M000006.html +15 -15
  45. data/html/created.rid +1 -1
  46. data/html/files/lib/enum_rb.html +123 -0
  47. data/html/files/lib/envelope_rb.html +108 -108
  48. data/html/files/lib/forward_referencing_rb.html +119 -119
  49. data/html/files/lib/histogram_rb.html +108 -108
  50. data/html/files/lib/methodic_hash_rb.html +139 -139
  51. data/html/fr_class_index.html +35 -34
  52. data/html/fr_file_index.html +30 -29
  53. data/html/fr_method_index.html +59 -59
  54. data/html/index.html +23 -23
  55. data/html/rdoc-style.css +207 -207
  56. data/lib/enum.rb +57 -0
  57. data/test/tc_enum.rb +70 -0
  58. metadata +6 -2
data/html/classes/ForwardReferencer.html CHANGED
@@ -1,174 +1,174 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
- <head>
8
- <title>Class: ForwardReferencer</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
- <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
12
- <script type="text/javascript">
13
- // <![CDATA[
14
-
15
- function popupCode( url ) {
16
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
- }
18
-
19
- function toggleCode( id ) {
20
- if ( document.getElementById )
21
- elem = document.getElementById( id );
22
- else if ( document.all )
23
- elem = eval( "document.all." + id );
24
- else
25
- return false;
26
-
27
- elemStyle = elem.style;
28
-
29
- if ( elemStyle.display != "block" ) {
30
- elemStyle.display = "block"
31
- } else {
32
- elemStyle.display = "none"
33
- }
34
-
35
- return true;
36
- }
37
-
38
- // Make codeblocks hidden by default
39
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
-
41
- // ]]>
42
- </script>
43
-
44
- </head>
45
- <body>
46
-
47
-
48
-
49
- <div id="classHeader">
50
- <table class="header-table">
51
- <tr class="top-aligned-row">
52
- <td><strong>Class</strong></td>
53
- <td class="class-name-in-header">ForwardReferencer</td>
54
- </tr>
55
- <tr class="top-aligned-row">
56
- <td><strong>In:</strong></td>
57
- <td>
58
- <a href="../files/lib/forward_referencing_rb.html">
59
- lib/forward_referencing.rb
60
- </a>
61
- <br />
62
- </td>
63
- </tr>
64
-
65
- <tr class="top-aligned-row">
66
- <td><strong>Parent:</strong></td>
67
- <td>
68
- Object
69
- </td>
70
- </tr>
71
- </table>
72
- </div>
73
- <!-- banner header -->
74
-
75
- <div id="bodyContent">
76
-
77
-
78
-
79
- <div id="contextContent">
80
-
81
- <div id="description">
82
- <p>
83
- A <a href="ForwardReferencer.html">ForwardReferencer</a> is simply a
84
- class-wrapper for the <a
85
- href="ForwardReferencing.html">ForwardReferencing</a> module. method have
86
- been shortened there is reduced potential for conflict from inheritence
87
- than from inclusion or extension.
88
- </p>
89
-
90
- </div>
91
-
92
-
93
- </div>
94
-
95
-
96
- </div>
97
-
98
-
99
- <!-- if includes -->
100
-
101
- <div id="section">
102
-
103
-
104
-
105
- <div id="aliases-list">
106
- <h3 class="section-bar">External Aliases</h3>
107
-
108
- <div class="name-list">
109
- <table summary="aliases">
110
- <tr class="top-aligned-row context-row">
111
- <td class="context-item-name">start_forward_referencing</td>
112
- <td>-&gt;</td>
113
- <td class="context-item-value">initialize</td>
114
- </tr>
115
- <tr class="top-aligned-row context-row">
116
- <td class="context-item-name">create_forward_reference</td>
117
- <td>-&gt;</td>
118
- <td class="context-item-value">create</td>
119
- </tr>
120
- <tr class="top-aligned-row context-row">
121
- <td class="context-item-name">remove_forward_reference</td>
122
- <td>-&gt;</td>
123
- <td class="context-item-value">remove</td>
124
- </tr>
125
- <tr class="top-aligned-row context-row">
126
- <td class="context-item-name">resolve_forward_references</td>
127
- <td>-&gt;</td>
128
- <td class="context-item-value">resolve</td>
129
- </tr>
130
- <tr class="top-aligned-row context-row">
131
- <td class="context-item-name">continue_forward_reference_resolution</td>
132
- <td>-&gt;</td>
133
- <td class="context-item-value">continue</td>
134
- </tr>
135
- <tr class="top-aligned-row context-row">
136
- <td class="context-item-name">forward_reference_dependencies</td>
137
- <td>-&gt;</td>
138
- <td class="context-item-value">dependencies</td>
139
- </tr>
140
- <tr class="top-aligned-row context-row">
141
- <td class="context-item-name">forward_references_to_s</td>
142
- <td>-&gt;</td>
143
- <td class="context-item-value">to_s</td>
144
- </tr>
145
- <tr class="top-aligned-row context-row">
146
- <td class="context-item-name">forward_references_remaining</td>
147
- <td>-&gt;</td>
148
- <td class="context-item-value">remaining</td>
149
- </tr>
150
- <tr class="top-aligned-row context-row">
151
- <td class="context-item-name">forward_references_clear</td>
152
- <td>-&gt;</td>
153
- <td class="context-item-value">clear</td>
154
- </tr>
155
- </table>
156
- </div>
157
- </div>
158
-
159
-
160
-
161
-
162
-
163
- <!-- if method_list -->
164
-
165
-
166
- </div>
167
-
168
-
169
- <div id="validator-badges">
170
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
171
- </div>
172
-
173
- </body>
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Class: ForwardReferencer</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Class</strong></td>
53
+ <td class="class-name-in-header">ForwardReferencer</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../files/lib/forward_referencing_rb.html">
59
+ lib/forward_referencing.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ <tr class="top-aligned-row">
66
+ <td><strong>Parent:</strong></td>
67
+ <td>
68
+ Object
69
+ </td>
70
+ </tr>
71
+ </table>
72
+ </div>
73
+ <!-- banner header -->
74
+
75
+ <div id="bodyContent">
76
+
77
+
78
+
79
+ <div id="contextContent">
80
+
81
+ <div id="description">
82
+ <p>
83
+ A <a href="ForwardReferencer.html">ForwardReferencer</a> is simply a
84
+ class-wrapper for the <a
85
+ href="ForwardReferencing.html">ForwardReferencing</a> module. method have
86
+ been shortened there is reduced potential for conflict from inheritence
87
+ than from inclusion or extension.
88
+ </p>
89
+
90
+ </div>
91
+
92
+
93
+ </div>
94
+
95
+
96
+ </div>
97
+
98
+
99
+ <!-- if includes -->
100
+
101
+ <div id="section">
102
+
103
+
104
+
105
+ <div id="aliases-list">
106
+ <h3 class="section-bar">External Aliases</h3>
107
+
108
+ <div class="name-list">
109
+ <table summary="aliases">
110
+ <tr class="top-aligned-row context-row">
111
+ <td class="context-item-name">start_forward_referencing</td>
112
+ <td>-&gt;</td>
113
+ <td class="context-item-value">initialize</td>
114
+ </tr>
115
+ <tr class="top-aligned-row context-row">
116
+ <td class="context-item-name">create_forward_reference</td>
117
+ <td>-&gt;</td>
118
+ <td class="context-item-value">create</td>
119
+ </tr>
120
+ <tr class="top-aligned-row context-row">
121
+ <td class="context-item-name">remove_forward_reference</td>
122
+ <td>-&gt;</td>
123
+ <td class="context-item-value">remove</td>
124
+ </tr>
125
+ <tr class="top-aligned-row context-row">
126
+ <td class="context-item-name">resolve_forward_references</td>
127
+ <td>-&gt;</td>
128
+ <td class="context-item-value">resolve</td>
129
+ </tr>
130
+ <tr class="top-aligned-row context-row">
131
+ <td class="context-item-name">continue_forward_reference_resolution</td>
132
+ <td>-&gt;</td>
133
+ <td class="context-item-value">continue</td>
134
+ </tr>
135
+ <tr class="top-aligned-row context-row">
136
+ <td class="context-item-name">forward_reference_dependencies</td>
137
+ <td>-&gt;</td>
138
+ <td class="context-item-value">dependencies</td>
139
+ </tr>
140
+ <tr class="top-aligned-row context-row">
141
+ <td class="context-item-name">forward_references_to_s</td>
142
+ <td>-&gt;</td>
143
+ <td class="context-item-value">to_s</td>
144
+ </tr>
145
+ <tr class="top-aligned-row context-row">
146
+ <td class="context-item-name">forward_references_remaining</td>
147
+ <td>-&gt;</td>
148
+ <td class="context-item-value">remaining</td>
149
+ </tr>
150
+ <tr class="top-aligned-row context-row">
151
+ <td class="context-item-name">forward_references_clear</td>
152
+ <td>-&gt;</td>
153
+ <td class="context-item-value">clear</td>
154
+ </tr>
155
+ </table>
156
+ </div>
157
+ </div>
158
+
159
+
160
+
161
+
162
+
163
+ <!-- if method_list -->
164
+
165
+
166
+ </div>
167
+
168
+
169
+ <div id="validator-badges">
170
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
171
+ </div>
172
+
173
+ </body>
174
174
  </html>
data/html/classes/ForwardReferencing.html CHANGED
@@ -1,320 +1,320 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
- <head>
8
- <title>Module: ForwardReferencing</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
- <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
12
- <script type="text/javascript">
13
- // <![CDATA[
14
-
15
- function popupCode( url ) {
16
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
- }
18
-
19
- function toggleCode( id ) {
20
- if ( document.getElementById )
21
- elem = document.getElementById( id );
22
- else if ( document.all )
23
- elem = eval( "document.all." + id );
24
- else
25
- return false;
26
-
27
- elemStyle = elem.style;
28
-
29
- if ( elemStyle.display != "block" ) {
30
- elemStyle.display = "block"
31
- } else {
32
- elemStyle.display = "none"
33
- }
34
-
35
- return true;
36
- }
37
-
38
- // Make codeblocks hidden by default
39
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
-
41
- // ]]>
42
- </script>
43
-
44
- </head>
45
- <body>
46
-
47
-
48
-
49
- <div id="classHeader">
50
- <table class="header-table">
51
- <tr class="top-aligned-row">
52
- <td><strong>Module</strong></td>
53
- <td class="class-name-in-header">ForwardReferencing</td>
54
- </tr>
55
- <tr class="top-aligned-row">
56
- <td><strong>In:</strong></td>
57
- <td>
58
- <a href="../files/lib/forward_referencing_rb.html">
59
- lib/forward_referencing.rb
60
- </a>
61
- <br />
62
- </td>
63
- </tr>
64
-
65
- </table>
66
- </div>
67
- <!-- banner header -->
68
-
69
- <div id="bodyContent">
70
-
71
-
72
-
73
- <div id="contextContent">
74
-
75
- <div id="description">
76
- <p>
77
- The <a href="ForwardReferencing.html">ForwardReferencing</a> module can be
78
- mixed into a class to allow it to capture and resolve ForwardReferences.
79
- </p>
80
-
81
- </div>
82
-
83
-
84
- </div>
85
-
86
- <div id="method-list">
87
- <h3 class="section-bar">Methods</h3>
88
-
89
- <div class="name-list">
90
- <a href="#M000030">continue_forward_reference_resolution</a>&nbsp;&nbsp;
91
- <a href="#M000027">create_forward_reference</a>&nbsp;&nbsp;
92
- <a href="#M000031">forward_reference_dependencies</a>&nbsp;&nbsp;
93
- <a href="#M000034">forward_references_clear</a>&nbsp;&nbsp;
94
- <a href="#M000033">forward_references_remaining</a>&nbsp;&nbsp;
95
- <a href="#M000032">forward_references_to_s</a>&nbsp;&nbsp;
96
- <a href="#M000028">remove_forward_reference</a>&nbsp;&nbsp;
97
- <a href="#M000029">resolve_forward_references</a>&nbsp;&nbsp;
98
- <a href="#M000026">start_forward_referencing</a>&nbsp;&nbsp;
99
- </div>
100
- </div>
101
-
102
- </div>
103
-
104
-
105
- <!-- if includes -->
106
-
107
- <div id="section">
108
-
109
-
110
-
111
-
112
-
113
- <div id="attribute-list">
114
- <h3 class="section-bar">Attributes</h3>
115
-
116
- <div class="name-list">
117
- <table>
118
- <tr class="top-aligned-row context-row">
119
- <td class="context-item-name">forward_references</td>
120
- <td class="context-item-value">&nbsp;[R]&nbsp;</td>
121
- <td class="context-item-desc">
122
- An array containing the set of unresolved forward references.
123
-
124
- </td>
125
- </tr>
126
- </table>
127
- </div>
128
- </div>
129
-
130
-
131
-
132
- <!-- if method_list -->
133
- <div id="methods">
134
- <h3 class="section-bar">Public Instance methods</h3>
135
-
136
- <div id="method-M000030" class="method-detail">
137
- <a name="M000030"></a>
138
-
139
- <div class="method-heading">
140
- <a href="ForwardReferencing.src/M000030.html" target="Code" class="method-signature"
141
- onclick="popupCode('ForwardReferencing.src/M000030.html');return false;">
142
- <span class="method-name">continue_forward_reference_resolution</span><span class="method-args">()</span>
143
- </a>
144
- </div>
145
-
146
- <div class="method-description">
147
- <p>
148
- To be called at the end of a section of code that could contain a forward
149
- reference, it will continue during normal processing and jump back to the
150
- <a href="ForwardReferencing.html#M000029">resolve_forward_references</a>
151
- method during resolution.
152
- </p>
153
- </div>
154
- </div>
155
-
156
- <div id="method-M000027" class="method-detail">
157
- <a name="M000027"></a>
158
-
159
- <div class="method-heading">
160
- <a href="ForwardReferencing.src/M000027.html" target="Code" class="method-signature"
161
- onclick="popupCode('ForwardReferencing.src/M000027.html');return false;">
162
- <span class="method-name">create_forward_reference</span><span class="method-args">(dependency=nil,context=nil)</span>
163
- </a>
164
- </div>
165
-
166
- <div class="method-description">
167
- <p>
168
- To be called when a section of code that could contain a forward reference
169
- is entered. The method returns a newly created <a
170
- href="ForwardReference.html">ForwardReference</a> with the given dependency
171
- that can be jumped to during resolution.
172
- </p>
173
- </div>
174
- </div>
175
-
176
- <div id="method-M000031" class="method-detail">
177
- <a name="M000031"></a>
178
-
179
- <div class="method-heading">
180
- <a href="ForwardReferencing.src/M000031.html" target="Code" class="method-signature"
181
- onclick="popupCode('ForwardReferencing.src/M000031.html');return false;">
182
- <span class="method-name">forward_reference_dependencies</span><span class="method-args">()</span>
183
- </a>
184
- </div>
185
-
186
- <div class="method-description">
187
- <p>
188
- Returns a hash of dependencies to arrays of the ForwardReferences that have
189
- them as dependencies.
190
- </p>
191
- </div>
192
- </div>
193
-
194
- <div id="method-M000034" class="method-detail">
195
- <a name="M000034"></a>
196
-
197
- <div class="method-heading">
198
- <a href="ForwardReferencing.src/M000034.html" target="Code" class="method-signature"
199
- onclick="popupCode('ForwardReferencing.src/M000034.html');return false;">
200
- <span class="method-name">forward_references_clear</span><span class="method-args">()</span>
201
- </a>
202
- </div>
203
-
204
- <div class="method-description">
205
- <p>
206
- Remove the remaining unresolved forward references.
207
- </p>
208
- </div>
209
- </div>
210
-
211
- <div id="method-M000033" class="method-detail">
212
- <a name="M000033"></a>
213
-
214
- <div class="method-heading">
215
- <a href="ForwardReferencing.src/M000033.html" target="Code" class="method-signature"
216
- onclick="popupCode('ForwardReferencing.src/M000033.html');return false;">
217
- <span class="method-name">forward_references_remaining</span><span class="method-args">()</span>
218
- </a>
219
- </div>
220
-
221
- <div class="method-description">
222
- <p>
223
- Returns the number of unresolved forward references.
224
- </p>
225
- </div>
226
- </div>
227
-
228
- <div id="method-M000032" class="method-detail">
229
- <a name="M000032"></a>
230
-
231
- <div class="method-heading">
232
- <a href="ForwardReferencing.src/M000032.html" target="Code" class="method-signature"
233
- onclick="popupCode('ForwardReferencing.src/M000032.html');return false;">
234
- <span class="method-name">forward_references_to_s</span><span class="method-args">()</span>
235
- </a>
236
- </div>
237
-
238
- <div class="method-description">
239
- <p>
240
- Returns a string indicating the current state of <a
241
- href="ForwardReferencing.html">ForwardReferencing</a>.
242
- </p>
243
- </div>
244
- </div>
245
-
246
- <div id="method-M000028" class="method-detail">
247
- <a name="M000028"></a>
248
-
249
- <div class="method-heading">
250
- <a href="ForwardReferencing.src/M000028.html" target="Code" class="method-signature"
251
- onclick="popupCode('ForwardReferencing.src/M000028.html');return false;">
252
- <span class="method-name">remove_forward_reference</span><span class="method-args">(forward_reference=nil)</span>
253
- </a>
254
- </div>
255
-
256
- <div class="method-description">
257
- <p>
258
- To be called when a section of code that could contain a forward reference
259
- has successfully been reached. It is used to remove the <a
260
- href="ForwardReference.html">ForwardReference</a> that was created at the
261
- start of the section, and asserts that a resolution was made.
262
- </p>
263
- </div>
264
- </div>
265
-
266
- <div id="method-M000029" class="method-detail">
267
- <a name="M000029"></a>
268
-
269
- <div class="method-heading">
270
- <a href="ForwardReferencing.src/M000029.html" target="Code" class="method-signature"
271
- onclick="popupCode('ForwardReferencing.src/M000029.html');return false;">
272
- <span class="method-name">resolve_forward_references</span><span class="method-args">()</span>
273
- </a>
274
- </div>
275
-
276
- <div class="method-description">
277
- <p>
278
- To be called to try to resolve any unresolved ForwardReferences by jumping
279
- to each in turn and retrying the code that caused it. This method repeats
280
- until nothing more is resolved. At that point unresolved forward reference
281
- may still exist, to be possibly resolved by another call to this method
282
- downstream. Prior to continuing to a forward reference, the
283
- establish_forward_reference context method is called with the context that
284
- was provided at the time the forward reference was created to give the
285
- receiver a chance to reset any transcient infromation.
286
- </p>
287
- </div>
288
- </div>
289
-
290
- <div id="method-M000026" class="method-detail">
291
- <a name="M000026"></a>
292
-
293
- <div class="method-heading">
294
- <a href="ForwardReferencing.src/M000026.html" target="Code" class="method-signature"
295
- onclick="popupCode('ForwardReferencing.src/M000026.html');return false;">
296
- <span class="method-name">start_forward_referencing</span><span class="method-args">()</span>
297
- </a>
298
- </div>
299
-
300
- <div class="method-description">
301
- <p>
302
- To be called from the initializer of the includer, this sets up the forward
303
- reference capture and resolution mechanisms.
304
- </p>
305
- </div>
306
- </div>
307
-
308
-
309
- </div>
310
-
311
-
312
- </div>
313
-
314
-
315
- <div id="validator-badges">
316
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
317
- </div>
318
-
319
- </body>
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Module: ForwardReferencing</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Module</strong></td>
53
+ <td class="class-name-in-header">ForwardReferencing</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../files/lib/forward_referencing_rb.html">
59
+ lib/forward_referencing.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ </table>
66
+ </div>
67
+ <!-- banner header -->
68
+
69
+ <div id="bodyContent">
70
+
71
+
72
+
73
+ <div id="contextContent">
74
+
75
+ <div id="description">
76
+ <p>
77
+ The <a href="ForwardReferencing.html">ForwardReferencing</a> module can be
78
+ mixed into a class to allow it to capture and resolve ForwardReferences.
79
+ </p>
80
+
81
+ </div>
82
+
83
+
84
+ </div>
85
+
86
+ <div id="method-list">
87
+ <h3 class="section-bar">Methods</h3>
88
+
89
+ <div class="name-list">
90
+ <a href="#M000030">continue_forward_reference_resolution</a>&nbsp;&nbsp;
91
+ <a href="#M000027">create_forward_reference</a>&nbsp;&nbsp;
92
+ <a href="#M000031">forward_reference_dependencies</a>&nbsp;&nbsp;
93
+ <a href="#M000034">forward_references_clear</a>&nbsp;&nbsp;
94
+ <a href="#M000033">forward_references_remaining</a>&nbsp;&nbsp;
95
+ <a href="#M000032">forward_references_to_s</a>&nbsp;&nbsp;
96
+ <a href="#M000028">remove_forward_reference</a>&nbsp;&nbsp;
97
+ <a href="#M000029">resolve_forward_references</a>&nbsp;&nbsp;
98
+ <a href="#M000026">start_forward_referencing</a>&nbsp;&nbsp;
99
+ </div>
100
+ </div>
101
+
102
+ </div>
103
+
104
+
105
+ <!-- if includes -->
106
+
107
+ <div id="section">
108
+
109
+
110
+
111
+
112
+
113
+ <div id="attribute-list">
114
+ <h3 class="section-bar">Attributes</h3>
115
+
116
+ <div class="name-list">
117
+ <table>
118
+ <tr class="top-aligned-row context-row">
119
+ <td class="context-item-name">forward_references</td>
120
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
121
+ <td class="context-item-desc">
122
+ An array containing the set of unresolved forward references.
123
+
124
+ </td>
125
+ </tr>
126
+ </table>
127
+ </div>
128
+ </div>
129
+
130
+
131
+
132
+ <!-- if method_list -->
133
+ <div id="methods">
134
+ <h3 class="section-bar">Public Instance methods</h3>
135
+
136
+ <div id="method-M000030" class="method-detail">
137
+ <a name="M000030"></a>
138
+
139
+ <div class="method-heading">
140
+ <a href="ForwardReferencing.src/M000030.html" target="Code" class="method-signature"
141
+ onclick="popupCode('ForwardReferencing.src/M000030.html');return false;">
142
+ <span class="method-name">continue_forward_reference_resolution</span><span class="method-args">()</span>
143
+ </a>
144
+ </div>
145
+
146
+ <div class="method-description">
147
+ <p>
148
+ To be called at the end of a section of code that could contain a forward
149
+ reference, it will continue during normal processing and jump back to the
150
+ <a href="ForwardReferencing.html#M000029">resolve_forward_references</a>
151
+ method during resolution.
152
+ </p>
153
+ </div>
154
+ </div>
155
+
156
+ <div id="method-M000027" class="method-detail">
157
+ <a name="M000027"></a>
158
+
159
+ <div class="method-heading">
160
+ <a href="ForwardReferencing.src/M000027.html" target="Code" class="method-signature"
161
+ onclick="popupCode('ForwardReferencing.src/M000027.html');return false;">
162
+ <span class="method-name">create_forward_reference</span><span class="method-args">(dependency=nil,context=nil)</span>
163
+ </a>
164
+ </div>
165
+
166
+ <div class="method-description">
167
+ <p>
168
+ To be called when a section of code that could contain a forward reference
169
+ is entered. The method returns a newly created <a
170
+ href="ForwardReference.html">ForwardReference</a> with the given dependency
171
+ that can be jumped to during resolution.
172
+ </p>
173
+ </div>
174
+ </div>
175
+
176
+ <div id="method-M000031" class="method-detail">
177
+ <a name="M000031"></a>
178
+
179
+ <div class="method-heading">
180
+ <a href="ForwardReferencing.src/M000031.html" target="Code" class="method-signature"
181
+ onclick="popupCode('ForwardReferencing.src/M000031.html');return false;">
182
+ <span class="method-name">forward_reference_dependencies</span><span class="method-args">()</span>
183
+ </a>
184
+ </div>
185
+
186
+ <div class="method-description">
187
+ <p>
188
+ Returns a hash of dependencies to arrays of the ForwardReferences that have
189
+ them as dependencies.
190
+ </p>
191
+ </div>
192
+ </div>
193
+
194
+ <div id="method-M000034" class="method-detail">
195
+ <a name="M000034"></a>
196
+
197
+ <div class="method-heading">
198
+ <a href="ForwardReferencing.src/M000034.html" target="Code" class="method-signature"
199
+ onclick="popupCode('ForwardReferencing.src/M000034.html');return false;">
200
+ <span class="method-name">forward_references_clear</span><span class="method-args">()</span>
201
+ </a>
202
+ </div>
203
+
204
+ <div class="method-description">
205
+ <p>
206
+ Remove the remaining unresolved forward references.
207
+ </p>
208
+ </div>
209
+ </div>
210
+
211
+ <div id="method-M000033" class="method-detail">
212
+ <a name="M000033"></a>
213
+
214
+ <div class="method-heading">
215
+ <a href="ForwardReferencing.src/M000033.html" target="Code" class="method-signature"
216
+ onclick="popupCode('ForwardReferencing.src/M000033.html');return false;">
217
+ <span class="method-name">forward_references_remaining</span><span class="method-args">()</span>
218
+ </a>
219
+ </div>
220
+
221
+ <div class="method-description">
222
+ <p>
223
+ Returns the number of unresolved forward references.
224
+ </p>
225
+ </div>
226
+ </div>
227
+
228
+ <div id="method-M000032" class="method-detail">
229
+ <a name="M000032"></a>
230
+
231
+ <div class="method-heading">
232
+ <a href="ForwardReferencing.src/M000032.html" target="Code" class="method-signature"
233
+ onclick="popupCode('ForwardReferencing.src/M000032.html');return false;">
234
+ <span class="method-name">forward_references_to_s</span><span class="method-args">()</span>
235
+ </a>
236
+ </div>
237
+
238
+ <div class="method-description">
239
+ <p>
240
+ Returns a string indicating the current state of <a
241
+ href="ForwardReferencing.html">ForwardReferencing</a>.
242
+ </p>
243
+ </div>
244
+ </div>
245
+
246
+ <div id="method-M000028" class="method-detail">
247
+ <a name="M000028"></a>
248
+
249
+ <div class="method-heading">
250
+ <a href="ForwardReferencing.src/M000028.html" target="Code" class="method-signature"
251
+ onclick="popupCode('ForwardReferencing.src/M000028.html');return false;">
252
+ <span class="method-name">remove_forward_reference</span><span class="method-args">(forward_reference=nil)</span>
253
+ </a>
254
+ </div>
255
+
256
+ <div class="method-description">
257
+ <p>
258
+ To be called when a section of code that could contain a forward reference
259
+ has successfully been reached. It is used to remove the <a
260
+ href="ForwardReference.html">ForwardReference</a> that was created at the
261
+ start of the section, and asserts that a resolution was made.
262
+ </p>
263
+ </div>
264
+ </div>
265
+
266
+ <div id="method-M000029" class="method-detail">
267
+ <a name="M000029"></a>
268
+
269
+ <div class="method-heading">
270
+ <a href="ForwardReferencing.src/M000029.html" target="Code" class="method-signature"
271
+ onclick="popupCode('ForwardReferencing.src/M000029.html');return false;">
272
+ <span class="method-name">resolve_forward_references</span><span class="method-args">()</span>
273
+ </a>
274
+ </div>
275
+
276
+ <div class="method-description">
277
+ <p>
278
+ To be called to try to resolve any unresolved ForwardReferences by jumping
279
+ to each in turn and retrying the code that caused it. This method repeats
280
+ until nothing more is resolved. At that point unresolved forward reference
281
+ may still exist, to be possibly resolved by another call to this method
282
+ downstream. Prior to continuing to a forward reference, the
283
+ establish_forward_reference context method is called with the context that
284
+ was provided at the time the forward reference was created to give the
285
+ receiver a chance to reset any transcient infromation.
286
+ </p>
287
+ </div>
288
+ </div>
289
+
290
+ <div id="method-M000026" class="method-detail">
291
+ <a name="M000026"></a>
292
+
293
+ <div class="method-heading">
294
+ <a href="ForwardReferencing.src/M000026.html" target="Code" class="method-signature"
295
+ onclick="popupCode('ForwardReferencing.src/M000026.html');return false;">
296
+ <span class="method-name">start_forward_referencing</span><span class="method-args">()</span>
297
+ </a>
298
+ </div>
299
+
300
+ <div class="method-description">
301
+ <p>
302
+ To be called from the initializer of the includer, this sets up the forward
303
+ reference capture and resolution mechanisms.
304
+ </p>
305
+ </div>
306
+ </div>
307
+
308
+
309
+ </div>
310
+
311
+
312
+ </div>
313
+
314
+
315
+ <div id="validator-badges">
316
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
317
+ </div>
318
+
319
+ </body>
320
320
  </html>