2014-10-13 16:22:15 +00:00
|
|
|
/*
|
2019-02-13 15:56:46 +00:00
|
|
|
This file is part of solidity.
|
2014-10-13 16:22:15 +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 16:22:15 +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 16:22:15 +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 16:22:15 +00:00
|
|
|
*/
|
2020-07-17 14:54:12 +00:00
|
|
|
// SPDX-License-Identifier: GPL-3.0
|
2014-10-13 16:22:15 +00:00
|
|
|
/**
|
|
|
|
* @author Christian <c@ethdev.com>
|
|
|
|
* @date 2014
|
|
|
|
* Scope - object that holds declaration of names.
|
|
|
|
*/
|
|
|
|
|
2015-10-20 22:21:52 +00:00
|
|
|
#include <libsolidity/analysis/DeclarationContainer.h>
|
2018-12-17 11:30:08 +00:00
|
|
|
|
2015-10-20 22:21:52 +00:00
|
|
|
#include <libsolidity/ast/AST.h>
|
2020-01-06 10:52:23 +00:00
|
|
|
#include <libsolutil/StringUtils.h>
|
2014-10-13 16:22:15 +00:00
|
|
|
|
2021-02-08 04:50:58 +00:00
|
|
|
#include <range/v3/view/filter.hpp>
|
|
|
|
#include <range/v3/range/conversion.hpp>
|
|
|
|
|
2019-12-11 16:31:36 +00:00
|
|
|
using namespace solidity;
|
|
|
|
using namespace solidity::frontend;
|
2014-10-13 16:22:15 +00:00
|
|
|
|
2015-12-05 02:09:47 +00:00
|
|
|
Declaration const* DeclarationContainer::conflictingDeclaration(
|
|
|
|
Declaration const& _declaration,
|
|
|
|
ASTString const* _name
|
|
|
|
) const
|
2015-04-30 16:06:04 +00:00
|
|
|
{
|
2015-12-05 02:09:47 +00:00
|
|
|
if (!_name)
|
|
|
|
_name = &_declaration.name();
|
|
|
|
solAssert(!_name->empty(), "");
|
2023-08-14 08:37:11 +00:00
|
|
|
std::vector<Declaration const*> declarations;
|
2015-12-05 02:09:47 +00:00
|
|
|
if (m_declarations.count(*_name))
|
|
|
|
declarations += m_declarations.at(*_name);
|
|
|
|
if (m_invisibleDeclarations.count(*_name))
|
|
|
|
declarations += m_invisibleDeclarations.at(*_name);
|
2015-05-07 08:12:27 +00:00
|
|
|
|
2017-01-23 13:51:17 +00:00
|
|
|
if (
|
|
|
|
dynamic_cast<FunctionDefinition const*>(&_declaration) ||
|
2017-12-30 12:46:53 +00:00
|
|
|
dynamic_cast<EventDefinition const*>(&_declaration) ||
|
|
|
|
dynamic_cast<MagicVariableDeclaration const*>(&_declaration)
|
2017-01-23 13:51:17 +00:00
|
|
|
)
|
2015-04-30 16:06:04 +00:00
|
|
|
{
|
2018-07-16 15:00:47 +00:00
|
|
|
// check that all other declarations are of the same kind (in which
|
|
|
|
// case the type checker will ensure that the signatures are different)
|
2015-04-30 16:06:04 +00:00
|
|
|
for (Declaration const* declaration: declarations)
|
2016-12-02 15:24:53 +00:00
|
|
|
{
|
2017-01-23 13:51:17 +00:00
|
|
|
if (
|
2017-01-23 14:24:47 +00:00
|
|
|
dynamic_cast<FunctionDefinition const*>(&_declaration) &&
|
|
|
|
!dynamic_cast<FunctionDefinition const*>(declaration)
|
|
|
|
)
|
|
|
|
return declaration;
|
|
|
|
if (
|
|
|
|
dynamic_cast<EventDefinition const*>(&_declaration) &&
|
2017-01-23 13:51:17 +00:00
|
|
|
!dynamic_cast<EventDefinition const*>(declaration)
|
|
|
|
)
|
2016-10-18 12:52:27 +00:00
|
|
|
return declaration;
|
2017-12-30 12:46:53 +00:00
|
|
|
if (
|
|
|
|
dynamic_cast<MagicVariableDeclaration const*>(&_declaration) &&
|
|
|
|
!dynamic_cast<MagicVariableDeclaration const*>(declaration)
|
|
|
|
)
|
|
|
|
return declaration;
|
2016-10-20 08:47:15 +00:00
|
|
|
// Or, continue.
|
|
|
|
}
|
2016-10-18 12:52:27 +00:00
|
|
|
}
|
2016-01-11 12:55:58 +00:00
|
|
|
else if (declarations.size() == 1 && declarations.front() == &_declaration)
|
|
|
|
return nullptr;
|
2015-04-30 16:06:04 +00:00
|
|
|
else if (!declarations.empty())
|
|
|
|
return declarations.front();
|
|
|
|
|
|
|
|
return nullptr;
|
|
|
|
}
|
|
|
|
|
2018-02-15 10:30:32 +00:00
|
|
|
void DeclarationContainer::activateVariable(ASTString const& _name)
|
|
|
|
{
|
|
|
|
solAssert(
|
|
|
|
m_invisibleDeclarations.count(_name) && m_invisibleDeclarations.at(_name).size() == 1,
|
|
|
|
"Tried to activate a non-inactive variable or multiple inactive variables with the same name."
|
|
|
|
);
|
|
|
|
solAssert(m_declarations.count(_name) == 0 || m_declarations.at(_name).empty(), "");
|
|
|
|
m_declarations[_name].emplace_back(m_invisibleDeclarations.at(_name).front());
|
|
|
|
m_invisibleDeclarations.erase(_name);
|
|
|
|
}
|
|
|
|
|
2018-07-06 09:04:30 +00:00
|
|
|
bool DeclarationContainer::isInvisible(ASTString const& _name) const
|
|
|
|
{
|
|
|
|
return m_invisibleDeclarations.count(_name);
|
|
|
|
}
|
|
|
|
|
2015-12-05 02:09:47 +00:00
|
|
|
bool DeclarationContainer::registerDeclaration(
|
|
|
|
Declaration const& _declaration,
|
|
|
|
ASTString const* _name,
|
2020-10-07 22:41:04 +00:00
|
|
|
langutil::SourceLocation const* _location,
|
2015-12-05 02:09:47 +00:00
|
|
|
bool _invisible,
|
|
|
|
bool _update
|
|
|
|
)
|
2014-10-13 16:22:15 +00:00
|
|
|
{
|
2015-12-05 02:09:47 +00:00
|
|
|
if (!_name)
|
|
|
|
_name = &_declaration.name();
|
|
|
|
if (_name->empty())
|
2015-02-09 01:06:30 +00:00
|
|
|
return true;
|
|
|
|
|
2015-04-15 15:40:50 +00:00
|
|
|
if (_update)
|
|
|
|
{
|
|
|
|
solAssert(!dynamic_cast<FunctionDefinition const*>(&_declaration), "Attempt to update function definition.");
|
2015-12-05 02:09:47 +00:00
|
|
|
m_declarations.erase(*_name);
|
|
|
|
m_invisibleDeclarations.erase(*_name);
|
2015-04-15 15:40:50 +00:00
|
|
|
}
|
2020-10-07 22:41:04 +00:00
|
|
|
else
|
|
|
|
{
|
|
|
|
if (conflictingDeclaration(_declaration, _name))
|
|
|
|
return false;
|
|
|
|
|
2021-02-08 04:50:58 +00:00
|
|
|
if (m_enclosingContainer && _declaration.isVisibleAsUnqualifiedName())
|
2020-10-07 22:41:04 +00:00
|
|
|
m_homonymCandidates.emplace_back(*_name, _location ? _location : &_declaration.location());
|
|
|
|
}
|
2015-02-13 23:43:02 +00:00
|
|
|
|
2023-08-14 08:37:11 +00:00
|
|
|
std::vector<Declaration const*>& decls = _invisible ? m_invisibleDeclarations[*_name] : m_declarations[*_name];
|
2019-12-11 16:31:36 +00:00
|
|
|
if (!util::contains(decls, &_declaration))
|
2016-01-11 12:55:58 +00:00
|
|
|
decls.push_back(&_declaration);
|
2014-10-13 16:22:15 +00:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2020-10-07 22:41:04 +00:00
|
|
|
bool DeclarationContainer::registerDeclaration(
|
|
|
|
Declaration const& _declaration,
|
|
|
|
bool _invisible,
|
|
|
|
bool _update
|
|
|
|
)
|
|
|
|
{
|
|
|
|
return registerDeclaration(_declaration, nullptr, nullptr, _invisible, _update);
|
|
|
|
}
|
|
|
|
|
2023-08-14 08:37:11 +00:00
|
|
|
std::vector<Declaration const*> DeclarationContainer::resolveName(
|
2021-02-08 04:50:58 +00:00
|
|
|
ASTString const& _name,
|
2022-07-14 14:24:10 +00:00
|
|
|
ResolvingSettings _settings
|
2021-02-08 04:50:58 +00:00
|
|
|
) const
|
2014-10-13 16:22:15 +00:00
|
|
|
{
|
2015-02-09 01:06:30 +00:00
|
|
|
solAssert(!_name.empty(), "Attempt to resolve empty name.");
|
2023-08-14 08:37:11 +00:00
|
|
|
std::vector<Declaration const*> result;
|
2021-02-08 04:50:58 +00:00
|
|
|
|
2018-02-15 10:30:32 +00:00
|
|
|
if (m_declarations.count(_name))
|
2021-02-08 04:50:58 +00:00
|
|
|
{
|
2022-07-14 14:24:10 +00:00
|
|
|
if (_settings.onlyVisibleAsUnqualifiedNames)
|
2021-02-08 04:50:58 +00:00
|
|
|
result += m_declarations.at(_name) | ranges::views::filter(&Declaration::isVisibleAsUnqualifiedName) | ranges::to_vector;
|
|
|
|
else
|
|
|
|
result += m_declarations.at(_name);
|
|
|
|
}
|
|
|
|
|
2022-07-14 14:24:10 +00:00
|
|
|
if (_settings.alsoInvisible && m_invisibleDeclarations.count(_name))
|
2021-02-08 04:50:58 +00:00
|
|
|
{
|
2022-07-14 14:24:10 +00:00
|
|
|
if (_settings.onlyVisibleAsUnqualifiedNames)
|
2021-02-08 04:50:58 +00:00
|
|
|
result += m_invisibleDeclarations.at(_name) | ranges::views::filter(&Declaration::isVisibleAsUnqualifiedName) | ranges::to_vector;
|
|
|
|
else
|
|
|
|
result += m_invisibleDeclarations.at(_name);
|
|
|
|
}
|
|
|
|
|
2022-07-14 14:24:10 +00:00
|
|
|
if (result.empty() && _settings.recursive && m_enclosingContainer)
|
|
|
|
result = m_enclosingContainer->resolveName(_name, _settings);
|
2021-02-08 04:50:58 +00:00
|
|
|
|
2018-02-15 10:30:32 +00:00
|
|
|
return result;
|
2014-10-16 12:08:54 +00:00
|
|
|
}
|
2017-10-29 08:08:40 +00:00
|
|
|
|
2023-08-14 08:37:11 +00:00
|
|
|
std::vector<ASTString> DeclarationContainer::similarNames(ASTString const& _name) const
|
2017-10-29 08:08:40 +00:00
|
|
|
{
|
2018-10-11 21:21:49 +00:00
|
|
|
|
2018-08-10 10:31:19 +00:00
|
|
|
// because the function below has quadratic runtime - it will not magically improve once a better algorithm is discovered ;)
|
|
|
|
// since 80 is the suggested line length limit, we use 80^2 as length threshold
|
|
|
|
static size_t const MAXIMUM_LENGTH_THRESHOLD = 80 * 80;
|
2017-11-21 16:50:35 +00:00
|
|
|
|
2023-08-14 08:37:11 +00:00
|
|
|
std::vector<ASTString> similar;
|
2018-10-11 21:21:49 +00:00
|
|
|
size_t maximumEditDistance = _name.size() > 3 ? 2 : _name.size() / 2;
|
2017-10-29 08:08:40 +00:00
|
|
|
for (auto const& declaration: m_declarations)
|
|
|
|
{
|
2023-08-14 08:37:11 +00:00
|
|
|
std::string const& declarationName = declaration.first;
|
2019-12-11 16:31:36 +00:00
|
|
|
if (util::stringWithinDistance(_name, declarationName, maximumEditDistance, MAXIMUM_LENGTH_THRESHOLD))
|
2017-10-29 08:08:40 +00:00
|
|
|
similar.push_back(declarationName);
|
|
|
|
}
|
2018-02-15 10:30:32 +00:00
|
|
|
for (auto const& declaration: m_invisibleDeclarations)
|
|
|
|
{
|
2023-08-14 08:37:11 +00:00
|
|
|
std::string const& declarationName = declaration.first;
|
2019-12-11 16:31:36 +00:00
|
|
|
if (util::stringWithinDistance(_name, declarationName, maximumEditDistance, MAXIMUM_LENGTH_THRESHOLD))
|
2018-02-15 10:30:32 +00:00
|
|
|
similar.push_back(declarationName);
|
|
|
|
}
|
2017-10-29 08:08:40 +00:00
|
|
|
|
|
|
|
if (m_enclosingContainer)
|
2017-11-21 16:50:35 +00:00
|
|
|
similar += m_enclosingContainer->similarNames(_name);
|
2017-10-29 08:08:40 +00:00
|
|
|
|
|
|
|
return similar;
|
|
|
|
}
|
2020-10-07 22:41:04 +00:00
|
|
|
|
2023-08-14 08:37:11 +00:00
|
|
|
void DeclarationContainer::populateHomonyms(std::back_insert_iterator<Homonyms> _it) const
|
2020-10-07 22:41:04 +00:00
|
|
|
{
|
|
|
|
for (DeclarationContainer const* innerContainer: m_innerContainers)
|
|
|
|
innerContainer->populateHomonyms(_it);
|
|
|
|
|
|
|
|
for (auto [name, location]: m_homonymCandidates)
|
2020-10-08 01:59:06 +00:00
|
|
|
{
|
2022-07-14 14:24:10 +00:00
|
|
|
ResolvingSettings settings;
|
|
|
|
settings.recursive = true;
|
|
|
|
settings.alsoInvisible = true;
|
2023-08-14 08:37:11 +00:00
|
|
|
std::vector<Declaration const*> const& declarations = m_enclosingContainer->resolveName(name, std::move(settings));
|
2020-10-08 01:59:06 +00:00
|
|
|
if (!declarations.empty())
|
|
|
|
_it = make_pair(location, declarations);
|
|
|
|
}
|
2020-10-07 22:41:04 +00:00
|
|
|
}
|