solidity/libyul/optimiser/NameDispenser.h

60 lines
1.7 KiB
C++

/*
This file is part of solidity.
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.
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.
You should have received a copy of the GNU General Public License
along with solidity. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* Optimiser component that can create new unique names.
*/
#pragma once
#include <libyul/ASTDataForward.h>
#include <set>
#include <string>
namespace dev
{
namespace yul
{
/**
* Optimizer component that can be used to generate new names that
* do not conflict with existing names.
*
* Tries to keep names short and appends decimals to disambiguate.
*/
class NameDispenser
{
public:
/// Initialize the name dispenser with all the names used in the given AST.
explicit NameDispenser(Block const& _ast);
/// Initialize the name dispenser with the given used names.
explicit NameDispenser(std::set<std::string> _usedNames);
/// @returns a currently unused name that should be similar to _nameHint
/// and prefixed by _context if present.
/// If the resulting name would be too long, trims the context at the end
/// and the name hint at the start.
std::string newName(std::string const& _nameHint, std::string const& _context = {});
private:
std::string newNameInternal(std::string const& _nameHint);
std::set<std::string> m_usedNames;
};
}
}