Debian Codegraph @

doc-api/classes/Kwalify/PlainYamlParser.html

raw
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: Kwalify::PlainYamlParser</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">Kwalify::PlainYamlParser</td>
54 </tr>
55 <tr class="top-aligned-row">
56 <td><strong>In:</strong></td>
57 <td>
58 <a href="../../files/kwalify/yaml-parser_rb.html">
59 kwalify/yaml-parser.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 base class of yaml parser
84 </p>
85 <p>
86 ex.
87 </p>
88 <pre>
89 str = ARGF.read()
90 parser = Kwalify::PlainYamlParser.new(str)
91 doc = parser.parse()
92 p doc
93 </pre>
94
95 </div>
96
97
98 </div>
99
100 <div id="method-list">
101 <h3 class="section-bar">Methods</h3>
102
103 <div class="name-list">
104 <a href="#M000125">add_to_map</a>&nbsp;&nbsp;
105 <a href="#M000122">add_to_seq</a>&nbsp;&nbsp;
106 <a href="#M000124">create_mapping</a>&nbsp;&nbsp;
107 <a href="#M000129">create_scalar</a>&nbsp;&nbsp;
108 <a href="#M000121">create_sequence</a>&nbsp;&nbsp;
109 <a href="#M000130">current_line</a>&nbsp;&nbsp;
110 <a href="#M000131">current_linenum</a>&nbsp;&nbsp;
111 <a href="#M000119">has_next?</a>&nbsp;&nbsp;
112 <a href="#M000128">merge_map</a>&nbsp;&nbsp;
113 <a href="#M000117">new</a>&nbsp;&nbsp;
114 <a href="#M000118">parse</a>&nbsp;&nbsp;
115 <a href="#M000120">parse_all</a>&nbsp;&nbsp;
116 <a href="#M000127">set_default</a>&nbsp;&nbsp;
117 <a href="#M000126">set_map_with</a>&nbsp;&nbsp;
118 <a href="#M000123">set_seq_at</a>&nbsp;&nbsp;
119 </div>
120 </div>
121
122 </div>
123
124
125 <!-- if includes -->
126
127 <div id="section">
128
129 <div id="class-list">
130 <h3 class="section-bar">Classes and Modules</h3>
131
132 Class <a href="PlainYamlParser/Alias.html" class="link">Kwalify::PlainYamlParser::Alias</a><br />
133
134 </div>
135
136
137
138
139
140
141
142 <!-- if method_list -->
143 <div id="methods">
144 <h3 class="section-bar">Public Class methods</h3>
145
146 <div id="method-M000117" class="method-detail">
147 <a name="M000117"></a>
148
149 <div class="method-heading">
150 <a href="#M000117" class="method-signature">
151 <span class="method-name">new</span><span class="method-args">(yaml_str)</span>
152 </a>
153 </div>
154
155 <div class="method-description">
156 <p><a class="source-toggle" href="#"
157 onclick="toggleCode('M000117-source');return false;">[Source]</a></p>
158 <div class="method-source-code" id="M000117-source">
159 <pre>
160 <span class="ruby-comment cmt"># File kwalify/yaml-parser.rb, line 36</span>
161 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">yaml_str</span>)
162 <span class="ruby-ivar">@lines</span> = <span class="ruby-identifier">yaml_str</span>.<span class="ruby-identifier">to_a</span>()
163 <span class="ruby-ivar">@line</span> = <span class="ruby-keyword kw">nil</span>
164 <span class="ruby-ivar">@linenum</span> = <span class="ruby-value">0</span>
165 <span class="ruby-ivar">@anchors</span> = {}
166 <span class="ruby-ivar">@aliases</span> = {}
167 <span class="ruby-keyword kw">end</span>
168 </pre>
169 </div>
170 </div>
171 </div>
172
173 <h3 class="section-bar">Public Instance methods</h3>
174
175 <div id="method-M000119" class="method-detail">
176 <a name="M000119"></a>
177
178 <div class="method-heading">
179 <a href="#M000119" class="method-signature">
180 <span class="method-name">has_next?</span><span class="method-args">()</span>
181 </a>
182 </div>
183
184 <div class="method-description">
185 <p><a class="source-toggle" href="#"
186 onclick="toggleCode('M000119-source');return false;">[Source]</a></p>
187 <div class="method-source-code" id="M000119-source">
188 <pre>
189 <span class="ruby-comment cmt"># File kwalify/yaml-parser.rb, line 55</span>
190 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">has_next?</span>
191 <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@end_flag</span> <span class="ruby-operator">!=</span> <span class="ruby-value str">'EOF'</span>
192 <span class="ruby-keyword kw">end</span>
193 </pre>
194 </div>
195 </div>
196 </div>
197
198 <div id="method-M000118" class="method-detail">
199 <a name="M000118"></a>
200
201 <div class="method-heading">
202 <a href="#M000118" class="method-signature">
203 <span class="method-name">parse</span><span class="method-args">()</span>
204 </a>
205 </div>
206
207 <div class="method-description">
208 <p><a class="source-toggle" href="#"
209 onclick="toggleCode('M000118-source');return false;">[Source]</a></p>
210 <div class="method-source-code" id="M000118-source">
211 <pre>
212 <span class="ruby-comment cmt"># File kwalify/yaml-parser.rb, line 45</span>
213 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse</span>()
214 <span class="ruby-identifier">data</span> = <span class="ruby-identifier">parse_child</span>(<span class="ruby-value">0</span>)
215 <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@end_flag</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'---'</span>
216 <span class="ruby-identifier">data</span> = <span class="ruby-identifier">parse_child</span>(<span class="ruby-value">0</span>)
217 <span class="ruby-keyword kw">end</span>
218 <span class="ruby-identifier">resolve_aliases</span>(<span class="ruby-identifier">data</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@aliases</span>.<span class="ruby-identifier">empty?</span>
219 <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">data</span>
220 <span class="ruby-keyword kw">end</span>
221 </pre>
222 </div>
223 </div>
224 </div>
225
226 <div id="method-M000120" class="method-detail">
227 <a name="M000120"></a>
228
229 <div class="method-heading">
230 <a href="#M000120" class="method-signature">
231 <span class="method-name">parse_all</span><span class="method-args">()</span>
232 </a>
233 </div>
234
235 <div class="method-description">
236 <p><a class="source-toggle" href="#"
237 onclick="toggleCode('M000120-source');return false;">[Source]</a></p>
238 <div class="method-source-code" id="M000120-source">
239 <pre>
240 <span class="ruby-comment cmt"># File kwalify/yaml-parser.rb, line 60</span>
241 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse_all</span>
242 <span class="ruby-identifier">list</span> = []
243 <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">has_next</span>()
244 <span class="ruby-identifier">doc</span> = <span class="ruby-identifier">parse</span>()
245 <span class="ruby-identifier">list</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">doc</span>
246 <span class="ruby-keyword kw">end</span>
247 <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">list</span>
248 <span class="ruby-keyword kw">end</span>
249 </pre>
250 </div>
251 </div>
252 </div>
253
254 <h3 class="section-bar">Protected Instance methods</h3>
255
256 <div id="method-M000125" class="method-detail">
257 <a name="M000125"></a>
258
259 <div class="method-heading">
260 <a href="#M000125" class="method-signature">
261 <span class="method-name">add_to_map</span><span class="method-args">(map, key, value, linenum)</span>
262 </a>
263 </div>
264
265 <div class="method-description">
266 <p><a class="source-toggle" href="#"
267 onclick="toggleCode('M000125-source');return false;">[Source]</a></p>
268 <div class="method-source-code" id="M000125-source">
269 <pre>
270 <span class="ruby-comment cmt"># File kwalify/yaml-parser.rb, line 89</span>
271 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_to_map</span>(<span class="ruby-identifier">map</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">linenum</span>)
272 <span class="ruby-identifier">map</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span>
273 <span class="ruby-keyword kw">end</span>
274 </pre>
275 </div>
276 </div>
277 </div>
278
279 <div id="method-M000122" class="method-detail">
280 <a name="M000122"></a>
281
282 <div class="method-heading">
283 <a href="#M000122" class="method-signature">
284 <span class="method-name">add_to_seq</span><span class="method-args">(seq, value, linenum)</span>
285 </a>
286 </div>
287
288 <div class="method-description">
289 <p><a class="source-toggle" href="#"
290 onclick="toggleCode('M000122-source');return false;">[Source]</a></p>
291 <div class="method-source-code" id="M000122-source">
292 <pre>
293 <span class="ruby-comment cmt"># File kwalify/yaml-parser.rb, line 77</span>
294 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_to_seq</span>(<span class="ruby-identifier">seq</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">linenum</span>)
295 <span class="ruby-identifier">seq</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">value</span>
296 <span class="ruby-keyword kw">end</span>
297 </pre>
298 </div>
299 </div>
300 </div>
301
302 <div id="method-M000124" class="method-detail">
303 <a name="M000124"></a>
304
305 <div class="method-heading">
306 <a href="#M000124" class="method-signature">
307 <span class="method-name">create_mapping</span><span class="method-args">(linenum=nil)</span>
308 </a>
309 </div>
310
311 <div class="method-description">
312 <p><a class="source-toggle" href="#"
313 onclick="toggleCode('M000124-source');return false;">[Source]</a></p>
314 <div class="method-source-code" id="M000124-source">
315 <pre>
316 <span class="ruby-comment cmt"># File kwalify/yaml-parser.rb, line 85</span>
317 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_mapping</span>(<span class="ruby-identifier">linenum</span>=<span class="ruby-keyword kw">nil</span>)
318 <span class="ruby-keyword kw">return</span> {}
319 <span class="ruby-keyword kw">end</span>
320 </pre>
321 </div>
322 </div>
323 </div>
324
325 <div id="method-M000129" class="method-detail">
326 <a name="M000129"></a>
327
328 <div class="method-heading">
329 <a href="#M000129" class="method-signature">
330 <span class="method-name">create_scalar</span><span class="method-args">(value, linenum=nil)</span>
331 </a>
332 </div>
333
334 <div class="method-description">
335 <p><a class="source-toggle" href="#"
336 onclick="toggleCode('M000129-source');return false;">[Source]</a></p>
337 <div class="method-source-code" id="M000129-source">
338 <pre>
339 <span class="ruby-comment cmt"># File kwalify/yaml-parser.rb, line 107</span>
340 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_scalar</span>(<span class="ruby-identifier">value</span>, <span class="ruby-identifier">linenum</span>=<span class="ruby-keyword kw">nil</span>)
341 <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">value</span>
342 <span class="ruby-keyword kw">end</span>
343 </pre>
344 </div>
345 </div>
346 </div>
347
348 <div id="method-M000121" class="method-detail">
349 <a name="M000121"></a>
350
351 <div class="method-heading">
352 <a href="#M000121" class="method-signature">
353 <span class="method-name">create_sequence</span><span class="method-args">(linenum=nil)</span>
354 </a>
355 </div>
356
357 <div class="method-description">
358 <p><a class="source-toggle" href="#"
359 onclick="toggleCode('M000121-source');return false;">[Source]</a></p>
360 <div class="method-source-code" id="M000121-source">
361 <pre>
362 <span class="ruby-comment cmt"># File kwalify/yaml-parser.rb, line 73</span>
363 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_sequence</span>(<span class="ruby-identifier">linenum</span>=<span class="ruby-keyword kw">nil</span>)
364 <span class="ruby-keyword kw">return</span> []
365 <span class="ruby-keyword kw">end</span>
366 </pre>
367 </div>
368 </div>
369 </div>
370
371 <div id="method-M000130" class="method-detail">
372 <a name="M000130"></a>
373
374 <div class="method-heading">
375 <a href="#M000130" class="method-signature">
376 <span class="method-name">current_line</span><span class="method-args">()</span>
377 </a>
378 </div>
379
380 <div class="method-description">
381 <p><a class="source-toggle" href="#"
382 onclick="toggleCode('M000130-source');return false;">[Source]</a></p>
383 <div class="method-source-code" id="M000130-source">
384 <pre>
385 <span class="ruby-comment cmt"># File kwalify/yaml-parser.rb, line 112</span>
386 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">current_line</span>
387 <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@line</span>
388 <span class="ruby-keyword kw">end</span>
389 </pre>
390 </div>
391 </div>
392 </div>
393
394 <div id="method-M000131" class="method-detail">
395 <a name="M000131"></a>
396
397 <div class="method-heading">
398 <a href="#M000131" class="method-signature">
399 <span class="method-name">current_linenum</span><span class="method-args">()</span>
400 </a>
401 </div>
402
403 <div class="method-description">
404 <p><a class="source-toggle" href="#"
405 onclick="toggleCode('M000131-source');return false;">[Source]</a></p>
406 <div class="method-source-code" id="M000131-source">
407 <pre>
408 <span class="ruby-comment cmt"># File kwalify/yaml-parser.rb, line 116</span>
409 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">current_linenum</span>
410 <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@linenum</span>
411 <span class="ruby-keyword kw">end</span>
412 </pre>
413 </div>
414 </div>
415 </div>
416
417 <div id="method-M000128" class="method-detail">
418 <a name="M000128"></a>
419
420 <div class="method-heading">
421 <a href="#M000128" class="method-signature">
422 <span class="method-name">merge_map</span><span class="method-args">(map, map2, linenum)</span>
423 </a>
424 </div>
425
426 <div class="method-description">
427 <p><a class="source-toggle" href="#"
428 onclick="toggleCode('M000128-source');return false;">[Source]</a></p>
429 <div class="method-source-code" id="M000128-source">
430 <pre>
431 <span class="ruby-comment cmt"># File kwalify/yaml-parser.rb, line 101</span>
432 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">merge_map</span>(<span class="ruby-identifier">map</span>, <span class="ruby-identifier">map2</span>, <span class="ruby-identifier">linenum</span>)
433 <span class="ruby-identifier">map2</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span><span class="ruby-operator">|</span>
434 <span class="ruby-identifier">map</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">map</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">key</span>)
435 <span class="ruby-keyword kw">end</span>
436 <span class="ruby-keyword kw">end</span>
437 </pre>
438 </div>
439 </div>
440 </div>
441
442 <div id="method-M000127" class="method-detail">
443 <a name="M000127"></a>
444
445 <div class="method-heading">
446 <a href="#M000127" class="method-signature">
447 <span class="method-name">set_default</span><span class="method-args">(map, value, linenum)</span>
448 </a>
449 </div>
450
451 <div class="method-description">
452 <p><a class="source-toggle" href="#"
453 onclick="toggleCode('M000127-source');return false;">[Source]</a></p>
454 <div class="method-source-code" id="M000127-source">
455 <pre>
456 <span class="ruby-comment cmt"># File kwalify/yaml-parser.rb, line 97</span>
457 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_default</span>(<span class="ruby-identifier">map</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">linenum</span>)
458 <span class="ruby-identifier">map</span>.<span class="ruby-identifier">value</span> = <span class="ruby-identifier">value</span>
459 <span class="ruby-keyword kw">end</span>
460 </pre>
461 </div>
462 </div>
463 </div>
464
465 <div id="method-M000126" class="method-detail">
466 <a name="M000126"></a>
467
468 <div class="method-heading">
469 <a href="#M000126" class="method-signature">
470 <span class="method-name">set_map_with</span><span class="method-args">(map, key, value, linenum)</span>
471 </a>
472 </div>
473
474 <div class="method-description">
475 <p><a class="source-toggle" href="#"
476 onclick="toggleCode('M000126-source');return false;">[Source]</a></p>
477 <div class="method-source-code" id="M000126-source">
478 <pre>
479 <span class="ruby-comment cmt"># File kwalify/yaml-parser.rb, line 93</span>
480 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_map_with</span>(<span class="ruby-identifier">map</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">linenum</span>)
481 <span class="ruby-identifier">map</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span>
482 <span class="ruby-keyword kw">end</span>
483 </pre>
484 </div>
485 </div>
486 </div>
487
488 <div id="method-M000123" class="method-detail">
489 <a name="M000123"></a>
490
491 <div class="method-heading">
492 <a href="#M000123" class="method-signature">
493 <span class="method-name">set_seq_at</span><span class="method-args">(seq, i, value, linenum)</span>
494 </a>
495 </div>
496
497 <div class="method-description">
498 <p><a class="source-toggle" href="#"
499 onclick="toggleCode('M000123-source');return false;">[Source]</a></p>
500 <div class="method-source-code" id="M000123-source">
501 <pre>
502 <span class="ruby-comment cmt"># File kwalify/yaml-parser.rb, line 81</span>
503 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_seq_at</span>(<span class="ruby-identifier">seq</span>, <span class="ruby-identifier">i</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">linenum</span>)
504 <span class="ruby-identifier">seq</span>[<span class="ruby-identifier">i</span>] = <span class="ruby-identifier">value</span>
505 <span class="ruby-keyword kw">end</span>
506 </pre>
507 </div>
508 </div>
509 </div>
510
511
512 </div>
513
514
515 </div>
516
517
518 <div id="validator-badges">
519 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
520 </div>
521
522 </body>
523 </html>