solidity/libsolidity/analysis/DocStringTagParser.cpp

223 lines
7.2 KiB
C++
Raw Normal View History

2020-06-29 12:30:09 +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/>.
*/
/**
* @author Christian <c@ethdev.com>
* @date 2015
* Parses and analyses the doc strings.
* Stores the parsing results in the AST annotations and reports errors.
*/
#include <libsolidity/analysis/DocStringTagParser.h>
#include <libsolidity/ast/AST.h>
#include <libsolidity/parsing/DocStringParser.h>
#include <libsolidity/analysis/NameAndTypeResolver.h>
#include <liblangutil/ErrorReporter.h>
2021-03-01 16:13:28 +00:00
#include <liblangutil/Common.h>
#include <range/v3/algorithm/any_of.hpp>
2020-06-29 12:30:09 +00:00
2021-02-25 12:57:34 +00:00
#include <boost/algorithm/string.hpp>
2021-03-01 16:13:28 +00:00
#include <regex>
2020-06-29 12:30:09 +00:00
using namespace std;
using namespace solidity;
using namespace solidity::langutil;
using namespace solidity::frontend;
bool DocStringTagParser::parseDocStrings(SourceUnit const& _sourceUnit)
{
auto errorWatcher = m_errorReporter.errorWatcher();
_sourceUnit.accept(*this);
return errorWatcher.ok();
}
bool DocStringTagParser::visit(ContractDefinition const& _contract)
{
static set<string> const validTags = set<string>{"author", "title", "dev", "notice"};
parseDocStrings(_contract, _contract.annotation(), validTags, "contracts");
return true;
}
bool DocStringTagParser::visit(FunctionDefinition const& _function)
{
if (_function.isConstructor())
handleConstructor(_function, _function, _function.annotation());
else
handleCallable(_function, _function, _function.annotation());
return true;
}
bool DocStringTagParser::visit(VariableDeclaration const& _variable)
{
if (_variable.isStateVariable())
{
if (_variable.isPublic())
2020-09-25 10:15:31 +00:00
parseDocStrings(_variable, _variable.annotation(), {"dev", "notice", "return", "inheritdoc"}, "public state variables");
2020-06-29 12:30:09 +00:00
else
2020-09-25 10:15:31 +00:00
parseDocStrings(_variable, _variable.annotation(), {"dev", "inheritdoc"}, "non-public state variables");
2020-06-29 12:30:09 +00:00
}
2020-09-25 10:15:31 +00:00
else if (_variable.isFileLevelVariable())
parseDocStrings(_variable, _variable.annotation(), {"dev"}, "file-level variables");
2020-06-29 12:30:09 +00:00
return false;
}
bool DocStringTagParser::visit(ModifierDefinition const& _modifier)
{
handleCallable(_modifier, _modifier, _modifier.annotation());
return true;
}
bool DocStringTagParser::visit(EventDefinition const& _event)
{
handleCallable(_event, _event, _event.annotation());
return true;
}
void DocStringTagParser::checkParameters(
CallableDeclaration const& _callable,
StructurallyDocumented const& _node,
StructurallyDocumentedAnnotation& _annotation
)
{
set<string> validParams;
for (auto const& p: _callable.parameters())
validParams.insert(p->name());
if (_callable.returnParameterList())
for (auto const& p: _callable.returnParameterList()->parameters())
validParams.insert(p->name());
auto paramRange = _annotation.docTags.equal_range("param");
for (auto i = paramRange.first; i != paramRange.second; ++i)
if (!validParams.count(i->second.paramName))
m_errorReporter.docstringParsingError(
3881_error,
_node.documentation()->location(),
"Documented parameter \"" +
i->second.paramName +
"\" not found in the parameter list of the function."
);
}
void DocStringTagParser::handleConstructor(
CallableDeclaration const& _callable,
StructurallyDocumented const& _node,
StructurallyDocumentedAnnotation& _annotation
)
{
static set<string> const validTags = set<string>{"author", "dev", "notice", "param"};
parseDocStrings(_node, _annotation, validTags, "constructor");
checkParameters(_callable, _node, _annotation);
}
void DocStringTagParser::handleCallable(
CallableDeclaration const& _callable,
StructurallyDocumented const& _node,
StructurallyDocumentedAnnotation& _annotation
)
{
2020-07-21 09:39:25 +00:00
static set<string> const validEventTags = set<string>{"dev", "notice", "return", "param"};
static set<string> const validModifierTags = set<string>{"dev", "notice", "param", "inheritdoc"};
2020-07-21 09:39:25 +00:00
static set<string> const validTags = set<string>{"dev", "notice", "return", "param", "inheritdoc"};
2020-06-29 12:30:09 +00:00
if (dynamic_cast<EventDefinition const*>(&_callable))
parseDocStrings(_node, _annotation, validEventTags, "events");
else if (dynamic_cast<ModifierDefinition const*>(&_callable))
parseDocStrings(_node, _annotation, validModifierTags, "modifiers");
2020-06-29 12:30:09 +00:00
else
parseDocStrings(_node, _annotation, validTags, "functions");
checkParameters(_callable, _node, _annotation);
}
void DocStringTagParser::parseDocStrings(
StructurallyDocumented const& _node,
StructurallyDocumentedAnnotation& _annotation,
set<string> const& _validTags,
string const& _nodeName
)
{
if (!_node.documentation())
return;
_annotation.docTags = DocStringParser{*_node.documentation(), m_errorReporter}.parse();
2020-06-29 12:30:09 +00:00
size_t returnTagsVisited = 0;
2021-02-25 12:57:34 +00:00
for (auto const& [tagName, tagValue]: _annotation.docTags)
2020-06-29 12:30:09 +00:00
{
2021-03-01 16:13:28 +00:00
string static const customPrefix("custom:");
if (boost::starts_with(tagName, customPrefix) && tagName.size() > customPrefix.size())
{
regex static const customRegex("^custom:[a-z][a-z-]*$");
if (!regex_match(tagName, customRegex))
m_errorReporter.docstringParsingError(
2968_error,
_node.documentation()->location(),
"Invalid character in custom tag @" + tagName + ". Only lowercase letters and \"-\" are permitted."
);
2021-02-25 12:57:34 +00:00
continue;
2021-03-01 16:13:28 +00:00
}
2021-02-25 12:57:34 +00:00
else if (!_validTags.count(tagName))
2020-06-29 12:30:09 +00:00
m_errorReporter.docstringParsingError(
6546_error,
_node.documentation()->location(),
2021-02-25 12:57:34 +00:00
"Documentation tag @" + tagName + " not valid for " + _nodeName + "."
2020-06-29 12:30:09 +00:00
);
2021-02-25 12:57:34 +00:00
else if (tagName == "return")
2020-06-29 12:30:09 +00:00
{
returnTagsVisited++;
if (auto const* varDecl = dynamic_cast<VariableDeclaration const*>(&_node))
{
solAssert(varDecl->isPublic(), "@return is only allowed on public state-variables.");
2020-06-29 12:30:09 +00:00
if (returnTagsVisited > 1)
m_errorReporter.docstringParsingError(
5256_error,
_node.documentation()->location(),
2021-02-25 12:57:34 +00:00
"Documentation tag \"@" + tagName + "\" is only allowed once on state-variables."
2020-06-29 12:30:09 +00:00
);
}
else if (auto const* function = dynamic_cast<FunctionDefinition const*>(&_node))
{
2021-02-25 12:57:34 +00:00
string content = tagValue.content;
2020-06-29 12:30:09 +00:00
string firstWord = content.substr(0, content.find_first_of(" \t"));
if (returnTagsVisited > function->returnParameters().size())
m_errorReporter.docstringParsingError(
2604_error,
_node.documentation()->location(),
2021-02-25 12:57:34 +00:00
"Documentation tag \"@" + tagName + " " + tagValue.content + "\"" +
2020-06-29 12:30:09 +00:00
" exceeds the number of return parameters."
);
else
{
auto parameter = function->returnParameters().at(returnTagsVisited - 1);
if (!parameter->name().empty() && parameter->name() != firstWord)
m_errorReporter.docstringParsingError(
5856_error,
_node.documentation()->location(),
2021-02-25 12:57:34 +00:00
"Documentation tag \"@" + tagName + " " + tagValue.content + "\"" +
2020-06-29 12:30:09 +00:00
" does not contain the name of its return parameter."
);
}
}
}
}
}