2014-10-30 21:52:15 +00:00
|
|
|
/*
|
|
|
|
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>
|
2015-01-09 06:39:30 +00:00
|
|
|
* @author Gav Wood <g@ethdev.com>
|
2014-10-30 21:52:15 +00:00
|
|
|
* @date 2014
|
|
|
|
* Full-stack compiler that converts a source code string to bytecode.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2014-11-11 16:41:48 +00:00
|
|
|
#include <ostream>
|
2014-10-30 21:52:15 +00:00
|
|
|
#include <string>
|
|
|
|
#include <memory>
|
2015-03-02 00:13:10 +00:00
|
|
|
#include <vector>
|
2014-12-03 16:45:12 +00:00
|
|
|
#include <boost/noncopyable.hpp>
|
2015-01-28 07:50:53 +00:00
|
|
|
#include <json/json.h>
|
2014-10-30 21:52:15 +00:00
|
|
|
#include <libdevcore/Common.h>
|
2015-01-09 16:02:39 +00:00
|
|
|
#include <libdevcore/FixedHash.h>
|
2015-05-07 11:32:26 +00:00
|
|
|
#include <libevmasm/SourceLocation.h>
|
2014-10-30 21:52:15 +00:00
|
|
|
|
2015-03-02 16:34:43 +00:00
|
|
|
namespace dev
|
|
|
|
{
|
2015-03-02 00:13:10 +00:00
|
|
|
|
2015-03-02 16:34:43 +00:00
|
|
|
namespace eth
|
|
|
|
{
|
|
|
|
class AssemblyItem;
|
|
|
|
using AssemblyItems = std::vector<AssemblyItem>;
|
2015-03-02 00:13:10 +00:00
|
|
|
}
|
|
|
|
|
2015-03-02 16:34:43 +00:00
|
|
|
namespace solidity
|
|
|
|
{
|
2014-10-30 21:52:15 +00:00
|
|
|
|
2014-11-20 17:33:23 +00:00
|
|
|
// forward declarations
|
|
|
|
class Scanner;
|
|
|
|
class ContractDefinition;
|
2015-05-26 09:27:59 +00:00
|
|
|
class FunctionDefinition;
|
2014-12-03 06:46:55 +00:00
|
|
|
class SourceUnit;
|
2014-11-20 17:33:23 +00:00
|
|
|
class Compiler;
|
|
|
|
class GlobalContext;
|
2014-12-03 15:40:37 +00:00
|
|
|
class InterfaceHandler;
|
|
|
|
|
2014-12-05 14:50:39 +00:00
|
|
|
enum class DocumentationType: uint8_t
|
2014-12-03 15:40:37 +00:00
|
|
|
{
|
2015-02-09 13:12:36 +00:00
|
|
|
NatspecUser = 1,
|
|
|
|
NatspecDev,
|
|
|
|
ABIInterface,
|
|
|
|
ABISolidityInterface
|
2014-12-03 15:40:37 +00:00
|
|
|
};
|
2014-10-30 21:52:15 +00:00
|
|
|
|
2014-11-11 16:41:48 +00:00
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
2014-12-03 16:45:12 +00:00
|
|
|
class CompilerStack: boost::noncopyable
|
2014-10-30 21:52:15 +00:00
|
|
|
{
|
|
|
|
public:
|
2015-01-28 12:39:04 +00:00
|
|
|
/// Creates a new compiler stack. Adds standard sources if @a _addStandardSources.
|
2015-02-23 15:28:18 +00:00
|
|
|
explicit CompilerStack(bool _addStandardSources = true);
|
2014-12-05 14:27:07 +00:00
|
|
|
|
2015-05-19 22:27:07 +00:00
|
|
|
/// Resets the compiler to a state where the sources are not parsed or even removed.
|
|
|
|
void reset(bool _keepSources = false, bool _addStandardSources = true);
|
|
|
|
|
2014-12-03 16:45:12 +00:00
|
|
|
/// Adds a source object (e.g. file) to the parser. After this, parse has to be called again.
|
2014-12-18 13:39:16 +00:00
|
|
|
/// @returns true if a source object by the name already existed and was replaced.
|
2015-03-03 17:11:10 +00:00
|
|
|
void addSources(StringMap const& _nameContents, bool _isLibrary = false) { for (auto const& i: _nameContents) addSource(i.first, i.second, _isLibrary); }
|
2015-02-20 17:15:34 +00:00
|
|
|
bool addSource(std::string const& _name, std::string const& _content, bool _isLibrary = false);
|
2014-11-11 16:41:48 +00:00
|
|
|
void setSource(std::string const& _sourceCode);
|
2014-12-03 16:45:12 +00:00
|
|
|
/// Parses all source units that were added
|
2014-11-11 16:41:48 +00:00
|
|
|
void parse();
|
2015-01-28 12:39:04 +00:00
|
|
|
/// Sets the given source code as the only source unit apart from standard sources and parses it.
|
2014-11-11 16:41:48 +00:00
|
|
|
void parse(std::string const& _sourceCode);
|
2014-12-03 17:52:28 +00:00
|
|
|
/// Returns a list of the contract names in the sources.
|
2015-08-31 16:44:29 +00:00
|
|
|
std::vector<std::string> contractNames() const;
|
2015-02-15 00:00:09 +00:00
|
|
|
std::string defaultContractName() const;
|
2014-12-03 17:52:28 +00:00
|
|
|
|
2014-12-05 14:35:05 +00:00
|
|
|
/// Compiles the source units that were previously added and parsed.
|
2015-06-01 10:32:59 +00:00
|
|
|
void compile(bool _optimize = false, unsigned _runs = 200);
|
2014-11-11 16:41:48 +00:00
|
|
|
/// Parses and compiles the given source code.
|
2014-12-03 16:45:12 +00:00
|
|
|
/// @returns the compiled bytecode
|
2014-11-11 16:41:48 +00:00
|
|
|
bytes const& compile(std::string const& _sourceCode, bool _optimize = false);
|
|
|
|
|
2015-01-14 15:49:09 +00:00
|
|
|
/// @returns the assembled bytecode for a contract.
|
2015-08-31 16:44:29 +00:00
|
|
|
bytes const& bytecode(std::string const& _contractName = "") const;
|
2015-01-14 15:49:09 +00:00
|
|
|
/// @returns the runtime bytecode for the contract, i.e. the code that is returned by the constructor.
|
2015-08-31 16:44:29 +00:00
|
|
|
bytes const& runtimeBytecode(std::string const& _contractName = "") const;
|
2015-07-31 17:23:31 +00:00
|
|
|
/// @returns the bytecode of a contract that uses an already deployed contract via CALLCODE.
|
|
|
|
/// The returned bytes will contain a sequence of 20 bytes of the format "XXX...XXX" which have to
|
|
|
|
/// substituted by the actual address. Note that this sequence starts end ends in three X
|
|
|
|
/// characters but can contain anything in between.
|
2015-08-31 16:44:29 +00:00
|
|
|
bytes const& cloneBytecode(std::string const& _contractName = "") const;
|
2015-03-02 00:13:10 +00:00
|
|
|
/// @returns normal contract assembly items
|
2015-08-31 16:44:29 +00:00
|
|
|
eth::AssemblyItems const* assemblyItems(std::string const& _contractName = "") const;
|
2015-03-02 00:13:10 +00:00
|
|
|
/// @returns runtime contract assembly items
|
2015-08-31 16:44:29 +00:00
|
|
|
eth::AssemblyItems const* runtimeAssemblyItems(std::string const& _contractName = "") const;
|
2015-01-14 16:14:46 +00:00
|
|
|
/// @returns hash of the runtime bytecode for the contract, i.e. the code that is returned by the constructor.
|
2015-08-31 16:44:29 +00:00
|
|
|
dev::h256 contractCodeHash(std::string const& _contractName = "") const;
|
2015-01-13 14:59:42 +00:00
|
|
|
|
2014-11-11 16:41:48 +00:00
|
|
|
/// Streams a verbose version of the assembly to @a _outStream.
|
2015-03-03 17:11:10 +00:00
|
|
|
/// @arg _sourceCodes is the map of input files to source code strings
|
2015-04-14 09:38:36 +00:00
|
|
|
/// @arg _inJsonFromat shows whether the out should be in Json format
|
2014-11-11 16:41:48 +00:00
|
|
|
/// Prerequisite: Successful compilation.
|
2015-01-28 07:50:53 +00:00
|
|
|
Json::Value streamAssembly(std::ostream& _outStream, std::string const& _contractName = "", StringMap _sourceCodes = StringMap(), bool _inJsonFormat = false) const;
|
2014-11-11 16:41:48 +00:00
|
|
|
|
|
|
|
/// Returns a string representing the contract interface in JSON.
|
|
|
|
/// Prerequisite: Successful call to parse or compile.
|
2015-08-31 16:44:29 +00:00
|
|
|
std::string const& interface(std::string const& _contractName = "") const;
|
2015-01-09 06:39:30 +00:00
|
|
|
/// Returns a string representing the contract interface in Solidity.
|
2015-01-08 23:22:06 +00:00
|
|
|
/// Prerequisite: Successful call to parse or compile.
|
2015-08-31 16:44:29 +00:00
|
|
|
std::string const& solidityInterface(std::string const& _contractName = "") const;
|
2014-12-03 15:40:37 +00:00
|
|
|
/// Returns a string representing the contract's documentation in JSON.
|
2014-12-03 12:50:04 +00:00
|
|
|
/// Prerequisite: Successful call to parse or compile.
|
2014-12-03 15:40:37 +00:00
|
|
|
/// @param type The type of the documentation to get.
|
2015-01-09 06:39:30 +00:00
|
|
|
/// Can be one of 4 types defined at @c DocumentationType
|
2015-08-31 16:44:29 +00:00
|
|
|
std::string const& metadata(std::string const& _contractName, DocumentationType _type) const;
|
2014-11-11 16:41:48 +00:00
|
|
|
|
2014-12-18 13:39:16 +00:00
|
|
|
/// @returns the previously used scanner, useful for counting lines during error reporting.
|
2015-08-31 16:44:29 +00:00
|
|
|
Scanner const& scanner(std::string const& _sourceName = "") const;
|
2014-12-18 13:39:16 +00:00
|
|
|
/// @returns the parsed source unit with the supplied name.
|
2015-09-08 12:30:21 +00:00
|
|
|
SourceUnit const& ast(std::string const& _sourceName = "") const;
|
2014-12-18 13:39:16 +00:00
|
|
|
/// @returns the parsed contract with the supplied name. Throws an exception if the contract
|
|
|
|
/// does not exist.
|
2015-08-31 16:44:29 +00:00
|
|
|
ContractDefinition const& contractDefinition(std::string const& _contractName) const;
|
2014-11-11 16:41:48 +00:00
|
|
|
|
2015-05-26 09:27:59 +00:00
|
|
|
/// @returns the offset of the entry point of the given function into the list of assembly items
|
|
|
|
/// or zero if it is not found or does not exist.
|
2015-08-31 16:44:29 +00:00
|
|
|
size_t functionEntryPoint(
|
2015-05-26 09:27:59 +00:00
|
|
|
std::string const& _contractName,
|
|
|
|
FunctionDefinition const& _function
|
|
|
|
) const;
|
|
|
|
|
2014-10-30 21:52:15 +00:00
|
|
|
/// 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.
|
2014-11-11 16:41:48 +00:00
|
|
|
static bytes staticCompile(std::string const& _sourceCode, bool _optimize = false);
|
|
|
|
|
2015-05-07 15:22:24 +00:00
|
|
|
/// Helper function for logs printing. Do only use in error cases, it's quite expensive.
|
|
|
|
/// line and columns are numbered starting from 1 with following order:
|
|
|
|
/// start line, start column, end line, end column
|
|
|
|
std::tuple<int, int, int, int> positionFromSourceLocation(SourceLocation const& _sourceLocation) const;
|
2015-05-07 11:32:26 +00:00
|
|
|
|
2014-11-11 16:41:48 +00:00
|
|
|
private:
|
2014-12-03 16:45:12 +00:00
|
|
|
/**
|
|
|
|
* 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;
|
2015-02-21 17:55:55 +00:00
|
|
|
bool isLibrary = false;
|
2015-04-22 08:23:00 +00:00
|
|
|
void reset() { scanner.reset(); ast.reset(); interface.clear(); }
|
2014-12-03 16:45:12 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct Contract
|
|
|
|
{
|
2015-01-07 15:46:15 +00:00
|
|
|
ContractDefinition const* contract = nullptr;
|
2014-12-03 16:45:12 +00:00
|
|
|
std::shared_ptr<Compiler> compiler;
|
|
|
|
bytes bytecode;
|
2015-01-13 14:59:42 +00:00
|
|
|
bytes runtimeBytecode;
|
2015-07-31 17:23:31 +00:00
|
|
|
bytes cloneBytecode;
|
2014-12-05 14:27:07 +00:00
|
|
|
std::shared_ptr<InterfaceHandler> interfaceHandler;
|
2014-12-06 01:39:58 +00:00
|
|
|
mutable std::unique_ptr<std::string const> interface;
|
2015-01-08 23:22:06 +00:00
|
|
|
mutable std::unique_ptr<std::string const> solidityInterface;
|
2014-12-06 01:39:58 +00:00
|
|
|
mutable std::unique_ptr<std::string const> userDocumentation;
|
|
|
|
mutable std::unique_ptr<std::string const> devDocumentation;
|
2014-12-05 14:27:07 +00:00
|
|
|
|
|
|
|
Contract();
|
2014-12-03 16:45:12 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
void resolveImports();
|
|
|
|
|
2015-08-31 16:44:29 +00:00
|
|
|
Contract const& contract(std::string const& _contractName = "") const;
|
|
|
|
Source const& source(std::string const& _sourceName = "") const;
|
2014-12-03 16:45:12 +00:00
|
|
|
|
2014-11-11 16:41:48 +00:00
|
|
|
bool m_parseSuccessful;
|
2014-12-06 01:39:58 +00:00
|
|
|
std::map<std::string const, Source> m_sources;
|
2014-12-03 16:45:12 +00:00
|
|
|
std::shared_ptr<GlobalContext> m_globalContext;
|
|
|
|
std::vector<Source const*> m_sourceOrder;
|
2014-12-06 01:39:58 +00:00
|
|
|
std::map<std::string const, Contract> m_contracts;
|
2014-10-30 21:52:15 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
}
|
|
|
|
}
|