aboutsummaryrefslogtreecommitdiffstats
path: root/Types.h
blob: aed8a7e7c58821f4e536420da139b9a7486960ae (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
/*
    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 <boost/assert.hpp>

#include <libsolidity/Token.h>

namespace dev
{
namespace solidity
{

// AST forward declarations
class ContractDefinition;
class FunctionDefinition;
class StructDefinition;
class Literal;
class ElementaryTypeName;
class UserDefinedTypeName;
class Mapping;

template <typename T>
using ptr = std::shared_ptr<T>;

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

class Type : private boost::noncopyable
{
public:
    enum class Category
    {
        INTEGER, BOOL, REAL, STRING, CONTRACT, STRUCT, FUNCTION, MAPPING, VOID, TYPE
    };

    //! factory functions that convert an AST TypeName to a Type.
    static ptr<Type> fromElementaryTypeName(Token::Value _typeToken);
    static ptr<Type> fromUserDefinedTypeName(UserDefinedTypeName const& _typeName);
    static ptr<Type> fromMapping(Mapping const& _typeName);

    static ptr<Type> forLiteral(Literal const& _literal);

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

class IntegerType : public Type
{
public:
    enum class Modifier
    {
        UNSIGNED, SIGNED, HASH, ADDRESS
    };
    virtual Category getCategory() const { return Category::INTEGER; }

    static 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(const Type& _convertTo) const override;
    virtual bool acceptsBinaryOperator(Token::Value _operator) const override;
    virtual bool acceptsUnaryOperator(Token::Value _operator) 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;
};

class BoolType : public Type
{
public:
    virtual Category getCategory() const { return Category::BOOL; }
    virtual bool isImplicitlyConvertibleTo(const Type& _convertTo) const override
    {
        return _convertTo.getCategory() == Category::BOOL;
    }
    virtual bool isExplicitlyConvertibleTo(const Type& _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;
    }
};

class ContractType : public Type
{
public:
    virtual Category getCategory() const { return Category::CONTRACT; }
    ContractType(ContractDefinition const& _contract) : m_contract(_contract) {}
    virtual bool isImplicitlyConvertibleTo(Type const& _convertTo) const;
private:
    ContractDefinition const& m_contract;
};

class StructType : public Type
{
public:
    virtual Category getCategory() const { return Category::STRUCT; }
    StructType(StructDefinition const& _struct) : m_struct(_struct) {}
    virtual bool isImplicitlyConvertibleTo(Type const& _convertTo) const;
    virtual bool acceptsUnaryOperator(Token::Value _operator) const override
    {
        return _operator == Token::DELETE;
    }
private:
    StructDefinition const& m_struct;
};

class FunctionType : public Type
{
public:
    virtual Category getCategory() const { return Category::FUNCTION; }
    FunctionType(FunctionDefinition const& _function) : m_function(_function) {}

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

class MappingType : public Type
{
public:
    virtual Category getCategory() const { return Category::MAPPING; }
    MappingType() {}
private:
    //@todo
};

//@todo should be changed into "empty anonymous struct"
class VoidType : public Type
{
public:
    virtual Category getCategory() const { return Category::VOID; }
    VoidType() {}
};

class TypeType : public Type
{
public:
    virtual Category getCategory() const { return Category::TYPE; }
    TypeType(ptr<Type> const& _actualType) : m_actualType(_actualType) {}

    ptr<Type> const& getActualType() { return m_actualType; }
private:
    ptr<Type> m_actualType;
};


}
}