solidity/libsolidity/formal/Why3Translator.h

148 lines
5.2 KiB
C
Raw Normal View History

2015-10-21 14:43:31 +00:00
/*
This file is part of solidity.
2015-10-21 14:43:31 +00:00
solidity is free software: you can redistribute it and/or modify
2015-10-21 14:43:31 +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.
solidity is distributed in the hope that it will be useful,
2015-10-21 14:43:31 +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.
You should have received a copy of the GNU General Public License
along with solidity. If not, see <http://www.gnu.org/licenses/>.
2015-10-21 14:43:31 +00:00
*/
/**
* @author Christian <c@ethdev.com>
* @date 2015
* Component that translates Solidity code into the why3 programming language.
*/
#pragma once
#include <libsolidity/ast/ASTVisitor.h>
#include <libsolidity/interface/ErrorReporter.h>
2015-10-21 14:43:31 +00:00
#include <string>
namespace dev
{
namespace solidity
{
class SourceUnit;
/**
* Simple translator from Solidity to Why3.
*
* @todo detect side effects in sub-expressions and limit them to one per statement. #1043
2015-10-21 14:43:31 +00:00
* @todo `x = y = z`
* @todo implicit and explicit type conversion
*/
class Why3Translator: private ASTConstVisitor
{
public:
Why3Translator(ErrorReporter& _errorReporter): m_lines(std::vector<Line>{{std::string(), 0}}), m_errorReporter(_errorReporter) {}
2015-10-21 14:43:31 +00:00
/// Appends formalisation of the given source unit to the output.
/// @returns false on error.
bool process(SourceUnit const& _source);
std::string translation() const;
2015-10-21 14:43:31 +00:00
private:
/// Appends imports and constants use throughout the formal code.
void appendPreface();
/// @returns a string representation of the corresponding formal type or throws NoFormalType exception.
2015-10-21 14:43:31 +00:00
std::string toFormalType(Type const& _type) const;
using errinfo_noFormalTypeFrom = boost::error_info<struct tag_noFormalTypeFrom, std::string /* name of the type that cannot be translated */ >;
struct NoFormalType: virtual Exception {};
2015-10-21 14:43:31 +00:00
void error(ASTNode const& _source, std::string const& _description);
void fatalError(ASTNode const& _source, std::string const& _description);
void indent() { newLine(); m_lines.back().indentation++; }
2015-10-21 14:43:31 +00:00
void unindent();
void addLine(std::string const& _line);
void add(std::string const& _str);
void newLine();
void appendSemicolon();
2015-10-21 14:43:31 +00:00
virtual bool visit(SourceUnit const&) override { return true; }
virtual bool visit(ContractDefinition const& _contract) override;
2015-11-16 19:35:54 +00:00
virtual void endVisit(ContractDefinition const& _contract) override;
2015-10-21 14:43:31 +00:00
virtual bool visit(FunctionDefinition const& _function) override;
virtual void endVisit(FunctionDefinition const& _function) override;
2015-10-21 14:43:31 +00:00
virtual bool visit(Block const&) override;
virtual bool visit(IfStatement const& _node) override;
virtual bool visit(WhileStatement const& _node) override;
virtual bool visit(Return const& _node) override;
2016-07-13 09:16:00 +00:00
virtual bool visit(Throw const& _node) override;
2015-10-21 14:43:31 +00:00
virtual bool visit(VariableDeclarationStatement const& _node) override;
virtual bool visit(ExpressionStatement const&) override;
virtual bool visit(Assignment const& _node) override;
virtual bool visit(TupleExpression const& _node) override;
virtual void endVisit(TupleExpression const&) override { add(")"); }
virtual bool visit(UnaryOperation const& _node) override;
virtual bool visit(BinaryOperation const& _node) override;
virtual bool visit(FunctionCall const& _node) override;
virtual bool visit(MemberAccess const& _node) override;
virtual bool visit(IndexAccess const& _node) override;
virtual bool visit(Identifier const& _node) override;
virtual bool visit(Literal const& _node) override;
virtual bool visit(PragmaDirective const& _node) override;
2015-10-21 14:43:31 +00:00
virtual bool visitNode(ASTNode const& _node) override
{
m_errorReporter.why3TranslatorError(_node, "Code not supported for formal verification.");
2015-10-21 14:43:31 +00:00
return false;
}
2015-11-16 19:35:54 +00:00
bool isStateVariable(VariableDeclaration const* _var) const;
bool isStateVariable(std::string const& _name) const;
bool isLocalVariable(VariableDeclaration const* _var) const;
bool isLocalVariable(std::string const& _name) const;
2015-11-16 19:35:54 +00:00
2016-07-13 09:16:00 +00:00
/// @returns a string representing an expression that is a copy of this.storage
std::string copyOfStorage() const;
2016-09-07 11:54:57 +00:00
/// Visits the given statement and indents it unless it is a block
2015-11-11 14:20:53 +00:00
/// (which does its own indentation).
void visitIndentedUnlessBlock(Statement const& _statement);
2015-10-21 14:43:31 +00:00
void addSourceFromDocStrings(DocumentedAnnotation const& _annotation);
/// Transforms substring like `#varName` and `#stateVarName` to code that evaluates to their value.
std::string transformVariableReferences(std::string const& _annotation);
2015-10-21 14:43:31 +00:00
/// True if we have already seen a contract. For now, only a single contract
/// is supported.
bool m_seenContract = false;
bool m_errorOccured = false;
2015-11-16 19:35:54 +00:00
2016-07-13 09:16:00 +00:00
/// Metadata relating to the current contract
struct ContractMetadata
{
ContractDefinition const* contract = nullptr;
std::vector<VariableDeclaration const*> stateVariables;
void reset() { contract = nullptr; stateVariables.clear(); }
};
ContractMetadata m_currentContract;
bool m_currentLValueIsRef = false;
std::map<std::string, VariableDeclaration const*> m_localVariables;
2015-11-16 19:35:54 +00:00
struct Line
{
std::string contents;
unsigned indentation;
};
std::vector<Line> m_lines;
ErrorReporter& m_errorReporter;
2015-10-21 14:43:31 +00:00
};
}
}