/* 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 /** * @author Lefteris * @date 2014 * Solidity command line interface. */ #pragma once #include #include #include #include #include #include #include #include #include #include namespace solidity::frontend { class CommandLineInterface { public: explicit CommandLineInterface( std::istream& _sin, std::ostream& _sout, std::ostream& _serr, CommandLineOptions const& _options = CommandLineOptions{} ): m_sin(_sin), m_sout(_sout), m_serr(_serr), m_options(_options) {} /// Parses command-line arguments, executes the requested operation and handles validation and /// execution errors. /// @returns false if it catches a @p CommandLineValidationError or if the application is /// expected to exit with a non-zero exit code despite there being no error. bool run(int _argc, char const* const* _argv); /// Parses command line arguments and stores the result in @p m_options. /// @throws CommandLineValidationError if command-line arguments are invalid. /// @returns false if the application is expected to exit with a non-zero exit code despite /// there being no error. bool parseArguments(int _argc, char const* const* _argv); /// Reads the content of all input files and initializes the file reader. /// @throws CommandLineValidationError if it fails to read the input files (invalid paths, /// non-existent files, not enough or too many input files, etc.). void readInputFiles(); /// Executes the requested operation (compilation, assembling, standard JSON, etc.) and prints /// results to the terminal. /// @throws CommandLineExecutionError if execution fails due to errors in the input files. /// @throws CommandLineOutputError if creating output files or writing to them fails. void processInput(); CommandLineOptions const& options() const { return m_options; } FileReader const& fileReader() const { return m_fileReader; } std::optional const& standardJsonInput() const { return m_standardJsonInput; } private: void printVersion(); void printLicense(); void compile(); void serveLSP(); void link(); void writeLinkedFiles(); /// @returns the ``// -> name`` hint for library placeholders. static std::string libraryPlaceholderHint(std::string const& _libraryName); /// @returns the full object with library placeholder hints in hex. static std::string objectWithLinkRefsHex(evmasm::LinkerObject const& _obj); void assembleYul(yul::YulStack::Language _language, yul::YulStack::Machine _targetMachine); void outputCompilationResults(); void handleCombinedJSON(); void handleAst(); void handleBinary(std::string const& _contract); void handleOpcode(std::string const& _contract); void handleIR(std::string const& _contract); void handleIRAst(std::string const& _contract); void handleIROptimized(std::string const& _contract); void handleIROptimizedAst(std::string const& _contract); void handleBytecode(std::string const& _contract); void handleSignatureHashes(std::string const& _contract); void handleMetadata(std::string const& _contract); void handleABI(std::string const& _contract); void handleNatspec(bool _natspecDev, std::string const& _contract); void handleGasEstimation(std::string const& _contract); void handleStorageLayout(std::string const& _contract); /// Tries to read @ m_sourceCodes as a JSONs holding ASTs /// such that they can be imported into the compiler (importASTs()) /// (produced by --combined-json ast /// or standard-json output std::map parseAstFromInput(); /// Create a file in the given directory /// @arg _fileName the name of the file /// @arg _data to be written void createFile(std::string const& _fileName, std::string const& _data); /// Create a json file in the given directory /// @arg _fileName the name of the file (the extension will be replaced with .json) /// @arg _json json string to be written void createJson(std::string const& _fileName, std::string const& _json); /// Returns the stream that should receive normal output. Sets m_hasOutput to true if the /// stream has ever been used unless @arg _markAsUsed is set to false. std::ostream& sout(bool _markAsUsed = true); /// Returns the stream that should receive error output. Sets m_hasOutput to true if the /// stream has ever been used unless @arg _markAsUsed is set to false. std::ostream& serr(bool _markAsUsed = true); std::istream& m_sin; std::ostream& m_sout; std::ostream& m_serr; bool m_hasOutput = false; FileReader m_fileReader; SMTSolverCommand m_solverCommand; UniversalCallback m_universalCallback{m_fileReader, m_solverCommand}; std::optional m_standardJsonInput; std::unique_ptr m_compiler; CommandLineOptions m_options; }; }