solidity/libsolidity/ast/ASTPrinter.h

156 lines
6.2 KiB
C
Raw Normal View History

2014-10-13 15:13:48 +00:00
/*
This file is part of solidity.
2014-10-13 15:13:48 +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-13 15:13:48 +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-13 15:13:48 +00:00
2014-10-16 12:08:54 +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/>.
2014-10-13 15:13:48 +00:00
*/
/**
* @author Christian <c@ethdev.com>
* @date 2014
* Pretty-printer for the abstract syntax tree (the "pretty" is arguable), used for debugging.
*/
#pragma once
#include <ostream>
2015-10-20 22:21:52 +00:00
#include <libsolidity/ast/ASTVisitor.h>
#include <libsolidity/interface/GasEstimator.h>
2014-10-16 12:08:54 +00:00
namespace dev
{
namespace solidity
{
/**
* Pretty-printer for the abstract syntax tree (the "pretty" is arguable) for debugging purposes.
*/
class ASTPrinter: public ASTConstVisitor
{
public:
/// Create a printer for the given abstract syntax tree. If the source is specified,
/// the corresponding parts of the source are printed with each node.
2015-05-06 08:43:59 +00:00
ASTPrinter(
ASTNode const& _ast,
std::string const& _source = std::string(),
2015-05-22 08:48:54 +00:00
GasEstimator::ASTGasConsumption const& _gasCosts = GasEstimator::ASTGasConsumption()
2015-05-06 08:43:59 +00:00
);
/// Output the string representation of the AST to _stream.
void print(std::ostream& _stream);
2016-08-19 17:57:21 +00:00
bool visit(PragmaDirective const& _node) override;
bool visit(ImportDirective const& _node) override;
bool visit(ContractDefinition const& _node) override;
2015-01-28 10:28:22 +00:00
bool visit(InheritanceSpecifier const& _node) override;
bool visit(UsingForDirective const& _node) override;
bool visit(StructDefinition const& _node) override;
2015-02-09 17:08:56 +00:00
bool visit(EnumDefinition const& _node) override;
2015-02-13 16:34:46 +00:00
bool visit(EnumValue const& _node) override;
bool visit(ParameterList const& _node) override;
bool visit(FunctionDefinition const& _node) override;
bool visit(VariableDeclaration const& _node) override;
2015-01-21 10:16:18 +00:00
bool visit(ModifierDefinition const& _node) override;
bool visit(ModifierInvocation const& _node) override;
2015-01-29 13:35:28 +00:00
bool visit(EventDefinition const& _node) override;
bool visit(ElementaryTypeName const& _node) override;
bool visit(UserDefinedTypeName const& _node) override;
2016-09-27 19:37:32 +00:00
bool visit(FunctionTypeName const& _node) override;
bool visit(Mapping const& _node) override;
bool visit(ArrayTypeName const& _node) override;
2016-02-22 01:13:41 +00:00
bool visit(InlineAssembly const& _node) override;
bool visit(Block const& _node) override;
2015-01-21 10:16:18 +00:00
bool visit(PlaceholderStatement const& _node) override;
bool visit(IfStatement const& _node) override;
bool visit(WhileStatement const& _node) override;
bool visit(ForStatement const& _node) override;
bool visit(Continue const& _node) override;
bool visit(Break const& _node) override;
bool visit(Return const& _node) override;
2015-09-15 14:33:14 +00:00
bool visit(Throw const& _node) override;
2018-02-16 15:55:21 +00:00
bool visit(EmitStatement const& _node) override;
bool visit(VariableDeclarationStatement const& _node) override;
bool visit(ExpressionStatement const& _node) override;
bool visit(Conditional const& _node) override;
bool visit(Assignment const& _node) override;
2015-10-12 21:02:35 +00:00
bool visit(TupleExpression const& _node) override;
bool visit(UnaryOperation const& _node) override;
bool visit(BinaryOperation const& _node) override;
bool visit(FunctionCall const& _node) override;
2014-12-12 15:49:26 +00:00
bool visit(NewExpression const& _node) override;
bool visit(MemberAccess const& _node) override;
bool visit(IndexAccess const& _node) override;
bool visit(Identifier const& _node) override;
bool visit(ElementaryTypeNameExpression const& _node) override;
bool visit(Literal const& _node) override;
2016-08-19 17:57:21 +00:00
void endVisit(PragmaDirective const&) override;
void endVisit(ImportDirective const&) override;
void endVisit(ContractDefinition const&) override;
2015-01-28 10:28:22 +00:00
void endVisit(InheritanceSpecifier const&) override;
void endVisit(UsingForDirective const&) override;
void endVisit(StructDefinition const&) override;
2015-02-09 17:08:56 +00:00
void endVisit(EnumDefinition const&) override;
2015-02-13 16:34:46 +00:00
void endVisit(EnumValue const&) override;
void endVisit(ParameterList const&) override;
void endVisit(FunctionDefinition const&) override;
void endVisit(VariableDeclaration const&) override;
2015-01-21 10:16:18 +00:00
void endVisit(ModifierDefinition const&) override;
void endVisit(ModifierInvocation const&) override;
2015-01-29 13:35:28 +00:00
void endVisit(EventDefinition const&) override;
void endVisit(ElementaryTypeName const&) override;
void endVisit(UserDefinedTypeName const&) override;
2016-09-27 19:37:32 +00:00
void endVisit(FunctionTypeName const&) override;
void endVisit(Mapping const&) override;
void endVisit(ArrayTypeName const&) override;
2016-02-22 01:13:41 +00:00
void endVisit(InlineAssembly const&) override;
void endVisit(Block const&) override;
2015-01-21 10:16:18 +00:00
void endVisit(PlaceholderStatement const&) override;
void endVisit(IfStatement const&) override;
void endVisit(WhileStatement const&) override;
void endVisit(ForStatement const&) override;
void endVisit(Continue const&) override;
void endVisit(Break const&) override;
void endVisit(Return const&) override;
2015-09-15 14:33:14 +00:00
void endVisit(Throw const&) override;
2018-02-16 15:55:21 +00:00
void endVisit(EmitStatement const&) override;
void endVisit(VariableDeclarationStatement const&) override;
void endVisit(ExpressionStatement const&) override;
void endVisit(Conditional const&) override;
void endVisit(Assignment const&) override;
2015-10-12 21:02:35 +00:00
void endVisit(TupleExpression const&) override;
void endVisit(UnaryOperation const&) override;
void endVisit(BinaryOperation const&) override;
void endVisit(FunctionCall const&) override;
2014-12-12 15:49:26 +00:00
void endVisit(NewExpression const&) override;
void endVisit(MemberAccess const&) override;
void endVisit(IndexAccess const&) override;
void endVisit(Identifier const&) override;
void endVisit(ElementaryTypeNameExpression const&) override;
void endVisit(Literal const&) override;
private:
void printSourcePart(ASTNode const& _node);
2014-10-16 15:57:27 +00:00
void printType(Expression const& _expression);
2015-09-01 09:19:02 +00:00
std::string indentation() const;
void writeLine(std::string const& _line);
bool goDeeper() { m_indentation++; return true; }
2014-10-16 12:08:54 +00:00
int m_indentation;
std::string m_source;
ASTNode const* m_ast;
2015-05-22 08:48:54 +00:00
GasEstimator::ASTGasConsumption m_gasCosts;
2017-08-16 23:07:07 +00:00
std::ostream* m_ostream = nullptr;
};
2014-10-16 12:08:54 +00:00
}
}