2018-12-17 18:28:10 +00:00
|
|
|
/*
|
|
|
|
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/>.
|
|
|
|
*/
|
2015-10-26 14:13:36 +00:00
|
|
|
|
|
|
|
#include <libsolidity/parsing/DocStringParser.h>
|
2018-12-17 18:28:10 +00:00
|
|
|
|
2019-04-26 15:05:26 +00:00
|
|
|
#include <liblangutil/Common.h>
|
2018-11-14 13:59:30 +00:00
|
|
|
#include <liblangutil/ErrorReporter.h>
|
|
|
|
#include <liblangutil/Exceptions.h>
|
2015-10-26 14:13:36 +00:00
|
|
|
|
2019-01-31 13:14:24 +00:00
|
|
|
#include <boost/range/algorithm/find_first_of.hpp>
|
2018-12-17 18:28:10 +00:00
|
|
|
#include <boost/range/irange.hpp>
|
2017-01-27 10:19:48 +00:00
|
|
|
|
2015-10-26 14:13:36 +00:00
|
|
|
using namespace std;
|
2019-12-11 16:31:36 +00:00
|
|
|
using namespace solidity;
|
|
|
|
using namespace solidity::langutil;
|
|
|
|
using namespace solidity::frontend;
|
2015-10-26 14:13:36 +00:00
|
|
|
|
2017-01-27 10:19:48 +00:00
|
|
|
namespace
|
|
|
|
{
|
|
|
|
|
|
|
|
string::const_iterator skipLineOrEOS(
|
2015-10-26 14:13:36 +00:00
|
|
|
string::const_iterator _nlPos,
|
|
|
|
string::const_iterator _end
|
|
|
|
)
|
|
|
|
{
|
|
|
|
return (_nlPos == _end) ? _end : ++_nlPos;
|
|
|
|
}
|
|
|
|
|
2019-04-26 15:05:26 +00:00
|
|
|
string::const_iterator firstNonIdentifier(
|
2015-10-26 14:13:36 +00:00
|
|
|
string::const_iterator _pos,
|
|
|
|
string::const_iterator _end
|
|
|
|
)
|
|
|
|
{
|
2019-04-26 15:05:26 +00:00
|
|
|
auto currPos = _pos;
|
|
|
|
if (currPos == _pos && isIdentifierStart(*currPos))
|
|
|
|
{
|
|
|
|
currPos++;
|
|
|
|
while (currPos != _end && isIdentifierPart(*currPos))
|
|
|
|
currPos++;
|
|
|
|
}
|
|
|
|
return currPos;
|
2015-10-26 14:13:36 +00:00
|
|
|
}
|
|
|
|
|
2017-01-27 10:19:48 +00:00
|
|
|
string::const_iterator firstWhitespaceOrNewline(
|
2016-11-30 14:04:07 +00:00
|
|
|
string::const_iterator _pos,
|
|
|
|
string::const_iterator _end
|
|
|
|
)
|
|
|
|
{
|
2017-01-27 10:19:48 +00:00
|
|
|
return boost::range::find_first_of(make_pair(_pos, _end), " \t\n");
|
2016-11-30 14:04:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2017-01-27 10:19:48 +00:00
|
|
|
string::const_iterator skipWhitespace(
|
2016-11-30 14:04:07 +00:00
|
|
|
string::const_iterator _pos,
|
|
|
|
string::const_iterator _end
|
|
|
|
)
|
|
|
|
{
|
|
|
|
auto currPos = _pos;
|
2017-01-27 10:19:48 +00:00
|
|
|
while (currPos != _end && (*currPos == ' ' || *currPos == '\t'))
|
2016-11-30 14:04:07 +00:00
|
|
|
currPos += 1;
|
|
|
|
return currPos;
|
|
|
|
}
|
|
|
|
|
2017-01-27 10:19:48 +00:00
|
|
|
}
|
2016-11-30 14:04:07 +00:00
|
|
|
|
2020-05-12 19:49:04 +00:00
|
|
|
void DocStringParser::parse(string const& _docString, ErrorReporter& _errorReporter)
|
2015-10-26 14:13:36 +00:00
|
|
|
{
|
2017-05-11 13:26:35 +00:00
|
|
|
m_errorReporter = &_errorReporter;
|
2015-10-26 14:13:36 +00:00
|
|
|
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
|
2017-01-26 23:09:00 +00:00
|
|
|
auto tagNameEndPos = firstWhitespaceOrNewline(tagPos, end);
|
2020-07-01 02:42:37 +00:00
|
|
|
auto tagName = string(tagPos + 1, tagNameEndPos);
|
|
|
|
auto tagDataPos = (tagNameEndPos != end) ? tagNameEndPos + 1 : tagNameEndPos;
|
|
|
|
currPos = parseDocTag(tagDataPos, end, tagName);
|
2015-10-26 14:13:36 +00:00
|
|
|
}
|
|
|
|
else if (!!m_lastTag) // continuation of the previous tag
|
2020-07-01 02:42:37 +00:00
|
|
|
currPos = parseDocTagLine(currPos, end, true);
|
2015-10-26 14:13:36 +00:00
|
|
|
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;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
DocStringParser::iter DocStringParser::parseDocTagLine(iter _pos, iter _end, bool _appending)
|
|
|
|
{
|
|
|
|
solAssert(!!m_lastTag, "");
|
|
|
|
auto nlPos = find(_pos, _end, '\n');
|
2020-07-01 02:42:37 +00:00
|
|
|
if (_appending && _pos != _end && *_pos != ' ' && *_pos != '\t')
|
2015-10-26 14:13:36 +00:00
|
|
|
m_lastTag->content += " ";
|
2016-12-01 09:14:19 +00:00
|
|
|
else if (!_appending)
|
|
|
|
_pos = skipWhitespace(_pos, _end);
|
2015-10-26 14:13:36 +00:00
|
|
|
copy(_pos, nlPos, back_inserter(m_lastTag->content));
|
|
|
|
return skipLineOrEOS(nlPos, _end);
|
|
|
|
}
|
|
|
|
|
|
|
|
DocStringParser::iter DocStringParser::parseDocTagParam(iter _pos, iter _end)
|
|
|
|
{
|
2016-11-30 14:04:07 +00:00
|
|
|
// find param name start
|
|
|
|
auto nameStartPos = skipWhitespace(_pos, _end);
|
|
|
|
if (nameStartPos == _end)
|
|
|
|
{
|
2020-05-20 22:26:14 +00:00
|
|
|
m_errorReporter->docstringParsingError(3335_error, "No param name given");
|
2016-11-30 14:04:07 +00:00
|
|
|
return _end;
|
|
|
|
}
|
2019-04-26 15:05:26 +00:00
|
|
|
auto nameEndPos = firstNonIdentifier(nameStartPos, _end);
|
2016-11-30 14:04:07 +00:00
|
|
|
auto paramName = string(nameStartPos, nameEndPos);
|
2015-10-26 14:13:36 +00:00
|
|
|
|
2016-11-30 14:04:07 +00:00
|
|
|
auto descStartPos = skipWhitespace(nameEndPos, _end);
|
2018-03-14 08:55:04 +00:00
|
|
|
auto nlPos = find(descStartPos, _end, '\n');
|
|
|
|
|
|
|
|
if (descStartPos == nlPos)
|
2016-11-30 14:04:07 +00:00
|
|
|
{
|
2020-05-20 22:26:14 +00:00
|
|
|
m_errorReporter->docstringParsingError(9942_error, "No description given for param " + paramName);
|
2016-11-30 14:04:07 +00:00
|
|
|
return _end;
|
|
|
|
}
|
2015-10-26 14:13:36 +00:00
|
|
|
|
2016-11-30 14:04:07 +00:00
|
|
|
auto paramDesc = string(descStartPos, nlPos);
|
2015-10-26 14:13:36 +00:00
|
|
|
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
|
2020-07-01 02:42:37 +00:00
|
|
|
return parseDocTagLine(_pos, _end, true);
|
2015-10-26 14:13:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void DocStringParser::newTag(string const& _tagName)
|
|
|
|
{
|
|
|
|
m_lastTag = &m_docTags.insert(make_pair(_tagName, DocTag()))->second;
|
|
|
|
}
|