liblangutil: refactor SourceReferenceFormatter into formatting-only and add SourceReferenceExtractor

Christian Parpart · Christian Parpart · commit cfa70cabe8b2 · 2018-11-29T02:00:17.000+01:00
diff --git a/liblangutil/CMakeLists.txt b/liblangutil/CMakeLists.txt
@@ -5,6 +5,7 @@ set(sources
 	Exceptions.cpp
 	ParserBase.cpp
 	Scanner.cpp
+	SourceReferenceExtractor.cpp
 	SourceReferenceFormatter.cpp
 	Token.cpp
 )
diff --git a/liblangutil/SourceReferenceExtractor.cpp b/liblangutil/SourceReferenceExtractor.cpp
@@ -0,0 +1,126 @@
+/*
+	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/>.
+*/
+#include <liblangutil/SourceReferenceExtractor.h>
+#include <liblangutil/CharStream.h>
+#include <liblangutil/Exceptions.h>
+
+#include <cmath>
+#include <iomanip>
+
+using namespace std;
+using namespace dev;
+using namespace langutil;
+
+/* TODO
+ * - see if we can get rid of the GETTER fn by adding that functionality to SourceLocation
+ *   - SourceLocation: sourceName* with CharStream&
+ *   - CharStream: add sourceName*
+ *   - Scanner: remove m_sourceName
+ * - base SourceReferenceFormatter on top of that logic
+ * - make sure tests are running
+ * - write tests for SourceReferenceExtractor
+ * - Scanner::reset(CharStream _source, string _sourceName): drop 2nd param
+ */
+
+SourceReferenceExtractor::Message SourceReferenceExtractor::extract(
+	Exception const& _exception,
+	string _category,
+	CharStreamGetter _getter
+)
+{
+	SourceReferenceExtractor extractor{std::move(_getter)};
+	return extractor.extract(_exception, std::move(_category));
+}
+
+SourceReference SourceReferenceExtractor::extract(
+	SourceLocation const* _location,
+	string description,
+	CharStreamGetter _getter
+)
+{
+	return SourceReferenceExtractor{std::move(_getter)}.extract(_location, std::move(description));
+}
+
+SourceReferenceExtractor::Message SourceReferenceExtractor::extract(
+	Exception const& _exception,
+	string _category
+)
+{
+	SourceLocation const* location = boost::get_error_info<errinfo_sourceLocation>(_exception);
+
+	string const* description = boost::get_error_info<errinfo_comment>(_exception);
+	SourceReference primary = extract(location, description ? *description : "");
+
+	std::vector<SourceReference> secondary;
+	auto secondaryLocation = boost::get_error_info<errinfo_secondarySourceLocation>(_exception);
+	if (secondaryLocation && !secondaryLocation->infos.empty())
+		for (auto const& info: secondaryLocation->infos)
+			secondary.emplace_back(extract(&info.second, info.first));
+
+	return Message{std::move(primary), _category, std::move(secondary)};
+}
+
+SourceReference SourceReferenceExtractor::extract(SourceLocation const* _location, std::string description)
+{
+	if (!_location || !_location->hasSourceName()) // Nothing we can extract here
+		return SourceReference{"", "", 0, 0, 0, 0, 0, std::move(description)};
+
+	auto const& source = m_charStreamGetter(_location->sourceName());
+
+	int startLine;
+	int startColumn;
+	tie(startLine, startColumn) = source.translatePositionToLineColumn(_location->start);
+
+	int endLine;
+	int endColumn;
+	tie(endLine, endColumn) = source.translatePositionToLineColumn(_location->end);
+
+	string line = source.lineAtPosition(_location->start);
+
+	int locationLength = endColumn - startColumn;
+	if (locationLength > 150)
+	{
+		line = line.substr(0, startColumn + 35) + " ... " + line.substr(endColumn - 35);
+		endColumn = startColumn + 75;
+		locationLength = 75;
+	}
+
+	if (line.length() > 150)
+	{
+		int len = line.length();
+		line = line.substr(max(0, startColumn - 35), min(startColumn, 35) + min(locationLength + 35, len - startColumn));
+		if (startColumn + locationLength + 35 < len)
+			line += " ...";
+		if (startColumn > 35)
+		{
+			line = " ... " + line;
+			startColumn = 40;
+		}
+		endColumn = startColumn + locationLength;
+	}
+
+	return SourceReference{
+		_location->sourceName(),
+		line,
+		startLine,
+		startColumn,
+		endLine,
+		endColumn,
+		locationLength,
+		std::move(description),
+	};
+}
diff --git a/liblangutil/SourceReferenceExtractor.h b/liblangutil/SourceReferenceExtractor.h
@@ -0,0 +1,75 @@
+/*
+	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/>.
+*/
+#pragma once
+
+#include <string>
+#include <vector>
+#include <functional>
+
+namespace dev
+{
+struct Exception;
+}
+
+namespace langutil
+{
+
+struct SourceReference
+{
+	std::string filename;
+	std::string line;
+	int startLine;
+	int startColumn;
+	int endLine;
+	int endColumn;
+	int locationLength;
+	std::string description;
+};
+
+class CharStream;
+struct SourceLocation;
+
+class SourceReferenceExtractor
+{
+public:
+	using CharStreamGetter = std::function<CharStream const&(std::string const /*filename*/&)>;
+
+	struct Message
+	{
+		SourceReference primary;
+		std::string category; // "Error", "Warning", ... (TODO: use an enum class)
+		std::vector<SourceReference> secondary;
+	};
+
+	explicit SourceReferenceExtractor(CharStreamGetter getter): m_charStreamGetter{std::move(getter)} {}
+	SourceReferenceExtractor(SourceReferenceExtractor const&) = default;
+	SourceReferenceExtractor(SourceReferenceExtractor&&) = default;
+	SourceReferenceExtractor& operator=(SourceReferenceExtractor const&) = default;
+	SourceReferenceExtractor& operator=(SourceReferenceExtractor&&) = default;
+	~SourceReferenceExtractor() = default;
+
+	static Message extract(dev::Exception const& _exception, std::string _category, CharStreamGetter _getter);
+	static SourceReference extract(SourceLocation const* _location, std::string description, CharStreamGetter _getter);
+
+	Message extract(dev::Exception const& _exception, std::string _category);
+	SourceReference extract(SourceLocation const* _location, std::string description = "");
+
+private:
+	CharStreamGetter m_charStreamGetter;
+};
+
+}
diff --git a/liblangutil/SourceReferenceFormatter.cpp b/liblangutil/SourceReferenceFormatter.cpp
@@ -21,6 +21,7 @@
  */
 
 #include <liblangutil/SourceReferenceFormatter.h>
