path: root/libyul/optimiser/InlinableExpressionFunctionFinder.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/>.
*/
/**
 * Optimiser component that identifies functions to be inlined.
 */

#pragma once

#include <libyul/ASTDataForward.h>
#include <libyul/optimiser/ASTWalker.h>

#include <set>

namespace dev
{
namespace yul
{

/**
 * Optimiser component that finds functions that can be
 * inlined inside functional expressions, i.e. functions that
 *  - have a single return parameter r
 *  - have a body like r := <functional expression>
 *  - neither reference themselves nor r in the right hand side
 *
 * This component can only be used on sources with unique names.
 */
class InlinableExpressionFunctionFinder: public ASTWalker
{
public:

    std::map<YulString, FunctionDefinition const*> const& inlinableFunctions() const
    {
        return m_inlinableFunctions;
    }

    using ASTWalker::operator();
    virtual void operator()(Identifier const& _identifier) override;
    virtual void operator()(FunctionCall const& _funCall) override;
    virtual void operator()(FunctionDefinition const& _function) override;

private:
    void checkAllowed(YulString _name)
    {
        if (m_disallowedIdentifiers.count(_name))
            m_foundDisallowedIdentifier = true;
    }

    bool m_foundDisallowedIdentifier = false;
    std::set<YulString> m_disallowedIdentifiers;
    std::map<YulString, FunctionDefinition const*> m_inlinableFunctions;
};

}
}