aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/analysis/DocStringAnalyser.h
blob: f6b236db69b4a5dcbcef617d5203aa78b9ce148a (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
/*
    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/>.
*/
/**
 * @author Christian <c@ethdev.com>
 * @date 2015
 * Parses and analyses the doc strings.
 * Stores the parsing results in the AST annotations and reports errors.
 */

#pragma once

#include <libsolidity/ast/ASTVisitor.h>

namespace langutil
{
class ErrorReporter;
}

namespace dev
{
namespace solidity
{

/**
 * Parses and analyses the doc strings.
 * Stores the parsing results in the AST annotations and reports errors.
 */
class DocStringAnalyser: private ASTConstVisitor
{
public:
    DocStringAnalyser(langutil::ErrorReporter& _errorReporter): m_errorReporter(_errorReporter) {}
    bool analyseDocStrings(SourceUnit const& _sourceUnit);

private:
    bool visit(ContractDefinition const& _contract) override;
    bool visit(FunctionDefinition const& _function) override;
    bool visit(ModifierDefinition const& _modifier) override;
    bool visit(EventDefinition const& _event) override;

    void checkParameters(
        CallableDeclaration const& _callable,
        DocumentedAnnotation& _annotation
    );

    void handleConstructor(
        CallableDeclaration const& _callable,
        Documented const& _node,
        DocumentedAnnotation& _annotation
    );

    void handleCallable(
        CallableDeclaration const& _callable,
        Documented const& _node,
        DocumentedAnnotation& _annotation
    );

    void parseDocStrings(
        Documented const& _node,
        DocumentedAnnotation& _annotation,
        std::set<std::string> const& _validTags,
        std::string const& _nodeName
    );

    void appendError(std::string const& _description);

    bool m_errorOccured = false;
    langutil::ErrorReporter& m_errorReporter;
};

}
}