Reuse color definitions between SourceReferenceFormatter and CommonSyntaxTest

Author: cameel

liblangutil/SourceReferenceFormatter.cpp

@@ -55,6 +55,28 @@ std::string SourceReferenceFormatter::formatErrorInformation(Error const& _error
 	);
 }
 
+char const* SourceReferenceFormatter::errorTextColor(Error::Severity _severity)
+{
+	switch (_severity)
+	{
+	case Error::Severity::Error: return RED;
+	case Error::Severity::Warning: return YELLOW;
+	case Error::Severity::Info: return WHITE;
+	}
+	util::unreachable();
+}
+
+char const* SourceReferenceFormatter::errorHighlightColor(Error::Severity _severity)
+{
+	switch (_severity)
+	{
+	case Error::Severity::Error: return RED_BACKGROUND;
+	case Error::Severity::Warning: return ORANGE_BACKGROUND_256;
+	case Error::Severity::Info: return GRAY_BACKGROUND;
+	}
+	util::unreachable();
+}
+
 AnsiColorized SourceReferenceFormatter::normalColored() const
 {
 	return AnsiColorized(m_stream, m_colored, {WHITE});
@@ -67,18 +89,7 @@ AnsiColorized SourceReferenceFormatter::frameColored() const
 
 AnsiColorized SourceReferenceFormatter::errorColored(std::ostream& _stream, bool _colored, Error::Severity _severity)
 {
-	// We used to color messages of any severity as errors so this seems like a good default
-	// for cases where severity cannot be determined.
-	char const* textColor = RED;
-
-	switch (_severity)
-	{
-	case Error::Severity::Error: textColor = RED; break;
-	case Error::Severity::Warning: textColor = YELLOW; break;
-	case Error::Severity::Info: textColor = WHITE; break;
-	}
-
-	return AnsiColorized(_stream, _colored, {BOLD, textColor});
+	return AnsiColorized(_stream, _colored, {BOLD, errorTextColor(_severity)});
 }
 
 AnsiColorized SourceReferenceFormatter::messageColored(std::ostream& _stream, bool _colored)

liblangutil/SourceReferenceFormatter.h

@@ -127,6 +127,16 @@ class SourceReferenceFormatter
 		bool _withErrorIds = false
 	);
 
+	/// The default text color for printing error messages of a given severity in the terminal.
+	/// Assumes a dark background color.
+	static char const* errorTextColor(Error::Severity _severity);
+
+	/// The default background color for highlighting source fragments corresponding to an error
+	/// of a given severity in the terminal. Assumes a light text color.
+	/// @note This is *not* meant to be used for the same text in combination with @a errorTextColor().
+	///       It's an alternative way to highlight it, while preserving the original text color.
+	static char const* errorHighlightColor(Error::Severity _severity);
+
 private:
 	util::AnsiColorized normalColored() const;
 	util::AnsiColorized frameColored() const;

test/CommonSyntaxTest.cpp

@@ -19,12 +19,17 @@
 #include <test/CommonSyntaxTest.h>
 #include <test/Common.h>
 #include <test/TestCase.h>
+
+#include <liblangutil/SourceReferenceFormatter.h>
+
 #include <libsolutil/CommonIO.h>
 #include <libsolutil/StringUtils.h>
+
 #include <boost/algorithm/string.hpp>
 #include <boost/algorithm/string/predicate.hpp>
 #include <boost/test/unit_test.hpp>
 #include <boost/throw_exception.hpp>
+
 #include <fstream>
 #include <memory>
 #include <stdexcept>
@@ -116,21 +121,17 @@ void CommonSyntaxTest::printSource(ostream& _stream, string const& _linePrefix,
 					assert(static_cast<size_t>(error.locationStart) <= source.length());
 					assert(static_cast<size_t>(error.locationEnd) <= source.length());
 					for (int i = error.locationStart; i < error.locationEnd; i++)
-						if (error.type == Error::Type::Info)
-						{
-							if (sourceFormatting[static_cast<size_t>(i)] == util::formatting::RESET)
-								sourceFormatting[static_cast<size_t>(i)] = util::formatting::GRAY_BACKGROUND;
-						}
-						else if (error.type == Error::Type::Warning)
-						{
-							if (
-								sourceFormatting[static_cast<size_t>(i)] == util::formatting::RESET ||
-								sourceFormatting[static_cast<size_t>(i)] == util::formatting::GRAY_BACKGROUND
-							)
-								sourceFormatting[static_cast<size_t>(i)] = util::formatting::ORANGE_BACKGROUND_256;
-						}
-						else
-							sourceFormatting[static_cast<size_t>(i)] = util::formatting::RED_BACKGROUND;
+					{
+						char const*& cellFormat = sourceFormatting[static_cast<size_t>(i)];
+						char const* infoBgColor = SourceReferenceFormatter::errorHighlightColor(Error::Severity::Info);
+
+						if (
+							(error.type != Error::Type::Warning && error.type != Error::Type::Info) ||
+							(error.type == Error::Type::Warning && (cellFormat == RESET || cellFormat == infoBgColor)) ||
+							(error.type == Error::Type::Info && cellFormat == RESET)
+						)
+							cellFormat = SourceReferenceFormatter::errorHighlightColor(Error::errorSeverity(error.type));
+					}
 				}
 
 			_stream << _linePrefix << sourceFormatting.front() << source.front();
@@ -200,7 +201,7 @@ void CommonSyntaxTest::printErrorList(
 				util::AnsiColorized scope(
 					_stream,
 					_formatted,
-					{BOLD, error.type == Error::Type::Info ? WHITE : (error.type == Error::Type::Warning ? YELLOW : RED)}
+					{BOLD, SourceReferenceFormatter::errorTextColor(Error::errorSeverity(error.type))}
 				);
 				_stream << _linePrefix << Error::formatErrorType(error.type);
 				if (error.errorId.has_value())