mucgly 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,570 @@
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::String
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 (S)</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">String</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::String
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"><span class='object_link'><a href="InOut.html" title="EasyFile::InOut (class)">InOut</a></span></span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next"><span class='object_link'><a href="InOut.html" title="EasyFile::InOut (class)">InOut</a></span></li>
82
+
83
+ <li class="next">EasyFile::String</li>
84
+
85
+ </ul>
86
+ <a href="#" class="inheritanceTree">show all</a>
87
+
88
+ </dd>
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+ <dt class="r2 last">Defined in:</dt>
99
+ <dd class="r2 last">lib/easyfile.rb</dd>
100
+
101
+ </dl>
102
+ <div class="clear"></div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <p>String buffer file.</p>
108
+
109
+ <p>Features:</p>
110
+ <ul><li>
111
+ <p>Putback.</p>
112
+ </li></ul>
113
+
114
+
115
+ </div>
116
+ </div>
117
+ <div class="tags">
118
+
119
+
120
+ </div>
121
+ <h2>Constant Summary</h2>
122
+
123
+
124
+
125
+
126
+ <h2>Constant Summary</h2>
127
+
128
+ <h3 class="inherited">Constants inherited
129
+ from <span class='object_link'><a href="InOut.html" title="EasyFile::InOut (class)">InOut</a></span></h3>
130
+ <p class="inherited"><span class='object_link'><a href="InOut.html#FILEMODEMAP-constant" title="EasyFile::InOut::FILEMODEMAP (constant)">InOut::FILEMODEMAP</a></span></p>
131
+
132
+
133
+
134
+
135
+ <h2>Instance Attribute Summary</h2>
136
+
137
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="InOut.html" title="EasyFile::InOut (class)">InOut</a></span></h3>
138
+ <p class="inherited"><span class='object_link'><a href="InOut.html#absname-instance_method" title="EasyFile::InOut#absname (method)">#absname</a></span>, <span class='object_link'><a href="InOut.html#filename-instance_method" title="EasyFile::InOut#filename (method)">#filename</a></span>, <span class='object_link'><a href="InOut.html#io-instance_method" title="EasyFile::InOut#io (method)">#io</a></span>, <span class='object_link'><a href="InOut.html#line-instance_method" title="EasyFile::InOut#line (method)">#line</a></span>, <span class='object_link'><a href="InOut.html#mode-instance_method" title="EasyFile::InOut#mode (method)">#mode</a></span>, <span class='object_link'><a href="InOut.html#parent-instance_method" title="EasyFile::InOut#parent (method)">#parent</a></span>, <span class='object_link'><a href="InOut.html#peers-instance_method" title="EasyFile::InOut#peers (method)">#peers</a></span></p>
139
+
140
+
141
+
142
+ <h2>
143
+ Class Method Summary
144
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
145
+ </h2>
146
+
147
+ <ul class="summary">
148
+
149
+ <li class="public ">
150
+ <span class="summary_signature">
151
+
152
+ <a href="#open-class_method" title="open (class method)">+ (String) <strong>open</strong>(name) </a>
153
+
154
+
155
+
156
+ </span>
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+ <span class="summary_desc"><div class='inline'>
167
+ <p>Create EasyFile::String object and, open file with given name.</p>
168
+ </div></span>
169
+
170
+ </li>
171
+
172
+
173
+ </ul>
174
+
175
+ <h2>
176
+ Instance Method Summary
177
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
178
+ </h2>
179
+
180
+ <ul class="summary">
181
+
182
+ <li class="public ">
183
+ <span class="summary_signature">
184
+
185
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (String) <strong>initialize</strong>(filename, absname = nil, io = nil) </a>
186
+
187
+
188
+
189
+ </span>
190
+
191
+
192
+ <span class="note title constructor">constructor</span>
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+ <span class="summary_desc"><div class='inline'>
202
+ <p>Create String object.</p>
203
+ </div></span>
204
+
205
+ </li>
206
+
207
+
208
+ <li class="public ">
209
+ <span class="summary_signature">
210
+
211
+ <a href="#method_missing-instance_method" title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(name, *args, &amp;block) </a>
212
+
213
+
214
+
215
+ </span>
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+ <span class="summary_desc"><div class='inline'></div></span>
226
+
227
+ </li>
228
+
229
+
230
+ <li class="public ">
231
+ <span class="summary_signature">
232
+
233
+ <a href="#putback-instance_method" title="#putback (instance method)">- (Object) <strong>putback</strong>(c) </a>
234
+
235
+
236
+
237
+ </span>
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+ <span class="summary_desc"><div class='inline'>
248
+ <p>Put-back char(s) (to put-back buffer).</p>
249
+ </div></span>
250
+
251
+ </li>
252
+
253
+
254
+ </ul>
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="InOut.html" title="EasyFile::InOut (class)">InOut</a></span></h3>
267
+ <p class="inherited"><span class='object_link'><a href="InOut.html#abspath-class_method" title="EasyFile::InOut.abspath (method)">abspath</a></span>, <span class='object_link'><a href="InOut.html#add-class_method" title="EasyFile::InOut.add (method)">add</a></span>, <span class='object_link'><a href="InOut.html#close-instance_method" title="EasyFile::InOut#close (method)">#close</a></span>, <span class='object_link'><a href="InOut.html#create-class_method" title="EasyFile::InOut.create (method)">create</a></span>, <span class='object_link'><a href="InOut.html#delete-class_method" title="EasyFile::InOut.delete (method)">delete</a></span>, <span class='object_link'><a href="InOut.html#get-class_method" title="EasyFile::InOut.get (method)">get</a></span>, <span class='object_link'><a href="InOut.html#getByAbsname-class_method" title="EasyFile::InOut.getByAbsname (method)">getByAbsname</a></span>, <span class='object_link'><a href="InOut.html#getList-class_method" title="EasyFile::InOut.getList (method)">getList</a></span>, <span class='object_link'><a href="InOut.html#open-instance_method" title="EasyFile::InOut#open (method)">#open</a></span>, <span class='object_link'><a href="InOut.html#standard%3F-class_method" title="EasyFile::InOut.standard? (method)">standard?</a></span></p>
268
+ <div id="constructor_details" class="method_details_list">
269
+ <h2>Constructor Details</h2>
270
+
271
+ <div class="method_details first">
272
+ <h3 class="signature first" id="initialize-instance_method">
273
+
274
+ - (<tt><span class='object_link'><a href="" title="EasyFile::String (class)">String</a></span></tt>) <strong>initialize</strong>(filename, absname = nil, io = nil)
275
+
276
+
277
+
278
+
279
+
280
+ </h3><div class="docstring">
281
+ <div class="discussion">
282
+
283
+ <p>Create String object.</p>
284
+
285
+
286
+ </div>
287
+ </div>
288
+ <div class="tags">
289
+ <p class="tag_title">Parameters:</p>
290
+ <ul class="param">
291
+
292
+ <li>
293
+
294
+ <span class='name'>filename</span>
295
+
296
+
297
+ <span class='type'>(<tt><span class='object_link'><a href="" title="EasyFile::String (class)">String</a></span></tt>)</span>
298
+
299
+
300
+
301
+ &mdash;
302
+ <div class='inline'>
303
+ <p>Name.</p>
304
+ </div>
305
+
306
+ </li>
307
+
308
+ <li>
309
+
310
+ <span class='name'>absname</span>
311
+
312
+
313
+ <span class='type'>(<tt><span class='object_link'><a href="" title="EasyFile::String (class)">String</a></span></tt>)</span>
314
+
315
+
316
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
317
+
318
+
319
+ &mdash;
320
+ <div class='inline'>
321
+ <p>Absolute path file name (generated if not given).</p>
322
+ </div>
323
+
324
+ </li>
325
+
326
+ <li>
327
+
328
+ <span class='name'>io</span>
329
+
330
+
331
+ <span class='type'>(<tt>IO</tt>)</span>
332
+
333
+
334
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
335
+
336
+
337
+ &mdash;
338
+ <div class='inline'>
339
+ <p>IO handle.</p>
340
+ </div>
341
+
342
+ </li>
343
+
344
+ </ul>
345
+
346
+
347
+ </div><table class="source_code">
348
+ <tr>
349
+ <td>
350
+ <pre class="lines">
351
+
352
+
353
+ 618
354
+ 619
355
+ 620</pre>
356
+ </td>
357
+ <td>
358
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 618</span>
359
+
360
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span> <span class='id identifier rubyid_absname'>absname</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_io'>io</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
361
+ <span class='kw'>super</span><span class='lparen'>(</span> <span class='symbol'>:string</span><span class='comma'>,</span> <span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span> <span class='id identifier rubyid_absname'>absname</span><span class='comma'>,</span> <span class='id identifier rubyid_io'>io</span> <span class='rparen'>)</span>
362
+ <span class='kw'>end</span></pre>
363
+ </td>
364
+ </tr>
365
+ </table>
366
+ </div>
367
+
368
+ </div>
369
+ <div id="method_missing_details" class="method_details_list">
370
+ <h2>Dynamic Method Handling</h2>
371
+ <p class="notice this">
372
+ This class handles dynamic methods through the <tt>method_missing</tt> method
373
+
374
+ </p>
375
+
376
+ <div class="method_details first">
377
+ <h3 class="signature first" id="method_missing-instance_method">
378
+
379
+ - (<tt>Object</tt>) <strong>method_missing</strong>(name, *args, &amp;block)
380
+
381
+
382
+
383
+
384
+
385
+ </h3><table class="source_code">
386
+ <tr>
387
+ <td>
388
+ <pre class="lines">
389
+
390
+
391
+ 599
392
+ 600
393
+ 601</pre>
394
+ </td>
395
+ <td>
396
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 599</span>
397
+
398
+ <span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span> <span class='rparen'>)</span>
399
+ <span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span> <span class='rparen'>)</span>
400
+ <span class='kw'>end</span></pre>
401
+ </td>
402
+ </tr>
403
+ </table>
404
+ </div>
405
+
406
+ </div>
407
+
408
+
409
+ <div id="class_method_details" class="method_details_list">
410
+ <h2>Class Method Details</h2>
411
+
412
+
413
+ <div class="method_details first">
414
+ <h3 class="signature first" id="open-class_method">
415
+
416
+ + (<tt><span class='object_link'><a href="" title="EasyFile::String (class)">String</a></span></tt>) <strong>open</strong>(name)
417
+
418
+
419
+
420
+
421
+
422
+ </h3><div class="docstring">
423
+ <div class="discussion">
424
+
425
+ <p>Create EasyFile::String object and, open file with given name.</p>
426
+
427
+
428
+ </div>
429
+ </div>
430
+ <div class="tags">
431
+ <p class="tag_title">Parameters:</p>
432
+ <ul class="param">
433
+
434
+ <li>
435
+
436
+ <span class='name'>name</span>
437
+
438
+
439
+ <span class='type'>(<tt><span class='object_link'><a href="" title="EasyFile::String (class)">String</a></span></tt>)</span>
440
+
441
+
442
+
443
+ &mdash;
444
+ <div class='inline'>
445
+ <p>Name for file.</p>
446
+ </div>
447
+
448
+ </li>
449
+
450
+ </ul>
451
+
452
+ <p class="tag_title">Returns:</p>
453
+ <ul class="return">
454
+
455
+ <li>
456
+
457
+
458
+ <span class='type'>(<tt><span class='object_link'><a href="" title="EasyFile::String (class)">String</a></span></tt>)</span>
459
+
460
+
461
+
462
+ &mdash;
463
+ <div class='inline'>
464
+ <p>EasyFile handle.</p>
465
+ </div>
466
+
467
+ </li>
468
+
469
+ </ul>
470
+
471
+ </div><table class="source_code">
472
+ <tr>
473
+ <td>
474
+ <pre class="lines">
475
+
476
+
477
+ 608
478
+ 609
479
+ 610</pre>
480
+ </td>
481
+ <td>
482
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 608</span>
483
+
484
+ <span class='kw'>def</span> <span class='const'>String</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='rparen'>)</span>
485
+ <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'>:string</span> <span class='rparen'>)</span>
486
+ <span class='kw'>end</span></pre>
487
+ </td>
488
+ </tr>
489
+ </table>
490
+ </div>
491
+
492
+ </div>
493
+
494
+ <div id="instance_method_details" class="method_details_list">
495
+ <h2>Instance Method Details</h2>
496
+
497
+
498
+ <div class="method_details first">
499
+ <h3 class="signature first" id="putback-instance_method">
500
+
501
+ - (<tt>Object</tt>) <strong>putback</strong>(c)
502
+
503
+
504
+
505
+
506
+
507
+ </h3><div class="docstring">
508
+ <div class="discussion">
509
+
510
+ <p>Put-back char(s) (to put-back buffer).</p>
511
+
512
+
513
+ </div>
514
+ </div>
515
+ <div class="tags">
516
+ <p class="tag_title">Parameters:</p>
517
+ <ul class="param">
518
+
519
+ <li>
520
+
521
+ <span class='name'>c</span>
522
+
523
+
524
+ <span class='type'>(<tt><span class='object_link'><a href="" title="EasyFile::String (class)">String</a></span></tt>)</span>
525
+
526
+
527
+
528
+ &mdash;
529
+ <div class='inline'>
530
+ <p>Chars to put back to buffer.</p>
531
+ </div>
532
+
533
+ </li>
534
+
535
+ </ul>
536
+
537
+
538
+ </div><table class="source_code">
539
+ <tr>
540
+ <td>
541
+ <pre class="lines">
542
+
543
+
544
+ 625
545
+ 626
546
+ 627</pre>
547
+ </td>
548
+ <td>
549
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 625</span>
550
+
551
+ <span class='kw'>def</span> <span class='id identifier rubyid_putback'>putback</span><span class='lparen'>(</span> <span class='id identifier rubyid_c'>c</span> <span class='rparen'>)</span>
552
+ <span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span> <span class='op'>=</span> <span class='id identifier rubyid_c'>c</span> <span class='op'>+</span> <span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span><span class='lbracket'>[</span> <span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_pos'>pos</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span> <span class='rbracket'>]</span>
553
+ <span class='kw'>end</span></pre>
554
+ </td>
555
+ </tr>
556
+ </table>
557
+ </div>
558
+
559
+ </div>
560
+
561
+ </div>
562
+
563
+ <div id="footer">
564
+ Generated on Wed Jan 15 19:29:45 2014 by
565
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
566
+ 0.8.6.1 (ruby-1.9.3).
567
+ </div>
568
+
569
+ </body>
570
+ </html>