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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
#include <libsolidity/parsing/DocStringParser.h>
#include <boost/range/irange.hpp>
#include <libsolidity/interface/Utils.h>
using namespace std;
using namespace dev;
using namespace dev::solidity;
static inline string::const_iterator skipLineOrEOS(
string::const_iterator _nlPos,
string::const_iterator _end
)
{
return (_nlPos == _end) ? _end : ++_nlPos;
}
static inline string::const_iterator firstSpaceOrTab(
string::const_iterator _pos,
string::const_iterator _end
)
{
auto spacePos = find(_pos, _end, ' ');
auto tabPos = find(_pos, _end, '\t');
return (spacePos < tabPos) ? spacePos : tabPos;
}
static inline string::const_iterator firstWhitespaceOrNewline(
string::const_iterator _pos,
string::const_iterator _end
)
{
auto nlPos = find(_pos, _end, '\n');
auto wsPos = firstSpaceOrTab(_pos, _end);
return (wsPos < nlPos) ? wsPos : nlPos;
}
static inline string::const_iterator skipWhitespace(
string::const_iterator _pos,
string::const_iterator _end
)
{
auto currPos = _pos;
while ((*currPos == ' ' || *currPos == '\t') && currPos != _end)
currPos += 1;
return currPos;
}
bool DocStringParser::parse(string const& _docString, ErrorList& _errors)
{
m_errors = &_errors;
m_errorsOccurred = false;
m_lastTag = nullptr;
auto currPos = _docString.begin();
auto end = _docString.end();
while (currPos != end)
{
auto tagPos = find(currPos, end, '@');
auto nlPos = find(currPos, end, '\n');
if (tagPos != end && tagPos < nlPos)
{
// we found a tag
auto tagNameEndPos = firstWhitespaceOrNewline(tagPos, end);
if (tagNameEndPos == end)
{
appendError("End of tag " + string(tagPos, tagNameEndPos) + "not found");
break;
}
currPos = parseDocTag(tagNameEndPos + 1, end, string(tagPos + 1, tagNameEndPos));
}
else if (!!m_lastTag) // continuation of the previous tag
currPos = appendDocTag(currPos, end);
else if (currPos != end)
{
// if it begins without a tag then consider it as @notice
if (currPos == _docString.begin())
{
currPos = parseDocTag(currPos, end, "notice");
continue;
}
else if (nlPos == end) //end of text
break;
// else skip the line if a newline was found and we get here
currPos = nlPos + 1;
}
}
return !m_errorsOccurred;
}
DocStringParser::iter DocStringParser::parseDocTagLine(iter _pos, iter _end, bool _appending)
{
solAssert(!!m_lastTag, "");
auto nlPos = find(_pos, _end, '\n');
if (_appending && _pos < _end && *_pos != ' ' && *_pos != '\t')
{
m_lastTag->content += " ";
}
else if (!_appending)
{
_pos = skipWhitespace(_pos, _end);
}
copy(_pos, nlPos, back_inserter(m_lastTag->content));
return skipLineOrEOS(nlPos, _end);
}
DocStringParser::iter DocStringParser::parseDocTagParam(iter _pos, iter _end)
{
// find param name start
auto nameStartPos = skipWhitespace(_pos, _end);
if (nameStartPos == _end)
{
appendError("No param name given" + string(nameStartPos, _end));
return _end;
}
auto nameEndPos = firstSpaceOrTab(nameStartPos, _end);
if (nameEndPos == _end)
{
appendError("End of param name not found" + string(nameStartPos, _end));
return _end;
}
auto paramName = string(nameStartPos, nameEndPos);
auto descStartPos = skipWhitespace(nameEndPos, _end);
if (descStartPos == _end)
{
appendError("No description given for param" + paramName);
return _end;
}
auto nlPos = find(descStartPos, _end, '\n');
auto paramDesc = string(descStartPos, nlPos);
newTag("param");
m_lastTag->paramName = paramName;
m_lastTag->content = paramDesc;
return skipLineOrEOS(nlPos, _end);
}
DocStringParser::iter DocStringParser::parseDocTag(iter _pos, iter _end, string const& _tag)
{
// LTODO: need to check for @(start of a tag) between here and the end of line
// for all cases.
if (!m_lastTag || _tag != "")
{
if (_tag == "param")
return parseDocTagParam(_pos, _end);
else
{
newTag(_tag);
return parseDocTagLine(_pos, _end, false);
}
}
else
return appendDocTag(_pos, _end);
}
DocStringParser::iter DocStringParser::appendDocTag(iter _pos, iter _end)
{
solAssert(!!m_lastTag, "");
return parseDocTagLine(_pos, _end, true);
}
void DocStringParser::newTag(string const& _tagName)
{
m_lastTag = &m_docTags.insert(make_pair(_tagName, DocTag()))->second;
}
void DocStringParser::appendError(string const& _description)
{
auto err = make_shared<Error>(Error::Type::DocstringParsingError);
*err << errinfo_comment(_description);
m_errors->push_back(err);
m_errorsOccurred = true;
}
|
