solidity/libsolidity/parsing/Parser.h

169 lines
6.5 KiB
C
Raw Normal View History

/*
2014-10-16 12:08:54 +00:00
This file is part of cpp-ethereum.
2014-10-16 12:08:54 +00:00
cpp-ethereum is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
2014-10-16 12:08:54 +00:00
cpp-ethereum is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
2014-10-16 12:08:54 +00:00
You should have received a copy of the GNU General Public License
along with cpp-ethereum. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @author Christian <c@ethdev.com>
* @date 2014
* Solidity parser.
*/
#pragma once
2015-10-20 22:21:52 +00:00
#include "libsolidity/ast/AST.h"
2014-10-16 12:08:54 +00:00
namespace dev
{
namespace solidity
{
class Scanner;
class Parser
{
public:
2015-10-15 14:27:26 +00:00
Parser(ErrorList& errors): m_errors(errors){};
2015-03-10 14:11:13 +00:00
2014-12-03 06:46:55 +00:00
ASTPointer<SourceUnit> parse(std::shared_ptr<Scanner> const& _scanner);
2015-08-31 16:44:29 +00:00
std::shared_ptr<std::string const> const& sourceName() const;
private:
2014-10-09 10:28:37 +00:00
class ASTNodeFactory;
2014-10-09 10:28:37 +00:00
/// Start position of the current token
2015-08-31 16:44:29 +00:00
int position() const;
2014-10-09 10:28:37 +00:00
/// End position of the current token
2015-08-31 16:44:29 +00:00
int endPosition() const;
struct VarDeclParserOptions
{
2015-01-29 13:35:28 +00:00
VarDeclParserOptions() {}
bool allowVar = false;
bool isStateVariable = false;
bool allowIndexed = false;
bool allowEmptyName = false;
bool allowInitialValue = false;
bool allowLocationSpecifier = false;
2015-01-29 13:35:28 +00:00
};
///@{
///@name Parsing functions for the AST nodes
2014-12-03 06:46:55 +00:00
ASTPointer<ImportDirective> parseImportDirective();
ASTPointer<ContractDefinition> parseContractDefinition(bool _isLibrary);
ASTPointer<InheritanceSpecifier> parseInheritanceSpecifier();
2015-02-02 16:24:09 +00:00
Declaration::Visibility parseVisibilitySpecifier(Token::Value _token);
ASTPointer<FunctionDefinition> parseFunctionDefinition(ASTString const* _contractName);
ASTPointer<StructDefinition> parseStructDefinition();
2015-02-09 17:08:56 +00:00
ASTPointer<EnumDefinition> parseEnumDefinition();
ASTPointer<EnumValue> parseEnumValue();
ASTPointer<VariableDeclaration> parseVariableDeclaration(
VarDeclParserOptions const& _options = VarDeclParserOptions(),
ASTPointer<TypeName> const& _lookAheadArrayType = ASTPointer<TypeName>()
);
2015-01-21 10:16:18 +00:00
ASTPointer<ModifierDefinition> parseModifierDefinition();
2015-01-29 13:35:28 +00:00
ASTPointer<EventDefinition> parseEventDefinition();
2015-11-22 19:39:10 +00:00
ASTPointer<UsingForDirective> parseUsingDirective();
ASTPointer<ModifierInvocation> parseModifierInvocation();
2015-01-28 10:28:22 +00:00
ASTPointer<Identifier> parseIdentifier();
ASTPointer<UserDefinedTypeName> parseUserDefinedTypeName();
ASTPointer<TypeName> parseTypeName(bool _allowVar);
ASTPointer<Mapping> parseMapping();
ASTPointer<ParameterList> parseParameterList(
VarDeclParserOptions const& _options,
bool _allowEmpty = true
);
2015-10-26 16:20:29 +00:00
ASTPointer<Block> parseBlock(ASTPointer<ASTString> const& _docString = {});
ASTPointer<Statement> parseStatement();
2015-10-26 16:20:29 +00:00
ASTPointer<IfStatement> parseIfStatement(ASTPointer<ASTString> const& _docString);
ASTPointer<WhileStatement> parseWhileStatement(ASTPointer<ASTString> const& _docString);
ASTPointer<ForStatement> parseForStatement(ASTPointer<ASTString> const& _docString);
/// A "simple statement" can be a variable declaration statement or an expression statement.
2015-10-26 16:20:29 +00:00
ASTPointer<Statement> parseSimpleStatement(ASTPointer<ASTString> const& _docString);
ASTPointer<VariableDeclarationStatement> parseVariableDeclarationStatement(
2015-10-26 16:20:29 +00:00
ASTPointer<ASTString> const& _docString,
2015-09-25 14:49:15 +00:00
ASTPointer<TypeName> const& _lookAheadArrayType = ASTPointer<TypeName>()
);
ASTPointer<ExpressionStatement> parseExpressionStatement(
2015-10-26 16:20:29 +00:00
ASTPointer<ASTString> const& _docString,
2015-09-25 14:49:15 +00:00
ASTPointer<Expression> const& _lookAheadIndexAccessStructure = ASTPointer<Expression>()
);
ASTPointer<Expression> parseExpression(
2015-09-25 14:49:15 +00:00
ASTPointer<Expression> const& _lookAheadIndexAccessStructure = ASTPointer<Expression>()
);
ASTPointer<Expression> parseBinaryExpression(int _minPrecedence = 4,
2015-09-25 14:49:15 +00:00
ASTPointer<Expression> const& _lookAheadIndexAccessStructure = ASTPointer<Expression>()
);
ASTPointer<Expression> parseUnaryExpression(
2015-09-25 14:49:15 +00:00
ASTPointer<Expression> const& _lookAheadIndexAccessStructure = ASTPointer<Expression>()
);
ASTPointer<Expression> parseLeftHandSideExpression(
2015-09-25 14:49:15 +00:00
ASTPointer<Expression> const& _lookAheadIndexAccessStructure = ASTPointer<Expression>()
);
ASTPointer<Expression> parsePrimaryExpression();
2015-01-29 17:26:00 +00:00
std::vector<ASTPointer<Expression>> parseFunctionCallListArguments();
2015-02-03 20:25:08 +00:00
std::pair<std::vector<ASTPointer<Expression>>, std::vector<ASTPointer<ASTString>>> parseFunctionCallArguments();
///@}
///@{
///@name Helper functions
2015-02-23 13:38:44 +00:00
/// Used as return value of @see peekStatementType.
enum class LookAheadInfo
{
IndexAccessStructure, VariableDeclarationStatement, ExpressionStatement
};
/// Performs limited look-ahead to distinguish between variable declaration and expression statement.
2015-02-23 13:55:06 +00:00
/// For source code of the form "a[][8]" ("IndexAccessStructure"), this is not possible to
2015-02-23 13:38:44 +00:00
/// decide with constant look-ahead.
LookAheadInfo peekStatementType() const;
/// Returns a typename parsed in look-ahead fashion from something like "a.b[8][2**70]".
2015-02-23 13:38:44 +00:00
ASTPointer<TypeName> typeNameIndexAccessStructure(
std::vector<ASTPointer<PrimaryExpression>> const& _path,
2015-09-25 14:49:15 +00:00
std::vector<std::pair<ASTPointer<Expression>, SourceLocation>> const& _indices
);
/// Returns an expression parsed in look-ahead fashion from something like "a.b[8][2**70]".
2015-02-23 13:38:44 +00:00
ASTPointer<Expression> expressionFromIndexAccessStructure(
std::vector<ASTPointer<PrimaryExpression>> const& _path,
2015-09-25 14:49:15 +00:00
std::vector<std::pair<ASTPointer<Expression>, SourceLocation>> const& _indices
);
2014-10-09 10:28:37 +00:00
/// If current token value is not _value, throw exception otherwise advance token.
void expectToken(Token::Value _value);
Token::Value expectAssignmentOperator();
ASTPointer<ASTString> expectIdentifierToken();
ASTPointer<ASTString> getLiteralAndAdvance();
///@}
2015-01-30 20:43:19 +00:00
/// Creates an empty ParameterList at the current location (used if parameters can be omitted).
ASTPointer<ParameterList> createEmptyParameterList();
/// Creates a @ref ParserError and annotates it with the current position and the
2014-10-23 17:22:30 +00:00
/// given @a _description.
void parserError(std::string const& _description);
/// Creates a @ref ParserError and annotates it with the current position and the
/// given @a _description. Throws the FatalError.
void fatalParserError(std::string const& _description);
2014-10-23 17:22:30 +00:00
2014-10-09 10:28:37 +00:00
std::shared_ptr<Scanner> m_scanner;
2015-01-21 10:16:18 +00:00
/// Flag that signifies whether '_' is parsed as a PlaceholderStatement or a regular identifier.
bool m_insideModifier = false;
/// The reference to the list of errors and warning to add errors/warnings during parsing
ErrorList& m_errors;
};
2014-10-16 12:08:54 +00:00
}
}