solidity/libsolidity/analysis/NameAndTypeResolver.h

192 lines
7.6 KiB
C
Raw Normal View History

2014-10-13 15:13:48 +00:00
/*
2019-02-13 15:56:46 +00:00
This file is part of solidity.
2014-10-13 15:13:48 +00:00
2019-02-13 15:56:46 +00:00
solidity 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
2019-02-13 15:56:46 +00:00
solidity 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
2019-02-13 15:56:46 +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
*/
// SPDX-License-Identifier: GPL-3.0
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
2015-10-20 22:21:52 +00:00
#include <libsolidity/analysis/DeclarationContainer.h>
#include <libsolidity/analysis/GlobalContext.h>
2015-10-20 22:21:52 +00:00
#include <libsolidity/analysis/ReferencesResolver.h>
#include <libsolidity/ast/ASTAnnotations.h>
2018-12-17 11:30:08 +00:00
#include <libsolidity/ast/ASTVisitor.h>
#include <liblangutil/EVMVersion.h>
2018-12-17 11:30:08 +00:00
#include <boost/noncopyable.hpp>
#include <list>
#include <map>
2014-10-13 13:07:21 +00:00
2019-12-11 16:31:36 +00:00
namespace solidity::langutil
{
class ErrorReporter;
}
2019-12-11 16:31:36 +00:00
namespace solidity::frontend
2014-10-16 12:08:54 +00:00
{
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(
GlobalContext& _globalContext,
langutil::EVMVersion _evmVersion,
langutil::ErrorReporter& _errorReporter
2017-01-31 21:59:56 +00:00
);
/// 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(SourceUnit& _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);
2020-06-11 15:17:07 +00:00
/// Resolves all names and types referenced from the given Source Node.
2015-10-15 14:27:26 +00:00
/// @returns false in case of error.
2020-06-11 15:17:07 +00:00
bool resolveNamesAndTypes(SourceUnit& _source);
/// 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);
2018-06-15 10:30:28 +00:00
/// Activates a previously inactive (invisible) variable. To be used in C99 scoping for
/// VariableDeclarationStatements.
void activateVariable(std::string const& _name);
/// 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.
2018-02-09 14:09:22 +00:00
/// SHOULD only be used for testing.
2015-12-05 02:09:47 +00:00
std::vector<Declaration const*> resolveName(ASTString const& _name, ASTNode const* _scope = nullptr) const;
2018-02-09 14:09:22 +00:00
/// Resolves a name in the "current" scope, but also searches parent scopes.
/// Should only be called during the initial resolving phase.
std::vector<Declaration const*> nameFromCurrentScope(ASTString const& _name, bool _includeInvisibles = false) const;
2018-02-09 14:09:22 +00:00
/// Resolves a path starting from the "current" scope, but also searches parent scopes.
/// Should only be called during the initial resolving phase.
2015-10-06 10:35:10 +00:00
/// @note Returns a null pointer if any component in the path was not unique or not found.
2018-02-09 14:09:22 +00:00
Declaration const* pathFromCurrentScope(std::vector<ASTString> const& _path) const;
2015-10-06 10:35:10 +00:00
/// Generate and store warnings about variables that are named like instructions.
void warnVariablesNamedLikeInstructions() const;
/// Generate and store warnings about declarations with the same name.
void warnHomonymDeclarations() const;
/// @returns a list of similar identifiers in the current and enclosing scopes. May return empty string if no suggestions.
std::string similarNameSuggestions(ASTString const& _name) const;
2018-02-09 15:53:25 +00:00
/// Sets the current scope.
void setScope(ASTNode const* _node);
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);
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.
2020-05-14 09:56:10 +00:00
std::map<ASTNode const*, std::shared_ptr<DeclarationContainer>> m_scopes;
2015-12-05 02:09:47 +00:00
langutil::EVMVersion m_evmVersion;
DeclarationContainer* m_currentScope = nullptr;
langutil::ErrorReporter& m_errorReporter;
GlobalContext& m_globalContext;
};
/**
* 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,
langutil::ErrorReporter& _errorReporter,
GlobalContext& _globalContext,
ASTNode const* _currentScope = nullptr
);
2017-02-02 11:39:12 +00:00
static bool registerDeclaration(
DeclarationContainer& _container,
Declaration const& _declaration,
std::string const* _name,
langutil::SourceLocation const* _errorLocation,
bool _inactive,
langutil::ErrorReporter& _errorReporter
2017-02-02 11:39:12 +00:00
);
private:
bool visit(SourceUnit& _sourceUnit) override;
void endVisit(SourceUnit& _sourceUnit) override;
bool visit(ImportDirective& _import) override;
2015-01-31 15:50:33 +00:00
bool visit(ContractDefinition& _contract) override;
void endVisit(ContractDefinition& _contract) override;
void endVisit(VariableDeclarationStatement& _variableDeclarationStatement) override;
bool visitNode(ASTNode& _node) override;
void endVisitNode(ASTNode& _node) override;
2014-10-13 13:07:21 +00:00
2018-02-09 15:53:25 +00:00
void enterNewSubScope(ASTNode& _subScope);
2014-10-13 13:07:21 +00:00
void closeCurrentScope();
void registerDeclaration(Declaration& _declaration);
2014-10-13 13:07:21 +00:00
static bool isOverloadedFunction(Declaration const& _declaration1, Declaration const& _declaration2);
/// @returns the canonical name of the current scope.
std::string currentCanonicalName() const;
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;
ContractDefinition const* m_currentContract = nullptr;
langutil::ErrorReporter& m_errorReporter;
GlobalContext& m_globalContext;
2014-10-13 13:07:21 +00:00
};
2014-10-16 12:08:54 +00:00
}