aboutsummaryrefslogtreecommitdiffstats
path: root/solc/CommandLineInterface.h
blob: 4768c9d880babce54a5d40bf1567e1f61e688300 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/*
    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/>.
*/
/**
 * @author Lefteris <lefteris@ethdev.com>
 * @date 2014
 * Solidity command line interface.
 */
#pragma once

#include <libsolidity/interface/CompilerStack.h>
#include <libsolidity/interface/AssemblyStack.h>

#include <boost/program_options.hpp>
#include <boost/filesystem/path.hpp>

#include <memory>

namespace dev
{
namespace solidity
{

//forward declaration
enum class DocumentationType: uint8_t;

class CommandLineInterface
{
public:
    CommandLineInterface() {}

    /// 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
    /// @returns true on success.
    bool actOnInput();

private:
    bool link();
    void writeLinkedFiles();

    bool assemble(AssemblyStack::Language _language, AssemblyStack::Machine _targetMachine);

    void outputCompilationResults();

    void handleCombinedJSON();
    void handleAst(std::string const& _argStr);
    void handleBinary(std::string const& _contract);
    void handleOpcode(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 handleFormal();

    /// Fills @a m_sourceCodes initially and @a m_redirects.
    void readInputFilesAndConfigureRemappings();
    /// 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);

    /// 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);

    bool m_error = false; ///< If true, some error occurred.

    bool m_onlyAssemble = false;

    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;
    /// list of allowed directories to read files from
    std::vector<boost::filesystem::path> m_allowedDirectories;
    /// map of library names to addresses
    std::map<std::string, h160> m_libraries;
    /// Solidity compiler stack
    std::unique_ptr<dev::solidity::CompilerStack> m_compiler;
};

}
}