aboutsummaryrefslogtreecommitdiffstats
path: root/libyul/backends/evm/EVMDialect.h
blob: feb00b038d91eefdf695e85edddf0eac775ddd37 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/*
    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/>.
*/
/**
 * Yul dialects for EVM.
 */

#pragma once

#include <libyul/Dialect.h>

#include <libyul/backends/evm/AbstractAssembly.h>

#include <map>

namespace yul
{

class YulString;
using Type = YulString;
struct FunctionCall;
struct Object;

struct BuiltinFunctionForEVM: BuiltinFunction
{
    /// Function to generate code for the given function call and append it to the abstract
    /// assembly. The third parameter is called to visit (and generate code for) the arguments
    /// from right to left.
    std::function<void(FunctionCall const&, AbstractAssembly&, std::function<void()>)> generateCode;
};

/**
 * Yul dialect for EVM as a backend.
 * The main difference is that the builtin functions take an AbstractAssembly for the
 * code generation.
 */
struct EVMDialect: public Dialect
{
    EVMDialect(AsmFlavour _flavour, bool _objectAccess);

    /// @returns the builtin function of the given name or a nullptr if it is not a builtin function.
    BuiltinFunctionForEVM const* builtin(YulString _name) const override;

    static std::shared_ptr<EVMDialect> looseAssemblyForEVM();
    static std::shared_ptr<EVMDialect> strictAssemblyForEVM();
    static std::shared_ptr<EVMDialect> strictAssemblyForEVMObjects();
    static std::shared_ptr<EVMDialect> yulForEVM();

    bool providesObjectAccess() const { return m_objectAccess; }

    /// Sets the mapping of current sub assembly IDs. Used during code generation.
    void setSubIDs(std::map<YulString, AbstractAssembly::SubID> _subIDs);
    /// Sets the current object. Used during code generation.
    void setCurrentObject(Object const* _object);

private:
    void addFunction(
        std::string _name,
        size_t _params,
        size_t _returns,
        bool _movable,
        std::function<void(FunctionCall const&, AbstractAssembly&, std::function<void()>)> _generateCode
    );

    bool m_objectAccess;
    Object const* m_currentObject = nullptr;
    /// Mapping from named objects to abstract assembly sub IDs.
    std::map<YulString, AbstractAssembly::SubID> m_subIDs;
    std::map<YulString, BuiltinFunctionForEVM> m_functions;
};

}