+#include <liblangutil/SourceReferenceExtractor.h>
 #include <liblangutil/Scanner.h>
 #include <liblangutil/Exceptions.h>
 
@@ -30,100 +31,68 @@ using namespace langutil;
 
 void SourceReferenceFormatter::printSourceLocation(SourceLocation const* _location)
 {
-	if (!_location || !_location->hasSourceName())
-		return; // Nothing we can print here
-	auto const& scanner = m_scannerFromSourceName(_location->sourceName());
-	int startLine;
-	int startColumn;
-	tie(startLine, startColumn) = scanner.translatePositionToLineColumn(_location->start);
-	int endLine;
-	int endColumn;
-	tie(endLine, endColumn) = scanner.translatePositionToLineColumn(_location->end);
-	if (startLine == endLine)
-	{
-		string line = scanner.lineAtPosition(_location->start);
+	auto resolver = [this](string const& filename) -> CharStream const& { return m_scannerFromSourceName(filename).charStream(); };
+	printSourceLocation(SourceReferenceExtractor::extract(_location, "", resolver));
+}
 
-		int locationLength = endColumn - startColumn;
-		if (locationLength > 150)
-		{
-			line = line.substr(0, startColumn + 35) + " ... " + line.substr(endColumn - 35);
-			endColumn = startColumn + 75;
-			locationLength = 75;
-		}
-		if (line.length() > 150)
-		{
-			int len = line.length();
-			line = line.substr(max(0, startColumn - 35), min(startColumn, 35) + min(locationLength + 35, len - startColumn));
-			if (startColumn + locationLength + 35 < len)
-				line += " ...";
-			if (startColumn > 35)
-			{
-				line = " ... " + line;
-				startColumn = 40;
-			}
-			endColumn = startColumn + locationLength;
-		}
+void SourceReferenceFormatter::printSourceLocation(SourceReference const& _ref)
+{
+	if (_ref.startLine == 0 || _ref.filename.empty())
+		return; // Nothing we can print here
 
-		m_stream << line << endl;
+	if (_ref.startLine == _ref.endLine)
+	{
+		m_stream << _ref.line << endl;
 
 		for_each(
-			line.cbegin(),
-			line.cbegin() + startColumn,
+			_ref.line.cbegin(),
+			_ref.line.cbegin() + _ref.startColumn,
 			[this](char const& ch) { m_stream << (ch == '\t' ? '\t' : ' '); }
 		);
 		m_stream << "^";
-		if (endColumn > startColumn + 2)
-			m_stream << string(endColumn - startColumn - 2, '-');
-		if (endColumn > startColumn + 1)
+		if (_ref.endColumn > _ref.startColumn + 2)
+			m_stream << string(_ref.endColumn - _ref.startColumn - 2, '-');
+		if (_ref.endColumn > _ref.startColumn + 1)
 			m_stream << "^";
 		m_stream << endl;
 	}
 	else
 		m_stream <<
-			scanner.lineAtPosition(_location->start) <<
+			_ref.line <<
 			endl <<
-			string(startColumn, ' ') <<
+			string(_ref.startColumn, ' ') <<
 			"^ (Relevant source part starts here and spans across multiple lines)." <<
 			endl;
 }
 
-void SourceReferenceFormatter::printSourceName(SourceLocation const* _location)
+void SourceReferenceFormatter::printSourceName(SourceReference const& _ref)
 {
-	if (!_location || !_location->hasSourceName())
-		return; // Nothing we can print here
-	auto const& scanner = m_scannerFromSourceName(_location->sourceName());
-	int startLine;
-	int startColumn;
-	tie(startLine, startColumn) = scanner.translatePositionToLineColumn(_location->start);
-	m_stream << _location->sourceName() << ":" << (startLine + 1) << ":" << (startColumn + 1) << ": ";
+	if (!_ref.filename.empty())
+		m_stream << _ref.filename << ":" << (_ref.startLine + 1) << ":" << (_ref.startColumn + 1) << ": ";
 }
 
 void SourceReferenceFormatter::printExceptionInformation(
 	dev::Exception const& _exception,
 	string const& _name
 )
 {
-	SourceLocation const* location = boost::get_error_info<errinfo_sourceLocation>(_exception);
-	auto secondarylocation = boost::get_error_info<errinfo_secondarySourceLocation>(_exception);
+	auto resolver = [this](string const& filename) -> CharStream const& { return m_scannerFromSourceName(filename).charStream(); };
+	auto const ref = SourceReferenceExtractor::extract(_exception, _name, resolver);
 
-	printSourceName(location);
+	printSourceName(ref.primary);
 
-	m_stream << _name;
-	if (string const* description = boost::get_error_info<errinfo_comment>(_exception))
-		m_stream << ": " << *description << endl;
+	m_stream << ref.category;
+	if (!ref.primary.description.empty())
+		m_stream << ": " << ref.primary.description << endl;
 	else
 		m_stream << endl;
 
-	printSourceLocation(location);
+	printSourceLocation(ref.primary);
 
-	if (secondarylocation && !secondarylocation->infos.empty())
+	for (auto const& secondary: ref.secondary)
 	{
-		for (auto info: secondarylocation->infos)
-		{
-			printSourceName(&info.second);
-			m_stream << info.first << endl;
-			printSourceLocation(&info.second);
-		}
-		m_stream << endl;
+		printSourceName(secondary);
+		printSourceLocation(secondary);
 	}
+	m_stream << endl;
 }
diff --git a/liblangutil/SourceReferenceFormatter.h b/liblangutil/SourceReferenceFormatter.h
@@ -34,6 +34,7 @@ struct Exception; // forward
 namespace langutil
 {
 struct SourceLocation;
+struct SourceReference;
 class Scanner;
 
 class SourceReferenceFormatter
@@ -50,7 +51,8 @@ class SourceReferenceFormatter
 	{}
 
 	/// Prints source location if it is given.
-	void printSourceLocation(langutil::SourceLocation const* _location);
+	void printSourceLocation(SourceLocation const* _location);
+	void printSourceLocation(SourceReference const& ref);
 	void printExceptionInformation(dev::Exception const& _exception, std::string const& _name);
 
 	static std::string formatExceptionInformation(
@@ -67,7 +69,7 @@ class SourceReferenceFormatter
 	}
 private:
 	/// Prints source name if location is given.
-	void printSourceName(langutil::SourceLocation const* _location);
+	void printSourceName(SourceReference const& ref);
 
 	std::ostream& m_stream;
 	ScannerFromSourceNameFun m_scannerFromSourceName;

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ set(sources`
`5`	`5`	`Exceptions.cpp`
`6`	`6`	`ParserBase.cpp`
`7`	`7`	`Scanner.cpp`
	`8`	`+ SourceReferenceExtractor.cpp`
`8`	`9`	`SourceReferenceFormatter.cpp`
`9`	`10`	`Token.cpp`
`10`	`11`	`)`