mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
101 lines
3.4 KiB
C++
101 lines
3.4 KiB
C++
/*
|
|
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/>.
|
|
*/
|
|
/**
|
|
* Component that can generate various useful Yul functions.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <liblangutil/EVMVersion.h>
|
|
|
|
#include <libsolidity/codegen/MultiUseYulFunctionCollector.h>
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
namespace dev
|
|
{
|
|
namespace solidity
|
|
{
|
|
|
|
class Type;
|
|
class ArrayType;
|
|
|
|
/**
|
|
* Component that can generate various useful Yul functions.
|
|
*/
|
|
class YulUtilFunctions
|
|
{
|
|
public:
|
|
explicit YulUtilFunctions(
|
|
langutil::EVMVersion _evmVersion,
|
|
std::shared_ptr<MultiUseYulFunctionCollector> _functionCollector
|
|
):
|
|
m_evmVersion(_evmVersion),
|
|
m_functionCollector(std::move(_functionCollector))
|
|
{}
|
|
|
|
/// @returns a function that combines the address and selector to a single value
|
|
/// for use in the ABI.
|
|
std::string combineExternalFunctionIdFunction();
|
|
|
|
/// @returns a function that splits the address and selector from a single value
|
|
/// for use in the ABI.
|
|
std::string splitExternalFunctionIdFunction();
|
|
|
|
/// @returns a function that copies raw bytes of dynamic length from calldata
|
|
/// or memory to memory.
|
|
/// Pads with zeros and might write more than exactly length.
|
|
std::string copyToMemoryFunction(bool _fromCalldata);
|
|
|
|
/// @returns the name of a function that takes a (cleaned) value of the given value type and
|
|
/// left-aligns it, usually for use in non-padded encoding.
|
|
std::string leftAlignFunction(Type const& _type);
|
|
|
|
std::string shiftLeftFunction(size_t _numBits);
|
|
std::string shiftRightFunction(size_t _numBits);
|
|
/// @returns the name of a function that rounds its input to the next multiple
|
|
/// of 32 or the input if it is a multiple of 32.
|
|
std::string roundUpFunction();
|
|
|
|
std::string arrayLengthFunction(ArrayType const& _type);
|
|
/// @returns the name of a function that computes the number of bytes required
|
|
/// to store an array in memory given its length (internally encoded, not ABI encoded).
|
|
/// The function reverts for too large lengths.
|
|
std::string arrayAllocationSizeFunction(ArrayType const& _type);
|
|
/// @returns the name of a function that converts a storage slot number
|
|
/// or a memory pointer to the slot number / memory pointer for the data position of an array
|
|
/// which is stored in that slot / memory area.
|
|
std::string arrayDataAreaFunction(ArrayType const& _type);
|
|
/// @returns the name of a function that advances an array data pointer to the next element.
|
|
/// Only works for memory arrays and storage arrays that store one item per slot.
|
|
std::string nextArrayElementFunction(ArrayType const& _type);
|
|
|
|
/// @returns the name of a function that allocates memory.
|
|
/// Modifies the "free memory pointer"
|
|
/// Arguments: size
|
|
/// Return value: pointer
|
|
std::string allocationFunction();
|
|
|
|
private:
|
|
langutil::EVMVersion m_evmVersion;
|
|
std::shared_ptr<MultiUseYulFunctionCollector> m_functionCollector;
|
|
};
|
|
|
|
}
|
|
}
|