term_utils 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +6 -0
- data/COPYING +3 -3
- data/README.md +7 -1
- data/doc/TermUtils/AP/Article.html +991 -0
- data/doc/TermUtils/AP/Element.html +1025 -0
- data/doc/TermUtils/AP/Flag.html +539 -0
- data/doc/TermUtils/AP/Level.html +638 -0
- data/doc/TermUtils/AP/NoSuchValueError.html +217 -0
- data/doc/TermUtils/AP/Parameter.html +804 -0
- data/doc/TermUtils/AP/ParseError.html +217 -0
- data/doc/TermUtils/AP/Parser.html +572 -0
- data/doc/TermUtils/AP/Result.html +1029 -0
- data/doc/TermUtils/AP/ResultView.html +597 -0
- data/doc/TermUtils/AP/Syntax.html +1051 -0
- data/doc/TermUtils/AP/SyntaxError.html +217 -0
- data/doc/TermUtils/AP.html +505 -0
- data/doc/TermUtils/FF/Config.html +1 -1
- data/doc/TermUtils/FF/Cursor/Context.html +1 -1
- data/doc/TermUtils/FF/Cursor.html +1 -1
- data/doc/TermUtils/FF/Query.html +1 -1
- data/doc/TermUtils/FF.html +1 -1
- data/doc/TermUtils/PropertyTreeNode.html +1999 -0
- data/doc/TermUtils/Tab/Column.html +1 -1
- data/doc/TermUtils/Tab/Holder.html +1 -1
- data/doc/TermUtils/Tab/Printer.html +1 -1
- data/doc/TermUtils/Tab/Table.html +1 -1
- data/doc/TermUtils/Tab.html +1 -1
- data/doc/TermUtils.html +5 -3
- data/doc/_index.html +143 -1
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +8 -2
- data/doc/index.html +8 -2
- data/doc/method_list.html +638 -22
- data/doc/top-level-namespace.html +1 -1
- data/lib/term_utils/ap/article.rb +68 -0
- data/lib/term_utils/ap/element.rb +78 -0
- data/lib/term_utils/ap/flag.rb +48 -0
- data/lib/term_utils/ap/level.rb +57 -0
- data/lib/term_utils/ap/no_such_value_error.rb +27 -0
- data/lib/term_utils/ap/parameter.rb +75 -0
- data/lib/term_utils/ap/parse_error.rb +27 -0
- data/lib/term_utils/ap/parser.rb +185 -0
- data/lib/term_utils/ap/result.rb +175 -0
- data/lib/term_utils/ap/syntax.rb +112 -0
- data/lib/term_utils/ap/syntax_error.rb +27 -0
- data/lib/term_utils/ap.rb +59 -0
- data/lib/term_utils/property_tree_node.rb +200 -0
- data/lib/term_utils.rb +1 -0
- data/term_utils.gemspec +2 -2
- metadata +29 -2
@@ -0,0 +1,539 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
Class: TermUtils::AP::Flag
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.20
|
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
|
+
pathId = "TermUtils::AP::Flag";
|
19
|
+
relpath = '../../';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="../../_index.html">Index (F)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span> » <span class='title'><span class='object_link'><a href="../AP.html" title="TermUtils::AP (module)">AP</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Flag</span>
|
43
|
+
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<div id="search">
|
47
|
+
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
49
|
+
href="../../class_list.html">
|
50
|
+
|
51
|
+
<svg width="24" height="24">
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
+
</svg>
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<div id="content"><h1>Class: TermUtils::AP::Flag
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
<dl>
|
70
|
+
<dt>Inherits:</dt>
|
71
|
+
<dd>
|
72
|
+
<span class="inheritName">Object</span>
|
73
|
+
|
74
|
+
<ul class="fullTree">
|
75
|
+
<li>Object</li>
|
76
|
+
|
77
|
+
<li class="next">TermUtils::AP::Flag</li>
|
78
|
+
|
79
|
+
</ul>
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
81
|
+
|
82
|
+
</dd>
|
83
|
+
</dl>
|
84
|
+
|
85
|
+
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
<dl>
|
96
|
+
<dt>Defined in:</dt>
|
97
|
+
<dd>lib/term_utils/ap/flag.rb</dd>
|
98
|
+
</dl>
|
99
|
+
|
100
|
+
</div>
|
101
|
+
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
103
|
+
<div class="discussion">
|
104
|
+
|
105
|
+
<p>Represents a Flag.</p>
|
106
|
+
|
107
|
+
|
108
|
+
</div>
|
109
|
+
</div>
|
110
|
+
<div class="tags">
|
111
|
+
|
112
|
+
|
113
|
+
</div>
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
118
|
+
<ul class="summary">
|
119
|
+
|
120
|
+
<li class="public ">
|
121
|
+
<span class="summary_signature">
|
122
|
+
|
123
|
+
<a href="#flavor-instance_method" title="#flavor (instance method)">#<strong>flavor</strong> ⇒ Symbol </a>
|
124
|
+
|
125
|
+
|
126
|
+
|
127
|
+
</span>
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
<span class="summary_desc"><div class='inline'>
|
141
|
+
<p>`:anchor`, `:long`, `:short`.</p>
|
142
|
+
</div></span>
|
143
|
+
|
144
|
+
</li>
|
145
|
+
|
146
|
+
|
147
|
+
<li class="public ">
|
148
|
+
<span class="summary_signature">
|
149
|
+
|
150
|
+
<a href="#label-instance_method" title="#label (instance method)">#<strong>label</strong> ⇒ String </a>
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
</span>
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
168
|
+
|
169
|
+
</li>
|
170
|
+
|
171
|
+
|
172
|
+
</ul>
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
<h2>
|
179
|
+
Instance Method Summary
|
180
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
181
|
+
</h2>
|
182
|
+
|
183
|
+
<ul class="summary">
|
184
|
+
|
185
|
+
<li class="public ">
|
186
|
+
<span class="summary_signature">
|
187
|
+
|
188
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(opts = {}) ⇒ Flag </a>
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
</span>
|
193
|
+
|
194
|
+
|
195
|
+
<span class="note title constructor">constructor</span>
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
<span class="summary_desc"><div class='inline'>
|
205
|
+
<p>Constructs a new Flag.</p>
|
206
|
+
</div></span>
|
207
|
+
|
208
|
+
</li>
|
209
|
+
|
210
|
+
|
211
|
+
<li class="public ">
|
212
|
+
<span class="summary_signature">
|
213
|
+
|
214
|
+
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> ⇒ String </a>
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
</span>
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
<span class="summary_desc"><div class='inline'>
|
229
|
+
<p>Returns the string representation of this one.</p>
|
230
|
+
</div></span>
|
231
|
+
|
232
|
+
</li>
|
233
|
+
|
234
|
+
|
235
|
+
</ul>
|
236
|
+
|
237
|
+
|
238
|
+
<div id="constructor_details" class="method_details_list">
|
239
|
+
<h2>Constructor Details</h2>
|
240
|
+
|
241
|
+
<div class="method_details first">
|
242
|
+
<h3 class="signature first" id="initialize-instance_method">
|
243
|
+
|
244
|
+
#<strong>initialize</strong>(opts = {}) ⇒ <tt><span class='object_link'><a href="" title="TermUtils::AP::Flag (class)">Flag</a></span></tt>
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
</h3><div class="docstring">
|
251
|
+
<div class="discussion">
|
252
|
+
|
253
|
+
<p>Constructs a new Flag.</p>
|
254
|
+
|
255
|
+
|
256
|
+
</div>
|
257
|
+
</div>
|
258
|
+
<div class="tags">
|
259
|
+
<p class="tag_title">Parameters:</p>
|
260
|
+
<ul class="param">
|
261
|
+
|
262
|
+
<li>
|
263
|
+
|
264
|
+
<span class='name'>opts</span>
|
265
|
+
|
266
|
+
|
267
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
268
|
+
|
269
|
+
|
270
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
271
|
+
|
272
|
+
|
273
|
+
</li>
|
274
|
+
|
275
|
+
</ul>
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
|
281
|
+
<ul class="option">
|
282
|
+
|
283
|
+
<li>
|
284
|
+
<span class="name">:label</span>
|
285
|
+
<span class="type">(<tt>String</tt>)</span>
|
286
|
+
<span class="default">
|
287
|
+
|
288
|
+
</span>
|
289
|
+
|
290
|
+
</li>
|
291
|
+
|
292
|
+
<li>
|
293
|
+
<span class="name">:flavor</span>
|
294
|
+
<span class="type">(<tt>Symbol</tt>)</span>
|
295
|
+
<span class="default">
|
296
|
+
|
297
|
+
</span>
|
298
|
+
|
299
|
+
— <div class='inline'>
|
300
|
+
<p>`:anchor`, `:long`, `:short`.</p>
|
301
|
+
</div>
|
302
|
+
|
303
|
+
</li>
|
304
|
+
|
305
|
+
</ul>
|
306
|
+
|
307
|
+
|
308
|
+
|
309
|
+
</div><table class="source_code">
|
310
|
+
<tr>
|
311
|
+
<td>
|
312
|
+
<pre class="lines">
|
313
|
+
|
314
|
+
|
315
|
+
30
|
316
|
+
31
|
317
|
+
32
|
318
|
+
33</pre>
|
319
|
+
</td>
|
320
|
+
<td>
|
321
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/flag.rb', line 30</span>
|
322
|
+
|
323
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
324
|
+
<span class='ivar'>@label</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:label</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
325
|
+
<span class='ivar'>@flavor</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:flavor</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
326
|
+
<span class='kw'>end</span></pre>
|
327
|
+
</td>
|
328
|
+
</tr>
|
329
|
+
</table>
|
330
|
+
</div>
|
331
|
+
|
332
|
+
</div>
|
333
|
+
|
334
|
+
<div id="instance_attr_details" class="attr_details">
|
335
|
+
<h2>Instance Attribute Details</h2>
|
336
|
+
|
337
|
+
|
338
|
+
<span id="flavor=-instance_method"></span>
|
339
|
+
<div class="method_details first">
|
340
|
+
<h3 class="signature first" id="flavor-instance_method">
|
341
|
+
|
342
|
+
#<strong>flavor</strong> ⇒ <tt>Symbol</tt>
|
343
|
+
|
344
|
+
|
345
|
+
|
346
|
+
|
347
|
+
|
348
|
+
</h3><div class="docstring">
|
349
|
+
<div class="discussion">
|
350
|
+
|
351
|
+
<p>Returns `:anchor`, `:long`, `:short`.</p>
|
352
|
+
|
353
|
+
|
354
|
+
</div>
|
355
|
+
</div>
|
356
|
+
<div class="tags">
|
357
|
+
|
358
|
+
<p class="tag_title">Returns:</p>
|
359
|
+
<ul class="return">
|
360
|
+
|
361
|
+
<li>
|
362
|
+
|
363
|
+
|
364
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
365
|
+
|
366
|
+
|
367
|
+
|
368
|
+
—
|
369
|
+
<div class='inline'>
|
370
|
+
<p>`:anchor`, `:long`, `:short`.</p>
|
371
|
+
</div>
|
372
|
+
|
373
|
+
</li>
|
374
|
+
|
375
|
+
</ul>
|
376
|
+
|
377
|
+
</div><table class="source_code">
|
378
|
+
<tr>
|
379
|
+
<td>
|
380
|
+
<pre class="lines">
|
381
|
+
|
382
|
+
|
383
|
+
25
|
384
|
+
26
|
385
|
+
27</pre>
|
386
|
+
</td>
|
387
|
+
<td>
|
388
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/flag.rb', line 25</span>
|
389
|
+
|
390
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_flavor'>flavor</span>
|
391
|
+
<span class='ivar'>@flavor</span>
|
392
|
+
<span class='kw'>end</span></pre>
|
393
|
+
</td>
|
394
|
+
</tr>
|
395
|
+
</table>
|
396
|
+
</div>
|
397
|
+
|
398
|
+
|
399
|
+
<span id="label=-instance_method"></span>
|
400
|
+
<div class="method_details ">
|
401
|
+
<h3 class="signature " id="label-instance_method">
|
402
|
+
|
403
|
+
#<strong>label</strong> ⇒ <tt>String</tt>
|
404
|
+
|
405
|
+
|
406
|
+
|
407
|
+
|
408
|
+
|
409
|
+
</h3><div class="docstring">
|
410
|
+
<div class="discussion">
|
411
|
+
|
412
|
+
|
413
|
+
</div>
|
414
|
+
</div>
|
415
|
+
<div class="tags">
|
416
|
+
|
417
|
+
<p class="tag_title">Returns:</p>
|
418
|
+
<ul class="return">
|
419
|
+
|
420
|
+
<li>
|
421
|
+
|
422
|
+
|
423
|
+
<span class='type'>(<tt>String</tt>)</span>
|
424
|
+
|
425
|
+
|
426
|
+
|
427
|
+
</li>
|
428
|
+
|
429
|
+
</ul>
|
430
|
+
|
431
|
+
</div><table class="source_code">
|
432
|
+
<tr>
|
433
|
+
<td>
|
434
|
+
<pre class="lines">
|
435
|
+
|
436
|
+
|
437
|
+
23
|
438
|
+
24
|
439
|
+
25</pre>
|
440
|
+
</td>
|
441
|
+
<td>
|
442
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/flag.rb', line 23</span>
|
443
|
+
|
444
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_label'>label</span>
|
445
|
+
<span class='ivar'>@label</span>
|
446
|
+
<span class='kw'>end</span></pre>
|
447
|
+
</td>
|
448
|
+
</tr>
|
449
|
+
</table>
|
450
|
+
</div>
|
451
|
+
|
452
|
+
</div>
|
453
|
+
|
454
|
+
|
455
|
+
<div id="instance_method_details" class="method_details_list">
|
456
|
+
<h2>Instance Method Details</h2>
|
457
|
+
|
458
|
+
|
459
|
+
<div class="method_details first">
|
460
|
+
<h3 class="signature first" id="to_s-instance_method">
|
461
|
+
|
462
|
+
#<strong>to_s</strong> ⇒ <tt>String</tt>
|
463
|
+
|
464
|
+
|
465
|
+
|
466
|
+
|
467
|
+
|
468
|
+
</h3><div class="docstring">
|
469
|
+
<div class="discussion">
|
470
|
+
|
471
|
+
<p>Returns the string representation of this one.</p>
|
472
|
+
|
473
|
+
|
474
|
+
</div>
|
475
|
+
</div>
|
476
|
+
<div class="tags">
|
477
|
+
|
478
|
+
<p class="tag_title">Returns:</p>
|
479
|
+
<ul class="return">
|
480
|
+
|
481
|
+
<li>
|
482
|
+
|
483
|
+
|
484
|
+
<span class='type'>(<tt>String</tt>)</span>
|
485
|
+
|
486
|
+
|
487
|
+
|
488
|
+
</li>
|
489
|
+
|
490
|
+
</ul>
|
491
|
+
|
492
|
+
</div><table class="source_code">
|
493
|
+
<tr>
|
494
|
+
<td>
|
495
|
+
<pre class="lines">
|
496
|
+
|
497
|
+
|
498
|
+
36
|
499
|
+
37
|
500
|
+
38
|
501
|
+
39
|
502
|
+
40
|
503
|
+
41
|
504
|
+
42
|
505
|
+
43
|
506
|
+
44
|
507
|
+
45</pre>
|
508
|
+
</td>
|
509
|
+
<td>
|
510
|
+
<pre class="code"><span class="info file"># File 'lib/term_utils/ap/flag.rb', line 36</span>
|
511
|
+
|
512
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
|
513
|
+
<span class='kw'>case</span> <span class='ivar'>@flavor</span>
|
514
|
+
<span class='kw'>when</span> <span class='symbol'>:anchor</span>
|
515
|
+
<span class='ivar'>@label</span>
|
516
|
+
<span class='kw'>when</span> <span class='symbol'>:long</span>
|
517
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>--%s</span><span class='tstring_end'>"</span></span> <span class='op'>%</span> <span class='ivar'>@label</span>
|
518
|
+
<span class='kw'>when</span> <span class='symbol'>:short</span>
|
519
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>-%s</span><span class='tstring_end'>"</span></span> <span class='op'>%</span> <span class='ivar'>@label</span>
|
520
|
+
<span class='kw'>end</span>
|
521
|
+
<span class='kw'>end</span></pre>
|
522
|
+
</td>
|
523
|
+
</tr>
|
524
|
+
</table>
|
525
|
+
</div>
|
526
|
+
|
527
|
+
</div>
|
528
|
+
|
529
|
+
</div>
|
530
|
+
|
531
|
+
<div id="footer">
|
532
|
+
Generated on Sun Nov 10 18:36:19 2019 by
|
533
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
534
|
+
0.9.20 (ruby-2.6.5).
|
535
|
+
</div>
|
536
|
+
|
537
|
+
</div>
|
538
|
+
</body>
|
539
|
+
</html>
|