/*
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 .
*/
// SPDX-License-Identifier: GPL-3.0
/**
* Full assembly stack that can support EVM-assembly and Yul as input and EVM.
*/
#pragma once
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
namespace solidity::evmasm
{
class Assembly;
}
namespace solidity::langutil
{
class Scanner;
}
namespace solidity::yul
{
class AbstractAssembly;
struct MachineAssemblyObject
{
std::shared_ptr bytecode;
std::string assembly;
std::unique_ptr sourceMappings;
};
/*
* Full assembly stack that can support EVM-assembly and Yul as input and EVM as output.
*/
class YulStack: public langutil::CharStreamProvider
{
public:
enum class Language { Yul, Assembly, StrictAssembly };
enum class Machine { EVM };
YulStack():
YulStack(
langutil::EVMVersion{},
std::nullopt,
Language::Assembly,
solidity::frontend::OptimiserSettings::none(),
langutil::DebugInfoSelection::Default()
)
{}
YulStack(
langutil::EVMVersion _evmVersion,
std::optional _eofVersion,
Language _language,
solidity::frontend::OptimiserSettings _optimiserSettings,
langutil::DebugInfoSelection const& _debugInfoSelection
):
m_language(_language),
m_evmVersion(_evmVersion),
m_eofVersion(_eofVersion),
m_optimiserSettings(std::move(_optimiserSettings)),
m_debugInfoSelection(_debugInfoSelection),
m_errorReporter(m_errors)
{}
/// @returns the char stream used during parsing
langutil::CharStream const& charStream(std::string const& _sourceName) const override;
/// 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 optimizer suite. Can only be used with Yul or strict assembly.
/// If the settings (see constructor) disabled the optimizer, nothing is done here.
void optimize();
/// Run the assembly step (should only be called after parseAndAnalyze).
MachineAssemblyObject assemble(Machine _machine) const;
/// Run the assembly step (should only be called after parseAndAnalyze).
/// In addition to the value returned by @a assemble, returns
/// a second object that is the runtime code.
/// Only available for EVM.
std::pair
assembleWithDeployed(
std::optional _deployName = {}
) const;
/// Run the assembly step (should only be called after parseAndAnalyze).
/// Similar to @a assemblyWithDeployed, but returns EVM assembly objects.
/// Only available for EVM.
std::pair, std::shared_ptr>
assembleEVMWithDeployed(
std::optional _deployName = {}
) 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(
langutil::CharStreamProvider const* _soliditySourceProvider = nullptr
) const;
/// Return the parsed and analyzed object.
std::shared_ptr