/* 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 . */ /** * @author Christian * @date 2017 * Converts a parsed assembly into its textual form. */ #include #include #include #include #include #include #include #include #include using namespace std; using namespace dev; using namespace yul; //@TODO source locations string AsmPrinter::operator()(yul::Instruction const& _instruction) const { solAssert(!m_yul, ""); solAssert(isValidInstruction(_instruction.instruction), "Invalid instruction"); return boost::to_lower_copy(instructionInfo(_instruction.instruction).name); } string AsmPrinter::operator()(Literal const& _literal) const { switch (_literal.kind) { case LiteralKind::Number: solAssert(isValidDecimal(_literal.value.str()) || isValidHex(_literal.value.str()), "Invalid number literal"); return _literal.value.str() + appendTypeName(_literal.type); case LiteralKind::Boolean: solAssert(_literal.value == "true"_yulstring || _literal.value == "false"_yulstring, "Invalid bool literal."); return ((_literal.value == "true"_yulstring) ? "true" : "false") + appendTypeName(_literal.type); case LiteralKind::String: break; } string out; for (char c: _literal.value.str()) if (c == '\\') out += "\\\\"; else if (c == '"') out += "\\\""; 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; o << std::hex << setfill('0') << setw(2) << (unsigned)(unsigned char)(c); out += "\\x" + o.str(); } else out += c; return "\"" + out + "\"" + appendTypeName(_literal.type); } string AsmPrinter::operator()(Identifier const& _identifier) const { solAssert(!_identifier.name.empty(), "Invalid identifier."); return _identifier.name.str(); } string AsmPrinter::operator()(FunctionalInstruction const& _functionalInstruction) const { solAssert(!m_yul, ""); solAssert(isValidInstruction(_functionalInstruction.instruction), "Invalid instruction"); return boost::to_lower_copy(instructionInfo(_functionalInstruction.instruction).name) + "(" + boost::algorithm::join( _functionalInstruction.arguments | boost::adaptors::transformed(boost::apply_visitor(*this)), ", ") + ")"; } string AsmPrinter::operator()(ExpressionStatement const& _statement) const { return boost::apply_visitor(*this, _statement.expression); } string AsmPrinter::operator()(Label const& _label) const { solAssert(!m_yul, ""); solAssert(!_label.name.empty(), "Invalid label."); return _label.name.str() + ":"; } string AsmPrinter::operator()(Assignment const& _assignment) const { solAssert(_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 + " := " + boost::apply_visitor(*this, *_assignment.value); } string AsmPrinter::operator()(VariableDeclaration const& _variableDeclaration) const { string out = "let "; out += boost::algorithm::join( _variableDeclaration.variables | boost::adaptors::transformed( [this](TypedName argument) { return formatTypedName(argument); } ), ", " ); if (_variableDeclaration.value) { out += " := "; out += boost::apply_visitor(*this, *_variableDeclaration.value); } return out; } string AsmPrinter::operator()(FunctionDefinition const& _functionDefinition) const { solAssert(!_functionDefinition.name.empty(), "Invalid function name."); string out = "function " + _functionDefinition.name.str() + "("; out += boost::algorithm::join( _functionDefinition.parameters | boost::adaptors::transformed( [this](TypedName argument) { return formatTypedName(argument); } ), ", " ); out += ")"; if (!_functionDefinition.returnVariables.empty()) { out += " -> "; out += boost::algorithm::join( _functionDefinition.returnVariables | boost::adaptors::transformed( [this](TypedName argument) { return formatTypedName(argument); } ), ", " ); } return out + "\n" + (*this)(_functionDefinition.body); } string AsmPrinter::operator()(FunctionCall const& _functionCall) const { return (*this)(_functionCall.functionName) + "(" + boost::algorithm::join( _functionCall.arguments | boost::adaptors::transformed(boost::apply_visitor(*this)), ", " ) + ")"; } string AsmPrinter::operator()(If const& _if) const { solAssert(_if.condition, "Invalid if condition."); string body = (*this)(_if.body); char delim = '\n'; if (body.find('\n') == string::npos) delim = ' '; return "if " + boost::apply_visitor(*this, *_if.condition) + delim + (*this)(_if.body); } string AsmPrinter::operator()(Switch const& _switch) const { solAssert(_switch.expression, "Invalid expression pointer."); string out = "switch " + boost::apply_visitor(*this, *_switch.expression); for (auto const& _case: _switch.cases) { if (!_case.value) out += "\ndefault "; else out += "\ncase " + (*this)(*_case.value) + " "; out += (*this)(_case.body); } return out; } string AsmPrinter::operator()(ForLoop const& _forLoop) const { solAssert(_forLoop.condition, "Invalid for loop condition."); string pre = (*this)(_forLoop.pre); string condition = boost::apply_visitor(*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"; } string AsmPrinter::operator()(Block const& _block) const { if (_block.statements.empty()) return "{ }"; string body = boost::algorithm::join( _block.statements | boost::adaptors::transformed(boost::apply_visitor(*this)), "\n" ); if (body.size() < 30 && body.find('\n') == string::npos) return "{ " + body + " }"; else { boost::replace_all(body, "\n", "\n "); return "{\n " + body + "\n}"; } } string AsmPrinter::formatTypedName(TypedName _variable) const { solAssert(!_variable.name.empty(), "Invalid variable name."); return _variable.name.str() + appendTypeName(_variable.type); } string AsmPrinter::appendTypeName(YulString _type) const { if (m_yul && !_type.empty()) return ":" + _type.str(); return ""; }