aboutsummaryrefslogtreecommitdiffstats
path: root/CompilerStack.h
blob: a5b8ec41ec1453b0c527e58700aefceaa19e2cd0 (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
109
110
111
112
113
114
115
116
117
118
/*
    This file is part of cpp-ethereum.

    cpp-ethereum 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.

    cpp-ethereum 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 cpp-ethereum.  If not, see <http://www.gnu.org/licenses/>.
*/
/**
 * @author Christian <c@ethdev.com>
 * @date 2014
 * Full-stack compiler that converts a source code string to bytecode.
 */

#pragma once

#include <ostream>
#include <string>
#include <memory>
#include <boost/noncopyable.hpp>
#include <libdevcore/Common.h>

namespace dev {
namespace solidity {

// forward declarations
class Scanner;
class SourceUnit;
class Compiler;
class GlobalContext;
class ContractDefinition;

/**
 * Easy to use and self-contained Solidity compiler with as few header dependencies as possible.
 * It holds state and can be used to either step through the compilation stages (and abort e.g.
 * before compilation to bytecode) or run the whole compilation in one call.
 */
class CompilerStack: boost::noncopyable
{
public:
    CompilerStack(): m_parseSuccessful(false) {}
    /// Adds a source object (e.g. file) to the parser. After this, parse has to be called again.
    void addSource(std::string const& _name, std::string const& _content);
    void setSource(std::string const& _sourceCode);
    /// Parses all source units that were added
    void parse();
    /// Sets the given source code as the only source unit and parses it.
    void parse(std::string const& _sourceCode);
    /// Returns a list of the contract names in the sources.
    std::vector<std::string> getContractNames();

    /// Compiles the source units that were prevously added and parsed.
    void compile(bool _optimize = false);
    /// Parses and compiles the given source code.
    /// @returns the compiled bytecode
    bytes const& compile(std::string const& _sourceCode, bool _optimize = false);

    bytes const& getBytecode(std::string const& _contractName = "");
    /// Streams a verbose version of the assembly to @a _outStream.
    /// Prerequisite: Successful compilation.
    void streamAssembly(std::ostream& _outStream, std::string const& _contractName = "");

    /// Returns a string representing the contract interface in JSON.
    /// Prerequisite: Successful call to parse or compile.
    std::string const& getInterface(std::string const& _contractName = "");

    /// Returns the previously used scanner, useful for counting lines during error reporting.
    Scanner const& getScanner(std::string const& _sourceName = "");
    SourceUnit& getAST(std::string const& _sourceName = "");

    /// Compile the given @a _sourceCode to bytecode. If a scanner is provided, it is used for
    /// scanning the source code - this is useful for printing exception information.
    static bytes staticCompile(std::string const& _sourceCode, bool _optimize = false);

private:
    /**
     * Information pertaining to one source unit, filled gradually during parsing and compilation.
     */
    struct Source
    {
        std::shared_ptr<Scanner> scanner;
        std::shared_ptr<SourceUnit> ast;
        std::string interface;
        void reset() { scanner.reset(); ast.reset(); interface.clear(); }
    };

    struct Contract
    {
        ContractDefinition const* contract;
        std::string interface;
        std::shared_ptr<Compiler> compiler;
        bytes bytecode;
    };

    void reset(bool _keepSources = false);
    void resolveImports();

    Contract& getContract(std::string const& _contractName = "");
    Source& getSource(std::string const& _sourceName = "");

    bool m_parseSuccessful;
    std::map<std::string, Source> m_sources;
    std::shared_ptr<GlobalContext> m_globalContext;
    std::shared_ptr<Compiler> m_compiler;
    std::vector<Source const*> m_sourceOrder;
    std::map<std::string, Contract> m_contracts;
};

}
}