mucgly 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,461 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: EasyFile::ReadStack
8
+
9
+ &mdash; Documentation by YARD 0.8.6.1
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (R)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../EasyFile.html" title="EasyFile (module)">EasyFile</a></span></span>
36
+ &raquo;
37
+ <span class="title">ReadStack</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: EasyFile::ReadStack
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">EasyFile::ReadStack</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+ <dt class="r2">Includes:</dt>
94
+ <dd class="r2"><span class='object_link'><a href="Stacked.html" title="EasyFile::Stacked (module)">Stacked</a></span></dd>
95
+
96
+
97
+
98
+
99
+
100
+ <dt class="r1 last">Defined in:</dt>
101
+ <dd class="r1 last">lib/easyfile.rb</dd>
102
+
103
+ </dl>
104
+ <div class="clear"></div>
105
+
106
+ <h2>Overview</h2><div class="docstring">
107
+ <div class="discussion">
108
+
109
+ <p>Stack of Read files.</p>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+
117
+ </div>
118
+
119
+
120
+
121
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
122
+ <ul class="summary">
123
+
124
+ <li class="public ">
125
+ <span class="summary_signature">
126
+
127
+ <a href="#automode-instance_method" title="#automode (instance method)">- (Object) <strong>automode</strong> </a>
128
+
129
+
130
+
131
+ </span>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+ <span class="summary_desc"><div class='inline'>
145
+ <p>Automatically revert to lower file at EOF.</p>
146
+ </div></span>
147
+
148
+ </li>
149
+
150
+
151
+ </ul>
152
+
153
+
154
+
155
+
156
+
157
+ <h3 class="inherited">Attributes included from <span class='object_link'><a href="Stacked.html" title="EasyFile::Stacked (module)">Stacked</a></span></h3>
158
+ <p class="inherited"><span class='object_link'><a href="Stacked.html#stack-instance_method" title="EasyFile::Stacked#stack (method)">#stack</a></span></p>
159
+
160
+
161
+
162
+ <h2>
163
+ Instance Method Summary
164
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
165
+ </h2>
166
+
167
+ <ul class="summary">
168
+
169
+ <li class="public ">
170
+ <span class="summary_signature">
171
+
172
+ <a href="#eof%3F-instance_method" title="#eof? (instance method)">- (Boolean) <strong>eof?</strong> </a>
173
+
174
+
175
+
176
+ </span>
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+ <span class="summary_desc"><div class='inline'></div></span>
187
+
188
+ </li>
189
+
190
+
191
+ <li class="public ">
192
+ <span class="summary_signature">
193
+
194
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (ReadStack) <strong>initialize</strong>(name) </a>
195
+
196
+
197
+
198
+ </span>
199
+
200
+
201
+ <span class="note title constructor">constructor</span>
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+ <span class="summary_desc"><div class='inline'>
211
+ <p>A new instance of ReadStack.</p>
212
+ </div></span>
213
+
214
+ </li>
215
+
216
+
217
+ <li class="public ">
218
+ <span class="summary_signature">
219
+
220
+ <a href="#push-instance_method" title="#push (instance method)">- (Object) <strong>push</strong>(name) </a>
221
+
222
+
223
+
224
+ </span>
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+ <span class="summary_desc"><div class='inline'></div></span>
235
+
236
+ </li>
237
+
238
+
239
+ </ul>
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Stacked.html" title="EasyFile::Stacked (module)">Stacked</a></span></h3>
252
+ <p class="inherited"><span class='object_link'><a href="Stacked.html#method_missing-instance_method" title="EasyFile::Stacked#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="Stacked.html#pop-instance_method" title="EasyFile::Stacked#pop (method)">#pop</a></span>, <span class='object_link'><a href="Stacked.html#setup-instance_method" title="EasyFile::Stacked#setup (method)">#setup</a></span></p>
253
+ <div id="constructor_details" class="method_details_list">
254
+ <h2>Constructor Details</h2>
255
+
256
+ <div class="method_details first">
257
+ <h3 class="signature first" id="initialize-instance_method">
258
+
259
+ - (<tt><span class='object_link'><a href="" title="EasyFile::ReadStack (class)">ReadStack</a></span></tt>) <strong>initialize</strong>(name)
260
+
261
+
262
+
263
+
264
+
265
+ </h3><div class="docstring">
266
+ <div class="discussion">
267
+
268
+ <p>A new instance of ReadStack</p>
269
+
270
+
271
+ </div>
272
+ </div>
273
+ <div class="tags">
274
+
275
+
276
+ </div><table class="source_code">
277
+ <tr>
278
+ <td>
279
+ <pre class="lines">
280
+
281
+
282
+ 687
283
+ 688
284
+ 689
285
+ 690
286
+ 691</pre>
287
+ </td>
288
+ <td>
289
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 687</span>
290
+
291
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span> <span class='rparen'>)</span>
292
+ <span class='id identifier rubyid_io'>io</span> <span class='op'>=</span> <span class='const'>InOut</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='symbol'>:read</span> <span class='rparen'>)</span>
293
+ <span class='id identifier rubyid_setup'>setup</span><span class='lparen'>(</span> <span class='id identifier rubyid_io'>io</span> <span class='rparen'>)</span>
294
+ <span class='ivar'>@automode</span> <span class='op'>=</span> <span class='kw'>true</span>
295
+ <span class='kw'>end</span></pre>
296
+ </td>
297
+ </tr>
298
+ </table>
299
+ </div>
300
+
301
+ </div>
302
+ <div id="method_missing_details" class="method_details_list">
303
+ <h2>Dynamic Method Handling</h2>
304
+ <p class="notice super">
305
+ This class handles dynamic methods through the <tt>method_missing</tt> method
306
+
307
+ in the class <span class='object_link'><a href="Stacked.html#method_missing-instance_method" title="EasyFile::Stacked#method_missing (method)">EasyFile::Stacked</a></span>
308
+
309
+ </p>
310
+
311
+ </div>
312
+
313
+ <div id="instance_attr_details" class="attr_details">
314
+ <h2>Instance Attribute Details</h2>
315
+
316
+
317
+ <span id="automode=-instance_method"></span>
318
+ <div class="method_details first">
319
+ <h3 class="signature first" id="automode-instance_method">
320
+
321
+ - (<tt>Object</tt>) <strong>automode</strong>
322
+
323
+
324
+
325
+
326
+
327
+ </h3><div class="docstring">
328
+ <div class="discussion">
329
+
330
+ <p>Automatically revert to lower file at EOF.</p>
331
+
332
+
333
+ </div>
334
+ </div>
335
+ <div class="tags">
336
+
337
+
338
+ </div><table class="source_code">
339
+ <tr>
340
+ <td>
341
+ <pre class="lines">
342
+
343
+
344
+ 685
345
+ 686
346
+ 687</pre>
347
+ </td>
348
+ <td>
349
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 685</span>
350
+
351
+ <span class='kw'>def</span> <span class='id identifier rubyid_automode'>automode</span>
352
+ <span class='ivar'>@automode</span>
353
+ <span class='kw'>end</span></pre>
354
+ </td>
355
+ </tr>
356
+ </table>
357
+ </div>
358
+
359
+ </div>
360
+
361
+
362
+ <div id="instance_method_details" class="method_details_list">
363
+ <h2>Instance Method Details</h2>
364
+
365
+
366
+ <div class="method_details first">
367
+ <h3 class="signature first" id="eof?-instance_method">
368
+
369
+ - (<tt>Boolean</tt>) <strong>eof?</strong>
370
+
371
+
372
+
373
+
374
+
375
+ </h3><div class="docstring">
376
+ <div class="discussion">
377
+
378
+
379
+ </div>
380
+ </div>
381
+ <div class="tags">
382
+
383
+ <p class="tag_title">Returns:</p>
384
+ <ul class="return">
385
+
386
+ <li>
387
+
388
+
389
+ <span class='type'>(<tt>Boolean</tt>)</span>
390
+
391
+
392
+
393
+ </li>
394
+
395
+ </ul>
396
+
397
+ </div><table class="source_code">
398
+ <tr>
399
+ <td>
400
+ <pre class="lines">
401
+
402
+
403
+ 698
404
+ 699
405
+ 700</pre>
406
+ </td>
407
+ <td>
408
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 698</span>
409
+
410
+ <span class='kw'>def</span> <span class='id identifier rubyid_eof?'>eof?</span>
411
+ <span class='ivar'>@stack</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>==</span> <span class='int'>1</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@stack</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_eof?'>eof?</span>
412
+ <span class='kw'>end</span></pre>
413
+ </td>
414
+ </tr>
415
+ </table>
416
+ </div>
417
+
418
+ <div class="method_details ">
419
+ <h3 class="signature " id="push-instance_method">
420
+
421
+ - (<tt>Object</tt>) <strong>push</strong>(name)
422
+
423
+
424
+
425
+
426
+
427
+ </h3><table class="source_code">
428
+ <tr>
429
+ <td>
430
+ <pre class="lines">
431
+
432
+
433
+ 693
434
+ 694
435
+ 695
436
+ 696</pre>
437
+ </td>
438
+ <td>
439
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 693</span>
440
+
441
+ <span class='kw'>def</span> <span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span> <span class='rparen'>)</span>
442
+ <span class='id identifier rubyid_io'>io</span> <span class='op'>=</span> <span class='const'>InOut</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='symbol'>:read</span> <span class='rparen'>)</span>
443
+ <span class='ivar'>@stack</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_io'>io</span>
444
+ <span class='kw'>end</span></pre>
445
+ </td>
446
+ </tr>
447
+ </table>
448
+ </div>
449
+
450
+ </div>
451
+
452
+ </div>
453
+
454
+ <div id="footer">
455
+ Generated on Wed Jan 15 19:29:45 2014 by
456
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
457
+ 0.8.6.1 (ruby-1.9.3).
458
+ </div>
459
+
460
+ </body>
461
+ </html>