Merge pull request #11023 from ethereum/natspecparsinglocations

Provide locations for docstring parsing errors.

libsolidity/analysis/DocStringAnalyser.cpp

@@ -25,7 +25,6 @@
 #include <libsolidity/analysis/DocStringAnalyser.h>
 
 #include <libsolidity/ast/AST.h>
-#include <libsolidity/parsing/DocStringParser.h>
 #include <liblangutil/ErrorReporter.h>
 
 using namespace std;

libsolidity/analysis/DocStringTagParser.cpp

@@ -147,12 +147,10 @@ void DocStringTagParser::parseDocStrings(
 	string const& _nodeName
 )
 {
-	DocStringParser parser;
-	if (_node.documentation() && !_node.documentation()->text()->empty())
-	{
-		parser.parse(*_node.documentation()->text(), m_errorReporter);
-		_annotation.docTags = parser.tags();
-	}
+	if (!_node.documentation())
+		return;
+
+	_annotation.docTags = DocStringParser{*_node.documentation(), m_errorReporter}.parse();
 
 	size_t returnTagsVisited = 0;
 	for (auto const& docTag: _annotation.docTags)

libsolidity/parsing/DocStringParser.cpp

@@ -18,6 +18,8 @@
 
 #include <libsolidity/parsing/DocStringParser.h>
 
+#include <libsolidity/ast/AST.h>
+
 #include <liblangutil/Common.h>
 #include <liblangutil/ErrorReporter.h>
 #include <liblangutil/Exceptions.h>
@@ -78,25 +80,26 @@ string::const_iterator skipWhitespace(
 
 }
 
-void DocStringParser::parse(string const& _docString, ErrorReporter& _errorReporter)
+multimap<string, DocTag> DocStringParser::parse()
 {
-	m_errorReporter = &_errorReporter;
 	m_lastTag = nullptr;
+	m_docTags = {};
 
-	auto currPos = _docString.begin();
-	auto end = _docString.end();
+	solAssert(m_node.text(), "");
+	iter currPos = m_node.text()->begin();
+	iter end = m_node.text()->end();
 
 	while (currPos != end)
 	{
-		auto tagPos = find(currPos, end, '@');
-		auto nlPos = find(currPos, end, '\n');
+		iter tagPos = find(currPos, end, '@');
+		iter nlPos = find(currPos, end, '\n');
 
 		if (tagPos != end && tagPos < nlPos)
 		{
 			// we found a tag
-			auto tagNameEndPos = firstWhitespaceOrNewline(tagPos, end);
-			auto tagName = string(tagPos + 1, tagNameEndPos);
-			auto tagDataPos = (tagNameEndPos != end) ? tagNameEndPos + 1 : tagNameEndPos;
+			iter tagNameEndPos = firstWhitespaceOrNewline(tagPos, end);
+			string tagName{tagPos + 1, tagNameEndPos};
+			iter tagDataPos = (tagNameEndPos != end) ? tagNameEndPos + 1 : tagNameEndPos;
 			currPos = parseDocTag(tagDataPos, end, tagName);
 		}
 		else if (!!m_lastTag) // continuation of the previous tag
@@ -104,7 +107,7 @@ void DocStringParser::parse(string const& _docString, ErrorReporter& _errorRepor
 		else if (currPos != end)
 		{
 			// if it begins without a tag then consider it as @notice
-			if (currPos == _docString.begin())
+			if (currPos == m_node.text()->begin())
 			{
 				currPos = parseDocTag(currPos, end, "notice");
 				continue;
@@ -115,6 +118,7 @@ void DocStringParser::parse(string const& _docString, ErrorReporter& _errorRepor
 			currPos = nlPos + 1;
 		}
 	}
+	return move(m_docTags);
 }
 
 DocStringParser::iter DocStringParser::parseDocTagLine(iter _pos, iter _end, bool _appending)
@@ -135,7 +139,7 @@ DocStringParser::iter DocStringParser::parseDocTagParam(iter _pos, iter _end)
 	auto nameStartPos = skipWhitespace(_pos, _end);
 	if (nameStartPos == _end)
 	{
-		m_errorReporter->docstringParsingError(3335_error, "No param name given");
+		m_errorReporter.docstringParsingError(3335_error, m_node.location(), "No param name given");
 		return _end;
 	}
 	auto nameEndPos = firstNonIdentifier(nameStartPos, _end);
@@ -146,7 +150,7 @@ DocStringParser::iter DocStringParser::parseDocTagParam(iter _pos, iter _end)
 
 	if (descStartPos == nlPos)
 	{
-		m_errorReporter->docstringParsingError(9942_error, "No description given for param " + paramName);
+		m_errorReporter.docstringParsingError(9942_error, m_node.location(), "No description given for param " + paramName);
 		return _end;
 	}
 

libsolidity/parsing/DocStringParser.h

@@ -24,6 +24,7 @@
 #pragma once
 
 #include <libsolidity/ast/ASTAnnotations.h>
+#include <liblangutil/SourceLocation.h>
 #include <string>
 
 namespace solidity::langutil
@@ -34,13 +35,17 @@ class ErrorReporter;
 namespace solidity::frontend
 {
 
+class StructurallyDocumented;
+
 class DocStringParser
 {
 public:
-	/// Parse the given @a _docString and stores the parsed components internally.
-	void parse(std::string const& _docString, langutil::ErrorReporter& _errorReporter);
-
-	std::multimap<std::string, DocTag> const& tags() const { return m_docTags; }
+	/// @param _documentedNode the node whose documentation is parsed.
+	DocStringParser(StructuredDocumentation const& _documentedNode, langutil::ErrorReporter& _errorReporter):
+		m_node(_documentedNode),
+		m_errorReporter(_errorReporter)
+	{}
+	std::multimap<std::string, DocTag> parse();
 
 private:
 	using iter = std::string::const_iterator;
@@ -58,10 +63,11 @@ private:
 	/// Creates and inserts a new tag and adjusts m_lastTag.
 	void newTag(std::string const& _tagName);
 
+	StructuredDocumentation const& m_node;
+	langutil::ErrorReporter& m_errorReporter;
 	/// Mapping tag name -> content.
 	std::multimap<std::string, DocTag> m_docTags;
 	DocTag* m_lastTag = nullptr;
-	langutil::ErrorReporter* m_errorReporter = nullptr;
 };
 
 }