aboutsummaryrefslogtreecommitdiffstats
path: root/Types.h
blob: c9f6da5741ada2ea8d09cc05cf39deac15f6e115 (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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
/*
    This file is part of cpp-ethereum.

    cpp-ethereum 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.

    cpp-ethereum 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 cpp-ethereum.  If not, see <http://www.gnu.org/licenses/>.
*/
/**
 * @author Christian <c@ethdev.com>
 * @date 2014
 * Solidity data types
 */

#pragma once

#include <memory>
#include <string>
#include <boost/noncopyable.hpp>
#include <libdevcore/Common.h>
#include <libsolidity/ASTForward.h>
#include <libsolidity/Token.h>

namespace dev
{
namespace solidity
{

// @todo realMxN, string<N>, mapping

/**
 * Abstract base class that forms the root of the type hierarchy.
 */
class Type: private boost::noncopyable
{
public:
    enum class Category
    {
        INTEGER, BOOL, REAL, STRING, CONTRACT, STRUCT, FUNCTION, MAPPING, VOID, TYPE
    };

    ///@{
    ///@name Factory functions
    /// Factory functions that convert an AST @ref TypeName to a Type.
    static std::shared_ptr<Type> fromElementaryTypeName(Token::Value _typeToken);
    static std::shared_ptr<Type> fromUserDefinedTypeName(UserDefinedTypeName const& _typeName);
    static std::shared_ptr<Type> fromMapping(Mapping const& _typeName);
    /// @}

    /// Auto-detect the proper type for a literal
    static std::shared_ptr<Type> forLiteral(Literal const& _literal);

    virtual Category getCategory() const = 0;
    virtual bool isImplicitlyConvertibleTo(Type const& _other) const { return *this == _other; }
    virtual bool isExplicitlyConvertibleTo(Type const& _convertTo) const
    {
        return isImplicitlyConvertibleTo(_convertTo);
    }
    virtual bool acceptsBinaryOperator(Token::Value) const { return false; }
    virtual bool acceptsUnaryOperator(Token::Value) const { return false; }

    virtual bool operator==(Type const& _other) const { return getCategory() == _other.getCategory(); }
    virtual bool operator!=(Type const& _other) const { return !this->operator ==(_other); }

    virtual std::string toString() const = 0;
    virtual bytes literalToBigEndian(Literal const&) const { return NullBytes; }
};

/**
 * Any kind of integer type including hash and address.
 */
class IntegerType: public Type
{
public:
    enum class Modifier
    {
        UNSIGNED, SIGNED, HASH, ADDRESS
    };
    virtual Category getCategory() const override { return Category::INTEGER; }

    static std::shared_ptr<IntegerType> smallestTypeForLiteral(std::string const& _literal);

    explicit IntegerType(int _bits, Modifier _modifier = Modifier::UNSIGNED);

    virtual bool isImplicitlyConvertibleTo(Type const& _convertTo) const override;
    virtual bool isExplicitlyConvertibleTo(Type const& _convertTo) const override;
    virtual bool acceptsBinaryOperator(Token::Value _operator) const override;
    virtual bool acceptsUnaryOperator(Token::Value _operator) const override;

    virtual bool operator==(Type const& _other) const override;

    virtual std::string toString() const override;
    virtual bytes literalToBigEndian(Literal const& _literal) const override;

    int getNumBits() const { return m_bits; }
    bool isHash() const { return m_modifier == Modifier::HASH || m_modifier == Modifier::ADDRESS; }
    bool isAddress() const { return m_modifier == Modifier::ADDRESS; }
    int isSigned() const { return m_modifier == Modifier::SIGNED; }

private:
    int m_bits;
    Modifier m_modifier;
};

/**
 * The boolean type.
 */
class BoolType: public Type
{
public:
    virtual Category getCategory() const { return Category::BOOL; }
    virtual bool isExplicitlyConvertibleTo(Type const& _convertTo) const override;
    virtual bool acceptsBinaryOperator(Token::Value _operator) const override
    {
        return _operator == Token::AND || _operator == Token::OR;
    }
    virtual bool acceptsUnaryOperator(Token::Value _operator) const override
    {
        return _operator == Token::NOT || _operator == Token::DELETE;
    }

    virtual std::string toString() const override { return "bool"; }
    virtual bytes literalToBigEndian(Literal const& _literal) const override;
};

/**
 * The type of a contract instance, there is one distinct type for each contract definition.
 */
class ContractType: public Type
{
public:
    virtual Category getCategory() const override { return Category::CONTRACT; }
    ContractType(ContractDefinition const& _contract): m_contract(_contract) {}

    virtual bool operator==(Type const& _other) const override;

    virtual std::string toString() const override { return "contract{...}"; }

private:
    ContractDefinition const& m_contract;
};

/**
 * The type of a struct instance, there is one distinct type per struct definition.
 */
class StructType: public Type
{
public:
    virtual Category getCategory() const override { return Category::STRUCT; }
    StructType(StructDefinition const& _struct): m_struct(_struct) {}
    virtual bool acceptsUnaryOperator(Token::Value _operator) const override
    {
        return _operator == Token::DELETE;
    }

    virtual bool operator==(Type const& _other) const override;

    virtual std::string toString() const override { return "struct{...}"; }

private:
    StructDefinition const& m_struct;
};

/**
 * The type of a function, there is one distinct type per function definition.
 */
class FunctionType: public Type
{
public:
    virtual Category getCategory() const override { return Category::FUNCTION; }
    FunctionType(FunctionDefinition const& _function): m_function(_function) {}

    FunctionDefinition const& getFunction() const { return m_function; }

    virtual std::string toString() const override { return "function(...)returns(...)"; }

    virtual bool operator==(Type const& _other) const override;

private:
    FunctionDefinition const& m_function;
};

/**
 * The type of a mapping, there is one distinct type per key/value type pair.
 */
class MappingType: public Type
{
public:
    virtual Category getCategory() const override { return Category::MAPPING; }
    MappingType() {}
    virtual std::string toString() const override { return "mapping(...=>...)"; }

    virtual bool operator==(Type const& _other) const override;

private:
    std::shared_ptr<Type const> m_keyType;
    std::shared_ptr<Type const> m_valueType;
};

/**
 * The void type, can only be implicitly used as the type that is returned by functions without
 * return parameters.
 */
class VoidType: public Type
{
public:
    virtual Category getCategory() const override { return Category::VOID; }
    VoidType() {}

    virtual std::string toString() const override { return "void"; }
};

/**
 * The type of a type reference. The type of "uint32" when used in "a = uint32(2)" is an example
 * of a TypeType.
 */
class TypeType: public Type
{
public:
    virtual Category getCategory() const override { return Category::TYPE; }
    TypeType(std::shared_ptr<Type const> const& _actualType): m_actualType(_actualType) {}

    std::shared_ptr<Type const> const& getActualType() const { return m_actualType; }

    virtual bool operator==(Type const& _other) const override;

    virtual std::string toString() const override { return "type(" + m_actualType->toString() + ")"; }

private:
    std::shared_ptr<Type const> m_actualType;
};


}
}