annotate mayachemtools/docs/modules/html/SimpleCalcParser.html @ 0:73ae111cf86f draft

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 11:55:01 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 <html>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 <head>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3 <title>MayaChemTools:Documentation:Parsers::SimpleCalcParser.pm</title>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 <meta http-equiv="content-type" content="text/html;charset=utf-8">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 <link rel="stylesheet" type="text/css" href="../../css/MayaChemTools.css">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6 </head>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 <br/>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 <a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 <br/>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 <div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 <tr align="left" valign="top"><td width="33%" align="left"><a href="./Lexer.html" title="Lexer.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./SimpleCalcYYLexer.html" title="SimpleCalcYYLexer.html">Next</a></td><td width="34%" align="middle"><strong>Parsers::SimpleCalcParser.pm</strong></td><td width="33%" align="right"><a href="././code/SimpleCalcParser.html" title="View source code">Code</a>&nbsp;|&nbsp;<a href="./../pdf/SimpleCalcParser.pdf" title="PDF US Letter Size">PDF</a>&nbsp;|&nbsp;<a href="./../pdfgreen/SimpleCalcParser.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a>&nbsp;|&nbsp;<a href="./../pdfa4/SimpleCalcParser.pdf" title="PDF A4 Size">PDFA4</a>&nbsp;|&nbsp;<a href="./../pdfa4green/SimpleCalcParser.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 <h2>NAME</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 <p>Parsers::SimpleCalcParser</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 <h2>SYNOPSIS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 <p>use Parsers::SimpleCalcParser ;</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 <p>use Parsers::SimpleCalcParser qw(:all);</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 <h2>DESCRIPTION</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 <p><strong>Parsers::SimpleCalcParser</strong> class provides the following methods:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 <p> <a href="#new">new</a>, <a href="#yyclearin">yyclearin</a>, <a href="#yyerrok">yyerrok</a>, <a href="#yyerror">yyerror</a>, <a href="#yyparse">yyparse</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 </p><p><strong>Parsers::SimpleCalcParse.yy</strong> parser grammer definition file implements a simple
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 calculator and is provided to highlight usage of lexer capability available through
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 <strong>Parsers::SimpleCalcYYLexer</strong>, which in turn uses <strong>Parsers::YYLexer</strong> and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 <strong>Parsers::Lexer</strong> classes to procide underlying lexer functionality.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 <p>The parser package and token table files, <strong>Parsers::SimpleCalcParser.pm</strong> and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 <strong>SimpleCalcParser.tab.ph</strong>, are automatically generated from parser grammar definition
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 file, <strong>Parsers::SimpleCalcParser.yy</strong>, using byacc available through perl-byacc1.8 modified
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 with perl5-byacc-patches-0.5 for generation of object oriented parser:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 byacc -l -P -d -b SimpleCalcParser SimpleCalcParser.yy
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 <br/> mv SimpleCalcParser.tab.pl SimpleCalcParser.pm</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 <h2>METHODS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 <dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 <dt><strong><a name="new" class="item"><strong>new</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 $SimpleCalcParser = new Parsers::SimpleCalcParser($YYLex,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 \&amp;Parsers::SimpleCalcParser::yyerror);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 <br/> $SimpleCalcParser = new Parsers::SimpleCalcParser($YYLex,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 \&amp;Parsers::SimpleCalcParser::yyerror, $Debug);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 <p>Using specified <em>YYLex</em> <em>YYError</em> functions, <strong>new</strong> method generates a new
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 <strong>SimpleCalcParser</strong> and returns a reference to newly created <strong>SimpleCalcYYParser</strong> object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 <p>Examples:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 # Input string...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 <br/> $InputText = &quot;3 + 4 +6\nx=3\ny=5\nx+y\nx+z\n&quot;;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 <br/> $YYLexer = new Parsers::SimpleCalcYYLexer($InputText);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 <br/> $YYLex = $YYLexer-&gt;GetYYLex();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 $Debug = 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 <br/> $SimpleCalcParser = new Parsers::SimpleCalcParser($YYLex,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 \&amp;Parsers::SimpleCalcParser::yyerror, $Debug);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 <br/> $Value = $SimpleCalcParser-&gt;yyparse();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 <br/> print &quot;Value = &quot; . (defined($Value) ? &quot;$Value&quot; : &quot;Undefined&quot;) . &quot;\n&quot;;</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 # Input file...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 <br/> $InputFile = &quot;TestSimpleCalcParser.txt&quot;;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 <br/> open INPUTFILE, &quot;$InputFile&quot; or die &quot;Couldn't open $InputFile: $!\n&quot;;</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 $YYLexer = new Parsers::SimpleCalcYYLexer(\*INPUTFILE);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 <br/> $YYLex = $YYLexer-&gt;GetYYLex();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 $Debug = 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 <br/> $SimpleCalcParser = new Parsers::SimpleCalcParser($YYLex,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 \&amp;Parsers::SimpleCalcParser::yyerror, $Debug);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 <br/> $Value = $SimpleCalcParser-&gt;yyparse();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 <br/> print &quot;Value = &quot; . (defined($Value) ? &quot;$Value&quot; : &quot;Undefined&quot;) . &quot;\n&quot;;</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 close INPUTFILE;</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 # Input iterator...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 <br/> $InputFile = &quot;TestSimpleCalcParser.txt&quot;;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 <br/> open INPUTFILE, &quot;$InputFile&quot; or die &quot;Couldn't open $InputFile: $!\n&quot;;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 <br/> $InputIterator = sub { return &lt;INPUTFILE&gt;; };</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 $YYLexer = new Parsers::SimpleCalcYYLexer($InputIterator);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 <br/> $YYLex = $YYLexer-&gt;GetYYLex();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 $Debug = 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 <br/> $SimpleCalcParser = new Parsers::SimpleCalcParser($YYLex,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 \&amp;Parsers::SimpleCalcParser::yyerror, $Debug);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 <br/> $Value = $SimpleCalcParser-&gt;yyparse();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 <br/> print &quot;Value = &quot; . (defined($Value) ? &quot;$Value&quot; : &quot;Undefined&quot;) . &quot;\n&quot;;</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 close INPUTFILE;</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 <dt><strong><a name="yyclearin" class="item"><strong>yyclearin</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 $SimpleCalcParser-&gt;yyclearin();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 <p><strong>yyclearin</strong> method clears any previous look-ahead token after encountering a syntax error
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 during parsing. It can be used after <strong>yyerrok</strong> in a grammer rule with the reserved word
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 <strong>error</strong>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 <dt><strong><a name="yyerrok" class="item"><strong>yyerrok</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 $SimpleCalcParser-&gt;yyerrok();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 <p><strong>yyerrok</strong> method is used with the reserved word <strong>error</strong> in grammer rule to indcate
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 error recovery is complete after encountering a syntax error during parsing.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115 <dt><strong><a name="yyerror" class="item"><strong>yyerror</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118 $SimpleCalcParser-&gt;yyerror();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 <p><strong>yyerror</strong> function is provided for the caller to use during initialization of a parser. It
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 is used by <strong>yyparse</strong> to print any error messages encountered during parsing of the
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121 input.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123 <dt><strong><a name="yyparse" class="item"><strong>yyparse</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
126 $Value = $SimpleCalcParser-&gt;yyparse();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
127 <p>Returns <em>Value</em> after parsing all the input from a input stream using specified
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
128 grammer rules.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
129 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
130 </dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
131 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
132 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
133 <h2>AUTHOR</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
134 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
135 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
136 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
137 <h2>SEE ALSO</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
138 <p><a href="./Lexer.html">Lexer.pm</a>,&nbsp<a href="./YYLexer.html">YYLexer.pm</a>,&nbsp<a href="./SimpleCalcYYLexer.html">SimpleCalcYYLexer.pm</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
139 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
140 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
141 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
142 <h2>COPYRIGHT</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
143 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
144 <p>This file is part of MayaChemTools.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
145 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
146 the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
147 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
148 any later version.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
149 <p>&nbsp</p><p>&nbsp</p><div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
150 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
151 <tr align="left" valign="top"><td width="33%" align="left"><a href="./Lexer.html" title="Lexer.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./SimpleCalcYYLexer.html" title="SimpleCalcYYLexer.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>Parsers::SimpleCalcParser.pm</strong></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
152 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
153 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
154 <br />
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
155 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
156 <img src="../../images/h2o2.png">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
157 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
158 </body>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
159 </html>