solidity/libsolidity/analysis/DeclarationContainer.h

81 lines
3.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
* Scope - object that holds declaration of names.
*/
2014-10-13 13:07:21 +00:00
#pragma once
#include <map>
2015-02-13 23:43:02 +00:00
#include <set>
2014-10-13 16:22:15 +00:00
#include <boost/noncopyable.hpp>
2015-10-20 22:21:52 +00:00
#include <libsolidity/ast/ASTForward.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
/**
* Container that stores mappings between names and declarations. It also contains a link to the
* enclosing scope.
*/
2014-12-01 14:22:45 +00:00
class DeclarationContainer
2014-10-13 13:07:21 +00:00
{
public:
explicit DeclarationContainer(
2015-12-05 02:09:47 +00:00
ASTNode const* _enclosingNode = nullptr,
DeclarationContainer const* _enclosingContainer = nullptr
):
2015-12-05 02:09:47 +00:00
m_enclosingNode(_enclosingNode), m_enclosingContainer(_enclosingContainer) {}
/// Registers the declaration in the scope unless its name is already declared or the name is empty.
2015-12-05 02:09:47 +00:00
/// @param _name the name to register, if nullptr the intrinsic name of @a _declaration is used.
2015-02-13 23:43:02 +00:00
/// @param _invisible if true, registers the declaration, reports name clashes but does not return it in @a resolveName
/// @param _update if true, replaces a potential declaration that is already present
/// @returns false if the name was already declared.
2015-12-05 02:09:47 +00:00
bool registerDeclaration(Declaration const& _declaration, ASTString const* _name = nullptr, bool _invisible = false, bool _update = false);
std::vector<Declaration const*> resolveName(ASTString const& _name, bool _recursive = false, bool _alsoInvisible = false) const;
2015-12-05 02:09:47 +00:00
ASTNode const* enclosingNode() const { return m_enclosingNode; }
DeclarationContainer const* enclosingContainer() const { return m_enclosingContainer; }
2015-08-31 16:44:29 +00:00
std::map<ASTString, std::vector<Declaration const*>> const& declarations() const { return m_declarations; }
2015-05-04 13:46:46 +00:00
/// @returns whether declaration is valid, and if not also returns previous declaration.
2015-12-05 02:09:47 +00:00
Declaration const* conflictingDeclaration(Declaration const& _declaration, ASTString const* _name = nullptr) const;
2014-10-13 13:07:21 +00:00
2018-06-15 10:30:28 +00:00
/// Activates a previously inactive (invisible) variable. To be used in C99 scoping for
/// VariableDeclarationStatements.
void activateVariable(ASTString const& _name);
/// @returns true if declaration is currently invisible.
bool isInvisible(ASTString const& _name) const;
/// @returns existing declaration names similar to @a _name.
2018-02-09 16:45:45 +00:00
/// Searches this and all parent containers.
std::vector<ASTString> similarNames(ASTString const& _name) const;
2014-10-13 13:07:21 +00:00
private:
2015-12-05 02:09:47 +00:00
ASTNode const* m_enclosingNode;
2014-12-06 01:32:51 +00:00
DeclarationContainer const* m_enclosingContainer;
std::map<ASTString, std::vector<Declaration const*>> m_declarations;
std::map<ASTString, std::vector<Declaration const*>> m_invisibleDeclarations;
2014-10-13 13:07:21 +00:00
};
2014-10-16 12:08:54 +00:00
}
}