annotate mayachemtools/docs/modules/html/SimpleCalcYYLexer.html @ 9:ab29fa5c8c1f draft default tip

Uploaded
author deepakjadmin
date Thu, 15 Dec 2016 14:18:03 -0500
parents 73ae111cf86f
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::SimpleCalcYYLexer.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="./SimpleCalcParser.html" title="SimpleCalcParser.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./YYLexer.html" title="YYLexer.html">Next</a></td><td width="34%" align="middle"><strong>Parsers::SimpleCalcYYLexer.pm</strong></td><td width="33%" align="right"><a href="././code/SimpleCalcYYLexer.html" title="View source code">Code</a>&nbsp;|&nbsp;<a href="./../pdf/SimpleCalcYYLexer.pdf" title="PDF US Letter Size">PDF</a>&nbsp;|&nbsp;<a href="./../pdfgreen/SimpleCalcYYLexer.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a>&nbsp;|&nbsp;<a href="./../pdfa4/SimpleCalcYYLexer.pdf" title="PDF A4 Size">PDFA4</a>&nbsp;|&nbsp;<a href="./../pdfa4green/SimpleCalcYYLexer.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::SimpleCalcYYLexer</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::SimpleCalcYYLexer;</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 <p>use Parsers::SimpleCalcYYLexer 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>SimpleCalcYYLexer</strong> class provides the following methods:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 <p> <a href="#new">new</a>, <a href="#yylex">YYLex</a>, <a href="#getyylex">GetYYLex</a>, <a href="#stringifysimplecalcyylexer">StringifySimpleCalcYYLexer</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 </p><p><strong>Parser::SimpleCalcYYLexer</strong> class is derived from <strong>Parser::YYLexer</strong> class, which in
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 turn is derived from base class <strong>Parser::Lexer</strong> that provides all the underlying
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 lexer functionality. <strong>SimpleCalcYYLexer</strong> class is designed to be used with
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 <strong>yyparse</strong> code generated by running <strong>byacc</strong> on a parser defined using
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 parser definition <strong>SimpleCalcParser.yy</strong> file.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 <p>The parser package and token table files, <strong>SimpleCalcParser.pm</strong> and <strong>SimpleCalcParser.tab.ph</strong>,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 are automatically generated from parser grammar definition file, <strong>SimpleCalcParser.yy</strong>, using
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 byacc available through perl-byacc1.8 modified with perl5-byacc-patches-0.5 for generation
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 of object oriented parser:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 byacc -l -P -d -b SimpleCalcParser SimpleCalcParser.yy
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 <br/> mv SimpleCalcParser.tab.pl SimpleCalcParser.pm</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 <p><strong>SimpleCalcYYLexer.pm</strong> class implements a lexer for a simple calculator and is provided
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 to highlight usasge of <strong>YYLex</strong> through <strong>yyparse</strong>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 <p>The default specification of lexer tokens for <strong>SimpleCalcYYLexer.pm</strong> includes:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 @YYLexerTokensSpec = (
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 <br/>&nbsp;&nbsp;&nbsp;&nbsp; [ 'LETTER', qr/[a-zA-Z]/ ],
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 [ 'NUMBER', qr/\d+/ ],
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 [ 'SPACE', qr/[ ]*/,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 <br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; sub { my($This, $TokenLabel, $MatchedText) = @_; return ''; }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 <br/>&nbsp;&nbsp;&nbsp;&nbsp; ],
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 [ 'NEWLINE', qr/(?:\r\n|\r|\n)/,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 <br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; sub { my($This, $TokenLabel, $MatchedText) = @_; return &quot;\n&quot;; }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 <br/>&nbsp;&nbsp;&nbsp;&nbsp; ],
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 [ 'CHAR', qr/./ ]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 <br/> );</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 <p>The default <strong>SimpleCalcParser.tab.ph</strong> file containing token identifiers for
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 <strong>SimpleCalcParser.yy</strong> includes:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 $NUMBER=257;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 <br/> $LETTER=258;</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 <h2>METHODS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 <dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 <dt><strong><a name="new" class="item"><strong>new</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 $SimpleCalcYYLexer = new Parsers::SimpleCalcYYLexer($Input);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 <p>Using specified <em>Input</em>, <strong>new</strong> method generates a new <strong>SimpleCalcYYLexer</strong>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 and returns a reference to newly created <strong>SimpleCalcYYLexer</strong> object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 <p>Examples:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 # Input string...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 <br/> $InputText = &quot;3 + 4 +6\nx=3\ny=5\nx+y\nx+z\n&quot;;</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 $YYLexer = new Parsers::SimpleCalcYYLexer($InputText);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 <br/> $YYLex = $YYLexer-&gt;GetYYLex();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 $Debug = 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 <br/> $CalcParser = new Parsers::SimpleCalcParser($YYLex,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 \&amp;Parsers::SimpleCalcParser::yyerror, $Debug);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 <br/> $Value = $SimpleCalcParser-&gt;yyparse();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 <br/> print &quot;Value: $Value\n&quot;;</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 # Input file...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 <br/> $InputFile = &quot;Input.txt&quot;;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 <br/> open INPUTFILE, &quot;$InputFile&quot; or die &quot;Couldn't open $InputFile: $!\n&quot;;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 <br/> $YYLexer = new Parsers::SimpleCalcYYLexer($InputFile);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 <br/> $YYLex = $YYLexer-&gt;GetYYLex();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 $CalcParser = new Parsers::SimpleCalcParser($YYLex,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 \&amp;Parsers::SimpleCalcParser::yyerror);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 <br/> $Value = $SimpleCalcParser-&gt;yyparse();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 <br/> print &quot;Value: $Value\n&quot;;</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 # Input file iterator...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 <br/> $InputFile = &quot;TestSimpleCalcParser.txt&quot;;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 <br/> open INPUTFILE, &quot;$InputFile&quot; or die &quot;Couldn't open $InputFile: $!\n&quot;;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 <br/> $InputIterator = sub { return &lt;INPUTFILE&gt;; };
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 <br/> $YYLexer = new Parsers::SimpleCalcYYLexer($InputIterator);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 <br/> $YYLex = $YYLexer-&gt;GetYYLex();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 $CalcParser = new Parsers::SimpleCalcParser($YYLex,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 \&amp;Parsers::SimpleCalcParser::yyerror);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 <br/> $Value = $SimpleCalcParser-&gt;yyparse();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 <br/> print &quot;Value: $Value\n&quot;;</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 <dt><strong><a name="stringifysimplecalcyylexer" class="item"><strong>StringifySimpleCalcYYLexer</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114 $YYLexerString = $YYLexer-&gt;StringifySimpleCalcYYLexer();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115 <p>Returns a string containing information about <em>YYLexer</em> object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 </dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 <h2>AUTHOR</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124 <h2>SEE ALSO</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 <p><a href="./Lexer.html">Lexer.pm</a>,&nbsp<a href="./YYLexer.html">YYLexer.pm</a>,&nbsp<a href="./SimpleCalcParser.html">SimpleCalcParser.yy</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
126 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
127 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
128 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
129 <h2>COPYRIGHT</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
130 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
131 <p>This file is part of MayaChemTools.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
132 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
133 the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
134 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
135 any later version.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
136 <p>&nbsp</p><p>&nbsp</p><div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
137 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
138 <tr align="left" valign="top"><td width="33%" align="left"><a href="./SimpleCalcParser.html" title="SimpleCalcParser.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./YYLexer.html" title="YYLexer.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>Parsers::SimpleCalcYYLexer.pm</strong></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
139 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
140 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
141 <br />
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
142 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
143 <img src="../../images/h2o2.png">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
144 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
145 </body>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
146 </html>