Update version according to OSCI-936
[packages/precise/mcollective.git] / doc / MCollective / Matcher / Parser.html
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6         <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
8         <title>Class: MCollective::Matcher::Parser</title>
9
10         <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
11
12         <script src="../../js/jquery.js" type="text/javascript"
13                 charset="utf-8"></script>
14         <script src="../../js/thickbox-compressed.js" type="text/javascript"
15                 charset="utf-8"></script>
16         <script src="../../js/quicksearch.js" type="text/javascript"
17                 charset="utf-8"></script>
18         <script src="../../js/darkfish.js" type="text/javascript"
19                 charset="utf-8"></script>
20
21 </head>
22 <body class="class">
23
24         <div id="metadata">
25                 <div id="file-metadata">
26                         <div id="file-list-section" class="section">
27                                 <h3 class="section-header">In Files</h3>
28                                 <div class="section-body">
29                                         <ul>
30                                         
31                                                 <li><a href="../../lib/mcollective/matcher/parser_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32                                                         class="thickbox" title="lib/mcollective/matcher/parser.rb">lib/mcollective/matcher/parser.rb</a></li>
33                                         
34                                         </ul>
35                                 </div>
36                         </div>
37
38                         
39                 </div>
40
41                 <div id="class-metadata">
42
43                         <!-- Parent Class -->
44                         
45                         <div id="parent-class-section" class="section">
46                                 <h3 class="section-header">Parent</h3>
47                                 
48                                 <p class="link"><a href="../../Object.html">Object</a></p>
49                                 
50                         </div>
51                         
52
53                         <!-- Namespace Contents -->
54                         
55
56                         <!-- Method Quickref -->
57                         
58                         <div id="method-list-section" class="section">
59                                 <h3 class="section-header">Methods</h3>
60                                 <ul class="link-list">
61                                         
62                                         <li><a href="#M000046">::new</a></li>
63                                         
64                                         <li><a href="#M000049">#exit_with_paren_errors</a></li>
65                                         
66                                         <li><a href="#M000048">#exit_with_parse_errors</a></li>
67                                         
68                                         <li><a href="#M000047">#exit_with_token_errors</a></li>
69                                         
70                                         <li><a href="#M000050">#parse</a></li>
71                                         
72                                 </ul>
73                         </div>
74                         
75
76                         <!-- Included Modules -->
77                         
78                 </div>
79
80                 <div id="project-metadata">
81                         
82                         
83                         <div id="fileindex-section" class="section project-section">
84                                 <h3 class="section-header">Files</h3>
85                                 <ul>
86                                 
87                                         <li class="file"><a href="../../COPYING.html">COPYING</a></li>
88                                 
89                                         <li class="file"><a href="../../Gemfile.html">Gemfile</a></li>
90                                 
91                                         <li class="file"><a href="../../README.html">README</a></li>
92                                 
93                                         <li class="file"><a href="../../Rakefile.html">Rakefile</a></li>
94                                 
95                                         <li class="file"><a href="../../etc/client_cfg_dist.html">client.cfg.dist</a></li>
96                                 
97                                         <li class="file"><a href="../../etc/data-help_erb.html">data-help.erb</a></li>
98                                 
99                                         <li class="file"><a href="../../etc/discovery-help_erb.html">discovery-help.erb</a></li>
100                                 
101                                         <li class="file"><a href="../../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
102                                 
103                                         <li class="file"><a href="../../etc/metadata-help_erb.html">metadata-help.erb</a></li>
104                                 
105                                         <li class="file"><a href="../../etc/msg-help_erb.html">msg-help.erb</a></li>
106                                 
107                                         <li class="file"><a href="../../etc/rpc-help_erb.html">rpc-help.erb</a></li>
108                                 
109                                         <li class="file"><a href="../../etc/server_cfg_dist.html">server.cfg.dist</a></li>
110                                 
111                                         <li class="file"><a href="../../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
112                                 
113                                         <li class="file"><a href="../../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
114                                 
115                                         <li class="file"><a href="../../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
116                                 
117                                         <li class="file"><a href="../../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
118                                 
119                                         <li class="file"><a href="../../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
120                                 
121                                         <li class="file"><a href="../../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
122                                 
123                                         <li class="file"><a href="../../lib/mcollective/locales/en_yml.html">en.yml</a></li>
124                                 
125                                         <li class="file"><a href="../../mcollective_init.html">mcollective.init</a></li>
126                                 
127                                 </ul>
128                         </div>
129                         
130
131                         <div id="classindex-section" class="section project-section">
132                                 <h3 class="section-header">Class Index
133                                         <span class="search-toggle"><img src="../../images/find.png"
134                                                 height="16" width="16" alt="[+]"
135                                                 title="show/hide quicksearch" /></span></h3>
136                                 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
137                                 <fieldset>
138                                         <legend>Quicksearch</legend>
139                                         <input type="text" name="quicksearch" value=""
140                                                 class="quicksearch-field" />
141                                 </fieldset>
142                                 </form>
143
144                                 <ul class="link-list">
145                                 
146                                         <li><a href="../../MCollective.html">MCollective</a></li>
147                                 
148                                         <li><a href="../../MCollective/Agent.html">MCollective::Agent</a></li>
149                                 
150                                         <li><a href="../../MCollective/Agents.html">MCollective::Agents</a></li>
151                                 
152                                         <li><a href="../../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
153                                 
154                                         <li><a href="../../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
155                                 
156                                         <li><a href="../../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
157                                 
158                                         <li><a href="../../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
159                                 
160                                         <li><a href="../../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
161                                 
162                                         <li><a href="../../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
163                                 
164                                         <li><a href="../../MCollective/Application.html">MCollective::Application</a></li>
165                                 
166                                         <li><a href="../../MCollective/Applications.html">MCollective::Applications</a></li>
167                                 
168                                         <li><a href="../../MCollective/Cache.html">MCollective::Cache</a></li>
169                                 
170                                         <li><a href="../../MCollective/Client.html">MCollective::Client</a></li>
171                                 
172                                         <li><a href="../../MCollective/CodedError.html">MCollective::CodedError</a></li>
173                                 
174                                         <li><a href="../../MCollective/Config.html">MCollective::Config</a></li>
175                                 
176                                         <li><a href="../../MCollective/Connector.html">MCollective::Connector</a></li>
177                                 
178                                         <li><a href="../../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
179                                 
180                                         <li><a href="../../MCollective/DDL.html">MCollective::DDL</a></li>
181                                 
182                                         <li><a href="../../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
183                                 
184                                         <li><a href="../../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
185                                 
186                                         <li><a href="../../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
187                                 
188                                         <li><a href="../../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
189                                 
190                                         <li><a href="../../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
191                                 
192                                         <li><a href="../../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
193                                 
194                                         <li><a href="../../MCollective/Data.html">MCollective::Data</a></li>
195                                 
196                                         <li><a href="../../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
197                                 
198                                         <li><a href="../../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
199                                 
200                                         <li><a href="../../MCollective/Discovery.html">MCollective::Discovery</a></li>
201                                 
202                                         <li><a href="../../MCollective/Facts.html">MCollective::Facts</a></li>
203                                 
204                                         <li><a href="../../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
205                                 
206                                         <li><a href="../../MCollective/Generators.html">MCollective::Generators</a></li>
207                                 
208                                         <li><a href="../../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
209                                 
210                                         <li><a href="../../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
211                                 
212                                         <li><a href="../../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
213                                 
214                                         <li><a href="../../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
215                                 
216                                         <li><a href="../../MCollective/Log.html">MCollective::Log</a></li>
217                                 
218                                         <li><a href="../../MCollective/Logger.html">MCollective::Logger</a></li>
219                                 
220                                         <li><a href="../../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
221                                 
222                                         <li><a href="../../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
223                                 
224                                         <li><a href="../../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
225                                 
226                                         <li><a href="../../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
227                                 
228                                         <li><a href="../../MCollective/Matcher.html">MCollective::Matcher</a></li>
229                                 
230                                         <li><a href="../../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
231                                 
232                                         <li><a href="../../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
233                                 
234                                         <li><a href="../../MCollective/Message.html">MCollective::Message</a></li>
235                                 
236                                         <li><a href="../../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
237                                 
238                                         <li><a href="../../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
239                                 
240                                         <li><a href="../../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
241                                 
242                                         <li><a href="../../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
243                                 
244                                         <li><a href="../../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
245                                 
246                                         <li><a href="../../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
247                                 
248                                         <li><a href="../../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
249                                 
250                                         <li><a href="../../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
251                                 
252                                         <li><a href="../../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
253                                 
254                                         <li><a href="../../MCollective/RPC.html">MCollective::RPC</a></li>
255                                 
256                                         <li><a href="../../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
257                                 
258                                         <li><a href="../../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
259                                 
260                                         <li><a href="../../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
261                                 
262                                         <li><a href="../../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
263                                 
264                                         <li><a href="../../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
265                                 
266                                         <li><a href="../../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
267                                 
268                                         <li><a href="../../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
269                                 
270                                         <li><a href="../../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
271                                 
272                                         <li><a href="../../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
273                                 
274                                         <li><a href="../../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
275                                 
276                                         <li><a href="../../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
277                                 
278                                         <li><a href="../../MCollective/RPCError.html">MCollective::RPCError</a></li>
279                                 
280                                         <li><a href="../../MCollective/Registration.html">MCollective::Registration</a></li>
281                                 
282                                         <li><a href="../../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
283                                 
284                                         <li><a href="../../MCollective/Runner.html">MCollective::Runner</a></li>
285                                 
286                                         <li><a href="../../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
287                                 
288                                         <li><a href="../../MCollective/SSL.html">MCollective::SSL</a></li>
289                                 
290                                         <li><a href="../../MCollective/Security.html">MCollective::Security</a></li>
291                                 
292                                         <li><a href="../../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
293                                 
294                                         <li><a href="../../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
295                                 
296                                         <li><a href="../../MCollective/Shell.html">MCollective::Shell</a></li>
297                                 
298                                         <li><a href="../../MCollective/Translatable.html">MCollective::Translatable</a></li>
299                                 
300                                         <li><a href="../../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
301                                 
302                                         <li><a href="../../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
303                                 
304                                         <li><a href="../../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
305                                 
306                                         <li><a href="../../MCollective/Util.html">MCollective::Util</a></li>
307                                 
308                                         <li><a href="../../MCollective/Validator.html">MCollective::Validator</a></li>
309                                 
310                                         <li><a href="../../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
311                                 
312                                         <li><a href="../../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
313                                 
314                                         <li><a href="../../Array.html">Array</a></li>
315                                 
316                                         <li><a href="../../Dir.html">Dir</a></li>
317                                 
318                                         <li><a href="../../Object.html">Object</a></li>
319                                 
320                                         <li><a href="../../String.html">String</a></li>
321                                 
322                                         <li><a href="../../Symbol.html">Symbol</a></li>
323                                 
324                                 </ul>
325                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
326                         </div>
327
328                         
329                 </div>
330         </div>
331
332         <div id="documentation">
333                 <h1 class="class">MCollective::Matcher::Parser</h1>
334
335                 <div id="description">
336                         
337                 </div>
338
339                 <!-- Constants -->
340                 
341
342                 <!-- Attributes -->
343                 
344                 <div id="attribute-method-details" class="method-section section">
345                         <h3 class="section-header">Attributes</h3>
346
347                         
348                         <div id="scanner-attribute-method" class="method-detail">
349                                 <a name="scanner"></a>
350                                 
351                                 <div class="method-heading attribute-method-heading">
352                                         <span class="method-name">scanner</span><span
353                                                 class="attribute-access-type">[R]</span>
354                                 </div>
355
356                                 <div class="method-description">
357                                 
358                                 <p class="missing-docs">(Not documented)</p>
359                                 
360                                 </div>
361                         </div>
362                         
363                         <div id="execution-stack-attribute-method" class="method-detail">
364                                 <a name="execution_stack"></a>
365                                 
366                                 <div class="method-heading attribute-method-heading">
367                                         <span class="method-name">execution_stack</span><span
368                                                 class="attribute-access-type">[R]</span>
369                                 </div>
370
371                                 <div class="method-description">
372                                 
373                                 <p class="missing-docs">(Not documented)</p>
374                                 
375                                 </div>
376                         </div>
377                         
378                 </div>
379                 
380
381                 <!-- Methods -->
382                 
383                 <div id="public-class-method-details" class="method-section section">
384                         <h3 class="section-header">Public Class Methods</h3>
385
386                 
387                         <div id="new-method" class="method-detail ">
388                                 <a name="M000046"></a>
389
390                                 <div class="method-heading">
391                                 
392                                         <span class="method-name">new</span><span
393                                                 class="method-args">(args)</span>
394                                         <span class="method-click-advice">click to toggle source</span>
395                                 
396                                 </div>
397
398                                 <div class="method-description">
399                                         
400                                         <p class="missing-docs">(Not documented)</p>
401                                         
402
403                                         
404                                         <div class="method-source-code"
405                                                 id="new-source">
406 <pre>
407     <span class="ruby-comment cmt"># File lib/mcollective/matcher/parser.rb, line 6</span>
408  6:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">args</span>)
409  7:         <span class="ruby-ivar">@scanner</span> = <span class="ruby-constant">Scanner</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">args</span>)
410  8:         <span class="ruby-ivar">@execution_stack</span> = []
411  9:         <span class="ruby-ivar">@parse_errors</span> = []
412 10:         <span class="ruby-ivar">@token_errors</span> = []
413 11:         <span class="ruby-ivar">@paren_errors</span> = []
414 12:         <span class="ruby-identifier">parse</span>
415 13:         <span class="ruby-identifier">exit_with_token_errors</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@token_errors</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>
416 14:         <span class="ruby-identifier">exit_with_parse_errors</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@parse_errors</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>
417 15:         <span class="ruby-identifier">exit_with_paren_errors</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@paren_errors</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>
418 16:       <span class="ruby-keyword kw">end</span></pre>
419                                         </div>
420                                         
421                                 </div>
422
423                                 
424                         </div>
425
426                 
427                 </div>
428         
429                 <div id="public-instance-method-details" class="method-section section">
430                         <h3 class="section-header">Public Instance Methods</h3>
431
432                 
433                         <div id="exit-with-paren-errors-method" class="method-detail ">
434                                 <a name="M000049"></a>
435
436                                 <div class="method-heading">
437                                 
438                                         <span class="method-name">exit_with_paren_errors</span><span
439                                                 class="method-args">()</span>
440                                         <span class="method-click-advice">click to toggle source</span>
441                                 
442                                 </div>
443
444                                 <div class="method-description">
445                                         
446                                         <p class="missing-docs">(Not documented)</p>
447                                         
448
449                                         
450                                         <div class="method-source-code"
451                                                 id="exit-with-paren-errors-source">
452 <pre>
453     <span class="ruby-comment cmt"># File lib/mcollective/matcher/parser.rb, line 37</span>
454 37:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">exit_with_paren_errors</span>
455 38:         <span class="ruby-ivar">@paren_errors</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
456 39:           <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">i</span>] = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:red</span>, <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">i</span>])
457 40:         <span class="ruby-keyword kw">end</span>
458 41:         <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Missing parenthesis found while parsing -S input #{@scanner.arguments.join}&quot;</span>
459 42:       <span class="ruby-keyword kw">end</span></pre>
460                                         </div>
461                                         
462                                 </div>
463
464                                 
465                         </div>
466
467                 
468                         <div id="exit-with-parse-errors-method" class="method-detail ">
469                                 <a name="M000048"></a>
470
471                                 <div class="method-heading">
472                                 
473                                         <span class="method-name">exit_with_parse_errors</span><span
474                                                 class="method-args">()</span>
475                                         <span class="method-click-advice">click to toggle source</span>
476                                 
477                                 </div>
478
479                                 <div class="method-description">
480                                         
481                                         <p class="missing-docs">(Not documented)</p>
482                                         
483
484                                         
485                                         <div class="method-source-code"
486                                                 id="exit-with-parse-errors-source">
487 <pre>
488     <span class="ruby-comment cmt"># File lib/mcollective/matcher/parser.rb, line 28</span>
489 28:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">exit_with_parse_errors</span>
490 29:         <span class="ruby-ivar">@parse_errors</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">error_range</span><span class="ruby-operator">|</span>
491 30:           (<span class="ruby-identifier">error_range</span>[<span class="ruby-value">0</span>]<span class="ruby-operator">..</span><span class="ruby-identifier">error_range</span>[<span class="ruby-value">1</span>]).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
492 31:             <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">i</span>] = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:red</span>, <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">i</span>])
493 32:           <span class="ruby-keyword kw">end</span>
494 33:         <span class="ruby-keyword kw">end</span>
495 34:         <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Parse errors found while parsing -S input #{ @scanner.arguments.join}&quot;</span>
496 35:       <span class="ruby-keyword kw">end</span></pre>
497                                         </div>
498                                         
499                                 </div>
500
501                                 
502                         </div>
503
504                 
505                         <div id="exit-with-token-errors-method" class="method-detail ">
506                                 <a name="M000047"></a>
507
508                                 <div class="method-heading">
509                                 
510                                         <span class="method-name">exit_with_token_errors</span><span
511                                                 class="method-args">()</span>
512                                         <span class="method-click-advice">click to toggle source</span>
513                                 
514                                 </div>
515
516                                 <div class="method-description">
517                                         
518                                         <p>
519 Exit and highlight any malformed tokens
520 </p>
521                                         
522
523                                         
524                                         <div class="method-source-code"
525                                                 id="exit-with-token-errors-source">
526 <pre>
527     <span class="ruby-comment cmt"># File lib/mcollective/matcher/parser.rb, line 19</span>
528 19:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">exit_with_token_errors</span>
529 20:         <span class="ruby-ivar">@token_errors</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">error_range</span><span class="ruby-operator">|</span>
530 21:           (<span class="ruby-identifier">error_range</span>[<span class="ruby-value">0</span>]<span class="ruby-operator">..</span><span class="ruby-identifier">error_range</span>[<span class="ruby-value">1</span>]).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
531 22:             <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">i</span>] = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">:red</span>, <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">i</span>])
532 23:           <span class="ruby-keyword kw">end</span>
533 24:         <span class="ruby-keyword kw">end</span>
534 25:         <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Malformed token(s) found while parsing -S input #{@scanner.arguments.join}&quot;</span>
535 26:       <span class="ruby-keyword kw">end</span></pre>
536                                         </div>
537                                         
538                                 </div>
539
540                                 
541                         </div>
542
543                 
544                         <div id="parse-method" class="method-detail ">
545                                 <a name="M000050"></a>
546
547                                 <div class="method-heading">
548                                 
549                                         <span class="method-name">parse</span><span
550                                                 class="method-args">()</span>
551                                         <span class="method-click-advice">click to toggle source</span>
552                                 
553                                 </div>
554
555                                 <div class="method-description">
556                                         
557                                         <p>
558 Parse the input string, one token at a time a contruct the call stack
559 </p>
560                                         
561
562                                         
563                                         <div class="method-source-code"
564                                                 id="parse-source">
565 <pre>
566      <span class="ruby-comment cmt"># File lib/mcollective/matcher/parser.rb, line 45</span>
567  45:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse</span>
568  46:         <span class="ruby-identifier">pre_index</span> = <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">token_index</span>
569  47:         <span class="ruby-identifier">p_token</span>,<span class="ruby-identifier">p_token_value</span> = <span class="ruby-keyword kw">nil</span>
570  48:         <span class="ruby-identifier">c_token</span>,<span class="ruby-identifier">c_token_value</span> = <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">get_token</span>
571  49:         <span class="ruby-identifier">parenth</span> = <span class="ruby-value">0</span>
572  50: 
573  51:         <span class="ruby-keyword kw">while</span> (<span class="ruby-identifier">c_token</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span>)
574  52:           <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">token_index</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
575  53:           <span class="ruby-identifier">n_token</span>, <span class="ruby-identifier">n_token_value</span> = <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">get_token</span>
576  54: 
577  55:           <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">n_token</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot; &quot;</span>
578  56:             <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">c_token</span>
579  57:             <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;bad_token&quot;</span>
580  58:               <span class="ruby-ivar">@token_errors</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">c_token_value</span>
581  59: 
582  60:             <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;and&quot;</span>
583  61:               <span class="ruby-keyword kw">unless</span> (<span class="ruby-identifier">n_token</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/not|fstatement|statement|\(/</span>) <span class="ruby-operator">||</span> (<span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">size</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span>(<span class="ruby-identifier">n_token</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>)
584  62:                 <span class="ruby-ivar">@parse_errors</span> <span class="ruby-operator">&lt;&lt;</span> [<span class="ruby-identifier">pre_index</span>, <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span>]
585  63:               <span class="ruby-keyword kw">end</span>
586  64: 
587  65:               <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">p_token</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>
588  66:                 <span class="ruby-ivar">@parse_errors</span> <span class="ruby-operator">&lt;&lt;</span> [<span class="ruby-identifier">pre_index</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">c_token</span>.<span class="ruby-identifier">size</span>, <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span>]
589  67:               <span class="ruby-keyword kw">elsif</span> (<span class="ruby-identifier">p_token</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;and&quot;</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">p_token</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;or&quot;</span>)
590  68:                 <span class="ruby-ivar">@parse_errors</span> <span class="ruby-operator">&lt;&lt;</span> [<span class="ruby-identifier">pre_index</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">p_token</span>.<span class="ruby-identifier">size</span>, <span class="ruby-identifier">pre_index</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>]
591  69:               <span class="ruby-keyword kw">end</span>
592  70: 
593  71:             <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;or&quot;</span>
594  72:               <span class="ruby-keyword kw">unless</span> (<span class="ruby-identifier">n_token</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/not|fstatement|statement|\(/</span>) <span class="ruby-operator">||</span> (<span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">size</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span>(<span class="ruby-identifier">n_token</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>)
595  73:                 <span class="ruby-ivar">@parse_errors</span> <span class="ruby-operator">&lt;&lt;</span> [<span class="ruby-identifier">pre_index</span>, <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span>]
596  74:               <span class="ruby-keyword kw">end</span>
597  75: 
598  76:               <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">p_token</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>
599  77:                 <span class="ruby-ivar">@parse_errors</span> <span class="ruby-operator">&lt;&lt;</span> [<span class="ruby-identifier">pre_index</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">c_token</span>.<span class="ruby-identifier">size</span>, <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span>]
600  78:               <span class="ruby-keyword kw">elsif</span> (<span class="ruby-identifier">p_token</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;and&quot;</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">p_token</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;or&quot;</span>)
601  79:                 <span class="ruby-ivar">@parse_errors</span> <span class="ruby-operator">&lt;&lt;</span> [<span class="ruby-identifier">pre_index</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">p_token</span>.<span class="ruby-identifier">size</span>, <span class="ruby-identifier">pre_index</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>]
602  80:               <span class="ruby-keyword kw">end</span>
603  81: 
604  82:             <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;not&quot;</span>
605  83:               <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">n_token</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/fstatement|statement|\(|not/</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span>(<span class="ruby-identifier">n_token</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>)
606  84:                 <span class="ruby-ivar">@parse_errors</span> <span class="ruby-operator">&lt;&lt;</span> [<span class="ruby-identifier">pre_index</span>, <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span>]
607  85:               <span class="ruby-keyword kw">end</span>
608  86: 
609  87:             <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;statement&quot;</span>,<span class="ruby-value str">&quot;fstatement&quot;</span>
610  88:               <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">n_token</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/and|or|\)/</span>
611  89:                 <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">size</span>
612  90:                   <span class="ruby-ivar">@parse_errors</span> <span class="ruby-operator">&lt;&lt;</span> [<span class="ruby-identifier">pre_index</span>, <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span>]
613  91:                 <span class="ruby-keyword kw">end</span>
614  92:               <span class="ruby-keyword kw">end</span>
615  93: 
616  94:             <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;)&quot;</span>
617  95:               <span class="ruby-keyword kw">unless</span> (<span class="ruby-identifier">n_token</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/|and|or|not|\(/</span>)
618  96:                 <span class="ruby-keyword kw">unless</span>(<span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">size</span>)
619  97:                   <span class="ruby-ivar">@parse_errors</span> <span class="ruby-operator">&lt;&lt;</span> [<span class="ruby-identifier">pre_index</span>, <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span>]
620  98:                 <span class="ruby-keyword kw">end</span>
621  99:               <span class="ruby-keyword kw">end</span>
622 100:               <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@paren_errors</span>.<span class="ruby-identifier">empty?</span>
623 101:                 <span class="ruby-ivar">@paren_errors</span>.<span class="ruby-identifier">pop</span>
624 102:               <span class="ruby-keyword kw">else</span>
625 103:                 <span class="ruby-ivar">@paren_errors</span>.<span class="ruby-identifier">push</span>((<span class="ruby-identifier">n_token</span>.<span class="ruby-identifier">nil?</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span><span class="ruby-operator">:</span> <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">n_token_value</span>.<span class="ruby-identifier">size</span>)
626 104:               <span class="ruby-keyword kw">end</span>
627 105: 
628 106:             <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;(&quot;</span>
629 107:               <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">n_token</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/fstatement|statement|not|\(/</span>
630 108:                 <span class="ruby-ivar">@parse_errors</span> <span class="ruby-operator">&lt;&lt;</span> [<span class="ruby-identifier">pre_index</span>, <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span>]
631 109:               <span class="ruby-keyword kw">end</span>
632 110:               <span class="ruby-ivar">@paren_errors</span>.<span class="ruby-identifier">push</span>((<span class="ruby-identifier">n_token</span>.<span class="ruby-identifier">nil?</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span><span class="ruby-operator">:</span> <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">n_token_value</span>.<span class="ruby-identifier">size</span>)
633 111: 
634 112:             <span class="ruby-keyword kw">else</span>
635 113:               <span class="ruby-ivar">@parse_errors</span> <span class="ruby-operator">&lt;&lt;</span> [<span class="ruby-identifier">pre_index</span>, <span class="ruby-identifier">scanner</span>.<span class="ruby-identifier">token_index</span>]
636 114:             <span class="ruby-keyword kw">end</span>
637 115: 
638 116:             <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">n_token</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot; &quot;</span> <span class="ruby-operator">||</span><span class="ruby-identifier">c_token</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;bad_token&quot;</span>
639 117:               <span class="ruby-ivar">@execution_stack</span> <span class="ruby-operator">&lt;&lt;</span> {<span class="ruby-identifier">c_token</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">c_token_value</span>}
640 118:             <span class="ruby-keyword kw">end</span>
641 119: 
642 120:             <span class="ruby-identifier">p_token</span>, <span class="ruby-identifier">p_token_value</span> = <span class="ruby-identifier">c_token</span>, <span class="ruby-identifier">c_token_value</span>
643 121:             <span class="ruby-identifier">c_token</span>, <span class="ruby-identifier">c_token_value</span> = <span class="ruby-identifier">n_token</span>, <span class="ruby-identifier">n_token_value</span>
644 122:           <span class="ruby-keyword kw">end</span>
645 123:           <span class="ruby-identifier">pre_index</span> = <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">token_index</span>
646 124:         <span class="ruby-keyword kw">end</span>
647 125:       <span class="ruby-keyword kw">end</span></pre>
648                                         </div>
649                                         
650                                 </div>
651
652                                 
653                         </div>
654
655                 
656                 </div>
657         
658
659         </div>
660
661
662         <div id="rdoc-debugging-section-dump" class="debugging-section">
663         
664                 <p>Disabled; run with --debug to generate this.</p>
665         
666         </div>
667
668         <div id="validator-badges">
669                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
670                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
671                         Rdoc Generator</a> 1.1.6</small>.</p>
672         </div>
673
674 </body>
675 </html>
676