solidity/libsolidity/parsing/Parser.h

235 lines
9.6 KiB
C
Raw Normal View History

/*
2019-02-13 15:56:46 +00:00
This file is part of solidity.
2019-02-13 15:56:46 +00:00
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.
2019-02-13 15:56:46 +00:00
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.
2019-02-13 15:56:46 +00:00
You should have received a copy of the GNU General Public License
along with solidity. If not, see <http://www.gnu.org/licenses/>.
*/
// SPDX-License-Identifier: GPL-3.0
/**
* @author Christian <c@ethdev.com>
* @date 2014
* Solidity parser.
*/
#pragma once
#include <libsolidity/ast/AST.h>
#include <liblangutil/ParserBase.h>
#include <liblangutil/EVMVersion.h>
2019-12-11 16:31:36 +00:00
namespace solidity::langutil
{
2021-07-14 10:53:39 +00:00
class CharStream;
}
2019-12-11 16:31:36 +00:00
namespace solidity::frontend
2014-10-16 12:08:54 +00:00
{
class Parser: public langutil::ParserBase
{
public:
explicit Parser(
langutil::ErrorReporter& _errorReporter,
langutil::EVMVersion _evmVersion,
bool _errorRecovery = false
):
ParserBase(_errorReporter, _errorRecovery),
m_evmVersion(_evmVersion)
{}
2015-03-10 14:11:13 +00:00
2021-07-14 10:53:39 +00:00
ASTPointer<SourceUnit> parse(langutil::CharStream& _charStream);
private:
2014-10-09 10:28:37 +00:00
class ASTNodeFactory;
2020-09-25 10:15:31 +00:00
enum class VarDeclKind { FileLevel, State, Other };
struct VarDeclParserOptions
{
// This is actually not needed, but due to a defect in the C++ standard, we have to.
// https://stackoverflow.com/questions/17430377
2015-01-29 13:35:28 +00:00
VarDeclParserOptions() {}
2020-09-25 10:15:31 +00:00
VarDeclKind kind = VarDeclKind::Other;
2015-01-29 13:35:28 +00:00
bool allowIndexed = false;
bool allowEmptyName = false;
bool allowInitialValue = false;
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
{
2019-11-05 17:25:34 +00:00
bool isVirtual = false;
2019-08-13 11:00:46 +00:00
ASTPointer<OverrideSpecifier> overrides;
2016-09-27 19:37:32 +00:00
ASTPointer<ParameterList> parameters;
ASTPointer<ParameterList> returnParameters;
2019-12-10 14:54:09 +00:00
Visibility visibility = Visibility::Default;
StateMutability stateMutability = StateMutability::NonPayable;
2016-09-27 19:37:32 +00:00
std::vector<ASTPointer<ModifierInvocation>> modifiers;
};
/// Struct to share parsed function call arguments.
struct FunctionCallArguments
{
std::vector<ASTPointer<Expression>> arguments;
std::vector<ASTPointer<ASTString>> parameterNames;
std::vector<langutil::SourceLocation> parameterNameLocations;
};
///@{
///@name Parsing functions for the AST nodes
void parsePragmaVersion(langutil::SourceLocation const& _location, std::vector<Token> const& _tokens, std::vector<std::string> const& _literals);
ASTPointer<StructuredDocumentation> parseStructuredDocumentation();
ASTPointer<PragmaDirective> parsePragmaDirective(bool _finishedParsingTopLevelPragmas);
2014-12-03 06:46:55 +00:00
ASTPointer<ImportDirective> parseImportDirective();
/// @returns an std::pair<ContractKind, bool>, where
2019-09-04 22:01:13 +00:00
/// result.second is set to true, if an abstract contract was parsed, false otherwise.
std::pair<ContractKind, bool> parseContractKind();
ASTPointer<ContractDefinition> parseContractDefinition();
ASTPointer<InheritanceSpecifier> parseInheritanceSpecifier();
2019-12-10 14:54:09 +00:00
Visibility parseVisibilitySpecifier();
2019-08-13 11:00:46 +00:00
ASTPointer<OverrideSpecifier> parseOverrideSpecifier();
StateMutability parseStateMutability();
FunctionHeaderParserResult parseFunctionHeader(bool _isStateVariable);
2020-05-04 16:38:00 +00:00
ASTPointer<ASTNode> parseFunctionDefinition(bool _freeFunction = false);
ASTPointer<StructDefinition> parseStructDefinition();
2015-02-09 17:08:56 +00:00
ASTPointer<EnumDefinition> parseEnumDefinition();
ASTPointer<UserDefinedValueTypeDefinition> parseUserDefinedValueTypeDefinition();
ASTPointer<EnumValue> parseEnumValue();
ASTPointer<VariableDeclaration> parseVariableDeclaration(
VarDeclParserOptions const& _options = {},
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();
2021-01-28 11:56:22 +00:00
ASTPointer<ErrorDefinition> parseErrorDefinition();
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();
2021-02-24 15:28:13 +00:00
ASTPointer<Identifier> parseIdentifierOrAddress();
ASTPointer<UserDefinedTypeName> parseUserDefinedTypeName();
2020-08-31 15:37:03 +00:00
ASTPointer<IdentifierPath> parseIdentifierPath();
2016-10-10 21:06:44 +00:00
ASTPointer<TypeName> parseTypeNameSuffix(ASTPointer<TypeName> type, ASTNodeFactory& nodeFactory);
2020-07-15 17:50:59 +00:00
ASTPointer<TypeName> parseTypeName();
2016-09-27 19:37:32 +00:00
ASTPointer<FunctionTypeName> parseFunctionType();
ASTPointer<Mapping> parseMapping();
ASTPointer<ParameterList> parseParameterList(
VarDeclParserOptions const& _options = {},
bool _allowEmpty = true
);
2020-07-22 08:28:04 +00:00
ASTPointer<Block> parseBlock(bool _allowUncheckedBlock = false, ASTPointer<ASTString> const& _docString = {});
ASTPointer<Statement> parseStatement(bool _allowUncheckedBlock = false);
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);
2019-09-03 14:06:00 +00:00
ASTPointer<TryStatement> parseTryStatement(ASTPointer<ASTString> const& _docString);
ASTPointer<TryCatchClause> parseCatchClause();
2015-10-26 16:20:29 +00:00
ASTPointer<WhileStatement> parseWhileStatement(ASTPointer<ASTString> const& _docString);
ASTPointer<WhileStatement> parseDoWhileStatement(ASTPointer<ASTString> const& _docString);
2015-10-26 16:20:29 +00:00
ASTPointer<ForStatement> parseForStatement(ASTPointer<ASTString> const& _docString);
2018-02-16 15:55:21 +00:00
ASTPointer<EmitStatement> parseEmitStatement(ASTPointer<ASTString> const& docString);
2021-02-24 09:55:49 +00:00
ASTPointer<RevertStatement> parseRevertStatement(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,
2018-04-27 22:17:35 +00:00
ASTPointer<Expression> const& _partiallyParsedExpression = ASTPointer<Expression>()
2015-09-25 14:49:15 +00:00
);
ASTPointer<Expression> parseExpression(
2018-04-27 22:17:35 +00:00
ASTPointer<Expression> const& _partiallyParsedExpression = ASTPointer<Expression>()
2015-09-25 14:49:15 +00:00
);
ASTPointer<Expression> parseBinaryExpression(int _minPrecedence = 4,
2018-04-27 22:17:35 +00:00
ASTPointer<Expression> const& _partiallyParsedExpression = ASTPointer<Expression>()
2015-09-25 14:49:15 +00:00
);
ASTPointer<Expression> parseUnaryExpression(
2018-04-27 22:17:35 +00:00
ASTPointer<Expression> const& _partiallyParsedExpression = ASTPointer<Expression>()
2015-09-25 14:49:15 +00:00
);
ASTPointer<Expression> parseLeftHandSideExpression(
2018-04-27 22:17:35 +00:00
ASTPointer<Expression> const& _partiallyParsedExpression = ASTPointer<Expression>()
2015-09-25 14:49:15 +00:00
);
ASTPointer<Expression> parseLiteral();
ASTPointer<Expression> parsePrimaryExpression();
2015-01-29 17:26:00 +00:00
std::vector<ASTPointer<Expression>> parseFunctionCallListArguments();
FunctionCallArguments parseFunctionCallArguments();
FunctionCallArguments parseNamedArguments();
std::pair<ASTPointer<ASTString>, langutil::SourceLocation> expectIdentifierWithLocation();
///@}
///@{
///@name Helper functions
2020-09-25 10:15:31 +00:00
/// @return true if we are at the start of a variable declaration.
bool variableDeclarationStart();
2015-02-23 13:38:44 +00:00
/// Used as return value of @see peekStatementType.
enum class LookAheadInfo
{
2018-04-27 22:26:56 +00:00
IndexAccessStructure, VariableDeclaration, Expression
2015-02-23 13:38:44 +00:00
};
2018-04-26 08:42:56 +00:00
/// Structure that represents a.b.c[x][y][z]. Can be converted either to an expression
2018-04-27 22:26:56 +00:00
/// or to a type name. For this to be valid, path cannot be empty, but indices can be empty.
2018-04-26 08:42:56 +00:00
struct IndexAccessedPath
{
struct Index
{
ASTPointer<Expression> start;
std::optional<ASTPointer<Expression>> end;
langutil::SourceLocation location;
};
2018-04-26 08:42:56 +00:00
std::vector<ASTPointer<PrimaryExpression>> path;
std::vector<Index> indices;
bool empty() const;
2018-04-26 08:42:56 +00:00
};
2015-02-23 13:38:44 +00:00
std::optional<std::string> findLicenseString(std::vector<ASTPointer<ASTNode>> const& _nodes);
2019-09-11 19:16:35 +00:00
/// Returns the next AST node ID
int64_t nextID() { return ++m_currentNodeID; }
2018-04-27 22:26:56 +00:00
std::pair<LookAheadInfo, IndexAccessedPath> tryParseIndexAccessedPath();
/// 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;
2018-04-26 08:42:56 +00:00
/// @returns an IndexAccessedPath as a prestage to parsing a variable declaration (type name)
/// or an expression;
IndexAccessedPath parseIndexAccessedPath();
2018-04-27 22:26:56 +00:00
/// @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.
2018-04-26 08:42:56 +00:00
ASTPointer<TypeName> typeNameFromIndexAccessStructure(IndexAccessedPath const& _pathAndIndices);
2018-04-27 22:26:56 +00:00
/// @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.
2018-04-26 08:42:56 +00:00
ASTPointer<Expression> expressionFromIndexAccessStructure(IndexAccessedPath const& _pathAndIndices);
ASTPointer<ASTString> expectIdentifierToken();
2021-02-24 15:28:13 +00:00
ASTPointer<ASTString> expectIdentifierTokenOrAddress();
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();
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;
langutil::EVMVersion m_evmVersion;
2019-09-11 19:16:35 +00:00
/// Counter for the next AST node ID
int64_t m_currentNodeID = 0;
/// Flag that indicates whether experimental mode is enabled in the current source unit
bool m_experimentalSolidityEnabledInCurrentSourceUnit = false;
};
2014-10-16 12:08:54 +00:00
}