/*

  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

/**

 * Small useful snippets for the optimiser.

 */

#pragma once

#include <libsolutil/Common.h>

#include <libsolutil/Numeric.h>

#include <libyul/ASTForward.h>

#include <string_view>

namespace solidity::yul

{

class Dialect;

class EVMDialect;

struct BuiltinFunction;

struct BuiltinFunctionForEVM;

std::string reindent(std::string const& _code);

LiteralValue valueOfNumberLiteral(std::string_view _literal);

LiteralValue valueOfStringLiteral(std::string_view _literal);

LiteralValue valueOfBuiltinStringLiteralArgument(std::string_view _literal);

LiteralValue valueOfBoolLiteral(std::string_view _literal);

LiteralValue valueOfLiteral(std::string_view _literal, LiteralKind const& _kind, bool _unlimitedLiteralArgument = false);

bool validLiteral(Literal const& _literal);

bool validStringLiteral(Literal const& _literal);

bool validNumberLiteral(Literal const& _literal);

bool validBoolLiteral(Literal const& _literal);

/// Produces a string representation of a Literal instance.

/// @param _literal the Literal to be formatted

/// @param _validated whether the Literal was already validated, i.e., assumptions are asserted in the method

/// @returns the literal's string representation

std::string formatLiteral(Literal const& _literal, bool _validated = true);

/**

 * Linear order on Yul AST nodes.

 *

 * Defines a linear order on Yul AST nodes to be used in maps and sets.

 * Note: the order is total and deterministic, but independent of the semantics, e.g.

 * it is not guaranteed that the false Literal is "less" than the true Literal.

 */

template<typename T>

struct Less

{

  bool operator()(T const& _lhs, T const& _rhs) const;

};

template<typename T>

struct Less<T*>

{

  bool operator()(T const* _lhs, T const* _rhs) const

  {

    if (_lhs && _rhs)

      return Less<T>{}(*_lhs, *_rhs);

    else

      return _lhs < _rhs;

  }

};

template<> bool Less<Literal>::operator()(Literal const& _lhs, Literal const& _rhs) const;

extern template struct Less<Literal>;

// This can only be used for cases within one switch statement and

// relies on the fact that there are no duplicate cases.

struct SwitchCaseCompareByLiteralValue

{

  bool operator()(Case const* _lhsCase, Case const* _rhsCase) const;

};

std::string_view resolveFunctionName(FunctionName const& _functionName, Dialect const& _dialect);

BuiltinFunction const* resolveBuiltinFunction(FunctionName const& _functionName, Dialect const& _dialect);

BuiltinFunctionForEVM const* resolveBuiltinFunctionForEVM(FunctionName const& _functionName, EVMDialect const& _dialect);

FunctionHandle functionNameToHandle(FunctionName const& _functionName);

}