solidity/libsolidity/formal/VariableUsage.h

66 lines
2.6 KiB
C
Raw Normal View History

2017-09-28 13:24:24 +00:00
/*
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/>.
*/
// SPDX-License-Identifier: GPL-3.0
2017-09-28 13:24:24 +00:00
#pragma once
2019-04-01 09:10:28 +00:00
#include <libsolidity/ast/ASTVisitor.h>
2017-09-28 13:24:24 +00:00
#include <vector>
2019-04-01 09:10:28 +00:00
#include <set>
2017-09-28 13:24:24 +00:00
2019-12-11 16:31:36 +00:00
namespace solidity::frontend::smt
{
2017-09-28 13:24:24 +00:00
/**
2019-04-01 09:10:28 +00:00
* This class computes information about which variables are modified in a certain subtree.
2017-09-28 13:24:24 +00:00
*/
2019-04-01 09:10:28 +00:00
class VariableUsage: private ASTConstVisitor
2017-09-28 13:24:24 +00:00
{
public:
2019-04-01 09:10:28 +00:00
/// @param _outerCallstack the current callstack in the callers context.
std::set<VariableDeclaration const*> touchedVariables(ASTNode const& _node, std::vector<CallableDeclaration const*> const& _outerCallstack);
2017-09-28 13:24:24 +00:00
/// Sets whether to inline function calls.
2021-01-25 17:17:56 +00:00
void setFunctionInlining(std::function<bool(FunctionCall const&, ContractDefinition const*, ContractDefinition const*)> _inlineFunctionCalls) { m_inlineFunctionCalls = _inlineFunctionCalls; }
void setCurrentContract(ContractDefinition const& _contract) { m_currentContract = &_contract; }
2021-01-25 17:17:56 +00:00
void setCurrentFunction(FunctionDefinition const& _function) { m_currentFunction = &_function; }
2017-09-28 13:24:24 +00:00
private:
2019-04-01 09:10:28 +00:00
void endVisit(Identifier const& _node) override;
void endVisit(IndexAccess const& _node) override;
2019-04-01 09:10:28 +00:00
void endVisit(FunctionCall const& _node) override;
bool visit(FunctionDefinition const& _node) override;
void endVisit(FunctionDefinition const& _node) override;
void endVisit(ModifierInvocation const& _node) override;
void endVisit(PlaceholderStatement const& _node) override;
/// Checks whether an identifier should be added to touchedVariables.
void checkIdentifier(Identifier const& _identifier);
2019-04-01 09:10:28 +00:00
std::set<VariableDeclaration const*> m_touchedVariables;
std::vector<CallableDeclaration const*> m_callStack;
CallableDeclaration const* m_lastCall = nullptr;
ContractDefinition const* m_currentContract = nullptr;
2021-01-25 17:17:56 +00:00
FunctionDefinition const* m_currentFunction = nullptr;
2021-01-25 17:17:56 +00:00
std::function<bool(FunctionCall const&, ContractDefinition const*, ContractDefinition const*)> m_inlineFunctionCalls = [](FunctionCall const&, ContractDefinition const*, ContractDefinition const*) { return false; };
2017-09-28 13:24:24 +00:00
};
}