solidity/libyul/AsmPrinter.cpp

255 lines
6.9 KiB
C++
Raw Normal View History

2017-02-09 13:04:23 +00:00
/*
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 Christian <c@ethdev.com>
* @date 2017
* Converts a parsed assembly into its textual form.
*/
#include <libyul/AsmPrinter.h>
#include <libyul/AsmData.h>
#include <libyul/Exceptions.h>
#include <libyul/Dialect.h>
2017-02-09 13:04:23 +00:00
#include <libsolutil/CommonData.h>
2017-02-09 13:04:23 +00:00
#include <boost/algorithm/string.hpp>
#include <boost/algorithm/string/replace.hpp>
#include <boost/range/adaptor/transformed.hpp>
#include <memory>
#include <functional>
using namespace std;
2019-12-11 16:31:36 +00:00
using namespace solidity;
using namespace solidity::util;
using namespace solidity::yul;
2017-02-09 13:04:23 +00:00
//@TODO source locations
2018-12-13 11:56:53 +00:00
string AsmPrinter::operator()(Literal const& _literal) const
2017-02-09 13:04:23 +00:00
{
switch (_literal.kind)
{
case LiteralKind::Number:
yulAssert(isValidDecimal(_literal.value.str()) || isValidHex(_literal.value.str()), "Invalid number literal");
return _literal.value.str() + appendTypeName(_literal.type);
case LiteralKind::Boolean:
yulAssert(_literal.value == "true"_yulstring || _literal.value == "false"_yulstring, "Invalid bool literal.");
return ((_literal.value == "true"_yulstring) ? "true" : "false") + appendTypeName(_literal.type, true);
case LiteralKind::String:
break;
}
2017-02-09 13:04:23 +00:00
string out;
for (char c: _literal.value.str())
2017-02-09 13:04:23 +00:00
if (c == '\\')
out += "\\\\";
else if (c == '"')
2017-02-14 14:41:07 +00:00
out += "\\\"";
2017-02-09 13:04:23 +00:00
else if (c == '\b')
out += "\\b";
else if (c == '\f')
out += "\\f";
else if (c == '\n')
out += "\\n";
else if (c == '\r')
out += "\\r";
else if (c == '\t')
out += "\\t";
else if (c == '\v')
out += "\\v";
else if (!isprint(c, locale::classic()))
{
ostringstream o;
2017-02-14 14:41:07 +00:00
o << std::hex << setfill('0') << setw(2) << (unsigned)(unsigned char)(c);
2017-02-14 12:59:15 +00:00
out += "\\x" + o.str();
2017-02-09 13:04:23 +00:00
}
else
out += c;
2017-04-26 22:58:34 +00:00
return "\"" + out + "\"" + appendTypeName(_literal.type);
2017-02-09 13:04:23 +00:00
}
2018-12-13 11:56:53 +00:00
string AsmPrinter::operator()(Identifier const& _identifier) const
2017-02-09 13:04:23 +00:00
{
yulAssert(!_identifier.name.empty(), "Invalid identifier.");
return _identifier.name.str();
2017-02-09 13:04:23 +00:00
}
2018-12-13 11:56:53 +00:00
string AsmPrinter::operator()(ExpressionStatement const& _statement) const
2017-12-08 13:01:22 +00:00
{
return std::visit(*this, _statement.expression);
2017-12-08 13:01:22 +00:00
}
2018-12-13 11:56:53 +00:00
string AsmPrinter::operator()(Assignment const& _assignment) const
2017-02-09 13:04:23 +00:00
{
yulAssert(_assignment.variableNames.size() >= 1, "");
string variables = (*this)(_assignment.variableNames.front());
for (size_t i = 1; i < _assignment.variableNames.size(); ++i)
variables += ", " + (*this)(_assignment.variableNames[i]);
return variables + " := " + std::visit(*this, *_assignment.value);
2017-02-09 13:04:23 +00:00
}
2018-12-13 11:56:53 +00:00
string AsmPrinter::operator()(VariableDeclaration const& _variableDeclaration) const
2017-02-09 13:04:23 +00:00
{
string out = "let ";
out += boost::algorithm::join(
_variableDeclaration.variables | boost::adaptors::transformed(
[this](TypedName argument) { return formatTypedName(argument); }
),
", "
);
if (_variableDeclaration.value)
{
out += " := ";
out += std::visit(*this, *_variableDeclaration.value);
}
return out;
2017-02-09 13:04:23 +00:00
}
2018-12-13 11:56:53 +00:00
string AsmPrinter::operator()(FunctionDefinition const& _functionDefinition) const
2017-02-09 13:04:23 +00:00
{
yulAssert(!_functionDefinition.name.empty(), "Invalid function name.");
string out = "function " + _functionDefinition.name.str() + "(";
2017-05-03 18:32:38 +00:00
out += boost::algorithm::join(
_functionDefinition.parameters | boost::adaptors::transformed(
[this](TypedName argument) { return formatTypedName(argument); }
2017-05-03 18:32:38 +00:00
),
", "
);
2017-04-26 22:58:34 +00:00
out += ")";
if (!_functionDefinition.returnVariables.empty())
2017-04-26 22:58:34 +00:00
{
out += " -> ";
2017-05-03 18:32:38 +00:00
out += boost::algorithm::join(
_functionDefinition.returnVariables | boost::adaptors::transformed(
[this](TypedName argument) { return formatTypedName(argument); }
2017-05-03 18:32:38 +00:00
),
", "
);
2017-04-26 22:58:34 +00:00
}
2017-02-09 13:04:23 +00:00
return out + "\n" + (*this)(_functionDefinition.body);
}
2018-12-13 11:56:53 +00:00
string AsmPrinter::operator()(FunctionCall const& _functionCall) const
2017-02-09 13:04:23 +00:00
{
return
(*this)(_functionCall.functionName) + "(" +
boost::algorithm::join(
_functionCall.arguments | boost::adaptors::transformed([&](auto&& _node) { return std::visit(*this, _node); }),
2017-02-09 13:04:23 +00:00
", " ) +
")";
}
2018-12-13 11:56:53 +00:00
string AsmPrinter::operator()(If const& _if) const
{
yulAssert(_if.condition, "Invalid if condition.");
string body = (*this)(_if.body);
char delim = '\n';
if (body.find('\n') == string::npos)
delim = ' ';
return "if " + std::visit(*this, *_if.condition) + delim + (*this)(_if.body);
}
2018-12-13 11:56:53 +00:00
string AsmPrinter::operator()(Switch const& _switch) const
{
yulAssert(_switch.expression, "Invalid expression pointer.");
string out = "switch " + std::visit(*this, *_switch.expression);
for (auto const& _case: _switch.cases)
{
2017-05-17 10:21:37 +00:00
if (!_case.value)
2017-05-19 16:54:55 +00:00
out += "\ndefault ";
else
2017-05-19 16:54:55 +00:00
out += "\ncase " + (*this)(*_case.value) + " ";
out += (*this)(_case.body);
}
return out;
}
2018-12-13 11:56:53 +00:00
string AsmPrinter::operator()(ForLoop const& _forLoop) const
{
yulAssert(_forLoop.condition, "Invalid for loop condition.");
string pre = (*this)(_forLoop.pre);
string condition = std::visit(*this, *_forLoop.condition);
string post = (*this)(_forLoop.post);
char delim = '\n';
if (
pre.size() + condition.size() + post.size() < 60 &&
pre.find('\n') == string::npos &&
post.find('\n') == string::npos
)
delim = ' ';
return
("for " + move(pre) + delim + move(condition) + delim + move(post) + "\n") +
(*this)(_forLoop.body);
}
string AsmPrinter::operator()(Break const&) const
{
return "break";
}
string AsmPrinter::operator()(Continue const&) const
{
return "continue";
}
2019-10-28 14:25:02 +00:00
string AsmPrinter::operator()(Leave const&) const
{
return "leave";
}
2018-12-13 11:56:53 +00:00
string AsmPrinter::operator()(Block const& _block) const
2017-02-09 13:04:23 +00:00
{
2017-02-14 14:41:07 +00:00
if (_block.statements.empty())
return "{ }";
2017-02-09 13:04:23 +00:00
string body = boost::algorithm::join(
_block.statements | boost::adaptors::transformed([&](auto&& _node) { return std::visit(*this, _node); }),
2017-02-09 13:04:23 +00:00
"\n"
);
if (body.size() < 30 && body.find('\n') == string::npos)
return "{ " + body + " }";
else
{
boost::replace_all(body, "\n", "\n ");
return "{\n " + body + "\n}";
}
2017-02-09 13:04:23 +00:00
}
2017-04-26 22:58:34 +00:00
string AsmPrinter::formatTypedName(TypedName _variable) const
{
yulAssert(!_variable.name.empty(), "Invalid variable name.");
return _variable.name.str() + appendTypeName(_variable.type);
}
string AsmPrinter::appendTypeName(YulString _type, bool _isBoolLiteral) const
2017-04-26 22:58:34 +00:00
{
if (m_dialect && !_type.empty())
{
if (!_isBoolLiteral && _type == m_dialect->defaultType)
_type = {};
else if (_isBoolLiteral && _type == m_dialect->boolType && !m_dialect->defaultType.empty())
// Special case: If we have a bool type but empty default type, do not remove the type.
_type = {};
}
if (_type.empty())
return {};
else
return ":" + _type.str();
2017-04-26 22:58:34 +00:00
}