aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/analysis/SyntaxChecker.h
blob: 9e3c4652546dea4cac5197d9bbea4d93369b9f12 (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
/*
    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/>.
*/

#pragma once

#include <libsolidity/analysis/TypeChecker.h>
#include <libsolidity/ast/Types.h>
#include <libsolidity/ast/ASTAnnotations.h>
#include <libsolidity/ast/ASTForward.h>
#include <libsolidity/ast/ASTVisitor.h>

namespace dev
{
namespace solidity
{

/**
 * The module that performs syntax analysis on the AST:
 *  - whether continue/break is in a for/while loop.
 *  - whether a modifier contains at least one '_'
 *  - issues deprecation warnings for unary '+'
 *  - issues deprecation warning for throw
 */
class SyntaxChecker: private ASTConstVisitor
{
public:
    /// @param _errorReporter provides the error logging functionality.
    SyntaxChecker(ErrorReporter& _errorReporter): m_errorReporter(_errorReporter) {}

    bool checkSyntax(ASTNode const& _astRoot);

private:

    bool visit(SourceUnit const& _sourceUnit) override;
    void endVisit(SourceUnit const& _sourceUnit) override;
    bool visit(PragmaDirective const& _pragma) override;

    bool visit(ModifierDefinition const& _modifier) override;
    void endVisit(ModifierDefinition const& _modifier) override;

    /// Reports an error if _statement is a VariableDeclarationStatement.
    /// Used by if/while/for to check for single statement variable declarations
    /// without a block.
    void checkSingleStatementVariableDeclaration(ASTNode const& _statement);

    bool visit(IfStatement const& _ifStatement) override;
    bool visit(WhileStatement const& _whileStatement) override;
    void endVisit(WhileStatement const& _whileStatement) override;
    bool visit(ForStatement const& _forStatement) override;
    void endVisit(ForStatement const& _forStatement) override;

    bool visit(Continue const& _continueStatement) override;
    bool visit(Break const& _breakStatement) override;

    bool visit(Throw const& _throwStatement) override;

    bool visit(UnaryOperation const& _operation) override;

    bool visit(PlaceholderStatement const& _placeholderStatement) override;

    bool visit(ContractDefinition const& _contract) override;
    bool visit(FunctionDefinition const& _function) override;
    bool visit(FunctionTypeName const& _node) override;

    bool visit(VariableDeclarationStatement const& _statement) override;

    bool visit(StructDefinition const& _struct) override;
    bool visit(Literal const& _literal) override;

    ErrorReporter& m_errorReporter;

    /// Flag that indicates whether a function modifier actually contains '_'.
    bool m_placeholderFound = false;

    /// Flag that indicates whether some version pragma was present.
    bool m_versionPragmaFound = false;

    int m_inLoopDepth = 0;
    bool m_isInterface = false;

    SourceUnit const* m_sourceUnit = nullptr;
};

}
}