solidity/libsolidity/analysis/NameAndTypeResolver.h

199 lines
8.6 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
* 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>
2015-10-20 22:21:52 +00:00
#include <libsolidity/analysis/DeclarationContainer.h>
#include <libsolidity/analysis/ReferencesResolver.h>
#include <libsolidity/ast/ASTVisitor.h>
#include <libsolidity/ast/ASTAnnotations.h>
2014-10-13 13:07:21 +00:00
2014-10-16 12:08:54 +00:00
namespace dev
{
namespace solidity
{
2014-10-13 13:07:21 +00:00
/**
2015-10-06 10:35:10 +00:00
* Resolves name references, typenames and sets the (explicitly given) types for all variable
* declarations.
*/
2014-10-16 21:49:45 +00:00
class NameAndTypeResolver: private boost::noncopyable
2014-10-13 13:07:21 +00:00
{
public:
2017-02-14 12:32:48 +00:00
/// Creates the resolver with the given declarations added to the global scope.
/// @param _scopes mapping of scopes to be used (usually default constructed), these
/// are filled during the lifetime of this object.
2017-01-31 21:59:56 +00:00
NameAndTypeResolver(
std::vector<Declaration const*> const& _globals,
std::map<ASTNode const*, std::shared_ptr<DeclarationContainer>>& _scopes,
ErrorList& _errors
);
/// Registers all declarations found in the AST node, usually a source unit.
2015-10-15 14:27:26 +00:00
/// @returns false in case of error.
/// @param _currentScope should be nullptr but can be used to inject new declarations into
/// existing scopes, used by the snippets feature.
bool registerDeclarations(ASTNode& _sourceUnit, ASTNode const* _currentScope = nullptr);
2015-12-05 02:09:47 +00:00
/// Applies the effect of import directives.
bool performImports(SourceUnit& _sourceUnit, std::map<std::string, SourceUnit const*> const& _sourceUnits);
/// Resolves all names and types referenced from the given AST Node.
/// This is usually only called at the contract level, but with a bit of care, it can also
/// be called at deeper levels.
2017-02-14 12:32:48 +00:00
/// @param _resolveInsideCode if false, does not descend into nodes that contain code.
2015-10-15 14:27:26 +00:00
/// @returns false in case of error.
bool resolveNamesAndTypes(ASTNode& _node, bool _resolveInsideCode = true);
/// Updates the given global declaration (used for "this"). Not to be used with declarations
/// that create their own scope.
2015-10-15 14:27:26 +00:00
/// @returns false in case of error.
bool updateDeclaration(Declaration const& _declaration);
/// Resolves the given @a _name inside the scope @a _scope. If @a _scope is omitted,
2015-12-05 02:09:47 +00:00
/// the global scope is used (i.e. the one containing only the pre-defined global variables).
/// @returns a pointer to the declaration on success or nullptr on failure.
2015-12-05 02:09:47 +00:00
std::vector<Declaration const*> resolveName(ASTString const& _name, ASTNode const* _scope = nullptr) const;
/// Resolves a name in the "current" scope. Should only be called during the initial
/// resolving phase.
2015-10-06 12:43:09 +00:00
std::vector<Declaration const*> nameFromCurrentScope(ASTString const& _name, bool _recursive = true) const;
2015-10-06 10:35:10 +00:00
/// Resolves a path starting from the "current" scope. Should only be called during the initial
/// resolving phase.
/// @note Returns a null pointer if any component in the path was not unique or not found.
2015-10-06 12:43:09 +00:00
Declaration const* pathFromCurrentScope(std::vector<ASTString> const& _path, bool _recursive = true) const;
2015-10-06 10:35:10 +00:00
2015-05-08 14:07:25 +00:00
/// returns the vector of declarations without repetitions
std::vector<Declaration const*> cleanedDeclarations(
2015-05-08 14:07:25 +00:00
Identifier const& _identifier,
std::vector<Declaration const*> const& _declarations
);
2014-10-20 14:28:24 +00:00
2014-10-13 13:07:21 +00:00
private:
2017-02-16 11:36:43 +00:00
/// Internal version of @a resolveNamesAndTypes (called from there) throws exceptions on fatal errors.
bool resolveNamesAndTypesInternal(ASTNode& _node, bool _resolveInsideCode = true);
/// 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. Reports errors if any
void linearizeBaseContracts(ContractDefinition& _contract);
/// 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);
// creates the Declaration error and adds it in the errors list
void reportDeclarationError(
SourceLocation _sourceLoction,
std::string const& _description,
SourceLocation _secondarySourceLocation,
std::string const& _secondaryDescription
);
2015-10-15 14:08:02 +00:00
// creates the Declaration error and adds it in the errors list
2015-10-15 14:13:52 +00:00
void reportDeclarationError(SourceLocation _sourceLocation, std::string const& _description);
// creates the Declaration error and adds it in the errors list and throws FatalError
2015-10-15 14:13:52 +00:00
void reportFatalDeclarationError(SourceLocation _sourceLocation, std::string const& _description);
// creates the Declaration error and adds it in the errors list
2015-10-15 14:51:01 +00:00
void reportTypeError(Error const& _e);
// creates the Declaration error and adds it in the errors list and throws FatalError
2015-10-15 14:59:38 +00:00
void reportFatalTypeError(Error const& _e);
2015-12-05 02:09:47 +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.
2015-12-15 14:46:03 +00:00
/// Aliases (for example `import "x" as y;`) create multiple pointers to the same scope.
2017-01-31 21:59:56 +00:00
std::map<ASTNode const*, std::shared_ptr<DeclarationContainer>>& m_scopes;
2015-12-05 02:09:47 +00:00
DeclarationContainer* m_currentScope = nullptr;
ErrorList& m_errors;
};
/**
* 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:
/// Registers declarations in their scopes and creates new scopes as a side-effect
/// of construction.
/// @param _currentScope should be nullptr if we start at SourceUnit, but can be different
/// to inject new declarations into an existing scope, used by snippets.
DeclarationRegistrationHelper(
2015-12-15 14:46:03 +00:00
std::map<ASTNode const*, std::shared_ptr<DeclarationContainer>>& _scopes,
ASTNode& _astRoot,
ErrorList& _errors,
ASTNode const* _currentScope = nullptr
);
private:
bool visit(SourceUnit& _sourceUnit) override;
void endVisit(SourceUnit& _sourceUnit) override;
2015-12-15 14:46:03 +00:00
bool visit(ImportDirective& _declaration) override;
2015-01-31 15:50:33 +00:00
bool visit(ContractDefinition& _contract) override;
void endVisit(ContractDefinition& _contract) override;
bool visit(StructDefinition& _struct) override;
void endVisit(StructDefinition& _struct) override;
bool visit(EnumDefinition& _enum) override;
void endVisit(EnumDefinition& _enum) override;
2015-02-14 02:06:50 +00:00
bool visit(EnumValue& _value) override;
2015-01-31 15:50:33 +00:00
bool visit(FunctionDefinition& _function) override;
void endVisit(FunctionDefinition& _function) override;
bool visit(ModifierDefinition& _modifier) override;
void endVisit(ModifierDefinition& _modifier) override;
void endVisit(VariableDeclarationStatement& _variableDeclarationStatement) override;
2015-01-31 15:50:33 +00:00
bool visit(VariableDeclaration& _declaration) override;
bool visit(EventDefinition& _event) override;
void endVisit(EventDefinition& _event) override;
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
/// @returns the canonical name of the current scope.
std::string currentCanonicalName() const;
// creates the Declaration error and adds it in the errors list
void declarationError(
2015-10-15 14:13:52 +00:00
SourceLocation _sourceLocation,
std::string const& _description,
SourceLocation _secondarySourceLocation,
std::string const& _secondaryDescription
);
2015-10-15 14:08:02 +00:00
// creates the Declaration error and adds it in the errors list
2015-10-15 14:13:52 +00:00
void declarationError(SourceLocation _sourceLocation, std::string const& _description);
// creates the Declaration error and adds it in the errors list and throws FatalError
2015-10-15 14:13:52 +00:00
void fatalDeclarationError(SourceLocation _sourceLocation, std::string const& _description);
2015-12-15 14:46:03 +00:00
std::map<ASTNode const*, std::shared_ptr<DeclarationContainer>>& m_scopes;
2015-12-05 02:09:47 +00:00
ASTNode const* m_currentScope = nullptr;
2015-11-22 19:39:10 +00:00
VariableScope* m_currentFunction = nullptr;
ErrorList& m_errors;
2014-10-13 13:07:21 +00:00
};
2014-10-16 12:08:54 +00:00
}
}