solidity/NameAndTypeResolver.h

144 lines
5.3 KiB
C
Raw Normal View History

2014-10-13 15:13:48 +00:00
/*
2014-10-16 12:08:54 +00:00
This file is part of cpp-ethereum.
2014-10-13 15:13:48 +00:00
2014-10-16 12:08:54 +00:00
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.
2014-10-13 15:13:48 +00:00
2014-10-16 12:08:54 +00:00
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.
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 cpp-ethereum. If not, see <http://www.gnu.org/licenses/>.
2014-10-13 15:13:48 +00:00
*/
/**
* @author Christian <c@ethdev.com>
* @date 2014
* Parser part that determines the declarations corresponding to names and the types of expressions.
*/
2014-10-13 13:07:21 +00:00
#pragma once
#include <map>
#include <list>
2014-10-13 16:22:15 +00:00
#include <boost/noncopyable.hpp>
2014-12-01 14:22:45 +00:00
#include <libsolidity/DeclarationContainer.h>
2014-10-13 13:07:21 +00:00
#include <libsolidity/ASTVisitor.h>
2014-10-16 12:08:54 +00:00
namespace dev
{
namespace solidity
{
2014-10-13 13:07:21 +00:00
/**
* Resolves name references, types and checks types of all expressions.
* Specifically, it checks that all operations are valid for the inferred types.
* An exception is throw on the first error.
*/
2014-10-16 21:49:45 +00:00
class NameAndTypeResolver: private boost::noncopyable
2014-10-13 13:07:21 +00:00
{
public:
2014-12-06 01:32:51 +00:00
explicit NameAndTypeResolver(std::vector<Declaration const*> const& _globals);
/// Registers all declarations found in the source unit.
void registerDeclarations(SourceUnit& _sourceUnit);
/// Resolves all names and types referenced from the given contract.
2014-10-13 13:07:21 +00:00
void resolveNamesAndTypes(ContractDefinition& _contract);
/// Check all type requirements in the given contract.
void checkTypeRequirements(ContractDefinition& _contract);
/// Updates the given global declaration (used for "this"). Not to be used with declarations
/// that create their own scope.
2014-12-06 01:32:51 +00:00
void updateDeclaration(Declaration const& _declaration);
/// Resolves the given @a _name inside the scope @a _scope. If @a _scope is omitted,
/// the global scope is used (i.e. the one containing only the contract).
/// @returns a pointer to the declaration on success or nullptr on failure.
2014-12-06 01:32:51 +00:00
Declaration const* resolveName(ASTString const& _name, Declaration const* _scope = nullptr) const;
/// Resolves a name in the "current" scope. Should only be called during the initial
/// resolving phase.
2014-12-06 01:32:51 +00:00
Declaration const* getNameFromCurrentScope(ASTString const& _name, bool _recursive = true);
2014-10-20 14:28:24 +00:00
2014-10-13 13:07:21 +00:00
private:
void reset();
/// Imports all members declared directly in the given contract (i.e. does not import inherited
/// members) into the current scope if they are not present already.
void importInheritedScope(ContractDefinition const& _base);
/// Computes "C3-Linearization" of base contracts and stores it inside the contract.
void linearizeBaseContracts(ContractDefinition& _contract) const;
/// Computes the C3-merge of the given list of lists of bases.
/// @returns the linearized vector or an empty vector if linearization is not possible.
template <class _T>
static std::vector<_T const*> cThreeMerge(std::list<std::list<_T const*>>& _toMerge);
2014-11-13 00:12:57 +00:00
/// Maps nodes declaring a scope to scopes, i.e. ContractDefinition and FunctionDeclaration,
/// where nullptr denotes the global scope. Note that structs are not scope since they do
/// not contain code.
2014-12-01 14:22:45 +00:00
std::map<ASTNode const*, DeclarationContainer> m_scopes;
2014-10-13 13:07:21 +00:00
DeclarationContainer* m_currentScope = nullptr;
};
/**
* Traverses the given AST upon construction and fills _scopes with all declarations inside the
* AST.
*/
2014-10-16 21:49:45 +00:00
class DeclarationRegistrationHelper: private ASTVisitor
{
public:
2014-12-01 14:22:45 +00:00
DeclarationRegistrationHelper(std::map<ASTNode const*, DeclarationContainer>& _scopes, ASTNode& _astRoot);
private:
bool visit(ContractDefinition& _contract);
void endVisit(ContractDefinition& _contract);
bool visit(StructDefinition& _struct);
void endVisit(StructDefinition& _struct);
bool visit(FunctionDefinition& _function);
void endVisit(FunctionDefinition& _function);
bool visit(ModifierDefinition& _modifier);
void endVisit(ModifierDefinition& _modifier);
void endVisit(VariableDefinition& _variableDefinition);
bool visit(VariableDeclaration& _declaration);
2014-10-13 13:07:21 +00:00
2014-12-06 01:32:51 +00:00
void enterNewSubScope(Declaration const& _declaration);
2014-10-13 13:07:21 +00:00
void closeCurrentScope();
void registerDeclaration(Declaration& _declaration, bool _opensScope);
2014-10-13 13:07:21 +00:00
2014-12-01 14:22:45 +00:00
std::map<ASTNode const*, DeclarationContainer>& m_scopes;
2014-12-06 01:32:51 +00:00
Declaration const* m_currentScope;
VariableScope* m_currentFunction;
2014-10-13 13:07:21 +00:00
};
/**
* Resolves references to declarations (of variables and types) and also establishes the link
* between a return statement and the return parameter list.
*/
2014-10-16 21:49:45 +00:00
class ReferencesResolver: private ASTVisitor
{
public:
2014-11-13 00:12:57 +00:00
ReferencesResolver(ASTNode& _root, NameAndTypeResolver& _resolver,
2015-01-19 18:18:34 +00:00
ContractDefinition const* _currentContract,
ParameterList const* _returnParameters,
bool _allowLazyTypes = true);
2014-10-20 14:28:24 +00:00
private:
virtual void endVisit(VariableDeclaration& _variable) override;
virtual bool visit(Identifier& _identifier) override;
virtual bool visit(UserDefinedTypeName& _typeName) override;
virtual bool visit(Mapping&) override;
virtual bool visit(Return& _return) override;
2014-10-20 14:28:24 +00:00
NameAndTypeResolver& m_resolver;
2015-01-19 18:18:34 +00:00
ContractDefinition const* m_currentContract;
ParameterList const* m_returnParameters;
2014-11-13 00:12:57 +00:00
bool m_allowLazyTypes;
};
2014-10-16 12:08:54 +00:00
}
}