mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
402 lines
13 KiB
C++
402 lines
13 KiB
C++
|
|
#include <libsolidity/InterfaceHandler.h>
|
|
#include <libsolidity/AST.h>
|
|
#include <libsolidity/CompilerStack.h>
|
|
using namespace std;
|
|
|
|
namespace dev
|
|
{
|
|
namespace solidity
|
|
{
|
|
|
|
/* -- public -- */
|
|
|
|
InterfaceHandler::InterfaceHandler()
|
|
{
|
|
m_lastTag = DocTagType::None;
|
|
}
|
|
|
|
std::unique_ptr<std::string> InterfaceHandler::getDocumentation(ContractDefinition const& _contractDef,
|
|
DocumentationType _type)
|
|
{
|
|
switch(_type)
|
|
{
|
|
case DocumentationType::NatspecUser:
|
|
return getUserDocumentation(_contractDef);
|
|
case DocumentationType::NatspecDev:
|
|
return getDevDocumentation(_contractDef);
|
|
case DocumentationType::ABIInterface:
|
|
return getABIInterface(_contractDef);
|
|
case DocumentationType::ABISolidityInterface:
|
|
return getABISolidityInterface(_contractDef);
|
|
}
|
|
|
|
BOOST_THROW_EXCEPTION(InternalCompilerError() << errinfo_comment("Unknown documentation type"));
|
|
return nullptr;
|
|
}
|
|
|
|
std::unique_ptr<std::string> InterfaceHandler::getABIInterface(ContractDefinition const& _contractDef)
|
|
{
|
|
Json::Value abi(Json::arrayValue);
|
|
for (auto const& it: _contractDef.getInterfaceFunctions())
|
|
{
|
|
auto populateParameters = [](vector<string> const& _paramNames, vector<string> const& _paramTypes)
|
|
{
|
|
Json::Value params(Json::arrayValue);
|
|
solAssert(_paramNames.size() == _paramTypes.size(), "Names and types vector size does not match");
|
|
for (unsigned i = 0; i < _paramNames.size(); ++i)
|
|
{
|
|
Json::Value param;
|
|
param["name"] = _paramNames[i];
|
|
param["type"] = _paramTypes[i];
|
|
params.append(param);
|
|
}
|
|
return params;
|
|
};
|
|
|
|
Json::Value method;
|
|
method["type"] = "function";
|
|
method["name"] = it.second->getDeclaration().getName();
|
|
method["constant"] = it.second->isConstant();
|
|
method["inputs"] = populateParameters(it.second->getParameterNames(),
|
|
it.second->getParameterTypeNames());
|
|
method["outputs"] = populateParameters(it.second->getReturnParameterNames(),
|
|
it.second->getReturnParameterTypeNames());
|
|
abi.append(method);
|
|
}
|
|
|
|
for (auto const& it: _contractDef.getInterfaceEvents())
|
|
{
|
|
Json::Value event;
|
|
event["type"] = "event";
|
|
event["name"] = it->getName();
|
|
event["anonymous"] = it->isAnonymous();
|
|
Json::Value params(Json::arrayValue);
|
|
for (auto const& p: it->getParameters())
|
|
{
|
|
Json::Value input;
|
|
input["name"] = p->getName();
|
|
input["type"] = p->getType()->toString();
|
|
input["indexed"] = p->isIndexed();
|
|
params.append(input);
|
|
}
|
|
event["inputs"] = params;
|
|
abi.append(event);
|
|
}
|
|
return std::unique_ptr<std::string>(new std::string(m_writer.write(abi)));
|
|
}
|
|
|
|
unique_ptr<string> InterfaceHandler::getABISolidityInterface(ContractDefinition const& _contractDef)
|
|
{
|
|
string ret = "contract " + _contractDef.getName() + "{";
|
|
for (auto const& it: _contractDef.getInterfaceFunctions())
|
|
{
|
|
auto populateParameters = [](vector<string> const& _paramNames,
|
|
vector<string> const& _paramTypes)
|
|
{
|
|
string r = "";
|
|
solAssert(_paramNames.size() == _paramTypes.size(), "Names and types vector size does not match");
|
|
for (unsigned i = 0; i < _paramNames.size(); ++i)
|
|
r += (r.size() ? "," : "(") + _paramTypes[i] + " " + _paramNames[i];
|
|
return r.size() ? r + ")" : "()";
|
|
};
|
|
ret += "function " + it.second->getDeclaration().getName() +
|
|
populateParameters(it.second->getParameterNames(), it.second->getParameterTypeNames()) +
|
|
(it.second->isConstant() ? "constant " : "");
|
|
if (it.second->getReturnParameterTypes().size())
|
|
ret += "returns" + populateParameters(it.second->getReturnParameterNames(), it.second->getReturnParameterTypeNames());
|
|
else if (ret.back() == ' ')
|
|
ret.pop_back();
|
|
ret += "{}";
|
|
}
|
|
|
|
return unique_ptr<string>(new string(ret + "}"));
|
|
}
|
|
|
|
std::unique_ptr<std::string> InterfaceHandler::getUserDocumentation(ContractDefinition const& _contractDef)
|
|
{
|
|
Json::Value doc;
|
|
Json::Value methods(Json::objectValue);
|
|
|
|
for (auto const& it: _contractDef.getInterfaceFunctions())
|
|
{
|
|
Json::Value user;
|
|
auto strPtr = it.second->getDocumentation();
|
|
if (strPtr)
|
|
{
|
|
resetUser();
|
|
parseDocString(*strPtr, CommentOwner::Function);
|
|
if (!m_notice.empty())
|
|
{// since @notice is the only user tag if missing function should not appear
|
|
user["notice"] = Json::Value(m_notice);
|
|
methods[it.second->externalSignature()] = user;
|
|
}
|
|
}
|
|
}
|
|
doc["methods"] = methods;
|
|
|
|
return std::unique_ptr<std::string>(new std::string(m_writer.write(doc)));
|
|
}
|
|
|
|
std::unique_ptr<std::string> InterfaceHandler::getDevDocumentation(ContractDefinition const& _contractDef)
|
|
{
|
|
// LTODO: Somewhere in this function warnings for mismatch of param names
|
|
// should be thrown
|
|
Json::Value doc;
|
|
Json::Value methods(Json::objectValue);
|
|
|
|
auto contractDoc = _contractDef.getDocumentation();
|
|
if (contractDoc)
|
|
{
|
|
m_contractAuthor.clear();
|
|
m_title.clear();
|
|
parseDocString(*contractDoc, CommentOwner::Contract);
|
|
|
|
if (!m_contractAuthor.empty())
|
|
doc["author"] = m_contractAuthor;
|
|
|
|
if (!m_title.empty())
|
|
doc["title"] = m_title;
|
|
}
|
|
|
|
for (auto const& it: _contractDef.getInterfaceFunctions())
|
|
{
|
|
Json::Value method;
|
|
auto strPtr = it.second->getDocumentation();
|
|
if (strPtr)
|
|
{
|
|
resetDev();
|
|
parseDocString(*strPtr, CommentOwner::Function);
|
|
|
|
if (!m_dev.empty())
|
|
method["details"] = Json::Value(m_dev);
|
|
|
|
if (!m_author.empty())
|
|
method["author"] = m_author;
|
|
|
|
Json::Value params(Json::objectValue);
|
|
std::vector<std::string> paramNames = it.second->getParameterNames();
|
|
for (auto const& pair: m_params)
|
|
{
|
|
if (find(paramNames.begin(), paramNames.end(), pair.first) == paramNames.end())
|
|
// LTODO: mismatching parameter name, throw some form of warning and not just an exception
|
|
BOOST_THROW_EXCEPTION(
|
|
DocstringParsingError() <<
|
|
errinfo_comment("documented parameter \"" + pair.first + "\" not found found in the function")
|
|
);
|
|
params[pair.first] = pair.second;
|
|
}
|
|
|
|
if (!m_params.empty())
|
|
method["params"] = params;
|
|
|
|
if (!m_return.empty())
|
|
method["return"] = m_return;
|
|
|
|
if (!method.empty()) // add the function, only if we have any documentation to add
|
|
methods[it.second->externalSignature()] = method;
|
|
}
|
|
}
|
|
doc["methods"] = methods;
|
|
|
|
return std::unique_ptr<std::string>(new std::string(m_writer.write(doc)));
|
|
}
|
|
|
|
/* -- private -- */
|
|
void InterfaceHandler::resetUser()
|
|
{
|
|
m_notice.clear();
|
|
}
|
|
|
|
void InterfaceHandler::resetDev()
|
|
{
|
|
m_dev.clear();
|
|
m_author.clear();
|
|
m_return.clear();
|
|
m_params.clear();
|
|
}
|
|
|
|
static inline std::string::const_iterator skipLineOrEOS(std::string::const_iterator _nlPos,
|
|
std::string::const_iterator _end)
|
|
{
|
|
return (_nlPos == _end) ? _end : ++_nlPos;
|
|
}
|
|
|
|
std::string::const_iterator InterfaceHandler::parseDocTagLine(std::string::const_iterator _pos,
|
|
std::string::const_iterator _end,
|
|
std::string& _tagString,
|
|
DocTagType _tagType,
|
|
bool _appending)
|
|
{
|
|
auto nlPos = std::find(_pos, _end, '\n');
|
|
if (_appending && _pos < _end && *_pos != ' ')
|
|
_tagString += " ";
|
|
std::copy(_pos, nlPos, back_inserter(_tagString));
|
|
m_lastTag = _tagType;
|
|
return skipLineOrEOS(nlPos, _end);
|
|
}
|
|
|
|
std::string::const_iterator InterfaceHandler::parseDocTagParam(std::string::const_iterator _pos,
|
|
std::string::const_iterator _end)
|
|
{
|
|
// find param name
|
|
auto currPos = std::find(_pos, _end, ' ');
|
|
if (currPos == _end)
|
|
BOOST_THROW_EXCEPTION(DocstringParsingError() << errinfo_comment("End of param name not found" + std::string(_pos, _end)));
|
|
|
|
|
|
auto paramName = std::string(_pos, currPos);
|
|
|
|
currPos += 1;
|
|
auto nlPos = std::find(currPos, _end, '\n');
|
|
auto paramDesc = std::string(currPos, nlPos);
|
|
m_params.push_back(std::make_pair(paramName, paramDesc));
|
|
|
|
m_lastTag = DocTagType::Param;
|
|
return skipLineOrEOS(nlPos, _end);
|
|
}
|
|
|
|
std::string::const_iterator InterfaceHandler::appendDocTagParam(std::string::const_iterator _pos,
|
|
std::string::const_iterator _end)
|
|
{
|
|
// Should never be called with an empty vector
|
|
solAssert(!m_params.empty(), "Internal: Tried to append to empty parameter");
|
|
|
|
auto pair = m_params.back();
|
|
if (_pos < _end && *_pos != ' ')
|
|
pair.second += " ";
|
|
auto nlPos = std::find(_pos, _end, '\n');
|
|
std::copy(_pos, nlPos, back_inserter(pair.second));
|
|
|
|
m_params.at(m_params.size() - 1) = pair;
|
|
|
|
return skipLineOrEOS(nlPos, _end);
|
|
}
|
|
|
|
std::string::const_iterator InterfaceHandler::parseDocTag(std::string::const_iterator _pos,
|
|
std::string::const_iterator _end,
|
|
std::string const& _tag,
|
|
CommentOwner _owner)
|
|
{
|
|
// LTODO: need to check for @(start of a tag) between here and the end of line
|
|
// for all cases. Also somehow automate list of acceptable tags for each
|
|
// language construct since current way does not scale well.
|
|
if (m_lastTag == DocTagType::None || _tag != "")
|
|
{
|
|
if (_tag == "dev")
|
|
return parseDocTagLine(_pos, _end, m_dev, DocTagType::Dev, false);
|
|
else if (_tag == "notice")
|
|
return parseDocTagLine(_pos, _end, m_notice, DocTagType::Notice, false);
|
|
else if (_tag == "return")
|
|
return parseDocTagLine(_pos, _end, m_return, DocTagType::Return, false);
|
|
else if (_tag == "author")
|
|
{
|
|
if (_owner == CommentOwner::Contract)
|
|
return parseDocTagLine(_pos, _end, m_contractAuthor, DocTagType::Author, false);
|
|
else if (_owner == CommentOwner::Function)
|
|
return parseDocTagLine(_pos, _end, m_author, DocTagType::Author, false);
|
|
else
|
|
// LTODO: for now this else makes no sense but later comments will go to more language constructs
|
|
BOOST_THROW_EXCEPTION(DocstringParsingError() << errinfo_comment("@author tag is legal only for contracts"));
|
|
}
|
|
else if (_tag == "title")
|
|
{
|
|
if (_owner == CommentOwner::Contract)
|
|
return parseDocTagLine(_pos, _end, m_title, DocTagType::Title, false);
|
|
else
|
|
// LTODO: Unknown tag, throw some form of warning and not just an exception
|
|
BOOST_THROW_EXCEPTION(DocstringParsingError() << errinfo_comment("@title tag is legal only for contracts"));
|
|
}
|
|
else if (_tag == "param")
|
|
return parseDocTagParam(_pos, _end);
|
|
else
|
|
// LTODO: Unknown tag, throw some form of warning and not just an exception
|
|
BOOST_THROW_EXCEPTION(DocstringParsingError() << errinfo_comment("Unknown tag " + _tag + " encountered"));
|
|
}
|
|
else
|
|
return appendDocTag(_pos, _end, _owner);
|
|
}
|
|
|
|
std::string::const_iterator InterfaceHandler::appendDocTag(std::string::const_iterator _pos,
|
|
std::string::const_iterator _end,
|
|
CommentOwner _owner)
|
|
{
|
|
switch (m_lastTag)
|
|
{
|
|
case DocTagType::Dev:
|
|
return parseDocTagLine(_pos, _end, m_dev, DocTagType::Dev, true);
|
|
case DocTagType::Notice:
|
|
return parseDocTagLine(_pos, _end, m_notice, DocTagType::Notice, true);
|
|
case DocTagType::Return:
|
|
return parseDocTagLine(_pos, _end, m_return, DocTagType::Return, true);
|
|
case DocTagType::Author:
|
|
if (_owner == CommentOwner::Contract)
|
|
return parseDocTagLine(_pos, _end, m_contractAuthor, DocTagType::Author, true);
|
|
else if (_owner == CommentOwner::Function)
|
|
return parseDocTagLine(_pos, _end, m_author, DocTagType::Author, true);
|
|
else
|
|
// LTODO: Unknown tag, throw some form of warning and not just an exception
|
|
BOOST_THROW_EXCEPTION(DocstringParsingError() << errinfo_comment("@author tag in illegal comment"));
|
|
case DocTagType::Title:
|
|
if (_owner == CommentOwner::Contract)
|
|
return parseDocTagLine(_pos, _end, m_title, DocTagType::Title, true);
|
|
else
|
|
// LTODO: Unknown tag, throw some form of warning and not just an exception
|
|
BOOST_THROW_EXCEPTION(DocstringParsingError() << errinfo_comment("@title tag in illegal comment"));
|
|
case DocTagType::Param:
|
|
return appendDocTagParam(_pos, _end);
|
|
default:
|
|
BOOST_THROW_EXCEPTION(InternalCompilerError() << errinfo_comment("Internal: Illegal documentation tag type"));
|
|
break;
|
|
}
|
|
}
|
|
|
|
static inline std::string::const_iterator getFirstSpaceOrNl(std::string::const_iterator _pos,
|
|
std::string::const_iterator _end)
|
|
{
|
|
auto spacePos = std::find(_pos, _end, ' ');
|
|
auto nlPos = std::find(_pos, _end, '\n');
|
|
return (spacePos < nlPos) ? spacePos : nlPos;
|
|
}
|
|
|
|
void InterfaceHandler::parseDocString(std::string const& _string, CommentOwner _owner)
|
|
{
|
|
auto currPos = _string.begin();
|
|
auto end = _string.end();
|
|
|
|
while (currPos != end)
|
|
{
|
|
auto tagPos = std::find(currPos, end, '@');
|
|
auto nlPos = std::find(currPos, end, '\n');
|
|
|
|
if (tagPos != end && tagPos < nlPos)
|
|
{
|
|
// we found a tag
|
|
auto tagNameEndPos = getFirstSpaceOrNl(tagPos, end);
|
|
if (tagNameEndPos == end)
|
|
BOOST_THROW_EXCEPTION(DocstringParsingError() <<
|
|
errinfo_comment("End of tag " + std::string(tagPos, tagNameEndPos) + "not found"));
|
|
|
|
currPos = parseDocTag(tagNameEndPos + 1, end, std::string(tagPos + 1, tagNameEndPos), _owner);
|
|
}
|
|
else if (m_lastTag != DocTagType::None) // continuation of the previous tag
|
|
currPos = appendDocTag(currPos, end, _owner);
|
|
else if (currPos != end)
|
|
{
|
|
// if it begins without a tag then consider it as @notice
|
|
if (currPos == _string.begin())
|
|
{
|
|
currPos = parseDocTag(currPos, end, "notice", CommentOwner::Function);
|
|
continue;
|
|
}
|
|
else if (nlPos == end) //end of text
|
|
return;
|
|
// else skip the line if a newline was found and we get here
|
|
currPos = nlPos + 1;
|
|
}
|
|
}
|
|
}
|
|
|
|
} //solidity NS
|
|
} // dev NS
|