Improve the error output that occurs when saving the module (#447)

* Improve the error output that occurs when saving the module * Update * rollback only one '.' changes * rollback deleted MethodBodyWriter constructors * change internal errorContext to private * fix MetadataErrorContext.Source overwritten
0xd4d · Mar 24, 2022 · dafe486 · dafe486
1 parent 2fae02e
commit dafe486
Show file tree

Hide file tree

Showing 10 changed files with 175 additions and 66 deletions.
diff --git a/src/DotNet/Pdb/Portable/ImportScopeBlobWriter.cs b/src/DotNet/Pdb/Portable/ImportScopeBlobWriter.cs
@@ -36,7 +36,7 @@ void Write(DataWriter writer, IList<PdbImport> imports) {
 			for (int i = 0; i < count; i++) {
 				var import = imports[i];
 				if (!ImportDefinitionKindUtils.ToImportDefinitionKind(import.Kind, out uint rawKind)) {
-					helper.Error("Unknown import definition kind: " + import.Kind.ToString());
+					helper.Error2("Unknown import definition kind: {0}.", import.Kind);
 					return;
 				}
 				writer.WriteCompressedUInt32(rawKind);
@@ -94,7 +94,7 @@ void Write(DataWriter writer, IList<PdbImport> imports) {
 					break;
 
 				default:
-					helper.Error("Unknown import definition kind: " + import.Kind.ToString());
+					helper.Error2("Unknown import definition kind: {0}.", import.Kind);
 					return;
 				}
 			}
@@ -108,7 +108,7 @@ uint GetTypeDefOrRefEncodedToken(ITypeDefOrRef tdr) {
 			var token = systemMetadata.GetToken(tdr);
 			if (MD.CodedToken.TypeDefOrRef.Encode(token, out uint codedToken))
 				return codedToken;
-			helper.Error($"Could not encode token 0x{token.Raw:X8}");
+			helper.Error2("Could not encode token 0x{0:X8}.", token.Raw);
 			return 0;
 		}
 	}

diff --git a/src/DotNet/Pdb/Portable/LocalConstantSigBlobWriter.cs b/src/DotNet/Pdb/Portable/LocalConstantSigBlobWriter.cs
@@ -79,7 +79,7 @@ void Write(DataWriter writer, TypeSig type, object value) {
 					var tdr = ((ValueTypeSig)type).TypeDefOrRef;
 					var td = tdr.ResolveTypeDef();
 					if (td is null)
-						helper.Error($"Couldn't resolve type 0x{tdr?.MDToken.Raw ?? 0:X8}");
+						helper.Error2("Couldn't resolve type 0x{0:X8}.", tdr?.MDToken.Raw ?? 0);
 					else if (td.IsEnum) {
 						var underlyingType = td.GetEnumUnderlyingType().RemovePinnedAndModifiers();
 						switch (underlyingType.GetElementType()) {
@@ -135,7 +135,7 @@ void Write(DataWriter writer, TypeSig type, object value) {
 							if (value is byte[])
 								writer.WriteBytes((byte[])value);
 							else if (value is not null) {
-								helper.Error("Unsupported constant: " + value.GetType().FullName);
+								helper.Error2("Unsupported constant: {0}.", value.GetType().FullName);
 								return;
 							}
 						}
@@ -176,7 +176,7 @@ void Write(DataWriter writer, TypeSig type, object value) {
 				case ElementType.Sentinel:
 				case ElementType.Pinned:
 				default:
-					helper.Error("Unsupported element type in LocalConstant sig blob: " + et.ToString());
+					helper.Error2("Unsupported element type in LocalConstant sig blob: {0}.", et);
 					return;
 				}
 			}

diff --git a/src/DotNet/Pdb/Portable/PortablePdbCustomDebugInfoWriter.cs b/src/DotNet/Pdb/Portable/PortablePdbCustomDebugInfoWriter.cs
@@ -106,7 +106,7 @@ void WriteUTF8Z(string s) {
 
 		void WriteStateMachineHoistedLocalScopes(PdbStateMachineHoistedLocalScopesCustomDebugInfo cdi) {
 			if (!methodContext.HasBody) {
-				helper.Error("Method has no body, can't write custom debug info: " + cdi.Kind);
+				helper.Error2("Method has no body, can't write custom debug info: {0}.", cdi.Kind);
 				return;
 			}
 			var cdiScopes = cdi.Scopes;
@@ -222,7 +222,7 @@ void WriteSourceLink(PdbSourceLinkCustomDebugInfo cdi) {
 
 		void WriteAsyncMethodSteppingInformation(PdbAsyncMethodCustomDebugInfo cdi) {
 			if (!methodContext.HasBody) {
-				helper.Error("Method has no body, can't write custom debug info: " + cdi.Kind);
+				helper.Error2("Method has no body, can't write custom debug info: {0}.", cdi.Kind);
 				return;
 			}
 

diff --git a/src/DotNet/Writer/IWriterError.cs b/src/DotNet/Writer/IWriterError.cs
@@ -27,4 +27,20 @@ public interface IWriterError2 : IWriterError {
 		/// <param name="args">Optional message arguments</param>
 		void Error(string message, params object[] args);
 	}
+
+	static partial class Extensions {
+		/// <summary>
+		/// Called when an error is detected (eg. a null pointer or other invalid value). The error
+		/// can be ignored but the written data won't be valid.
+		/// </summary>
+		/// <param name="helper">The instance of <see cref="IWriterError"/></param>
+		/// <param name="message">Error message</param>
+		/// <param name="args">Optional message arguments</param>
+		internal static void Error2(this IWriterError helper, string message, params object[] args) {
+			if (helper is IWriterError2 helper2)
+				helper2.Error(message, args);
+			else
+				helper.Error(string.Format(message, args));
+		}
+	}
 }
diff --git a/src/DotNet/Writer/MarshalBlobWriter.cs b/src/DotNet/Writer/MarshalBlobWriter.cs
@@ -128,7 +128,7 @@ byte[] Write(MarshalType marshalType) {
 		bool UpdateCanWrite(bool isValid, string field, ref bool canWriteMore) {
 			if (!canWriteMore) {
 				if (isValid)
-					helper.Error($"MarshalType field {field} is valid even though a previous field was invalid");
+					helper.Error2("MarshalType field {0} is valid even though a previous field was invalid.", field);
 				return canWriteMore;
 			}