solidity/libsolidity/codegen/ir/Common.h

/*
	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
/**
 * Miscellaneous utilities for use in IR generator.
 */

#pragma once

#include <libsolidity/ast/AST.h>

#include <algorithm>
#include <string>

namespace solidity::frontend
{

class IRGenerationContext;

/**
 * Structure that describes arity and co-arity of a Yul function, i.e. the number of its inputs and outputs.
 */
struct YulArity
{
	explicit YulArity(size_t _in, size_t _out): in(_in), out(_out) {}

	static YulArity fromType(FunctionType const& _functionType);

	bool operator==(YulArity const& _other) const { return in == _other.in && out == _other.out; }
	bool operator!=(YulArity const& _other) const { return !(*this == _other); }

	size_t in;  /// Number of input parameters
	size_t out; /// Number of output parameters
};

struct IRNames
{
	static std::string externalFunctionABIWrapper(Declaration const& _functionOrVardecl);
	static std::string function(FunctionDefinition const& _function);
	static std::string function(VariableDeclaration const& _varDecl);
	static std::string modifierInvocation(ModifierInvocation const& _modifierInvocation);
	static std::string functionWithModifierInner(FunctionDefinition const& _function);
	static std::string creationObject(ContractDefinition const& _contract);
	static std::string deployedObject(ContractDefinition const& _contract);
	static std::string internalDispatch(YulArity const& _arity);
	static std::string constructor(ContractDefinition const& _contract);
	static std::string libraryAddressImmutable();
	static std::string constantValueFunction(VariableDeclaration const& _constant);
	static std::string localVariable(VariableDeclaration const& _declaration);
	static std::string localVariable(Expression const& _expression);
	/// @returns the variable name that can be used to inspect the success or failure of an external
	/// function call that was invoked as part of the try statement.
	static std::string trySuccessConditionVariable(Expression const& _expression);
	static std::string tupleComponent(size_t _i);
	static std::string zeroValue(Type const& _type, std::string const& _variableName);
};


/**
 * @returns a source location comment in the form of
 * `/// @src <sourceIndex>:<locationStart>:<locationEnd>`
 * and marks the source index as used.
 */
std::string dispenseLocationComment(langutil::SourceLocation const& _location, IRGenerationContext& _context);
std::string dispenseLocationComment(ASTNode const& _node, IRGenerationContext& _context);

}

// Overloading std::less() makes it possible to use YulArity as a map key. We could define operator<
// instead but such an operator would be a bit ambiguous (e.g. YulArity{2, 2} would be be greater than
// YulArity{1, 10} in lexicographical order but the latter has greater total number of inputs and outputs).
template<>
struct std::less<solidity::frontend::YulArity>
{
	bool operator() (solidity::frontend::YulArity const& _lhs, solidity::frontend::YulArity const& _rhs) const
	{
		return _lhs.in < _rhs.in || (_lhs.in == _rhs.in && _lhs.out < _rhs.out);
	}
};