aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/ASTAnnotations.h
blob: 9564d2d0d23543bf487d79e3f9f6c903fafaaae3 (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
/*
    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 2015
 * Object containing the type and other annotations for the AST nodes.
 */

#pragma once

#include <map>
#include <memory>
#include <vector>

namespace dev
{
namespace solidity
{

class ASTNode;
class ContractDefinition;
class Declaration;
class ParameterList;
class Type;
using TypePointer = std::shared_ptr<Type const>;

struct ASTAnnotation
{
    ///@TODO save space here - we do not need all members for all types.

    /// For expression: Inferred type. - For type declaration: Declared type. - For variable declaration: Type of variable.
    TypePointer type;
    /// For expression: Whether it is an LValue (i.e. something that can be assigned to).
    bool isLValue = false;
    /// For expression: Whether the expression is used in a context where the LValue is actually required.
    bool lValueRequested = false;
    /// For expressions: Types of arguments if the expression is a function that is called - used
    /// for overload resolution.
    std::shared_ptr<std::vector<TypePointer>> argumentTypes;
    /// For contract: Whether all functions are implemented.
    bool isFullyImplemented = true;
    /// For contract: List of all (direct and indirect) base contracts in order from derived to
    /// base, including the contract itself.
    std::vector<ContractDefinition const*> linearizedBaseContracts;
    /// For member access and Identifer: Referenced declaration, set during overload resolution stage.
    Declaration const* referencedDeclaration = nullptr;
    /// For Identifier: List of possible declarations it could refer to.
    std::vector<Declaration const*> overloadedDeclarations;
    /// For function call: Whether this is an explicit type conversion.
    bool isTypeConversion = false;
    /// For function call: Whether this is a struct constructor call.
    bool isStructConstructorCall = false;
    /// For Return statement: Reference to the return parameters of the function.
    ParameterList const* functionReturnParameters = nullptr;
    /// For Identifier: Stores a reference to the current contract.
    /// This is needed because types of base contracts change depending on the context.
    ContractDefinition const* contractScope = nullptr;
    /// For BinaryOperation: The common type that is used for the operation, not necessarily the result type (e.g. for
    /// comparisons, this is always bool).
    TypePointer commonType;
};

}
}