You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
433 lines
14 KiB
433 lines
14 KiB
/*
|
|
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/>.
|
|
*/
|
|
/** @file CodeModel.cpp
|
|
* @author Arkadiy Paronyan arkadiy@ethdev.com
|
|
* @date 2014
|
|
* Ethereum IDE client.
|
|
*/
|
|
|
|
#include <sstream>
|
|
#include <memory>
|
|
#include <QDebug>
|
|
#include <QApplication>
|
|
#include <QtQml>
|
|
#include <libdevcore/Common.h>
|
|
#include <libevmcore/SourceLocation.h>
|
|
#include <libsolidity/AST.h>
|
|
#include <libsolidity/Types.h>
|
|
#include <libsolidity/ASTVisitor.h>
|
|
#include <libsolidity/CompilerStack.h>
|
|
#include <libsolidity/SourceReferenceFormatter.h>
|
|
#include <libsolidity/InterfaceHandler.h>
|
|
#include <libevmcore/Instruction.h>
|
|
#include <libethcore/CommonJS.h>
|
|
#include "QContractDefinition.h"
|
|
#include "QFunctionDefinition.h"
|
|
#include "QVariableDeclaration.h"
|
|
#include "CodeHighlighter.h"
|
|
#include "FileIo.h"
|
|
#include "CodeModel.h"
|
|
|
|
using namespace dev::mix;
|
|
|
|
const std::set<std::string> c_predefinedContracts =
|
|
{ "Config", "Coin", "CoinReg", "coin", "service", "owned", "mortal", "NameReg", "named", "std", "configUser" };
|
|
|
|
|
|
namespace
|
|
{
|
|
using namespace dev::solidity;
|
|
class CollectDeclarationsVisitor: public ASTConstVisitor
|
|
{
|
|
public:
|
|
CollectDeclarationsVisitor(QHash<LocationPair, QString>* _functions, QHash<LocationPair, SolidityDeclaration>* _locals):
|
|
m_functions(_functions), m_locals(_locals), m_functionScope(false) {}
|
|
private:
|
|
LocationPair nodeLocation(ASTNode const& _node)
|
|
{
|
|
return LocationPair(_node.getLocation().start, _node.getLocation().end);
|
|
}
|
|
|
|
virtual bool visit(FunctionDefinition const& _node)
|
|
{
|
|
m_functions->insert(nodeLocation(_node), QString::fromStdString(_node.getName()));
|
|
m_functionScope = true;
|
|
return true;
|
|
}
|
|
|
|
virtual void endVisit(FunctionDefinition const&)
|
|
{
|
|
m_functionScope = false;
|
|
}
|
|
|
|
virtual bool visit(VariableDeclaration const& _node)
|
|
{
|
|
SolidityDeclaration decl;
|
|
decl.type = CodeModel::nodeType(_node.getType().get());
|
|
decl.name = QString::fromStdString(_node.getName());
|
|
decl.slot = 0;
|
|
decl.offset = 0;
|
|
if (m_functionScope)
|
|
m_locals->insert(nodeLocation(_node), decl);
|
|
return true;
|
|
}
|
|
|
|
private:
|
|
QHash<LocationPair, QString>* m_functions;
|
|
QHash<LocationPair, SolidityDeclaration>* m_locals;
|
|
bool m_functionScope;
|
|
};
|
|
|
|
QHash<unsigned, SolidityDeclarations> collectStorage(dev::solidity::ContractDefinition const& _contract)
|
|
{
|
|
QHash<unsigned, SolidityDeclarations> result;
|
|
dev::solidity::ContractType contractType(_contract);
|
|
|
|
for (auto v : contractType.getStateVariables())
|
|
{
|
|
dev::solidity::VariableDeclaration const* declaration = std::get<0>(v);
|
|
dev::u256 slot = std::get<1>(v);
|
|
unsigned offset = std::get<2>(v);
|
|
result[static_cast<unsigned>(slot)].push_back(SolidityDeclaration { QString::fromStdString(declaration->getName()), CodeModel::nodeType(declaration->getType().get()), slot, offset });
|
|
}
|
|
return result;
|
|
}
|
|
|
|
} //namespace
|
|
|
|
void BackgroundWorker::queueCodeChange(int _jobId)
|
|
{
|
|
m_model->runCompilationJob(_jobId);
|
|
}
|
|
|
|
CompiledContract::CompiledContract(const dev::solidity::CompilerStack& _compiler, QString const& _contractName, QString const& _source):
|
|
QObject(nullptr),
|
|
m_sourceHash(qHash(_source))
|
|
{
|
|
std::string name = _contractName.toStdString();
|
|
ContractDefinition const& contractDefinition = _compiler.getContractDefinition(name);
|
|
m_contract.reset(new QContractDefinition(nullptr, &contractDefinition));
|
|
QQmlEngine::setObjectOwnership(m_contract.get(), QQmlEngine::CppOwnership);
|
|
m_contract->moveToThread(QApplication::instance()->thread());
|
|
m_bytes = _compiler.getBytecode(_contractName.toStdString());
|
|
|
|
dev::solidity::InterfaceHandler interfaceHandler;
|
|
m_contractInterface = QString::fromStdString(*interfaceHandler.getABIInterface(contractDefinition));
|
|
if (m_contractInterface.isEmpty())
|
|
m_contractInterface = "[]";
|
|
if (contractDefinition.getLocation().sourceName.get())
|
|
m_documentId = QString::fromStdString(*contractDefinition.getLocation().sourceName);
|
|
|
|
CollectDeclarationsVisitor visitor(&m_functions, &m_locals);
|
|
m_storage = collectStorage(contractDefinition);
|
|
contractDefinition.accept(visitor);
|
|
m_assemblyItems = *_compiler.getRuntimeAssemblyItems(name);
|
|
m_constructorAssemblyItems = *_compiler.getAssemblyItems(name);
|
|
}
|
|
|
|
QString CompiledContract::codeHex() const
|
|
{
|
|
return QString::fromStdString(toJS(m_bytes));
|
|
}
|
|
|
|
CodeModel::CodeModel():
|
|
m_compiling(false),
|
|
m_codeHighlighterSettings(new CodeHighlighterSettings()),
|
|
m_backgroundWorker(this),
|
|
m_backgroundJobId(0)
|
|
{
|
|
m_backgroundThread.start();
|
|
m_backgroundWorker.moveToThread(&m_backgroundThread);
|
|
connect(this, &CodeModel::scheduleCompilationJob, &m_backgroundWorker, &BackgroundWorker::queueCodeChange, Qt::QueuedConnection);
|
|
qRegisterMetaType<CompiledContract*>("CompiledContract*");
|
|
qRegisterMetaType<QContractDefinition*>("QContractDefinition*");
|
|
qRegisterMetaType<QFunctionDefinition*>("QFunctionDefinition*");
|
|
qRegisterMetaType<QVariableDeclaration*>("QVariableDeclaration*");
|
|
qmlRegisterType<QFunctionDefinition>("org.ethereum.qml", 1, 0, "QFunctionDefinition");
|
|
qmlRegisterType<QVariableDeclaration>("org.ethereum.qml", 1, 0, "QVariableDeclaration");
|
|
}
|
|
|
|
CodeModel::~CodeModel()
|
|
{
|
|
stop();
|
|
disconnect(this);
|
|
releaseContracts();
|
|
}
|
|
|
|
void CodeModel::stop()
|
|
{
|
|
///@todo: cancel bg job
|
|
m_backgroundThread.exit();
|
|
m_backgroundThread.wait();
|
|
}
|
|
|
|
void CodeModel::reset(QVariantMap const& _documents)
|
|
{
|
|
///@todo: cancel bg job
|
|
Guard l(x_contractMap);
|
|
releaseContracts();
|
|
Guard pl(x_pendingContracts);
|
|
m_pendingContracts.clear();
|
|
|
|
for (QVariantMap::const_iterator d = _documents.cbegin(); d != _documents.cend(); ++d)
|
|
m_pendingContracts[d.key()] = d.value().toString();
|
|
// launch the background thread
|
|
m_compiling = true;
|
|
emit stateChanged();
|
|
emit scheduleCompilationJob(++m_backgroundJobId);
|
|
}
|
|
|
|
void CodeModel::registerCodeChange(QString const& _documentId, QString const& _code)
|
|
{
|
|
{
|
|
Guard pl(x_pendingContracts);
|
|
m_pendingContracts[_documentId] = _code;
|
|
}
|
|
|
|
// launch the background thread
|
|
m_compiling = true;
|
|
emit stateChanged();
|
|
emit scheduleCompilationJob(++m_backgroundJobId);
|
|
}
|
|
|
|
QVariantMap CodeModel::contracts() const
|
|
{
|
|
QVariantMap result;
|
|
Guard l(x_contractMap);
|
|
for (ContractMap::const_iterator c = m_contractMap.cbegin(); c != m_contractMap.cend(); ++c)
|
|
result.insert(c.key(), QVariant::fromValue(c.value()));
|
|
return result;
|
|
}
|
|
|
|
CompiledContract* CodeModel::contractByDocumentId(QString const& _documentId) const
|
|
{
|
|
Guard l(x_contractMap);
|
|
for (ContractMap::const_iterator c = m_contractMap.cbegin(); c != m_contractMap.cend(); ++c)
|
|
if (c.value()->m_documentId == _documentId)
|
|
return c.value();
|
|
return nullptr;
|
|
}
|
|
|
|
CompiledContract const& CodeModel::contract(QString const& _name) const
|
|
{
|
|
Guard l(x_contractMap);
|
|
CompiledContract* res = m_contractMap.value(_name);
|
|
if (res == nullptr)
|
|
BOOST_THROW_EXCEPTION(dev::Exception() << dev::errinfo_comment("Contract not found: " + _name.toStdString()));
|
|
return *res;
|
|
}
|
|
|
|
CompiledContract const* CodeModel::tryGetContract(QString const& _name) const
|
|
{
|
|
Guard l(x_contractMap);
|
|
CompiledContract* res = m_contractMap.value(_name);
|
|
return res;
|
|
}
|
|
|
|
void CodeModel::releaseContracts()
|
|
{
|
|
for (ContractMap::iterator c = m_contractMap.begin(); c != m_contractMap.end(); ++c)
|
|
c.value()->deleteLater();
|
|
m_contractMap.clear();
|
|
}
|
|
|
|
void CodeModel::runCompilationJob(int _jobId)
|
|
{
|
|
if (_jobId != m_backgroundJobId)
|
|
return; //obsolete job
|
|
solidity::CompilerStack cs(true);
|
|
try
|
|
{
|
|
cs.addSource("configUser", R"(contract configUser{function configAddr()constant returns(address a){ return 0xf025d81196b72fba60a1d4dddad12eeb8360d828;}})");
|
|
{
|
|
Guard l(x_pendingContracts);
|
|
for (auto const& c: m_pendingContracts)
|
|
cs.addSource(c.first.toStdString(), c.second.toStdString());
|
|
}
|
|
cs.compile(false);
|
|
collectContracts(cs);
|
|
}
|
|
catch (dev::Exception const& _exception)
|
|
{
|
|
std::ostringstream error;
|
|
solidity::SourceReferenceFormatter::printExceptionInformation(error, _exception, "Error", cs);
|
|
QString message = QString::fromStdString(error.str());
|
|
QString sourceName;
|
|
if (SourceLocation const* location = boost::get_error_info<solidity::errinfo_sourceLocation>(_exception))
|
|
{
|
|
if (location->sourceName)
|
|
sourceName = QString::fromStdString(*location->sourceName);
|
|
if (!sourceName.isEmpty())
|
|
if (CompiledContract* contract = contractByDocumentId(sourceName))
|
|
message = message.replace(sourceName, contract->contract()->name()); //substitute the location to match our contract names
|
|
}
|
|
compilationError(message, sourceName);
|
|
}
|
|
m_compiling = false;
|
|
emit stateChanged();
|
|
}
|
|
|
|
void CodeModel::collectContracts(dev::solidity::CompilerStack const& _cs)
|
|
{
|
|
Guard pl(x_pendingContracts);
|
|
Guard l(x_contractMap);
|
|
ContractMap result;
|
|
for (std::string n: _cs.getContractNames())
|
|
{
|
|
if (c_predefinedContracts.count(n) != 0)
|
|
continue;
|
|
QString name = QString::fromStdString(n);
|
|
ContractDefinition const& contractDefinition = _cs.getContractDefinition(n);
|
|
if (!contractDefinition.isFullyImplemented())
|
|
continue;
|
|
QString sourceName = QString::fromStdString(*contractDefinition.getLocation().sourceName);
|
|
auto sourceIter = m_pendingContracts.find(sourceName);
|
|
QString source = sourceIter != m_pendingContracts.end() ? sourceIter->second : QString();
|
|
CompiledContract* contract = new CompiledContract(_cs, name, source);
|
|
QQmlEngine::setObjectOwnership(contract, QQmlEngine::CppOwnership);
|
|
result[name] = contract;
|
|
CompiledContract* prevContract = nullptr;
|
|
// find previous contract by name
|
|
for (ContractMap::const_iterator c = m_contractMap.cbegin(); c != m_contractMap.cend(); ++c)
|
|
if (c.value()->contract()->name() == contract->contract()->name())
|
|
prevContract = c.value();
|
|
|
|
// if not found, try by documentId
|
|
if (!prevContract)
|
|
{
|
|
for (ContractMap::const_iterator c = m_contractMap.cbegin(); c != m_contractMap.cend(); ++c)
|
|
if (c.value()->documentId() == contract->documentId())
|
|
{
|
|
//make sure there are no other contracts in the same source, otherwise it is not a rename
|
|
if (!std::any_of(result.begin(),result.end(), [=](ContractMap::const_iterator::value_type _v) { return _v != contract && _v->documentId() == contract->documentId(); }))
|
|
prevContract = c.value();
|
|
}
|
|
}
|
|
if (prevContract != nullptr && prevContract->contractInterface() != result[name]->contractInterface())
|
|
emit contractInterfaceChanged(name);
|
|
if (prevContract == nullptr)
|
|
emit newContractCompiled(name);
|
|
else if (prevContract->contract()->name() != name)
|
|
emit contractRenamed(contract->documentId(), prevContract->contract()->name(), name);
|
|
}
|
|
releaseContracts();
|
|
m_contractMap.swap(result);
|
|
emit codeChanged();
|
|
emit compilationComplete();
|
|
}
|
|
|
|
bool CodeModel::hasContract() const
|
|
{
|
|
Guard l(x_contractMap);
|
|
return m_contractMap.size() != 0;
|
|
}
|
|
|
|
dev::bytes const& CodeModel::getStdContractCode(const QString& _contractName, const QString& _url)
|
|
{
|
|
auto cached = m_compiledContracts.find(_contractName);
|
|
if (cached != m_compiledContracts.end())
|
|
return cached->second;
|
|
|
|
FileIo fileIo;
|
|
std::string source = fileIo.readFile(_url).toStdString();
|
|
solidity::CompilerStack cs(false);
|
|
cs.setSource(source);
|
|
cs.compile(false);
|
|
for (std::string const& name: cs.getContractNames())
|
|
{
|
|
dev::bytes code = cs.getBytecode(name);
|
|
m_compiledContracts.insert(std::make_pair(QString::fromStdString(name), std::move(code)));
|
|
}
|
|
return m_compiledContracts.at(_contractName);
|
|
}
|
|
|
|
SolidityType CodeModel::nodeType(dev::solidity::Type const* _type)
|
|
{
|
|
SolidityType r { SolidityType::Type::UnsignedInteger, 32, 1, false, false, QString::fromStdString(_type->toString()), std::vector<SolidityDeclaration>(), std::vector<QString>() };
|
|
if (!_type)
|
|
return r;
|
|
switch (_type->getCategory())
|
|
{
|
|
case Type::Category::Integer:
|
|
{
|
|
IntegerType const* it = dynamic_cast<IntegerType const*>(_type);
|
|
r.size = it->getNumBits() / 8;
|
|
r.type = it->isAddress() ? SolidityType::Type::Address : it->isSigned() ? SolidityType::Type::SignedInteger : SolidityType::Type::UnsignedInteger;
|
|
}
|
|
break;
|
|
case Type::Category::Bool:
|
|
r.type = SolidityType::Type::Bool;
|
|
break;
|
|
case Type::Category::FixedBytes:
|
|
{
|
|
FixedBytesType const* b = dynamic_cast<FixedBytesType const*>(_type);
|
|
r.type = SolidityType::Type::Bytes;
|
|
r.size = static_cast<unsigned>(b->getNumBytes());
|
|
}
|
|
break;
|
|
case Type::Category::Contract:
|
|
r.type = SolidityType::Type::Address;
|
|
break;
|
|
case Type::Category::Array:
|
|
{
|
|
ArrayType const* array = dynamic_cast<ArrayType const*>(_type);
|
|
if (array->isByteArray())
|
|
r.type = SolidityType::Type::Bytes;
|
|
else
|
|
{
|
|
SolidityType elementType = nodeType(array->getBaseType().get());
|
|
elementType.name = r.name;
|
|
r = elementType;
|
|
}
|
|
r.count = static_cast<unsigned>(array->getLength());
|
|
r.dynamicSize = _type->isDynamicallySized();
|
|
r.array = true;
|
|
}
|
|
break;
|
|
case Type::Category::Enum:
|
|
{
|
|
r.type = SolidityType::Type::Enum;
|
|
EnumType const* e = dynamic_cast<EnumType const*>(_type);
|
|
for(auto const& enumValue: e->getEnumDefinition().getMembers())
|
|
r.enumNames.push_back(QString::fromStdString(enumValue->getName()));
|
|
}
|
|
break;
|
|
case Type::Category::Struct:
|
|
{
|
|
r.type = SolidityType::Type::Struct;
|
|
StructType const* s = dynamic_cast<StructType const*>(_type);
|
|
for(auto const& structMember: s->getMembers())
|
|
{
|
|
auto slotAndOffset = s->getStorageOffsetsOfMember(structMember.name);
|
|
r.members.push_back(SolidityDeclaration { QString::fromStdString(structMember.name), nodeType(structMember.type.get()), slotAndOffset.first, slotAndOffset.second });
|
|
}
|
|
}
|
|
break;
|
|
case Type::Category::Function:
|
|
case Type::Category::IntegerConstant:
|
|
case Type::Category::Magic:
|
|
case Type::Category::Mapping:
|
|
case Type::Category::Modifier:
|
|
case Type::Category::Real:
|
|
case Type::Category::TypeType:
|
|
case Type::Category::Void:
|
|
default:
|
|
break;
|
|
}
|
|
return r;
|
|
}
|
|
|
|
|