Debian Codegraph @

doc-api/classes/Kwalify/Yaml.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>Module: Kwalify::Yaml</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">Kwalify::Yaml</td>
54 </tr>
55 <tr class="top-aligned-row">
56 <td><strong>In:</strong></td>
57 <td>
58 <a href="../../files/kwalify/parser/yaml_rb.html">
59 kwalify/parser/yaml.rb
60 </a>
61 <br />
62 <a href="../../files/kwalify_rb.html">
63 kwalify.rb
64 </a>
65 <br />
66 </td>
67 </tr>
68
69 </table>
70 </div>
71 <!-- banner header -->
72
73 <div id="bodyContent">
74
75
76
77 <div id="contextContent">
78
79
80
81 </div>
82
83 <div id="method-list">
84 <h3 class="section-bar">Methods</h3>
85
86 <div class="name-list">
87 <a href="#M000038">load</a>&nbsp;&nbsp;
88 <a href="#M000039">load_file</a>&nbsp;&nbsp;
89 </div>
90 </div>
91
92 </div>
93
94
95 <!-- if includes -->
96
97 <div id="section">
98
99 <div id="class-list">
100 <h3 class="section-bar">Classes and Modules</h3>
101
102 Class <a href="Yaml/Parser.html" class="link">Kwalify::Yaml::Parser</a><br />
103
104 </div>
105
106
107
108
109
110
111
112 <!-- if method_list -->
113 <div id="methods">
114 <h3 class="section-bar">Public Class methods</h3>
115
116 <div id="method-M000038" class="method-detail">
117 <a name="M000038"></a>
118
119 <div class="method-heading">
120 <a href="#M000038" class="method-signature">
121 <span class="method-name">load</span><span class="method-args">(yaml_str, opts={})</span>
122 </a>
123 </div>
124
125 <div class="method-description">
126 <p>
127 read yaml_str, parse it, and return yaml document.
128 </p>
129 <p>
130 opts: ::validator: <a href="Validator.html">Kwalify::Validator</a> object
131 ::preceding_aliass: allow preceding alias if true ::data_binding: enable
132 data binding if true ::untabify: expand tab chars if true ::filename:
133 filename
134 </p>
135 <p><a class="source-toggle" href="#"
136 onclick="toggleCode('M000038-source');return false;">[Source]</a></p>
137 <div class="method-source-code" id="M000038-source">
138 <pre>
139 <span class="ruby-comment cmt"># File kwalify.rb, line 45</span>
140 <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">yaml_str</span>, <span class="ruby-identifier">opts</span>={})
141 <span class="ruby-comment cmt">#require 'kwalify/parser/yaml'</span>
142 <span class="ruby-identifier">parser</span> = <span class="ruby-constant">Kwalify</span><span class="ruby-operator">::</span><span class="ruby-constant">Yaml</span><span class="ruby-operator">::</span><span class="ruby-constant">Parser</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">opts</span>[<span class="ruby-identifier">:validator</span>])
143 <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">preceding_alias</span> = <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">opts</span>[<span class="ruby-identifier">:preceding_alias</span>]
144 <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">data_binding</span> = <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">opts</span>[<span class="ruby-identifier">:data_binding</span>]
145 <span class="ruby-identifier">yaml_str</span> = <span class="ruby-constant">Kwalify</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">untabify</span>(<span class="ruby-identifier">yaml_str</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">opts</span>[<span class="ruby-identifier">:untabify</span>]
146 <span class="ruby-identifier">ydoc</span> = <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">yaml_str</span>, <span class="ruby-identifier">:filename=</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">opts</span>[<span class="ruby-identifier">:filename</span>])
147 <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">ydoc</span>
148 <span class="ruby-keyword kw">end</span>
149 </pre>
150 </div>
151 </div>
152 </div>
153
154 <div id="method-M000039" class="method-detail">
155 <a name="M000039"></a>
156
157 <div class="method-heading">
158 <a href="#M000039" class="method-signature">
159 <span class="method-name">load_file</span><span class="method-args">(filename, opts={})</span>
160 </a>
161 </div>
162
163 <div class="method-description">
164 <p>
165 read file, parse it, and return yaml document. see
166 Kwalify::Yaml::Parser.load()
167 </p>
168 <p><a class="source-toggle" href="#"
169 onclick="toggleCode('M000039-source');return false;">[Source]</a></p>
170 <div class="method-source-code" id="M000039-source">
171 <pre>
172 <span class="ruby-comment cmt"># File kwalify.rb, line 57</span>
173 <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_file</span>(<span class="ruby-identifier">filename</span>, <span class="ruby-identifier">opts</span>={})
174 <span class="ruby-identifier">opts</span>[<span class="ruby-identifier">:filename</span>] = <span class="ruby-identifier">filename</span>
175 <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">filename</span>), <span class="ruby-identifier">opts</span>)
176 <span class="ruby-keyword kw">end</span>
177 </pre>
178 </div>
179 </div>
180 </div>
181
182
183 </div>
184
185
186 </div>
187
188
189 <div id="validator-badges">
190 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
191 </div>
192
193 </body>
194 </html>