annotate docs/modules/txt/SimpleCalcParser.txt @ 0:4816e4a8ae95 draft default tip

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