AsmJsonConverter.cpp

/*
	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/>.
*/
// SPDX-License-Identifier: GPL-3.0
/**
 * @date 2019
 * Converts inline assembly AST to JSON format
 */

#include <libyul/AST.h>
#include <libyul/AsmJsonConverter.h>
#include <libyul/Exceptions.h>
#include <libyul/Utilities.h>
#include <libsolutil/CommonData.h>
#include <libsolutil/UTF8.h>

namespace solidity::yul
{

Json AsmJsonConverter::operator()(Block const& _node) const
{
	Json ret = createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulBlock");
	ret["statements"] = vectorOfVariantsToJson(_node.statements);
	return ret;
}

Json AsmJsonConverter::operator()(NameWithDebugData const& _node) const
{
	yulAssert(!_node.name.empty(), "Invalid variable name.");
	Json ret = createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulTypedName");
	ret["name"] = _node.name.str();
	// even though types are removed from Yul, we keep this field in the Json interface to not introduce
	// a breaking change
	// can be removed with the next breaking version
	ret["type"] = "";
	return ret;
}

Json AsmJsonConverter::operator()(Literal const& _node) const
{
	yulAssert(validLiteral(_node));
	Json ret = createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulLiteral");
	switch (_node.kind)
	{
	case LiteralKind::Number:
		ret["kind"] = "number";
		break;
	case LiteralKind::Boolean:
		ret["kind"] = "bool";
		break;
	case LiteralKind::String:
		ret["kind"] = "string";
		ret["hexValue"] = util::toHex(util::asBytes(formatLiteral(_node)));
		break;
	}
	ret["type"] = "";
	{
		auto const formattedLiteral = formatLiteral(_node);
		if (util::validateUTF8(formattedLiteral))
			ret["value"] = formattedLiteral;
	}
	return ret;
}

Json AsmJsonConverter::operator()(Identifier const& _node) const
{
	yulAssert(!_node.name.empty(), "Invalid identifier");
	Json ret = createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulIdentifier");
	ret["name"] = _node.name.str();
	return ret;
}

Json AsmJsonConverter::operator()(Assignment const& _node) const
{
	yulAssert(_node.variableNames.size() >= 1, "Invalid assignment syntax");
	Json ret = createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulAssignment");
	for (auto const& var: _node.variableNames)
		ret["variableNames"].emplace_back((*this)(var));
	ret["value"] = _node.value ? std::visit(*this, *_node.value) : Json();
	return ret;
}

Json AsmJsonConverter::operator()(FunctionCall const& _node) const
{
	Json ret = createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulFunctionCall");
	ret["functionName"] = (*this)(_node.functionName);
	ret["arguments"] = vectorOfVariantsToJson(_node.arguments);
	return ret;
}

Json AsmJsonConverter::operator()(ExpressionStatement const& _node) const
{
	Json ret = createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulExpressionStatement");
	ret["expression"] = std::visit(*this, _node.expression);
	return ret;
}

Json AsmJsonConverter::operator()(VariableDeclaration const& _node) const
{
	Json ret = createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulVariableDeclaration");
	for (auto const& var: _node.variables)
		ret["variables"].emplace_back((*this)(var));
	ret["value"] = _node.value ? std::visit(*this, *_node.value) : Json();
	return ret;
}

Json AsmJsonConverter::operator()(FunctionDefinition const& _node) const
{
	yulAssert(!_node.name.empty(), "Invalid function name.");
	Json ret = createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulFunctionDefinition");
	ret["name"] = _node.name.str();
	for (auto const& var: _node.parameters)
		ret["parameters"].emplace_back((*this)(var));
	for (auto const& var: _node.returnVariables)
		ret["returnVariables"].emplace_back((*this)(var));
	ret["body"] = (*this)(_node.body);
	return ret;
}

Json AsmJsonConverter::operator()(If const& _node) const
{
	yulAssert(_node.condition, "Invalid if condition.");
	Json ret = createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulIf");
	ret["condition"] = std::visit(*this, *_node.condition);
	ret["body"] = (*this)(_node.body);
	return ret;
}

Json AsmJsonConverter::operator()(Switch const& _node) const
{
	yulAssert(_node.expression, "Invalid expression pointer.");
	Json ret = createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulSwitch");
	ret["expression"] = std::visit(*this, *_node.expression);
	for (auto const& var: _node.cases)
		ret["cases"].emplace_back((*this)(var));
	return ret;
}

Json AsmJsonConverter::operator()(Case const& _node) const
{
	Json ret = createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulCase");
	ret["value"] = _node.value ? (*this)(*_node.value) : "default";
	ret["body"] = (*this)(_node.body);
	return ret;
}

Json AsmJsonConverter::operator()(ForLoop const& _node) const
{
	yulAssert(_node.condition, "Invalid for loop condition.");
	Json ret = createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulForLoop");
	ret["pre"] = (*this)(_node.pre);
	ret["condition"] = std::visit(*this, *_node.condition);
	ret["post"] = (*this)(_node.post);
	ret["body"] = (*this)(_node.body);
	return ret;
}

Json AsmJsonConverter::operator()(Break const& _node) const
{
	return createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulBreak");
}

Json AsmJsonConverter::operator()(Continue const& _node) const
{
	return createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulContinue");
}

Json AsmJsonConverter::operator()(Leave const& _node) const
{
	return createAstNode(originLocationOf(_node), nativeLocationOf(_node), "YulLeave");
}

Json AsmJsonConverter::createAstNode(langutil::SourceLocation const& _originLocation, langutil::SourceLocation const& _nativeLocation, std::string _nodeType) const
{
	Json ret;
	ret["nodeType"] = std::move(_nodeType);
	auto srcLocation = [&](int start, int end) -> std::string
	{
		int length = (start >= 0 && end >= 0 && end >= start) ? end - start : -1;
		return std::to_string(start) + ":" + std::to_string(length) + ":" + (m_sourceIndex.has_value() ? std::to_string(m_sourceIndex.value()) : "-1");
	};
	ret["src"] = srcLocation(_originLocation.start, _originLocation.end);
	ret["nativeSrc"] = srcLocation(_nativeLocation.start, _nativeLocation.end);
	return ret;
}

template <class T>
Json AsmJsonConverter::vectorOfVariantsToJson(std::vector<T> const& _vec) const
{
	Json ret = Json::array();
	for (auto const& var: _vec)
		ret.emplace_back(std::visit(*this, var));
	return ret;
}

}