amath  1.8.5
Simple command line calculator
parser.h
Go to the documentation of this file.
1 /*-
2  * Copyright (c) 2014-2018 Carsten Sonne Larsen <cs@innolan.net>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  * Project homepage:
26  * https://amath.innolan.net
27  *
28  */
29 
30 #ifndef AMATH_PARSER_H
31 #define AMATH_PARSER_H
32 
33 /**
34  * @file parser.h
35  * @brief Application logic tied to Parser.
36  *
37  */
38 
39 #include "nodes.h"
40 #include "lexer.h"
41 
42 /**
43  * @brief Encapsulates a recursive descent parser.
44  * @details
45  * More info on recursive descent parsers is available at Wikipedia:
46  * https://wikipedia.org/wiki/Recursive_descent_parser
47  *
48  */
49 class Parser
50 {
51 public:
52  explicit Parser(const char* input);
53  ~Parser();
54 
55  /**
56  * @brief Parses the input into a syntax tree.
57  *
58  * @return SyntaxNode* representing a pointer to the top node of the tree.
59  * Notice: The caller is responsible for releasing memory.
60  *
61  */
62  SyntaxNode* Parse(); // Clang ns_returns_retained
63 
64 private:
67 
70 
83 
94 
95  void GetToken();
96  void PutToken();
97  bool Expect(Symbol symbol);
98  Token* Peek() const;
99 };
100 
101 #endif
ExpressionNode * ParsePower()
Definition: parser.cpp:329
ExpressionNode * ParseExpression()
Definition: parser.cpp:278
Encapsulates an lexical analyzer. Provides token for the parser.
Definition: lexer.h:48
SyntaxNode * ParseEvaluation()
Definition: parser.cpp:261
Token * token
Definition: parser.h:66
SyntaxNode * ParseDefault()
Definition: parser.cpp:237
Base class for all nodes in a syntax tree.
Definition: nodes.h:65
bool Expect(Symbol symbol)
Definition: parser.cpp:519
ExpressionNode * ParseAddSubstract()
Definition: parser.cpp:283
~Parser()
Definition: parser.cpp:51
Token * Peek() const
Definition: parser.cpp:506
SyntaxNode * ParsePromptStatement()
Definition: parser.cpp:748
ErrorNode * errorNode
Definition: parser.h:69
Lexer * lexer
Definition: parser.h:65
Tokens are created by the Lexical Analyzer and provides an intermediate state for input consumed by t...
Definition: token.h:46
SyntaxNode * ParseDeleteStatement()
Definition: parser.cpp:582
SyntaxNode * ParseListStatement()
Definition: parser.cpp:611
ExpressionNode * ParseUnary()
Definition: parser.cpp:344
ExpressionNode * ParseIdent()
Definition: parser.cpp:416
ExpressionNode * ParseNumber()
Definition: parser.cpp:469
SyntaxNode * ParseDigistStatement()
Definition: parser.cpp:713
Parser(const char *input)
Definition: parser.cpp:43
SyntaxNode * ParseHelpStatement()
Definition: parser.cpp:566
ExpressionNode * ParseAtomic()
Definition: parser.cpp:362
ExpressionNode * ParseFactor()
Definition: parser.cpp:306
SyntaxNode * ParseDrawStatement()
Definition: parser.cpp:772
SyntaxNode * ParseStatement()
Definition: parser.cpp:156
Represents an error message encapsulated in a syntax tree.
Definition: nodes.h:123
void GetToken()
Definition: parser.cpp:494
SyntaxNode * ParsePrefsStatement()
Definition: parser.cpp:760
Base class for all nodes related to mathematical expressions.
Definition: nodes.h:99
void PutToken()
Definition: parser.cpp:514
SyntaxNode * TryParseStatement()
Definition: parser.cpp:124
SyntaxNode * Parse()
Parses the input into a syntax tree.
Definition: parser.cpp:56
SyntaxNode * ParseFileStatement()
Definition: parser.cpp:627
SyntaxNode * ParseNumeralStatement()
Definition: parser.cpp:652
int syntaxError
Definition: parser.h:68
Encapsulates a recursive descent parser.
Definition: parser.h:49
SyntaxNode * ParseFunctionDef()
Definition: parser.cpp:535