aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/parsing/DocStringParser.h
blob: c83b416db690cfc1bb68037e2c540f59b8f99a12 (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
/*
    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 Lefteris <lefteris@ethdev.com>
 * @date 2014, 2015
 * Parses a given docstring into pieces introduced by tags.
 */

#pragma once

#include <string>
#include <libsolidity/ast/ASTAnnotations.h>

namespace langutil
{
class ErrorReporter;
}

namespace dev
{
namespace solidity
{

class DocStringParser
{
public:
    /// Parse the given @a _docString and stores the parsed components internally.
    /// @returns false on error and appends the error to @a _errors.
    bool parse(std::string const& _docString, langutil::ErrorReporter& _errorReporter);

    std::multimap<std::string, DocTag> const& tags() const { return m_docTags; }

private:
    using iter = std::string::const_iterator;
    void resetUser();
    void resetDev();

    iter parseDocTagLine(iter _pos, iter _end, bool _appending);
    iter parseDocTagParam(iter _pos, iter _end);
    iter appendDocTagParam(iter _pos, iter _end);
    void parseDocString(std::string const& _string);
    iter appendDocTag(iter _pos, iter _end);
    /// Parses the doc tag named @a _tag, adds it to m_docTags and returns the position
    /// after the tag.
    iter parseDocTag(iter _pos, iter _end, std::string const& _tag);

    /// Creates and inserts a new tag and adjusts m_lastTag.
    void newTag(std::string const& _tagName);

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

    /// Mapping tag name -> content.
    std::multimap<std::string, DocTag> m_docTags;
    DocTag* m_lastTag = nullptr;
    langutil::ErrorReporter* m_errorReporter = nullptr;
    bool m_errorsOccurred = false;
};

} //solidity NS
} // dev NS