solidity/libsolidity/analysis/DocStringAnalyser.cpp

118 lines
3.4 KiB
C++
Raw Normal View History

2015-10-26 14:13:36 +00:00
/*
This file is part of solidity.
2015-10-26 14:13:36 +00:00
solidity is free software: you can redistribute it and/or modify
2015-10-26 14:13:36 +00:00
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,
2015-10-26 14:13:36 +00:00
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
*/
/**
* @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/DocStringAnalyser.h>
#include <libsolidity/ast/AST.h>
#include <libsolidity/interface/ErrorReporter.h>
2015-10-26 14:13:36 +00:00
#include <libsolidity/parsing/DocStringParser.h>
using namespace std;
using namespace dev;
using namespace dev::solidity;
bool DocStringAnalyser::analyseDocStrings(SourceUnit const& _sourceUnit)
{
m_errorOccured = false;
_sourceUnit.accept(*this);
return !m_errorOccured;
}
bool DocStringAnalyser::visit(ContractDefinition const& _node)
{
2017-06-30 21:34:03 +00:00
static const set<string> validTags = set<string>{"author", "title", "dev", "notice"};
2015-10-26 16:20:29 +00:00
parseDocStrings(_node, _node.annotation(), validTags, "contracts");
2015-10-26 14:13:36 +00:00
return true;
}
bool DocStringAnalyser::visit(FunctionDefinition const& _node)
{
handleCallable(_node, _node, _node.annotation());
return true;
}
bool DocStringAnalyser::visit(ModifierDefinition const& _node)
{
handleCallable(_node, _node, _node.annotation());
return true;
}
bool DocStringAnalyser::visit(EventDefinition const& _node)
{
handleCallable(_node, _node, _node.annotation());
return true;
}
void DocStringAnalyser::handleCallable(
2015-10-26 16:21:32 +00:00
CallableDeclaration const& _callable,
Documented const& _node,
DocumentedAnnotation& _annotation
2015-10-26 14:13:36 +00:00
)
{
static const set<string> validTags = set<string>{"author", "dev", "notice", "return", "param"};
2015-10-26 16:20:29 +00:00
parseDocStrings(_node, _annotation, validTags, "functions");
2015-10-26 14:13:36 +00:00
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))
appendError(
"Documented parameter \"" +
i->second.paramName +
"\" not found in the parameter list of the function."
);
}
2015-10-26 16:20:29 +00:00
void DocStringAnalyser::parseDocStrings(
Documented const& _node,
DocumentedAnnotation& _annotation,
set<string> const& _validTags,
string const& _nodeName
)
2015-10-26 14:13:36 +00:00
{
DocStringParser parser;
if (_node.documentation() && !_node.documentation()->empty())
{
if (!parser.parse(*_node.documentation(), m_errorReporter))
2015-10-26 14:13:36 +00:00
m_errorOccured = true;
_annotation.docTags = parser.tags();
}
2015-10-26 16:20:29 +00:00
for (auto const& docTag: _annotation.docTags)
if (!_validTags.count(docTag.first))
appendError("Doc tag @" + docTag.first + " not valid for " + _nodeName + ".");
2015-10-26 14:13:36 +00:00
}
void DocStringAnalyser::appendError(string const& _description)
{
m_errorOccured = true;
m_errorReporter.docstringParsingError(_description);
2015-10-26 14:13:36 +00:00
}