annotate docs/modules/txt/SimpleCalcParser.txt @ 3:90ea638ce878 draft default tip

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:11:59 -0500
parents 2abf0d43254d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
2 Parsers::SimpleCalcParser
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
3
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
5 use Parsers::SimpleCalcParser ;
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
6
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
7 use Parsers::SimpleCalcParser qw(:all);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
8
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
10 Parsers::SimpleCalcParser class provides the following methods:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
11
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
12 new, yyclearin, yyerrok, yyerror, yyparse
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
13
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
14 Parsers::SimpleCalcParse.yy parser grammer definition file implements a
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
15 simple calculator and is provided to highlight usage of lexer capability
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
16 available through Parsers::SimpleCalcYYLexer, which in turn uses
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
17 Parsers::YYLexer and Parsers::Lexer classes to procide underlying lexer
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
18 functionality.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
19
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
20 The parser package and token table files, Parsers::SimpleCalcParser.pm
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
21 and SimpleCalcParser.tab.ph, are automatically generated from parser
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
22 grammar definition file, Parsers::SimpleCalcParser.yy, using byacc
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
23 available through perl-byacc1.8 modified with perl5-byacc-patches-0.5
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
24 for generation of object oriented parser:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
25
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
26 byacc -l -P -d -b SimpleCalcParser SimpleCalcParser.yy
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
27 mv SimpleCalcParser.tab.pl SimpleCalcParser.pm
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
28
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
29 METHODS
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
30 new
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
31 $SimpleCalcParser = new Parsers::SimpleCalcParser($YYLex,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
32 \&Parsers::SimpleCalcParser::yyerror);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
33 $SimpleCalcParser = new Parsers::SimpleCalcParser($YYLex,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
34 \&Parsers::SimpleCalcParser::yyerror, $Debug);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
35
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
36 Using specified *YYLex* *YYError* functions, new method generates a
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
37 new SimpleCalcParser and returns a reference to newly created
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
38 SimpleCalcYYParser object.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
39
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
40 Examples:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
41
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
42 # Input string...
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
43 $InputText = "3 + 4 +6\nx=3\ny=5\nx+y\nx+z\n";
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
44 $YYLexer = new Parsers::SimpleCalcYYLexer($InputText);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
45 $YYLex = $YYLexer->GetYYLex();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
46
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
47 $Debug = 0;
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
48 $SimpleCalcParser = new Parsers::SimpleCalcParser($YYLex,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
49 \&Parsers::SimpleCalcParser::yyerror, $Debug);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
50 $Value = $SimpleCalcParser->yyparse();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
51 print "Value = " . (defined($Value) ? "$Value" : "Undefined") . "\n";
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
52
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
53 # Input file...
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
54 $InputFile = "TestSimpleCalcParser.txt";
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
55 open INPUTFILE, "$InputFile" or die "Couldn't open $InputFile: $!\n";
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
56
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
57 $YYLexer = new Parsers::SimpleCalcYYLexer(\*INPUTFILE);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
58 $YYLex = $YYLexer->GetYYLex();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
59
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
60 $Debug = 0;
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
61 $SimpleCalcParser = new Parsers::SimpleCalcParser($YYLex,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
62 \&Parsers::SimpleCalcParser::yyerror, $Debug);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
63 $Value = $SimpleCalcParser->yyparse();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
64 print "Value = " . (defined($Value) ? "$Value" : "Undefined") . "\n";
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
65
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
66 close INPUTFILE;
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
67
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
68 # Input iterator...
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
69 $InputFile = "TestSimpleCalcParser.txt";
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
70 open INPUTFILE, "$InputFile" or die "Couldn't open $InputFile: $!\n";
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
71 $InputIterator = sub { return <INPUTFILE>; };
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
72
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
73 $YYLexer = new Parsers::SimpleCalcYYLexer($InputIterator);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
74 $YYLex = $YYLexer->GetYYLex();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
75
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
76 $Debug = 0;
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
77 $SimpleCalcParser = new Parsers::SimpleCalcParser($YYLex,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
78 \&Parsers::SimpleCalcParser::yyerror, $Debug);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
79 $Value = $SimpleCalcParser->yyparse();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
80 print "Value = " . (defined($Value) ? "$Value" : "Undefined") . "\n";
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
81
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
82 close INPUTFILE;
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
83
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
84 yyclearin
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
85 $SimpleCalcParser->yyclearin();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
86
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
87 yyclearin method clears any previous look-ahead token after
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
88 encountering a syntax error during parsing. It can be used after
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
89 yyerrok in a grammer rule with the reserved word error.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
90
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
91 yyerrok
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
92 $SimpleCalcParser->yyerrok();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
93
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
94 yyerrok method is used with the reserved word error in grammer rule
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
95 to indcate error recovery is complete after encountering a syntax
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
96 error during parsing.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
97
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
98 yyerror
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
99 $SimpleCalcParser->yyerror();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
100
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
101 yyerror function is provided for the caller to use during
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
102 initialization of a parser. It is used by yyparse to print any error
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
103 messages encountered during parsing of the input.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
104
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
105 yyparse
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
106 $Value = $SimpleCalcParser->yyparse();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
107
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
108 Returns *Value* after parsing all the input from a input stream
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
109 using specified grammer rules.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
110
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
111 AUTHOR
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
112 Manish Sud <msud@san.rr.com>
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
113
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
114 SEE ALSO
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
115 Lexer.pm, YYLexer.pm, SimpleCalcYYLexer.pm
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
116
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
117 COPYRIGHT
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
118 Copyright (C) 2015 Manish Sud. All rights reserved.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
119
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
120 This file is part of MayaChemTools.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
121
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
122 MayaChemTools is free software; you can redistribute it and/or modify it
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
123 under the terms of the GNU Lesser General Public License as published by
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
124 the Free Software Foundation; either version 3 of the License, or (at
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
125 your option) any later version.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
126