path: root/libsolidity/interface/AssemblyStack.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/>.
*/
/**
 * Full assembly stack that can support EVM-assembly and Yul as input and EVM, EVM1.5 and
 * eWasm as output.
 */

#pragma once

#include <liblangutil/ErrorReporter.h>
#include <liblangutil/EVMVersion.h>

#include <libyul/YulObject.h>
#include <libyul/YulObjectParser.h>

#include <libevmasm/LinkerObject.h>

#include <string>
#include <memory>

namespace langutil
{
class Scanner;
}

namespace yul
{
struct AsmAnalysisInfo;
struct Block;
}

namespace dev
{
namespace solidity
{

struct MachineAssemblyObject
{
    std::shared_ptr<eth::LinkerObject> bytecode;
    std::string assembly;
};

/*
 * Full assembly stack that can support EVM-assembly and Yul as input and EVM, EVM1.5 and
 * eWasm as output.
 */
class AssemblyStack
{
public:
    enum class Language { Yul, Assembly, StrictAssembly };
    enum class Machine { EVM, EVM15, eWasm };

    explicit AssemblyStack(EVMVersion _evmVersion = EVMVersion(), Language _language = Language::Assembly):
        m_language(_language), m_evmVersion(_evmVersion), m_errorReporter(m_errors)
    {}

    /// @returns the scanner used during parsing
    langutil::Scanner const& scanner() const;

    /// Runs parsing and analysis steps, returns false if input cannot be assembled.
    /// Multiple calls overwrite the previous state.
    bool parseAndAnalyze(std::string const& _sourceName, std::string const& _source);

    /// Run the assembly step (should only be called after parseAndAnalyze).
    MachineAssemblyObject assemble(Machine _machine) const;

    /// @returns the errors generated during parsing, analysis (and potentially assembly).
    langutil::ErrorList const& errors() const { return m_errors; }

    /// Pretty-print the input after having parsed it.
    std::string print() const;

private:
    bool analyzeParsed();

    Language m_language = Language::Assembly;
    EVMVersion m_evmVersion;

    std::shared_ptr<langutil::Scanner> m_scanner;

    bool m_analysisSuccessful = false;
    std::shared_ptr<yul::YulObject> m_parserResult;
    langutil::ErrorList m_errors;
    langutil::ErrorReporter m_errorReporter;
};

}
}