/*
This file is part of solidity.
solidity 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.
solidity 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.
You should have received a copy of the GNU General Public License
along with solidity. If not, see .
*/
/**
* @author Christian
* @date 2014
* Solidity parser.
*/
#pragma once
#include
#include
#include
namespace langutil
{
class Scanner;
}
namespace dev
{
namespace solidity
{
class Parser: public langutil::ParserBase
{
public:
explicit Parser(
langutil::ErrorReporter& _errorReporter,
langutil::EVMVersion _evmVersion,
bool _errorRecovery = false
):
ParserBase(_errorReporter, _errorRecovery),
m_evmVersion(_evmVersion)
{}
ASTPointer parse(std::shared_ptr const& _scanner);
private:
class ASTNodeFactory;
struct VarDeclParserOptions
{
// This is actually not needed, but due to a defect in the C++ standard, we have to.
// https://stackoverflow.com/questions/17430377
VarDeclParserOptions() {}
bool allowVar = false;
bool isStateVariable = false;
bool allowIndexed = false;
bool allowEmptyName = false;
bool allowInitialValue = false;
bool allowLocationSpecifier = false;
};
/// This struct is shared for parsing a function header and a function type.
struct FunctionHeaderParserResult
{
bool isConstructor;
ASTPointer overrides;
ASTPointer name;
ASTPointer parameters;
ASTPointer returnParameters;
Declaration::Visibility visibility = Declaration::Visibility::Default;
StateMutability stateMutability = StateMutability::NonPayable;
std::vector> modifiers;
};
///@{
///@name Parsing functions for the AST nodes
void parsePragmaVersion(langutil::SourceLocation const& _location, std::vector const& _tokens, std::vector const& _literals);
ASTPointer parsePragmaDirective();
ASTPointer parseImportDirective();
ContractDefinition::ContractKind parseContractKind();
ASTPointer parseContractDefinition();
ASTPointer parseInheritanceSpecifier();
Declaration::Visibility parseVisibilitySpecifier();
ASTPointer parseOverrideSpecifier();
StateMutability parseStateMutability();
FunctionHeaderParserResult parseFunctionHeader(bool _onlyFuncType, bool _allowFuncDef);
ASTPointer parseFunctionDefinitionOrFunctionTypeStateVariable();
ASTPointer parseFunctionDefinition(ASTString const* _contractName);
ASTPointer parseStructDefinition();
ASTPointer parseEnumDefinition();
ASTPointer parseEnumValue();
ASTPointer parseVariableDeclaration(
VarDeclParserOptions const& _options = {},
ASTPointer const& _lookAheadArrayType = ASTPointer()
);
ASTPointer parseModifierDefinition();
ASTPointer parseEventDefinition();
ASTPointer parseUsingDirective();
ASTPointer parseModifierInvocation();
ASTPointer parseIdentifier();
ASTPointer parseUserDefinedTypeName();
ASTPointer parseTypeNameSuffix(ASTPointer type, ASTNodeFactory& nodeFactory);
ASTPointer parseTypeName(bool _allowVar);
ASTPointer parseFunctionType();
ASTPointer parseMapping();
ASTPointer parseParameterList(
VarDeclParserOptions const& _options = {},
bool _allowEmpty = true
);
ASTPointer parseBlock(ASTPointer const& _docString = {});
ASTPointer parseStatement();
ASTPointer parseInlineAssembly(ASTPointer const& _docString = {});
ASTPointer parseIfStatement(ASTPointer const& _docString);
ASTPointer parseWhileStatement(ASTPointer const& _docString);
ASTPointer parseDoWhileStatement(ASTPointer const& _docString);
ASTPointer parseForStatement(ASTPointer const& _docString);
ASTPointer parseEmitStatement(ASTPointer const& docString);
/// A "simple statement" can be a variable declaration statement or an expression statement.
ASTPointer parseSimpleStatement(ASTPointer const& _docString);
ASTPointer parseVariableDeclarationStatement(
ASTPointer const& _docString,
ASTPointer const& _lookAheadArrayType = ASTPointer()
);
ASTPointer parseExpressionStatement(
ASTPointer const& _docString,
ASTPointer const& _partiallyParsedExpression = ASTPointer()
);
ASTPointer parseExpression(
ASTPointer const& _partiallyParsedExpression = ASTPointer()
);
ASTPointer parseBinaryExpression(int _minPrecedence = 4,
ASTPointer const& _partiallyParsedExpression = ASTPointer()
);
ASTPointer parseUnaryExpression(
ASTPointer const& _partiallyParsedExpression = ASTPointer()
);
ASTPointer parseLeftHandSideExpression(
ASTPointer const& _partiallyParsedExpression = ASTPointer()
);
ASTPointer parsePrimaryExpression();
std::vector> parseFunctionCallListArguments();
std::pair>, std::vector>> parseFunctionCallArguments();
///@}
///@{
///@name Helper functions
/// Used as return value of @see peekStatementType.
enum class LookAheadInfo
{
IndexAccessStructure, VariableDeclaration, Expression
};
/// Structure that represents a.b.c[x][y][z]. Can be converted either to an expression
/// or to a type name. For this to be valid, path cannot be empty, but indices can be empty.
struct IndexAccessedPath
{
std::vector> path;
std::vector, langutil::SourceLocation>> indices;
bool empty() const;
};
std::pair tryParseIndexAccessedPath();
/// Performs limited look-ahead to distinguish between variable declaration and expression statement.
/// For source code of the form "a[][8]" ("IndexAccessStructure"), this is not possible to
/// decide with constant look-ahead.
LookAheadInfo peekStatementType() const;
/// @returns an IndexAccessedPath as a prestage to parsing a variable declaration (type name)
/// or an expression;
IndexAccessedPath parseIndexAccessedPath();
/// @returns a typename parsed in look-ahead fashion from something like "a.b[8][2**70]",
/// or an empty pointer if an empty @a _pathAndIncides has been supplied.
ASTPointer typeNameFromIndexAccessStructure(IndexAccessedPath const& _pathAndIndices);
/// @returns an expression parsed in look-ahead fashion from something like "a.b[8][2**70]",
/// or an empty pointer if an empty @a _pathAndIncides has been supplied.
ASTPointer expressionFromIndexAccessStructure(IndexAccessedPath const& _pathAndIndices);
ASTPointer expectIdentifierToken();
ASTPointer getLiteralAndAdvance();
///@}
/// Creates an empty ParameterList at the current location (used if parameters can be omitted).
ASTPointer createEmptyParameterList();
/// Flag that signifies whether '_' is parsed as a PlaceholderStatement or a regular identifier.
bool m_insideModifier = false;
langutil::EVMVersion m_evmVersion;
};
}
}