2014-10-07 16:25:04 +00:00
|
|
|
/*
|
2016-11-18 23:13:20 +00:00
|
|
|
This file is part of solidity.
|
2014-10-07 16:25:04 +00:00
|
|
|
|
2016-11-18 23:13:20 +00:00
|
|
|
solidity is free software: you can redistribute it and/or modify
|
2014-10-16 12:08:54 +00:00
|
|
|
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-07 16:25:04 +00:00
|
|
|
|
2016-11-18 23:13:20 +00:00
|
|
|
solidity is distributed in the hope that it will be useful,
|
2014-10-16 12:08:54 +00:00
|
|
|
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-07 16:25:04 +00:00
|
|
|
|
2014-10-16 12:08:54 +00:00
|
|
|
You should have received a copy of the GNU General Public License
|
2016-11-18 23:13:20 +00:00
|
|
|
along with solidity. If not, see <http://www.gnu.org/licenses/>.
|
2014-10-07 16:25:04 +00:00
|
|
|
*/
|
|
|
|
/**
|
|
|
|
* @author Christian <c@ethdev.com>
|
|
|
|
* @date 2014
|
|
|
|
* Solidity parser.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2016-02-22 01:13:32 +00:00
|
|
|
#include <libsolidity/ast/AST.h>
|
|
|
|
#include <libsolidity/parsing/ParserBase.h>
|
2014-10-07 16:25:04 +00:00
|
|
|
|
2014-10-16 12:08:54 +00:00
|
|
|
namespace dev
|
|
|
|
{
|
|
|
|
namespace solidity
|
|
|
|
{
|
2014-10-07 16:25:04 +00:00
|
|
|
|
|
|
|
class Scanner;
|
|
|
|
|
2016-02-22 01:13:32 +00:00
|
|
|
class Parser: public ParserBase
|
2014-10-07 16:25:04 +00:00
|
|
|
{
|
|
|
|
public:
|
2017-05-11 13:26:35 +00:00
|
|
|
Parser(ErrorReporter& _errorReporter): ParserBase(_errorReporter) {}
|
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);
|
2014-10-07 16:25:04 +00:00
|
|
|
|
|
|
|
private:
|
2014-10-09 10:28:37 +00:00
|
|
|
class ASTNodeFactory;
|
2014-10-07 16:25:04 +00:00
|
|
|
|
2015-06-05 09:07:50 +00:00
|
|
|
struct VarDeclParserOptions
|
|
|
|
{
|
2015-01-29 13:35:28 +00:00
|
|
|
VarDeclParserOptions() {}
|
|
|
|
bool allowVar = false;
|
|
|
|
bool isStateVariable = false;
|
|
|
|
bool allowIndexed = false;
|
2015-02-09 01:06:30 +00:00
|
|
|
bool allowEmptyName = false;
|
2015-02-17 15:21:38 +00:00
|
|
|
bool allowInitialValue = false;
|
2015-06-05 09:07:50 +00:00
|
|
|
bool allowLocationSpecifier = false;
|
2015-01-29 13:35:28 +00:00
|
|
|
};
|
|
|
|
|
2016-09-27 19:37:32 +00:00
|
|
|
/// This struct is shared for parsing a function header and a function type.
|
|
|
|
struct FunctionHeaderParserResult
|
|
|
|
{
|
|
|
|
ASTPointer<ASTString> name;
|
|
|
|
ASTPointer<ParameterList> parameters;
|
|
|
|
ASTPointer<ParameterList> returnParameters;
|
|
|
|
Declaration::Visibility visibility = Declaration::Visibility::Default;
|
|
|
|
bool isDeclaredConst = false;
|
|
|
|
bool isPayable = false;
|
|
|
|
std::vector<ASTPointer<ModifierInvocation>> modifiers;
|
|
|
|
};
|
|
|
|
|
2014-10-22 18:35:35 +00:00
|
|
|
///@{
|
|
|
|
///@name Parsing functions for the AST nodes
|
2016-08-19 17:57:21 +00:00
|
|
|
ASTPointer<PragmaDirective> parsePragmaDirective();
|
2014-12-03 06:46:55 +00:00
|
|
|
ASTPointer<ImportDirective> parseImportDirective();
|
2017-02-15 11:40:29 +00:00
|
|
|
ContractDefinition::ContractKind tokenToContractKind(Token::Value _token);
|
2017-02-07 22:12:38 +00:00
|
|
|
ASTPointer<ContractDefinition> parseContractDefinition(Token::Value _expectedKind);
|
2015-01-19 20:05:47 +00:00
|
|
|
ASTPointer<InheritanceSpecifier> parseInheritanceSpecifier();
|
2015-02-02 16:24:09 +00:00
|
|
|
Declaration::Visibility parseVisibilitySpecifier(Token::Value _token);
|
2016-09-27 19:37:32 +00:00
|
|
|
FunctionHeaderParserResult parseFunctionHeader(bool _forceEmptyName, bool _allowModifiers);
|
2016-10-10 21:06:44 +00:00
|
|
|
ASTPointer<ASTNode> parseFunctionDefinitionOrFunctionTypeStateVariable(ASTString const* _contractName);
|
2015-02-02 16:24:09 +00:00
|
|
|
ASTPointer<FunctionDefinition> parseFunctionDefinition(ASTString const* _contractName);
|
2014-10-20 12:00:37 +00:00
|
|
|
ASTPointer<StructDefinition> parseStructDefinition();
|
2015-02-09 17:08:56 +00:00
|
|
|
ASTPointer<EnumDefinition> parseEnumDefinition();
|
2015-02-13 21:52:04 +00:00
|
|
|
ASTPointer<EnumValue> parseEnumValue();
|
2015-09-08 14:48:33 +00:00
|
|
|
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();
|
2015-01-22 00:02:38 +00:00
|
|
|
ASTPointer<ModifierInvocation> parseModifierInvocation();
|
2015-01-28 10:28:22 +00:00
|
|
|
ASTPointer<Identifier> parseIdentifier();
|
2015-12-21 17:44:21 +00:00
|
|
|
ASTPointer<UserDefinedTypeName> parseUserDefinedTypeName();
|
2016-10-10 21:06:44 +00:00
|
|
|
ASTPointer<TypeName> parseTypeNameSuffix(ASTPointer<TypeName> type, ASTNodeFactory& nodeFactory);
|
2014-10-20 12:00:37 +00:00
|
|
|
ASTPointer<TypeName> parseTypeName(bool _allowVar);
|
2016-09-27 19:37:32 +00:00
|
|
|
ASTPointer<FunctionTypeName> parseFunctionType();
|
2014-10-20 12:00:37 +00:00
|
|
|
ASTPointer<Mapping> parseMapping();
|
2015-06-05 09:07:50 +00:00
|
|
|
ASTPointer<ParameterList> parseParameterList(
|
|
|
|
VarDeclParserOptions const& _options,
|
|
|
|
bool _allowEmpty = true
|
|
|
|
);
|
2015-10-26 16:20:29 +00:00
|
|
|
ASTPointer<Block> parseBlock(ASTPointer<ASTString> const& _docString = {});
|
2014-10-20 12:00:37 +00:00
|
|
|
ASTPointer<Statement> parseStatement();
|
2016-02-22 01:13:41 +00:00
|
|
|
ASTPointer<InlineAssembly> parseInlineAssembly(ASTPointer<ASTString> const& _docString = {});
|
2015-10-26 16:20:29 +00:00
|
|
|
ASTPointer<IfStatement> parseIfStatement(ASTPointer<ASTString> const& _docString);
|
|
|
|
ASTPointer<WhileStatement> parseWhileStatement(ASTPointer<ASTString> const& _docString);
|
2016-07-30 07:13:05 +00:00
|
|
|
ASTPointer<WhileStatement> parseDoWhileStatement(ASTPointer<ASTString> const& _docString);
|
2015-10-26 16:20:29 +00:00
|
|
|
ASTPointer<ForStatement> parseForStatement(ASTPointer<ASTString> const& _docString);
|
2015-02-20 14:52:30 +00:00
|
|
|
/// 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);
|
2015-02-20 14:52:30 +00:00
|
|
|
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>()
|
|
|
|
);
|
2015-02-20 14:52:30 +00:00
|
|
|
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>()
|
|
|
|
);
|
2015-02-20 14:52:30 +00:00
|
|
|
ASTPointer<Expression> parseExpression(
|
2015-09-25 14:49:15 +00:00
|
|
|
ASTPointer<Expression> const& _lookAheadIndexAccessStructure = ASTPointer<Expression>()
|
|
|
|
);
|
2015-02-20 14:52:30 +00:00
|
|
|
ASTPointer<Expression> parseBinaryExpression(int _minPrecedence = 4,
|
2015-09-25 14:49:15 +00:00
|
|
|
ASTPointer<Expression> const& _lookAheadIndexAccessStructure = ASTPointer<Expression>()
|
|
|
|
);
|
2015-02-20 14:52:30 +00:00
|
|
|
ASTPointer<Expression> parseUnaryExpression(
|
2015-09-25 14:49:15 +00:00
|
|
|
ASTPointer<Expression> const& _lookAheadIndexAccessStructure = ASTPointer<Expression>()
|
|
|
|
);
|
2015-02-20 14:52:30 +00:00
|
|
|
ASTPointer<Expression> parseLeftHandSideExpression(
|
2015-09-25 14:49:15 +00:00
|
|
|
ASTPointer<Expression> const& _lookAheadIndexAccessStructure = ASTPointer<Expression>()
|
|
|
|
);
|
2014-10-20 12:00:37 +00:00
|
|
|
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();
|
2014-10-22 18:35:35 +00:00
|
|
|
///@}
|
|
|
|
|
|
|
|
///@{
|
|
|
|
///@name Helper functions
|
2014-10-07 16:25:04 +00:00
|
|
|
|
2015-02-23 13:38:44 +00:00
|
|
|
/// Used as return value of @see peekStatementType.
|
|
|
|
enum class LookAheadInfo
|
|
|
|
{
|
|
|
|
IndexAccessStructure, VariableDeclarationStatement, ExpressionStatement
|
|
|
|
};
|
|
|
|
|
2015-02-20 14:52:30 +00:00
|
|
|
/// 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;
|
2016-03-09 16:23:05 +00:00
|
|
|
/// @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(
|
2015-10-16 14:12:14 +00:00
|
|
|
std::vector<ASTPointer<PrimaryExpression>> const& _path,
|
2015-09-25 14:49:15 +00:00
|
|
|
std::vector<std::pair<ASTPointer<Expression>, SourceLocation>> const& _indices
|
|
|
|
);
|
2016-03-09 16:23:05 +00:00
|
|
|
/// @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(
|
2015-10-16 14:12:14 +00:00
|
|
|
std::vector<ASTPointer<PrimaryExpression>> const& _path,
|
2015-09-25 14:49:15 +00:00
|
|
|
std::vector<std::pair<ASTPointer<Expression>, SourceLocation>> const& _indices
|
|
|
|
);
|
2017-05-24 21:55:29 +00:00
|
|
|
|
2017-05-26 20:02:24 +00:00
|
|
|
std::string currentTokenName();
|
2017-05-24 21:55:29 +00:00
|
|
|
Token::Value expectAssignmentOperator();
|
|
|
|
ASTPointer<ASTString> expectIdentifierToken();
|
|
|
|
ASTPointer<ASTString> getLiteralAndAdvance();
|
2014-10-22 18:35:35 +00:00
|
|
|
///@}
|
2014-10-07 16:25:04 +00:00
|
|
|
|
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();
|
|
|
|
|
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;
|
2014-10-07 16:25:04 +00:00
|
|
|
};
|
|
|
|
|
2014-10-16 12:08:54 +00:00
|
|
|
}
|
|
|
|
}
|