aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--solc/CommandLineInterface.cpp276
-rw-r--r--solc/CommandLineInterface.h15
2 files changed, 134 insertions, 157 deletions
diff --git a/solc/CommandLineInterface.cpp b/solc/CommandLineInterface.cpp
index e579d883..a5ad07d7 100644
--- a/solc/CommandLineInterface.cpp
+++ b/solc/CommandLineInterface.cpp
@@ -54,32 +54,32 @@ namespace dev
namespace solidity
{
-static string const g_argAbiStr = "json-abi";
-static string const g_argSolAbiStr = "sol-abi";
+static string const g_argAbiStr = "abi";
+static string const g_argSolInterfaceStr = "interface";
static string const g_argSignatureHashes = "hashes";
static string const g_argGas = "gas";
static string const g_argAsmStr = "asm";
static string const g_argAsmJsonStr = "asm-json";
static string const g_argAstStr = "ast";
static string const g_argAstJson = "ast-json";
-static string const g_argBinaryStr = "binary";
-static string const g_argCloneBinaryStr = "clone-binary";
+static string const g_argBinaryStr = "bin";
+static string const g_argCloneBinaryStr = "clone-bin";
static string const g_argOpcodesStr = "opcodes";
-static string const g_argNatspecDevStr = "natspec-dev";
-static string const g_argNatspecUserStr = "natspec-user";
+static string const g_argNatspecDevStr = "devdoc";
+static string const g_argNatspecUserStr = "userdoc";
static string const g_argAddStandard = "add-std";
/// Possible arguments to for --combined-json
static set<string> const g_combinedJsonArgs{
- "binary",
- "clone-binary",
+ "bin",
+ "clone-bin",
"opcodes",
- "json-abi",
- "sol-abi",
+ "abi",
+ "interface",
"asm",
"ast",
- "natspec-user",
- "natspec-dev"
+ "userdoc",
+ "devdoc"
};
static void version()
@@ -95,7 +95,7 @@ static void version()
static inline bool humanTargetedStdout(po::variables_map const& _args, string const& _name)
{
- return _args.count(_name) && _args[_name].as<OutputType>() != OutputType::FILE;
+ return _args.count(_name) && !(_args.count("output-dir"));
}
static bool needsHumanTargetedStdout(po::variables_map const& _args)
@@ -104,7 +104,7 @@ static bool needsHumanTargetedStdout(po::variables_map const& _args)
return
_args.count(g_argGas) ||
humanTargetedStdout(_args, g_argAbiStr) ||
- humanTargetedStdout(_args, g_argSolAbiStr) ||
+ humanTargetedStdout(_args, g_argSolInterfaceStr) ||
humanTargetedStdout(_args, g_argSignatureHashes) ||
humanTargetedStdout(_args, g_argNatspecUserStr) ||
humanTargetedStdout(_args, g_argAstJson) ||
@@ -116,79 +116,60 @@ static bool needsHumanTargetedStdout(po::variables_map const& _args)
humanTargetedStdout(_args, g_argCloneBinaryStr);
}
-static inline bool outputToFile(OutputType type)
-{
- return type == OutputType::FILE || type == OutputType::BOTH;
-}
-
-static inline bool outputToStdout(OutputType type)
-{
- return type == OutputType::STDOUT || type == OutputType::BOTH;
-}
-
-static std::istream& operator>>(std::istream& _in, OutputType& io_output)
-{
- std::string token;
- _in >> token;
- if (token == "stdout")
- io_output = OutputType::STDOUT;
- else if (token == "file")
- io_output = OutputType::FILE;
- else if (token == "both")
- io_output = OutputType::BOTH;
- else
- throw boost::program_options::invalid_option_value(token);
- return _in;
-}
-
void CommandLineInterface::handleBinary(string const& _contract)
{
if (m_args.count(g_argBinaryStr))
{
- if (outputToStdout(m_args[g_argBinaryStr].as<OutputType>()))
+ if (m_args.count("output-dir"))
{
- cout << "Binary: " << endl;
- cout << toHex(m_compiler->getBytecode(_contract)) << endl;
+ stringstream data;
+ data << toHex(m_compiler->getBytecode(_contract));
+ createFile(_contract + ".bin", data.str());
}
- if (outputToFile(m_args[g_argBinaryStr].as<OutputType>()))
+ else
{
- ofstream outFile(_contract + ".binary");
- outFile << toHex(m_compiler->getBytecode(_contract));
- outFile.close();
+ cout << "Binary: " << endl;
+ cout << toHex(m_compiler->getBytecode(_contract)) << endl;
}
+
}
if (m_args.count(g_argCloneBinaryStr))
{
- if (outputToStdout(m_args[g_argCloneBinaryStr].as<OutputType>()))
+ if (m_args.count("output-dir"))
{
- cout << "Clone Binary: " << endl;
- cout << toHex(m_compiler->getCloneBytecode(_contract)) << endl;
+ stringstream data;
+ data << toHex(m_compiler->getCloneBytecode(_contract));
+ createFile(_contract + ".clone_bin", data.str());
}
- if (outputToFile(m_args[g_argCloneBinaryStr].as<OutputType>()))
+ else
{
- ofstream outFile(_contract + ".clone_binary");
- outFile << toHex(m_compiler->getCloneBytecode(_contract));
- outFile.close();
+ cout << "Clone Binary: " << endl;
+ cout << toHex(m_compiler->getCloneBytecode(_contract)) << endl;
}
}
+ else
+ {
+ cout << "Binary: " << endl;
+ cout << toHex(m_compiler->getBytecode(_contract)) << endl;
+ }
+
}
void CommandLineInterface::handleOpcode(string const& _contract)
{
- auto choice = m_args[g_argOpcodesStr].as<OutputType>();
- if (outputToStdout(choice))
+ if (m_args.count("output-dir"))
+ {
+ stringstream data;
+ data << eth::disassemble(m_compiler->getBytecode(_contract));
+ createFile(_contract + ".opcode", data.str());
+ }
+ else
{
cout << "Opcodes: " << endl;
cout << eth::disassemble(m_compiler->getBytecode(_contract));
cout << endl;
}
- if (outputToFile(choice))
- {
- ofstream outFile(_contract + ".opcode");
- outFile << eth::disassemble(m_compiler->getBytecode(_contract));
- outFile.close();
- }
}
void CommandLineInterface::handleBytecode(string const& _contract)
@@ -208,16 +189,14 @@ void CommandLineInterface::handleSignatureHashes(string const& _contract)
for (auto const& it: m_compiler->getContractDefinition(_contract).getInterfaceFunctions())
out += toHex(it.first.ref()) + ": " + it.second->externalSignature() + "\n";
- auto choice = m_args[g_argSignatureHashes].as<OutputType>();
- if (outputToStdout(choice))
- cout << "Function signatures: " << endl << out;
-
- if (outputToFile(choice))
+ if (m_args.count("output-dir"))
{
- ofstream outFile(_contract + ".signatures");
- outFile << out;
- outFile.close();
+ stringstream data;
+ data << out;
+ createFile(_contract + ".signatures", data.str());
}
+ else
+ cout << "Function signatures: " << endl << out;
}
void CommandLineInterface::handleMeta(DocumentationType _type, string const& _contract)
@@ -233,8 +212,8 @@ void CommandLineInterface::handleMeta(DocumentationType _type, string const& _co
title = "Contract JSON ABI";
break;
case DocumentationType::ABISolidityInterface:
- argName = g_argSolAbiStr;
- suffix = ".sol";
+ argName = g_argSolInterfaceStr;
+ suffix = "_interface.sol";
title = "Contract Solidity ABI";
break;
case DocumentationType::NatspecUser:
@@ -254,19 +233,18 @@ void CommandLineInterface::handleMeta(DocumentationType _type, string const& _co
if (m_args.count(argName))
{
- auto choice = m_args[argName].as<OutputType>();
- if (outputToStdout(choice))
+ if (m_args.count("output-dir"))
+ {
+ stringstream data;
+ data << m_compiler->getMetadata(_contract, _type);
+ createFile(_contract + suffix, data.str());
+ }
+ else
{
cout << title << endl;
cout << m_compiler->getMetadata(_contract, _type) << endl;
}
- if (outputToFile(choice))
- {
- ofstream outFile(_contract + suffix);
- outFile << m_compiler->getMetadata(_contract, _type);
- outFile.close();
- }
}
}
@@ -319,7 +297,19 @@ void CommandLineInterface::handleGasEstimation(string const& _contract)
}
}
-bool CommandLineInterface::parseArguments(int argc, char** argv)
+void CommandLineInterface::createFile(string const& _fileName, string const& _data)
+{
+ namespace fs = boost::filesystem;
+ // create directory if not existent
+ fs::path p(m_args["output-dir"].as<string>());
+ fs::create_directories(p);
+ ofstream outFile((p / _fileName).string());
+ outFile << _data;
+ if (!outFile)
+ BOOST_THROW_EXCEPTION(FileError() << errinfo_comment("Could not write to file: " + _fileName));
+}
+
+bool CommandLineInterface::parseArguments(int _argc, char** _argv)
{
// Declare the supported options.
po::options_description desc("Allowed options");
@@ -330,52 +320,43 @@ bool CommandLineInterface::parseArguments(int argc, char** argv)
("optimize-runs", po::value<unsigned>()->default_value(200), "Estimated number of contract runs for optimizer.")
("add-std", po::value<bool>()->default_value(false), "Add standard contracts")
("input-file", po::value<vector<string>>(), "input file")
+ ("output-dir,o", po::value<string>(), "Output directory path")
(
"combined-json",
po::value<string>()->value_name(boost::join(g_combinedJsonArgs, ",")),
"Output a single json document containing the specified information, can be combined."
)
- (g_argAstStr.c_str(), po::value<OutputType>()->value_name("stdout|file|both"),
- "Request to output the AST of the contract.")
- (g_argAstJson.c_str(), po::value<OutputType>()->value_name("stdout|file|both"),
- "Request to output the AST of the contract in JSON format.")
- (g_argAsmStr.c_str(), po::value<OutputType>()->value_name("stdout|file|both"),
- "Request to output the EVM assembly of the contract.")
- (g_argAsmJsonStr.c_str(), po::value<OutputType>()->value_name("stdout|file|both"),
- "Request to output the EVM assembly of the contract in JSON format.")
- (g_argOpcodesStr.c_str(), po::value<OutputType>()->value_name("stdout|file|both"),
- "Request to output the Opcodes of the contract.")
- (g_argBinaryStr.c_str(), po::value<OutputType>()->value_name("stdout|file|both"),
- "Request to output the contract in binary (hexadecimal).")
- (g_argCloneBinaryStr.c_str(), po::value<OutputType>()->value_name("stdout|file|both"),
- "Request to output the clone contract in binary (hexadecimal).")
- (g_argAbiStr.c_str(), po::value<OutputType>()->value_name("stdout|file|both"),
- "Request to output the contract's JSON ABI interface.")
- (g_argSolAbiStr.c_str(), po::value<OutputType>()->value_name("stdout|file|both"),
- "Request to output the contract's Solidity ABI interface.")
- (g_argSignatureHashes.c_str(), po::value<OutputType>()->value_name("stdout|file|both"),
- "Request to output the contract's functions' signature hashes.")
- (g_argGas.c_str(),
- "Request to output an estimate for each function's maximal gas usage.")
- (g_argNatspecUserStr.c_str(), po::value<OutputType>()->value_name("stdout|file|both"),
- "Request to output the contract's Natspec user documentation.")
- (g_argNatspecDevStr.c_str(), po::value<OutputType>()->value_name("stdout|file|both"),
- "Request to output the contract's Natspec developer documentation.");
+ (g_argAstStr.c_str(), "Outputs the AST of the contract.")
+ (g_argAstJson.c_str(), "Outputs the AST of the contract in JSON format.")
+ (g_argAsmStr.c_str(), "Outputs the EVM assembly of the contract.")
+ (g_argAsmJsonStr.c_str(), "Outputs the EVM assembly of the contract in JSON format.")
+ (g_argOpcodesStr.c_str(), "Outputs the Opcodes of the contract.")
+ (g_argBinaryStr.c_str(), "Outputs the contract in binary (hexadecimal).")
+ (g_argCloneBinaryStr.c_str(), "Output the clone contract in binary (hexadecimal).")
+ (g_argAbiStr.c_str(), "Outputs the contract's JSON ABI interface.")
+ (g_argSolInterfaceStr.c_str(), "Outputs the contract's Solidity interface.")
+ (g_argSignatureHashes.c_str(), "Outputs the contract's functions' signature hashes.")
+ (g_argGas.c_str(), "Outputs an estimate for each function's maximal gas usage.")
+ (g_argNatspecUserStr.c_str(), "Outputs the contract's Natspec user documentation.")
+ (g_argNatspecDevStr.c_str(), "Outputs the contract's Natspec developer documentation.");
// All positional options should be interpreted as input files
- po::positional_options_description p;
- p.add("input-file", -1);
+ po::positional_options_description filesPositions;
+ filesPositions.add("output-dir", 1);
+ filesPositions.add("input-file", -1);
// parse the compiler arguments
try
{
- po::store(po::command_line_parser(argc, argv).options(desc).positional(p).allow_unregistered().run(), m_args);
+ po::store(po::command_line_parser(_argc, _argv).options(desc).positional(filesPositions).allow_unregistered().run(), m_args);
+
}
catch (po::error const& _exception)
{
cerr << _exception.what() << endl;
return false;
}
+
if (m_args.count("combined-json"))
{
vector<string> requests;
@@ -504,14 +485,14 @@ void CommandLineInterface::handleCombinedJSON()
for (string const& contractName: contracts)
{
Json::Value contractData(Json::objectValue);
- if (requests.count("sol-abi"))
- contractData["sol-abi"] = m_compiler->getSolidityInterface(contractName);
- if (requests.count("json-abi"))
- contractData["json-abi"] = m_compiler->getInterface(contractName);
- if (requests.count("binary"))
- contractData["binary"] = toHex(m_compiler->getBytecode(contractName));
- if (requests.count("clone-binary"))
- contractData["clone-binary"] = toHex(m_compiler->getCloneBytecode(contractName));
+ if (requests.count("interface"))
+ contractData["interface"] = m_compiler->getSolidityInterface(contractName);
+ if (requests.count("abi"))
+ contractData["abi"] = m_compiler->getInterface(contractName);
+ if (requests.count("bin"))
+ contractData["bin"] = toHex(m_compiler->getBytecode(contractName));
+ if (requests.count("clone-bin"))
+ contractData["clone-bin"] = toHex(m_compiler->getCloneBytecode(contractName));
if (requests.count("opcodes"))
contractData["opcodes"] = eth::disassemble(m_compiler->getBytecode(contractName));
if (requests.count("asm"))
@@ -519,10 +500,10 @@ void CommandLineInterface::handleCombinedJSON()
ostringstream unused;
contractData["asm"] = m_compiler->streamAssembly(unused, contractName, m_sourceCodes, true);
}
- if (requests.count("natspec-dev"))
- contractData["natspec-dev"] = m_compiler->getMetadata(contractName, DocumentationType::NatspecDev);
- if (requests.count("natspec-user"))
- contractData["natspec-user"] = m_compiler->getMetadata(contractName, DocumentationType::NatspecUser);
+ if (requests.count("devdoc"))
+ contractData["devdoc"] = m_compiler->getMetadata(contractName, DocumentationType::NatspecDev);
+ if (requests.count("userdoc"))
+ contractData["userdoc"] = m_compiler->getMetadata(contractName, DocumentationType::NatspecUser);
output["contracts"][contractName] = contractData;
}
@@ -563,47 +544,46 @@ void CommandLineInterface::handleAst(string const& _argStr)
asts
);
- auto choice = m_args[_argStr].as<OutputType>();
- if (outputToStdout(choice))
+ if (m_args.count("output-dir"))
{
- cout << title << endl << endl;
for (auto const& sourceCode: m_sourceCodes)
{
- cout << endl << "======= " << sourceCode.first << " =======" << endl;
+ stringstream data;
+ string postfix = "";
if (_argStr == g_argAstStr)
{
- ASTPrinter printer(
- m_compiler->getAST(sourceCode.first),
- sourceCode.second,
- gasCosts
- );
- printer.print(cout);
+ ASTPrinter printer(m_compiler->getAST(sourceCode.first), sourceCode.second);
+ printer.print(data);
}
else
{
ASTJsonConverter converter(m_compiler->getAST(sourceCode.first));
- converter.print(cout);
+ converter.print(data);
+ postfix += "_json";
}
+ createFile(sourceCode.first + postfix + ".ast", data.str());
}
}
-
- if (outputToFile(choice))
+ else
{
+ cout << title << endl << endl;
for (auto const& sourceCode: m_sourceCodes)
{
- boost::filesystem::path p(sourceCode.first);
- ofstream outFile(p.stem().string() + ".ast");
+ cout << endl << "======= " << sourceCode.first << " =======" << endl;
if (_argStr == g_argAstStr)
{
- ASTPrinter printer(m_compiler->getAST(sourceCode.first), sourceCode.second);
- printer.print(outFile);
+ ASTPrinter printer(
+ m_compiler->getAST(sourceCode.first),
+ sourceCode.second,
+ gasCosts
+ );
+ printer.print(cout);
}
else
{
ASTJsonConverter converter(m_compiler->getAST(sourceCode.first));
- converter.print(outFile);
+ converter.print(cout);
}
- outFile.close();
}
}
}
@@ -626,18 +606,16 @@ void CommandLineInterface::actOnInput()
// do we need EVM assembly?
if (m_args.count(g_argAsmStr) || m_args.count(g_argAsmJsonStr))
{
- auto choice = m_args.count(g_argAsmStr) ? m_args[g_argAsmStr].as<OutputType>() : m_args[g_argAsmJsonStr].as<OutputType>();
- if (outputToStdout(choice))
+ if (m_args.count("output-dir"))
{
- cout << "EVM assembly:" << endl;
- m_compiler->streamAssembly(cout, contract, m_sourceCodes, m_args.count(g_argAsmJsonStr));
+ stringstream data;
+ m_compiler->streamAssembly(data, contract, m_sourceCodes, m_args.count(g_argAsmJsonStr));
+ createFile(contract + (m_args.count(g_argAsmJsonStr) ? "_evm.json" : ".evm"), data.str());
}
-
- if (outputToFile(choice))
+ else
{
- ofstream outFile(contract + (m_args.count(g_argAsmJsonStr) ? "_evm.json" : ".evm"));
- m_compiler->streamAssembly(outFile, contract, m_sourceCodes, m_args.count(g_argAsmJsonStr));
- outFile.close();
+ cout << "EVM assembly:" << endl;
+ m_compiler->streamAssembly(cout, contract, m_sourceCodes, m_args.count(g_argAsmJsonStr));
}
}
diff --git a/solc/CommandLineInterface.h b/solc/CommandLineInterface.h
index 46b9b1e2..f79bc0be 100644
--- a/solc/CommandLineInterface.h
+++ b/solc/CommandLineInterface.h
@@ -33,20 +33,13 @@ namespace solidity
//forward declaration
enum class DocumentationType: uint8_t;
-enum class OutputType: uint8_t
-{
- STDOUT,
- FILE,
- BOTH
-};
-
class CommandLineInterface
{
public:
CommandLineInterface() {}
/// Parse command line arguments and return false if we should not continue
- bool parseArguments(int argc, char** argv);
+ 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
@@ -63,6 +56,12 @@ private:
std::string const& _contract);
void handleGasEstimation(std::string const& _contract);
+
+ /// 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);
+
/// Compiler arguments variable map
boost::program_options::variables_map m_args;
/// map of input files to source code strings
generated by cgit v1.2.3 (git 2.25.1) at 2025-02-14 20:08:35 +0800