path: root/libyul/AsmScopeFiller.h

/*
    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/>.
*/
/**
 * Module responsible for registering identifiers inside their scopes.
 */

#pragma once

#include <libyul/AsmDataForward.h>

#include <boost/variant.hpp>

#include <functional>
#include <memory>

namespace langutil
{
class ErrorReporter;
struct SourceLocation;
}

namespace yul
{

struct TypedName;
struct Scope;
struct AsmAnalysisInfo;

/**
 * Fills scopes with identifiers and checks for name clashes.
 * Does not resolve references.
 */
class ScopeFiller: public boost::static_visitor<bool>
{
public:
    ScopeFiller(AsmAnalysisInfo& _info, langutil::ErrorReporter& _errorReporter);

    bool operator()(Instruction const&) { return true; }
    bool operator()(Literal const&) { return true; }
    bool operator()(Identifier const&) { return true; }
    bool operator()(FunctionalInstruction const&) { return true; }
    bool operator()(ExpressionStatement const& _expr);
    bool operator()(Label const& _label);
    bool operator()(StackAssignment const&) { return true; }
    bool operator()(Assignment const&) { return true; }
    bool operator()(VariableDeclaration const& _variableDeclaration);
    bool operator()(FunctionDefinition const& _functionDefinition);
    bool operator()(FunctionCall const&) { return true; }
    bool operator()(If const& _if);
    bool operator()(Switch const& _switch);
    bool operator()(ForLoop const& _forLoop);
    bool operator()(Block const& _block);

private:
    bool registerVariable(
        TypedName const& _name,
        langutil::SourceLocation const& _location,
        Scope& _scope
    );

    Scope& scope(Block const* _block);

    Scope* m_currentScope = nullptr;
    AsmAnalysisInfo& m_info;
    langutil::ErrorReporter& m_errorReporter;
};

}