aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/analysis/ContractLevelChecker.h
blob: 15cbf45dc9004b798c69731925acfa533ad76c61 (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
/*
    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/>.
*/
/**
 * Component that verifies overloads, abstract contracts, function clashes and others
 * checks at contract or function level.
 */

#pragma once

#include <libsolidity/ast/ASTForward.h>

#include <map>

namespace langutil
{
class ErrorReporter;
}

namespace dev
{
namespace solidity
{

/**
 * Component that verifies overloads, abstract contracts, function clashes and others
 * checks at contract or function level.
 */
class ContractLevelChecker
{
public:
    /// @param _errorReporter provides the error logging functionality.
    explicit ContractLevelChecker(langutil::ErrorReporter& _errorReporter):
        m_errorReporter(_errorReporter)
    {}

    /// Performs checks on the given contract.
    /// @returns true iff all checks passed. Note even if all checks passed, errors() can still contain warnings
    bool check(ContractDefinition const& _contract);

private:
    /// Checks that two functions defined in this contract with the same name have different
    /// arguments and that there is at most one constructor.
    void checkDuplicateFunctions(ContractDefinition const& _contract);
    void checkDuplicateEvents(ContractDefinition const& _contract);
    template <class T>
    void findDuplicateDefinitions(std::map<std::string, std::vector<T>> const& _definitions, std::string _message);
    void checkIllegalOverrides(ContractDefinition const& _contract);
    /// Reports a type error with an appropriate message if overridden function signature differs.
    /// Also stores the direct super function in the AST annotations.
    void checkFunctionOverride(FunctionDefinition const& function, FunctionDefinition const& super);
    void overrideError(FunctionDefinition const& function, FunctionDefinition const& super, std::string message);
    void checkAbstractFunctions(ContractDefinition const& _contract);
    void checkBaseConstructorArguments(ContractDefinition const& _contract);
    void annotateBaseConstructorArguments(
        ContractDefinition const& _currentContract,
        FunctionDefinition const* _baseConstructor,
        ASTNode const* _argumentNode
    );
    void checkConstructor(ContractDefinition const& _contract);
    void checkFallbackFunction(ContractDefinition const& _contract);
    /// Checks that different functions with external visibility end up having different
    /// external argument types (i.e. different signature).
    void checkExternalTypeClashes(ContractDefinition const& _contract);
    /// Checks for hash collisions in external function signatures.
    void checkHashCollisions(ContractDefinition const& _contract);
    /// Checks that all requirements for a library are fulfilled if this is a library.
    void checkLibraryRequirements(ContractDefinition const& _contract);

    langutil::ErrorReporter& m_errorReporter;
};

}
}