Use printErrorInformation() over printExceptionInformation() where po…

…ssible
snreynolds · Aug 11, 2023 · a59fc39 · a59fc39
1 parent 4020552
commit a59fc39
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/liblangutil/SourceReferenceFormatter.h b/liblangutil/SourceReferenceFormatter.h
@@ -52,6 +52,10 @@ class SourceReferenceFormatter
 		m_withErrorIds(_withErrorIds)
 	{}
 
+	// WARNING: Use the xyzErrorInformation() variants over xyzExceptionInformation() when you
+	// do have access to an Error instance. Error is implicitly convertible to util::Exception
+	// but the conversion loses the error ID.
+
 	/// Prints source location if it is given.
 	void printSourceLocation(SourceReference const& _ref);
 	void printExceptionInformation(SourceReferenceExtractor::Message const& _msg);

diff --git a/solc/CommandLineInterface.cpp b/solc/CommandLineInterface.cpp
@@ -827,7 +827,7 @@ void CommandLineInterface::compile()
 		else
 		{
 			m_hasOutput = true;
-			formatter.printExceptionInformation(_error, Error::errorSeverity(_error.type()));
+			formatter.printErrorInformation(_error);
 			solThrow(CommandLineExecutionError, "");
 		}
 	}

diff --git a/test/tools/ossfuzz/yulProto_diff_ossfuzz.cpp b/test/tools/ossfuzz/yulProto_diff_ossfuzz.cpp
@@ -77,10 +77,7 @@ DEFINE_PROTO_FUZZER(Program const& _input)
 		Error::containsErrors(stack.errors())
 	)
 	{
-		SourceReferenceFormatter formatter(std::cout, stack, false, false);
-
-		for (auto const& error: stack.errors())
-			formatter.printExceptionInformation(*error, Error::errorSeverity(error->type()));
+		SourceReferenceFormatter{std::cout, stack, false, false}.printErrorInformation(stack.errors());
 		yulAssert(false, "Proto fuzzer generated malformed program");
 	}