aboutsummaryrefslogtreecommitdiffstats
path: root/NameAndTypeResolver.h
blob: 1032a87cf9bb4c4a8f93b8ea440bf4c3c8d723d0 (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
/*
    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
 * Parser part that determines the declarations corresponding to names and the types of expressions.
 */

#pragma once

#include <map>
#include <boost/noncopyable.hpp>

#include <libsolidity/DeclarationContainer.h>
#include <libsolidity/ASTVisitor.h>

namespace dev
{
namespace solidity
{

/**
 * Resolves name references, types and checks types of all expressions.
 * Specifically, it checks that all operations are valid for the inferred types.
 * An exception is throw on the first error.
 */
class NameAndTypeResolver: private boost::noncopyable
{
public:
    explicit NameAndTypeResolver(std::vector<Declaration const*> const& _globals);
    /// Registers all declarations found in the source unit.
    void registerDeclarations(SourceUnit& _sourceUnit);
    /// Resolves all names and types referenced from the given contract.
    void resolveNamesAndTypes(ContractDefinition& _contract);
    /// Check all type requirements in the given contract.
    void checkTypeRequirements(ContractDefinition& _contract);
    /// Updates the given global declaration (used for "this"). Not to be used with declarations
    /// that create their own scope.
    void updateDeclaration(Declaration const& _declaration);

    /// Resolves the given @a _name inside the scope @a _scope. If @a _scope is omitted,
    /// the global scope is used (i.e. the one containing only the contract).
    /// @returns a pointer to the declaration on success or nullptr on failure.
    Declaration const* resolveName(ASTString const& _name, Declaration const* _scope = nullptr) const;

    /// Resolves a name in the "current" scope. Should only be called during the initial
    /// resolving phase.
    Declaration const* getNameFromCurrentScope(ASTString const& _name, bool _recursive = true);

private:
    void reset();

    /// Maps nodes declaring a scope to scopes, i.e. ContractDefinition and FunctionDeclaration,
    /// where nullptr denotes the global scope. Note that structs are not scope since they do
    /// not contain code.
    std::map<ASTNode const*, DeclarationContainer> m_scopes;

    DeclarationContainer* m_currentScope = nullptr;
};

/**
 * Traverses the given AST upon construction and fills _scopes with all declarations inside the
 * AST.
 */
class DeclarationRegistrationHelper: private ASTVisitor
{
public:
    DeclarationRegistrationHelper(std::map<ASTNode const*, DeclarationContainer>& _scopes, ASTNode& _astRoot);

private:
    bool visit(ContractDefinition& _contract);
    void endVisit(ContractDefinition& _contract);
    bool visit(StructDefinition& _struct);
    void endVisit(StructDefinition& _struct);
    bool visit(FunctionDefinition& _function);
    void endVisit(FunctionDefinition& _function);
    void endVisit(VariableDefinition& _variableDefinition);
    bool visit(VariableDeclaration& _declaration);

    void enterNewSubScope(Declaration const& _declaration);
    void closeCurrentScope();
    void registerDeclaration(Declaration& _declaration, bool _opensScope);

    std::map<ASTNode const*, DeclarationContainer>& m_scopes;
    Declaration const* m_currentScope;
    FunctionDefinition* m_currentFunction;
};

/**
 * Resolves references to declarations (of variables and types) and also establishes the link
 * between a return statement and the return parameter list.
 */
class ReferencesResolver: private ASTVisitor
{
public:
    ReferencesResolver(ASTNode& _root, NameAndTypeResolver& _resolver,
                       ParameterList* _returnParameters, bool _allowLazyTypes = true);

private:
    virtual void endVisit(VariableDeclaration& _variable) override;
    virtual bool visit(Identifier& _identifier) override;
    virtual bool visit(UserDefinedTypeName& _typeName) override;
    virtual bool visit(Mapping&) override;
    virtual bool visit(Return& _return) override;

    NameAndTypeResolver& m_resolver;
    ParameterList* m_returnParameters;
    bool m_allowLazyTypes;
};

}
}