CommandLineInterface: Report all errors/infos/warnings with proper severity and coloring

Author: cameel

Changelog.md

@@ -517,7 +517,7 @@ void CommandLineInterface::readInputFiles()
 			if (!m_options.input.ignoreMissingFiles)
 				solThrow(CommandLineValidationError, '"' + infile.string() + "\" is not found.");
 			else
-				serr() << infile << " is not found. Skipping." << std::endl;
+				report(Error::Severity::Info, fmt::format("\"{}\" is not found. Skipping.", infile.string()));
 
 			continue;
 		}
@@ -527,7 +527,7 @@ void CommandLineInterface::readInputFiles()
 			if (!m_options.input.ignoreMissingFiles)
 				solThrow(CommandLineValidationError, '"' + infile.string() + "\" is not a valid file.");
 			else
-				serr() << infile << " is not a valid file. Skipping." << std::endl;
+				report(Error::Severity::Info, fmt::format("\"{}\" is not a valid file. Skipping.", infile.string()));
 
 			continue;
 		}
@@ -639,7 +639,7 @@ bool CommandLineInterface::run(int _argc, char const* const* _argv)
 		// There might be no message in the exception itself if the error output is bulky and has
 		// already been printed to stderr (this happens e.g. for compiler errors).
 		if (_exception.what() != ""s)
-			serr() << _exception.what() << std::endl;
+			report(Error::Severity::Error, _exception.what());
 
 		return false;
 	}
@@ -817,7 +817,7 @@ void CommandLineInterface::compile()
 	{
 		if (_error.type() == Error::Type::DocstringParsingError)
 		{
-			serr() << *boost::get_error_info<errinfo_comment>(_error);
+			report(Error::Severity::Error, *boost::get_error_info<errinfo_comment>(_error));
 			solThrow(CommandLineExecutionError, "Documentation parsing failed.");
 		}
 		else
@@ -1020,7 +1020,10 @@ void CommandLineInterface::link()
 				copy(hexStr.begin(), hexStr.end(), it);
 			}
 			else
-				serr() << "Reference \"" << foundPlaceholder << "\" in file \"" << src.first << "\" still unresolved." << std::endl;
+				report(
+					Error::Severity::Warning,
+					fmt::format("Reference \"{}\" in file \"{}\" still unresolved.", foundPlaceholder, src.first)
+				);
 			it += placeholderSize;
 		}
 		// Remove hints for resolved libraries.
@@ -1136,7 +1139,7 @@ void CommandLineInterface::assembleYul(yul::YulStack::Language _language, yul::Y
 			if (object.bytecode)
 				sout() << object.bytecode->toHex() << std::endl;
 			else
-				serr() << "No binary representation found." << std::endl;
+				report(Error::Severity::Info, "No binary representation found.");
 		}
 		if (m_options.compiler.outputs.astCompactJson)
 		{
@@ -1150,7 +1153,7 @@ void CommandLineInterface::assembleYul(yul::YulStack::Language _language, yul::Y
 			if (!object.assembly.empty())
 				sout() << object.assembly << std::endl;
 			else
-				serr() << "No text representation found." << std::endl;
+				report(Error::Severity::Info, "No text representation found.");
 		}
 	}
 }
@@ -1220,4 +1223,16 @@ void CommandLineInterface::outputCompilationResults()
 	}
 }
 
+void CommandLineInterface::report(langutil::Error::Severity _severity, std::string _message)
+{
+	SourceReferenceFormatter::printPrimaryMessage(
+		serr(),
+		_message,
+		_severity,
+		std::nullopt,
+		coloredOutput(m_options),
+		m_options.formatting.withErrorIds
+	);
+}
+
 }

solc/CommandLineInterface.cpp

@@ -136,6 +136,8 @@ class CommandLineInterface
 	/// stream has ever been used unless @arg _markAsUsed is set to false.
 	std::ostream& serr(bool _markAsUsed = true);
 
+	void report(langutil::Error::Severity _severity, std::string _message);
+
 	std::istream& m_sin;
 	std::ostream& m_sout;
 	std::ostream& m_serr;

solc/CommandLineInterface.h

@@ -318,14 +318,14 @@ EOF
 ## RUN
 
 printTask "Testing passing files that are not found..."
-test_solc_behaviour "file_not_found.sol" "" "" "" 1 "" "\"file_not_found.sol\" is not found." "" ""
+test_solc_behaviour "file_not_found.sol" "" "" "" 1 "" "Error: \"file_not_found.sol\" is not found." "" ""
 
 printTask "Testing passing files that are not files..."
-test_solc_behaviour "." "" "" "" 1 "" "\".\" is not a valid file." "" ""
+test_solc_behaviour "." "" "" "" 1 "" "Error: \".\" is not a valid file." "" ""
 
 printTask "Testing passing empty remappings..."
-test_solc_behaviour "${0}" "=/some/remapping/target" "" "" 1 "" "Invalid remapping: \"=/some/remapping/target\"." "" ""
-test_solc_behaviour "${0}" "ctx:=/some/remapping/target" "" "" 1 "" "Invalid remapping: \"ctx:=/some/remapping/target\"." "" ""
+test_solc_behaviour "${0}" "=/some/remapping/target" "" "" 1 "" "Error: Invalid remapping: \"=/some/remapping/target\"." "" ""
+test_solc_behaviour "${0}" "ctx:=/some/remapping/target" "" "" 1 "" "Error: Invalid remapping: \"ctx:=/some/remapping/target\"." "" ""
 
 printTask "Running general commandline tests..."
 (

test/cmdlineTests.sh

@@ -1 +1 @@
-Failed to import AST: Imported tree evm version differs from configured evm version!
+Error: Failed to import AST: Imported tree evm version differs from configured evm version!

test/cmdlineTests/ast_json_import_wrong_evmVersion/err

@@ -1 +1 @@
-Invalid value for --debug-info option: location,all,none
+Error: Invalid value for --debug-info option: location,all,none

test/cmdlineTests/debug_info_in_yul_and_evm_asm_print_all_and_none/err

@@ -1 +1 @@
-To use 'snippet' with --debug-info you must select also 'location'.
+Error: To use 'snippet' with --debug-info you must select also 'location'.

test/cmdlineTests/debug_info_in_yul_and_evm_asm_print_snippet_only/err

@@ -1 +1 @@
-Option --no-optimize-yul is only valid in compiler and assembler modes.
+Error: Option --no-optimize-yul is only valid in compiler and assembler modes.

test/cmdlineTests/linker_mode_invalid_option_no_optimize_yul/err

@@ -1 +1 @@
-Option --optimize is only valid in compiler and assembler modes.
+Error: Option --optimize is only valid in compiler and assembler modes.

test/cmdlineTests/linker_mode_invalid_option_optimize/err

@@ -1 +1 @@
-Option --optimize-runs is only valid in compiler and assembler modes.
+Error: Option --optimize-runs is only valid in compiler and assembler modes.