liblangutil: adds SourceReferenceExtractor.

Author: Christian Parpart

liblangutil/CMakeLists.txt

@@ -5,6 +5,7 @@ set(sources
 	Exceptions.cpp
 	ParserBase.cpp
 	Scanner.cpp
+	SourceReferenceExtractor.cpp
 	SourceReferenceFormatter.cpp
 	Token.cpp
 )

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(std::move(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->sourceName) // 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),
+	};
+}

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;
+};
+
+}