aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/analysis/ViewPureChecker.h
blob: fd2432a7dae7e4a6547c359bb604b8b7fa3e3fcd (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
/*
    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/ast/ASTEnums.h>
#include <libsolidity/ast/ASTForward.h>
#include <libsolidity/ast/ASTVisitor.h>

#include <map>
#include <memory>

namespace langutil
{
class ErrorReporter;
struct SourceLocation;
}

namespace dev
{
namespace solidity
{

class ViewPureChecker: private ASTConstVisitor
{
public:
    ViewPureChecker(std::vector<std::shared_ptr<ASTNode>> const& _ast, langutil::ErrorReporter& _errorReporter):
        m_ast(_ast), m_errorReporter(_errorReporter) {}

    bool check();

private:
    struct MutabilityAndLocation
    {
        StateMutability mutability;
        langutil::SourceLocation location;
    };

    bool visit(FunctionDefinition const& _funDef) override;
    void endVisit(FunctionDefinition const& _funDef) override;
    bool visit(ModifierDefinition const& _modifierDef) override;
    void endVisit(ModifierDefinition const& _modifierDef) override;
    void endVisit(Identifier const& _identifier) override;
    bool visit(MemberAccess const& _memberAccess) override;
    void endVisit(MemberAccess const& _memberAccess) override;
    void endVisit(IndexAccess const& _indexAccess) override;
    void endVisit(ModifierInvocation const& _modifier) override;
    void endVisit(FunctionCall const& _functionCall) override;
    void endVisit(InlineAssembly const& _inlineAssembly) override;

    /// Called when an element of mutability @a _mutability is encountered.
    /// Creates appropriate warnings and errors and sets @a m_currentBestMutability.
    void reportMutability(
        StateMutability _mutability,
        langutil::SourceLocation const& _location,
        boost::optional<langutil::SourceLocation> const& _nestedLocation = {}
    );

    std::vector<std::shared_ptr<ASTNode>> const& m_ast;
    langutil::ErrorReporter& m_errorReporter;

    bool m_errors = false;
    MutabilityAndLocation m_bestMutabilityAndLocation = MutabilityAndLocation{StateMutability::Payable, langutil::SourceLocation()};
    FunctionDefinition const* m_currentFunction = nullptr;
    std::map<ModifierDefinition const*, MutabilityAndLocation> m_inferredMutability;
};

}
}