From 968934c05d260cb3149cbcd57014701a32987480 Mon Sep 17 00:00:00 2001 From: chriseth Date: Mon, 22 Feb 2016 02:13:32 +0100 Subject: Move reusable parser components into base class. --- libsolidity/parsing/Parser.cpp | 75 --------------------------- libsolidity/parsing/Parser.h | 29 ++--------- libsolidity/parsing/ParserBase.cpp | 103 +++++++++++++++++++++++++++++++++++++ libsolidity/parsing/ParserBase.h | 76 +++++++++++++++++++++++++++ 4 files changed, 183 insertions(+), 100 deletions(-) create mode 100644 libsolidity/parsing/ParserBase.cpp create mode 100644 libsolidity/parsing/ParserBase.h diff --git a/libsolidity/parsing/Parser.cpp b/libsolidity/parsing/Parser.cpp index e579f18b..7bda3610 100644 --- a/libsolidity/parsing/Parser.cpp +++ b/libsolidity/parsing/Parser.cpp @@ -96,21 +96,6 @@ ASTPointer Parser::parse(shared_ptr const& _scanner) } } -std::shared_ptr const& Parser::sourceName() const -{ - return m_scanner->sourceName(); -} - -int Parser::position() const -{ - return m_scanner->currentLocation().start; -} - -int Parser::endPosition() const -{ - return m_scanner->currentLocation().end; -} - ASTPointer Parser::parseImportDirective() { // import "abc" [as x]; @@ -1286,50 +1271,6 @@ ASTPointer Parser::expressionFromIndexAccessStructure( return expression; } -void Parser::expectToken(Token::Value _value) -{ - if (m_scanner->currentToken() != _value) - fatalParserError( - string("Expected token ") + - string(Token::name(_value)) + - string(" got '") + - string(Token::name(m_scanner->currentToken())) + - string("'") - ); - m_scanner->next(); -} - -Token::Value Parser::expectAssignmentOperator() -{ - Token::Value op = m_scanner->currentToken(); - if (!Token::isAssignmentOp(op)) - fatalParserError( - string("Expected assignment operator, got '") + - string(Token::name(m_scanner->currentToken())) + - string("'") - ); - m_scanner->next(); - return op; -} - -ASTPointer Parser::expectIdentifierToken() -{ - if (m_scanner->currentToken() != Token::Identifier) - fatalParserError( - string("Expected identifier, got '") + - string(Token::name(m_scanner->currentToken())) + - string("'") - ); - return getLiteralAndAdvance(); -} - -ASTPointer Parser::getLiteralAndAdvance() -{ - ASTPointer identifier = make_shared(m_scanner->currentLiteral()); - m_scanner->next(); - return identifier; -} - ASTPointer Parser::createEmptyParameterList() { ASTNodeFactory nodeFactory(*this); @@ -1337,21 +1278,5 @@ ASTPointer Parser::createEmptyParameterList() return nodeFactory.createNode(vector>()); } -void Parser::parserError(string const& _description) -{ - auto err = make_shared(Error::Type::ParserError); - *err << - errinfo_sourceLocation(SourceLocation(position(), position(), sourceName())) << - errinfo_comment(_description); - - m_errors.push_back(err); -} - -void Parser::fatalParserError(string const& _description) -{ - parserError(_description); - BOOST_THROW_EXCEPTION(FatalError()); -} - } } diff --git a/libsolidity/parsing/Parser.h b/libsolidity/parsing/Parser.h index eb1aa587..9db3b3c4 100644 --- a/libsolidity/parsing/Parser.h +++ b/libsolidity/parsing/Parser.h @@ -22,7 +22,8 @@ #pragma once -#include "libsolidity/ast/AST.h" +#include +#include namespace dev { @@ -31,22 +32,16 @@ namespace solidity class Scanner; -class Parser +class Parser: public ParserBase { public: - Parser(ErrorList& errors): m_errors(errors){}; + Parser(ErrorList& _errors): ParserBase(_errors) {} ASTPointer parse(std::shared_ptr const& _scanner); - std::shared_ptr const& sourceName() const; private: class ASTNodeFactory; - /// Start position of the current token - int position() const; - /// End position of the current token - int endPosition() const; - struct VarDeclParserOptions { VarDeclParserOptions() {} @@ -139,29 +134,13 @@ private: std::vector> const& _path, std::vector, SourceLocation>> const& _indices ); - /// If current token value is not _value, throw exception otherwise advance token. - void expectToken(Token::Value _value); - Token::Value expectAssignmentOperator(); - ASTPointer expectIdentifierToken(); - ASTPointer getLiteralAndAdvance(); ///@} /// Creates an empty ParameterList at the current location (used if parameters can be omitted). ASTPointer createEmptyParameterList(); - /// Creates a @ref ParserError and annotates it with the current position and the - /// 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); - - std::shared_ptr m_scanner; /// 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; }; } diff --git a/libsolidity/parsing/ParserBase.cpp b/libsolidity/parsing/ParserBase.cpp new file mode 100644 index 00000000..64e42841 --- /dev/null +++ b/libsolidity/parsing/ParserBase.cpp @@ -0,0 +1,103 @@ +/* + This file is part of cpp-ethereum. + + 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. + + 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. + + You should have received a copy of the GNU General Public License + along with cpp-ethereum. If not, see . +*/ +/** + * @author Christian + * @date 2016 + * Solidity parser shared functionality. + */ + +#include +#include + +using namespace std; +using namespace dev; +using namespace dev::solidity; + +std::shared_ptr const& ParserBase::sourceName() const +{ + return m_scanner->sourceName(); +} + +int ParserBase::position() const +{ + return m_scanner->currentLocation().start; +} + +int ParserBase::endPosition() const +{ + return m_scanner->currentLocation().end; +} + +void ParserBase::expectToken(Token::Value _value) +{ + if (m_scanner->currentToken() != _value) + fatalParserError( + string("Expected token ") + + string(Token::name(_value)) + + string(" got '") + + string(Token::name(m_scanner->currentToken())) + + string("'") + ); + m_scanner->next(); +} + +Token::Value ParserBase::expectAssignmentOperator() +{ + Token::Value op = m_scanner->currentToken(); + if (!Token::isAssignmentOp(op)) + fatalParserError( + string("Expected assignment operator, got '") + + string(Token::name(m_scanner->currentToken())) + + string("'") + ); + m_scanner->next(); + return op; +} + +ASTPointer ParserBase::expectIdentifierToken() +{ + if (m_scanner->currentToken() != Token::Identifier) + fatalParserError( + string("Expected identifier, got '") + + string(Token::name(m_scanner->currentToken())) + + string("'") + ); + return getLiteralAndAdvance(); +} + +ASTPointer ParserBase::getLiteralAndAdvance() +{ + ASTPointer identifier = make_shared(m_scanner->currentLiteral()); + m_scanner->next(); + return identifier; +} + +void ParserBase::parserError(string const& _description) +{ + auto err = make_shared(Error::Type::ParserError); + *err << + errinfo_sourceLocation(SourceLocation(position(), position(), sourceName())) << + errinfo_comment(_description); + + m_errors.push_back(err); +} + +void ParserBase::fatalParserError(string const& _description) +{ + parserError(_description); + BOOST_THROW_EXCEPTION(FatalError()); +} diff --git a/libsolidity/parsing/ParserBase.h b/libsolidity/parsing/ParserBase.h new file mode 100644 index 00000000..f087a6a9 --- /dev/null +++ b/libsolidity/parsing/ParserBase.h @@ -0,0 +1,76 @@ +/* + This file is part of cpp-ethereum. + + 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. + + 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. + + You should have received a copy of the GNU General Public License + along with cpp-ethereum. If not, see . +*/ +/** + * @author Christian + * @date 2016 + * Solidity parser shared functionality. + */ + +#pragma once + +#include +#include +#include + +namespace dev +{ +namespace solidity +{ + +class Scanner; +template +using ASTPointer = std::shared_ptr; +using ASTString = std::string; // might be changed to a reference to the source + +class ParserBase +{ +public: + ParserBase(ErrorList& errors): m_errors(errors) {} + + std::shared_ptr const& sourceName() const; + +protected: + /// Start position of the current token + int position() const; + /// End position of the current token + int endPosition() const; + + + ///@{ + ///@name Helper functions + /// If current token value is not _value, throw exception otherwise advance token. + void expectToken(Token::Value _value); + Token::Value expectAssignmentOperator(); + ASTPointer expectIdentifierToken(); + ASTPointer getLiteralAndAdvance(); + ///@} + + /// Creates a @ref ParserError and annotates it with the current position and the + /// 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); + + std::shared_ptr m_scanner; + /// The reference to the list of errors and warning to add errors/warnings during parsing + ErrorList& m_errors; +}; + +} +} -- cgit