solidity/solc/CommandLineInterface.h

145 lines
5.3 KiB
C
Raw Normal View History

/*
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/>.
*/
// SPDX-License-Identifier: GPL-3.0
/**
* @author Lefteris <lefteris@ethdev.com>
* @date 2014
* Solidity command line interface.
*/
#pragma once
#include <libsolidity/interface/CompilerStack.h>
#include <libsolidity/interface/DebugSettings.h>
2019-02-13 11:07:20 +00:00
#include <libyul/AssemblyStack.h>
#include <liblangutil/EVMVersion.h>
2017-01-26 12:47:57 +00:00
#include <boost/program_options.hpp>
#include <boost/filesystem/path.hpp>
#include <memory>
2019-12-11 16:31:36 +00:00
namespace solidity::frontend
{
//forward declaration
enum class DocumentationType: uint8_t;
class CommandLineInterface
{
public:
/// Parse command line arguments and return false if we should not continue
bool parseArguments(int _argc, char** _argv);
/// Parse the files and create source code objects
bool processInput();
/// Perform actions on the input depending on provided compiler arguments
2017-03-10 18:11:01 +00:00
/// @returns true on success.
bool actOnInput();
private:
2015-09-11 17:35:01 +00:00
bool link();
void writeLinkedFiles();
2018-10-04 12:55:02 +00:00
/// @returns the ``// <identifier> -> name`` hint for library placeholders.
static std::string libraryPlaceholderHint(std::string const& _libraryName);
/// @returns the full object with library placeholder hints in hex.
2019-12-11 16:31:36 +00:00
static std::string objectWithLinkRefsHex(evmasm::LinkerObject const& _obj);
2015-09-11 17:35:01 +00:00
bool assemble(
yul::AssemblyStack::Language _language,
yul::AssemblyStack::Machine _targetMachine,
bool _optimize,
std::optional<std::string> _yulOptimiserSteps = std::nullopt
);
2016-02-22 01:13:41 +00:00
2015-09-11 17:35:01 +00:00
void outputCompilationResults();
void handleCombinedJSON();
void handleAst(std::string const& _argStr);
void handleBinary(std::string const& _contract);
void handleOpcode(std::string const& _contract);
2019-03-04 22:26:46 +00:00
void handleIR(std::string const& _contract);
void handleIROptimized(std::string const& _contract);
2019-12-09 16:36:12 +00:00
void handleEwasm(std::string const& _contract);
void handleBytecode(std::string const& _contract);
void handleSignatureHashes(std::string const& _contract);
2017-05-19 15:10:32 +00:00
void handleMetadata(std::string const& _contract);
2017-05-06 17:02:56 +00:00
void handleABI(std::string const& _contract);
2017-07-27 10:28:04 +00:00
void handleNatspec(bool _natspecDev, std::string const& _contract);
void handleGasEstimation(std::string const& _contract);
void handleStorageLayout(std::string const& _contract);
2016-01-25 18:42:17 +00:00
/// Fills @a m_sourceCodes initially and @a m_redirects.
bool readInputFilesAndConfigureRemappings();
2015-09-11 17:35:01 +00:00
/// Tries to read from the file @a _input or interprets _input literally if that fails.
/// It then tries to parse the contents and appends to m_libraries.
bool parseLibraryOption(std::string const& _input);
2019-09-11 19:16:35 +00:00
/// 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,compact-format <file.sol>
/// or standard-json output
std::map<std::string, Json::Value> parseAstFromInput();
/// Create a file in the given directory
/// @arg _fileName the name of the file
/// @arg _data to be written
2015-07-21 13:29:15 +00:00
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)
2017-07-03 23:46:30 +00:00
/// @arg _json json string to be written
void createJson(std::string const& _fileName, std::string const& _json);
size_t countEnabledOptions(std::vector<std::string> const& _optionNames) const;
static std::string joinOptionNames(std::vector<std::string> const& _optionNames, std::string _separator = ", ");
2017-03-10 18:11:01 +00:00
bool m_error = false; ///< If true, some error occurred.
2016-02-22 01:13:41 +00:00
bool m_onlyAssemble = false;
2017-05-23 08:37:51 +00:00
2015-09-11 17:35:01 +00:00
bool m_onlyLink = false;
/// Compiler arguments variable map
boost::program_options::variables_map m_args;
/// map of input files to source code strings
std::map<std::string, std::string> m_sourceCodes;
2018-08-09 18:37:49 +00:00
/// list of remappings
2019-12-11 16:31:36 +00:00
std::vector<frontend::CompilerStack::Remapping> m_remappings;
/// list of allowed directories to read files from
std::vector<boost::filesystem::path> m_allowedDirectories;
/// Base path, used for resolving relative paths in imports.
boost::filesystem::path m_basePath;
2015-09-11 17:35:01 +00:00
/// map of library names to addresses
2019-12-11 16:31:36 +00:00
std::map<std::string, util::h160> m_libraries;
/// Solidity compiler stack
2019-12-11 16:31:36 +00:00
std::unique_ptr<frontend::CompilerStack> m_compiler;
2020-07-08 20:08:50 +00:00
CompilerStack::State m_stopAfter = CompilerStack::State::CompilationSuccessful;
/// EVM version to use
langutil::EVMVersion m_evmVersion;
/// How to handle revert strings
RevertStrings m_revertStrings = RevertStrings::Default;
2019-09-06 17:11:07 +00:00
/// Chosen hash method for the bytecode metadata.
CompilerStack::MetadataHash m_metadataHash = CompilerStack::MetadataHash::IPFS;
2020-11-02 20:20:20 +00:00
/// Model checker settings.
ModelCheckerSettings m_modelCheckerSettings;
/// Whether or not to colorize diagnostics output.
bool m_coloredOutput = true;
2020-06-04 01:19:47 +00:00
/// Whether or not to output error IDs.
bool m_withErrorIds = false;
};
}