Update version according to OSCI-856
[packages/precise/mcollective.git] / doc / classes / MCollective / Matcher / Scanner.html
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: MCollective::Matcher::Scanner</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">MCollective::Matcher::Scanner</td>
54         </tr>
55         <tr class="top-aligned-row">
56             <td><strong>In:</strong></td>
57             <td>
58                 <a href="../../../files/lib/mcollective/matcher/scanner_rb.html">
59                 lib/mcollective/matcher/scanner.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
82
83    </div>
84
85     <div id="method-list">
86       <h3 class="section-bar">Methods</h3>
87
88       <div class="name-list">
89       <a href="#M000154">get_token</a>&nbsp;&nbsp;
90       <a href="#M000153">new</a>&nbsp;&nbsp;
91       </div>
92     </div>
93
94   </div>
95
96
97     <!-- if includes -->
98
99     <div id="section">
100
101
102
103
104
105     <div id="attribute-list">
106       <h3 class="section-bar">Attributes</h3>
107
108       <div class="name-list">
109         <table>
110         <tr class="top-aligned-row context-row">
111           <td class="context-item-name">arguments</td>
112           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
113           <td class="context-item-desc"></td>
114         </tr>
115         <tr class="top-aligned-row context-row">
116           <td class="context-item-name">token_index</td>
117           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
118           <td class="context-item-desc"></td>
119         </tr>
120         </table>
121       </div>
122     </div>
123       
124
125
126     <!-- if method_list -->
127     <div id="methods">
128       <h3 class="section-bar">Public Class methods</h3>
129
130       <div id="method-M000153" class="method-detail">
131         <a name="M000153"></a>
132
133         <div class="method-heading">
134           <a href="#M000153" class="method-signature">
135           <span class="method-name">new</span><span class="method-args">(arguments)</span>
136           </a>
137         </div>
138       
139         <div class="method-description">
140           <p><a class="source-toggle" href="#"
141             onclick="toggleCode('M000153-source');return false;">[Source]</a></p>
142           <div class="method-source-code" id="M000153-source">
143 <pre>
144     <span class="ruby-comment cmt"># File lib/mcollective/matcher/scanner.rb, line 6</span>
145  6:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">arguments</span>)
146  7:         <span class="ruby-ivar">@token_index</span> = <span class="ruby-value">0</span>
147  8:         <span class="ruby-ivar">@arguments</span> = <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">&quot;&quot;</span>)
148  9:         <span class="ruby-ivar">@seperation_counter</span> = <span class="ruby-value">0</span>
149 10:         <span class="ruby-ivar">@white_spaces</span> = <span class="ruby-value">0</span>
150 11:       <span class="ruby-keyword kw">end</span>
151 </pre>
152           </div>
153         </div>
154       </div>
155
156       <h3 class="section-bar">Public Instance methods</h3>
157
158       <div id="method-M000154" class="method-detail">
159         <a name="M000154"></a>
160
161         <div class="method-heading">
162           <a href="#M000154" class="method-signature">
163           <span class="method-name">get_token</span><span class="method-args">()</span>
164           </a>
165         </div>
166       
167         <div class="method-description">
168           <p>
169 Scans the input string and identifies single language tokens
170 </p>
171           <p><a class="source-toggle" href="#"
172             onclick="toggleCode('M000154-source');return false;">[Source]</a></p>
173           <div class="method-source-code" id="M000154-source">
174 <pre>
175     <span class="ruby-comment cmt"># File lib/mcollective/matcher/scanner.rb, line 14</span>
176 14:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_token</span>
177 15:         <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@token_index</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-ivar">@arguments</span>.<span class="ruby-identifier">size</span>
178 16:           <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
179 17:         <span class="ruby-keyword kw">end</span>
180 18: 
181 19:         <span class="ruby-keyword kw">case</span> <span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span>]
182 20:         <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;(&quot;</span>
183 21:           <span class="ruby-keyword kw">return</span> <span class="ruby-value str">&quot;(&quot;</span>, <span class="ruby-value str">&quot;(&quot;</span>
184 22: 
185 23:         <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;)&quot;</span>
186 24:           <span class="ruby-keyword kw">return</span> <span class="ruby-value str">&quot;)&quot;</span>, <span class="ruby-value str">&quot;)&quot;</span>
187 25: 
188 26:         <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;n&quot;</span>
189 27:           <span class="ruby-keyword kw">if</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;o&quot;</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;t&quot;</span>) <span class="ruby-operator">&amp;&amp;</span> ((<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">3</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot; &quot;</span>) <span class="ruby-operator">||</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">3</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;(&quot;</span>))
190 28:             <span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+=</span> <span class="ruby-value">2</span>
191 29:             <span class="ruby-keyword kw">return</span> <span class="ruby-value str">&quot;not&quot;</span>, <span class="ruby-value str">&quot;not&quot;</span>
192 30:           <span class="ruby-keyword kw">else</span>
193 31:             <span class="ruby-identifier">gen_statement</span>
194 32:           <span class="ruby-keyword kw">end</span>
195 33: 
196 34:         <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;!&quot;</span>
197 35:           <span class="ruby-keyword kw">return</span> <span class="ruby-value str">&quot;not&quot;</span>, <span class="ruby-value str">&quot;not&quot;</span>
198 36: 
199 37:         <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;a&quot;</span>
200 38:           <span class="ruby-keyword kw">if</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;n&quot;</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;d&quot;</span>) <span class="ruby-operator">&amp;&amp;</span> ((<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">3</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot; &quot;</span>) <span class="ruby-operator">||</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">3</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;(&quot;</span>))
201 39:             <span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+=</span> <span class="ruby-value">2</span>
202 40:             <span class="ruby-keyword kw">return</span> <span class="ruby-value str">&quot;and&quot;</span>, <span class="ruby-value str">&quot;and&quot;</span>
203 41:           <span class="ruby-keyword kw">else</span>
204 42:             <span class="ruby-identifier">gen_statement</span>
205 43:           <span class="ruby-keyword kw">end</span>
206 44: 
207 45:         <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;o&quot;</span>
208 46:           <span class="ruby-keyword kw">if</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;r&quot;</span>) <span class="ruby-operator">&amp;&amp;</span> ((<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot; &quot;</span>) <span class="ruby-operator">||</span> (<span class="ruby-ivar">@arguments</span>[<span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;(&quot;</span>))
209 47:             <span class="ruby-ivar">@token_index</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
210 48:             <span class="ruby-keyword kw">return</span> <span class="ruby-value str">&quot;or&quot;</span>, <span class="ruby-value str">&quot;or&quot;</span>
211 49:           <span class="ruby-keyword kw">else</span>
212 50:             <span class="ruby-identifier">gen_statement</span>
213 51:           <span class="ruby-keyword kw">end</span>
214 52: 
215 53:         <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot; &quot;</span>
216 54:           <span class="ruby-keyword kw">return</span> <span class="ruby-value str">&quot; &quot;</span>, <span class="ruby-value str">&quot; &quot;</span>
217 55: 
218 56:         <span class="ruby-keyword kw">else</span>
219 57:           <span class="ruby-identifier">gen_statement</span>
220 58:         <span class="ruby-keyword kw">end</span>
221 59:       <span class="ruby-keyword kw">end</span>
222 </pre>
223           </div>
224         </div>
225       </div>
226
227
228     </div>
229
230
231   </div>
232
233
234 <div id="validator-badges">
235   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
236 </div>
237
238 </body>
239 </html>