annotate docs/modules/txt/SimpleCalcYYLexer.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::SimpleCalcYYLexer
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 use Parsers::SimpleCalcYYLexer;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7 use Parsers::SimpleCalcYYLexer qw(:all);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10 SimpleCalcYYLexer class provides the following methods:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12 new, YYLex, GetYYLex, StringifySimpleCalcYYLexer
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14 Parser::SimpleCalcYYLexer class is derived from Parser::YYLexer class,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 which in turn is derived from base class Parser::Lexer that provides all
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 the underlying lexer functionality. SimpleCalcYYLexer class is designed
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17 to be used with yyparse code generated by running byacc on a parser
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18 defined using parser definition SimpleCalcParser.yy file.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20 The parser package and token table files, SimpleCalcParser.pm and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21 SimpleCalcParser.tab.ph, are automatically generated from parser grammar
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 definition file, SimpleCalcParser.yy, using byacc available through
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23 perl-byacc1.8 modified with perl5-byacc-patches-0.5 for generation of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24 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 SimpleCalcYYLexer.pm class implements a lexer for a simple calculator
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 and is provided to highlight usasge of YYLex through yyparse.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 The default specification of lexer tokens for SimpleCalcYYLexer.pm
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 includes:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 @YYLexerTokensSpec = (
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36 [ 'LETTER', qr/[a-zA-Z]/ ],
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37 [ 'NUMBER', qr/\d+/ ],
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38 [ 'SPACE', qr/[ ]*/,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39 sub { my($This, $TokenLabel, $MatchedText) = @_; return ''; }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40 ],
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41 [ 'NEWLINE', qr/(?:\r\n|\r|\n)/,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42 sub { my($This, $TokenLabel, $MatchedText) = @_; return "\n"; }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 ],
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44 [ 'CHAR', qr/./ ]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45 );
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 The default SimpleCalcParser.tab.ph file containing token identifiers
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48 for SimpleCalcParser.yy includes:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 $NUMBER=257;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51 $LETTER=258;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 METHODS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54 new
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55 $SimpleCalcYYLexer = new Parsers::SimpleCalcYYLexer($Input);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57 Using specified *Input*, new method generates a new
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58 SimpleCalcYYLexer and returns a reference to newly created
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59 SimpleCalcYYLexer object.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 Examples:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63 # Input string...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
64 $InputText = "3 + 4 +6\nx=3\ny=5\nx+y\nx+z\n";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66 $YYLexer = new Parsers::SimpleCalcYYLexer($InputText);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67 $YYLex = $YYLexer->GetYYLex();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69 $Debug = 0;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70 $CalcParser = new Parsers::SimpleCalcParser($YYLex,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71 \&Parsers::SimpleCalcParser::yyerror, $Debug);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 $Value = $SimpleCalcParser->yyparse();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73 print "Value: $Value\n";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75 # Input file...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76 $InputFile = "Input.txt";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
77 open INPUTFILE, "$InputFile" or die "Couldn't open $InputFile: $!\n";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
78 $YYLexer = new Parsers::SimpleCalcYYLexer($InputFile);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
79 $YYLex = $YYLexer->GetYYLex();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
80
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
81 $CalcParser = new Parsers::SimpleCalcParser($YYLex,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
82 \&Parsers::SimpleCalcParser::yyerror);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
83 $Value = $SimpleCalcParser->yyparse();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
84 print "Value: $Value\n";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
85
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
86 # Input file iterator...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
87 $InputFile = "TestSimpleCalcParser.txt";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
88 open INPUTFILE, "$InputFile" or die "Couldn't open $InputFile: $!\n";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
89 $InputIterator = sub { return <INPUTFILE>; };
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
90 $YYLexer = new Parsers::SimpleCalcYYLexer($InputIterator);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
91 $YYLex = $YYLexer->GetYYLex();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
92
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
93 $CalcParser = new Parsers::SimpleCalcParser($YYLex,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
94 \&Parsers::SimpleCalcParser::yyerror);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
95 $Value = $SimpleCalcParser->yyparse();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
96 print "Value: $Value\n";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
97
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
98 StringifySimpleCalcYYLexer
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
99 $YYLexerString = $YYLexer->StringifySimpleCalcYYLexer();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
100
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
101 Returns a string containing information about *YYLexer* object.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
102
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
103 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
104 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
105
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
106 SEE ALSO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
107 Lexer.pm, YYLexer.pm, SimpleCalcParser.yy
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
108
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
109 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
110 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
111
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
112 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
113
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
114 MayaChemTools is free software; you can redistribute it and/or modify it
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
115 under the terms of the GNU Lesser General Public License as published by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
116 the Free Software Foundation; either version 3 of the License, or (at
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
117 your option) any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
118