/*
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
namespace dev
{
namespace solidity
{
class Scanner;
class Parser: public ParserBase
{
public:
Parser(ErrorList& _errors): ParserBase(_errors) {}
ASTPointer parse(std::shared_ptr const& _scanner);
private:
class ASTNodeFactory;
struct VarDeclParserOptions
{
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
{
ASTPointer name;
ASTPointer parameters;
ASTPointer returnParameters;
Declaration::Visibility visibility = Declaration::Visibility::Default;
bool isDeclaredConst = false;
bool isPayable = false;
std::vector> modifiers;
};
///@{
///@name Parsing functions for the AST nodes
ASTPointer parsePragmaDirective();
ASTPointer parseImportDirective();
ContractDefinition::ContractKind tokenToContractKind(Token::Value _token);
ASTPointer parseContractDefinition(Token::Value _expectedKind);
ASTPointer parseInheritanceSpecifier();
Declaration::Visibility parseVisibilitySpecifier(Token::Value _token);
FunctionHeaderParserResult parseFunctionHeader(bool _forceEmptyName, bool _allowModifiers);
ASTPointer parseFunctionDefinitionOrFunctionTypeStateVariable(ASTString const* _contractName);
ASTPointer parseFunctionDefinition(ASTString const* _contractName);
ASTPointer parseStructDefinition();
ASTPointer parseEnumDefinition();
ASTPointer parseEnumValue();
ASTPointer parseVariableDeclaration(
VarDeclParserOptions const& _options = VarDeclParserOptions(),
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);
/// 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& _lookAheadIndexAccessStructure = ASTPointer()
);
ASTPointer parseExpression(
ASTPointer const& _lookAheadIndexAccessStructure = ASTPointer()
);
ASTPointer parseBinaryExpression(int _minPrecedence = 4,
ASTPointer const& _lookAheadIndexAccessStructure = ASTPointer()
);
ASTPointer parseUnaryExpression(
ASTPointer const& _lookAheadIndexAccessStructure = ASTPointer()
);
ASTPointer parseLeftHandSideExpression(
ASTPointer const& _lookAheadIndexAccessStructure = 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, VariableDeclarationStatement, ExpressionStatement
};
/// 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 a typename parsed in look-ahead fashion from something like "a.b[8][2**70]".
ASTPointer typeNameIndexAccessStructure(
std::vector> const& _path,
std::vector, SourceLocation>> const& _indices
);
/// @returns an expression parsed in look-ahead fashion from something like "a.b[8][2**70]".
ASTPointer expressionFromIndexAccessStructure(
std::vector> const& _path,
std::vector, SourceLocation>> const& _indices
);
Token::Value expectAssignmentOperator();
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;
};
}
}