Fix all build warnings (castleproject#723)

stakx · web-flow · commit 6a81dd5b58bf · 2026-01-02T15:18:49.000+01:00
* Fix nullable reference type warnings
* Fix CA2022 ("avoid inexact read") in `ModuleScope`
* Fix `ref`/`in` warning due to changed method signature on .NET 9+
* Make exception types serializable only for the .NET Framework
* Suppress two instances of SYSLIB0050 ("Formatter-based serialization is obsolete")
* Update `ref/` contract files
diff --git a/ref/Castle.Core-net8.0.cs b/ref/Castle.Core-net8.0.cs
@@ -2131,12 +2131,10 @@ public void WarnFormat(System.Exception exception, string format, params object[
         public void WarnFormat(System.IFormatProvider formatProvider, string format, params object[] args) { }
         public void WarnFormat(System.Exception exception, System.IFormatProvider formatProvider, string format, params object[] args) { }
     }
-    [System.Serializable]
     public class LoggerException : System.Exception
     {
         public LoggerException() { }
         public LoggerException(string message) { }
-        protected LoggerException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
         public LoggerException(string message, System.Exception innerException) { }
     }
     public enum LoggerLevel
@@ -2331,12 +2329,10 @@ public interface IResourceFactory
         Castle.Core.Resource.IResource Create(Castle.Core.Resource.CustomUri uri);
         Castle.Core.Resource.IResource Create(Castle.Core.Resource.CustomUri uri, string basePath);
     }
-    [System.Serializable]
     public class ResourceException : System.Exception
     {
         public ResourceException() { }
         public ResourceException(string message) { }
-        protected ResourceException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
         public ResourceException(string message, System.Exception innerException) { }
     }
     public class StaticContentResource : Castle.Core.Resource.AbstractResource
@@ -2449,7 +2445,6 @@ public System.Type CreateInterfaceProxyTypeWithTarget(System.Type interfaceToPro
         public System.Type CreateInterfaceProxyTypeWithTargetInterface(System.Type interfaceToProxy, System.Type[]? additionalInterfacesToProxy, Castle.DynamicProxy.ProxyGenerationOptions options) { }
         public System.Type CreateInterfaceProxyTypeWithoutTarget(System.Type interfaceToProxy, System.Type[]? additionalInterfacesToProxy, Castle.DynamicProxy.ProxyGenerationOptions options) { }
     }
-    [System.Serializable]
     public sealed class DynamicProxyException : System.Exception { }
     public interface IChangeProxyTarget
     {
diff --git a/ref/Castle.Core-net9.0.cs b/ref/Castle.Core-net9.0.cs
@@ -2131,12 +2131,10 @@ public void WarnFormat(System.Exception exception, string format, params object[
         public void WarnFormat(System.IFormatProvider formatProvider, string format, params object[] args) { }
         public void WarnFormat(System.Exception exception, System.IFormatProvider formatProvider, string format, params object[] args) { }
     }
-    [System.Serializable]
     public class LoggerException : System.Exception
     {
         public LoggerException() { }
         public LoggerException(string message) { }
-        protected LoggerException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
         public LoggerException(string message, System.Exception innerException) { }
     }
     public enum LoggerLevel
@@ -2331,12 +2329,10 @@ public interface IResourceFactory
         Castle.Core.Resource.IResource Create(Castle.Core.Resource.CustomUri uri);
         Castle.Core.Resource.IResource Create(Castle.Core.Resource.CustomUri uri, string basePath);
     }
-    [System.Serializable]
     public class ResourceException : System.Exception
     {
         public ResourceException() { }
         public ResourceException(string message) { }
-        protected ResourceException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
         public ResourceException(string message, System.Exception innerException) { }
     }
     public class StaticContentResource : Castle.Core.Resource.AbstractResource
@@ -2449,7 +2445,6 @@ public System.Type CreateInterfaceProxyTypeWithTarget(System.Type interfaceToPro
         public System.Type CreateInterfaceProxyTypeWithTargetInterface(System.Type interfaceToProxy, System.Type[]? additionalInterfacesToProxy, Castle.DynamicProxy.ProxyGenerationOptions options) { }
         public System.Type CreateInterfaceProxyTypeWithoutTarget(System.Type interfaceToProxy, System.Type[]? additionalInterfacesToProxy, Castle.DynamicProxy.ProxyGenerationOptions options) { }
     }
-    [System.Serializable]
     public sealed class DynamicProxyException : System.Exception { }
     public interface IChangeProxyTarget
     {
diff --git a/ref/Castle.Core-netstandard2.0.cs b/ref/Castle.Core-netstandard2.0.cs
@@ -2131,12 +2131,10 @@ public void WarnFormat(System.Exception exception, string format, params object[
         public void WarnFormat(System.IFormatProvider formatProvider, string format, params object[] args) { }
         public void WarnFormat(System.Exception exception, System.IFormatProvider formatProvider, string format, params object[] args) { }
     }
-    [System.Serializable]
     public class LoggerException : System.Exception
     {
         public LoggerException() { }
         public LoggerException(string message) { }
-        protected LoggerException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
         public LoggerException(string message, System.Exception innerException) { }
     }
     public enum LoggerLevel
@@ -2331,12 +2329,10 @@ public interface IResourceFactory
         Castle.Core.Resource.IResource Create(Castle.Core.Resource.CustomUri uri);
         Castle.Core.Resource.IResource Create(Castle.Core.Resource.CustomUri uri, string basePath);
     }
-    [System.Serializable]
     public class ResourceException : System.Exception
     {
         public ResourceException() { }
         public ResourceException(string message) { }
-        protected ResourceException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
         public ResourceException(string message, System.Exception innerException) { }
     }
     public class StaticContentResource : Castle.Core.Resource.AbstractResource
@@ -2449,7 +2445,6 @@ public System.Type CreateInterfaceProxyTypeWithTarget(System.Type interfaceToPro
         public System.Type CreateInterfaceProxyTypeWithTargetInterface(System.Type interfaceToProxy, System.Type[]? additionalInterfacesToProxy, Castle.DynamicProxy.ProxyGenerationOptions options) { }
         public System.Type CreateInterfaceProxyTypeWithoutTarget(System.Type interfaceToProxy, System.Type[]? additionalInterfacesToProxy, Castle.DynamicProxy.ProxyGenerationOptions options) { }
     }
-    [System.Serializable]
     public sealed class DynamicProxyException : System.Exception { }
     public interface IChangeProxyTarget
     {
diff --git a/src/Castle.Core/Core/Logging/LoggerException.cs b/src/Castle.Core/Core/Logging/LoggerException.cs
@@ -17,7 +17,9 @@ namespace Castle.Core.Logging
 	using System;
 	using System.Runtime.Serialization;
 
+#if FEATURE_SERIALIZATION
 	[Serializable]
+#endif
 	public class LoggerException : Exception
 	{
 		public LoggerException()
@@ -32,8 +34,10 @@ public LoggerException(string message, Exception innerException) : base(message,
 		{
 		}
 
+#if FEATURE_SERIALIZATION
 		protected LoggerException(SerializationInfo info, StreamingContext context) : base(info, context)
 		{
 		}
+#endif
 	}
 }
diff --git a/src/Castle.Core/Core/Resource/ResourceException.cs b/src/Castle.Core/Core/Resource/ResourceException.cs
@@ -17,7 +17,9 @@ namespace Castle.Core.Resource
 	using System;
 	using System.Runtime.Serialization;
 
+#if FEATURE_SERIALIZATION
 	[Serializable]
+#endif
 	public class ResourceException : Exception
 	{
 		public ResourceException()
@@ -32,8 +34,10 @@ public ResourceException(string message, Exception innerException) : base(messag
 		{
 		}
 
+#if FEATURE_SERIALIZATION
 		protected ResourceException(SerializationInfo info, StreamingContext context) : base(info, context)
 		{
 		}
+#endif
 	}
 }
diff --git a/src/Castle.Core/DynamicProxy/DynamicProxyException.cs b/src/Castle.Core/DynamicProxy/DynamicProxyException.cs
@@ -23,7 +23,9 @@ namespace Castle.DynamicProxy
 	// Prefer throwing Base Class Library exception types wherever appropriate.
 	// This exception type is to be used mostly when something inside DynamicProxy goes wrong.
 	// Think of it as a "failed assertion" / "bug" exception.
+#if FEATURE_SERIALIZATION
 	[Serializable]
+#endif
 	public sealed class DynamicProxyException : Exception
 	{
 		internal DynamicProxyException(string message) : base(message)
@@ -34,8 +36,10 @@ internal DynamicProxyException(string message, Exception innerException) : base(
 		{
 		}
 
+#if FEATURE_SERIALIZATION
 		internal DynamicProxyException(SerializationInfo info, StreamingContext context) : base(info, context)
 		{
 		}
+#endif
 	}
 }
diff --git a/src/Castle.Core/DynamicProxy/Generators/Emitters/ClassEmitter.cs b/src/Castle.Core/DynamicProxy/Generators/Emitters/ClassEmitter.cs
@@ -43,8 +43,15 @@ internal sealed class ClassEmitter
 
 		private GenericTypeParameterBuilder[] genericTypeParams;
 
+		// TODO: reconsider the following warning suppression once we have made a decision
+		// regarding DynamicProxy's future support for serialization. For now, we tolerate
+		// the `[Serializable]` attribute on types a little longer, because it is not just
+		// for `BinaryFormatter`'s sake, but also for e.g. the non-obsolete `DataContract-
+		// erializer` which recognizes it.
+#pragma warning disable SYSLIB0050
 		internal const TypeAttributes DefaultTypeAttributes =
 			TypeAttributes.Public | TypeAttributes.Class | TypeAttributes.Serializable;
+#pragma warning restore SYSLIB0050
 
 		public ClassEmitter(TypeBuilder typeBuilder)
 		{
@@ -195,7 +202,10 @@ public FieldReference CreateField(string name, Type fieldType, bool serializable
 
 			if (!serializable)
 			{
+				// TODO: as above, see explanation there (at `DefaultTypeAttributes`'s declaration site)
+#pragma warning disable SYSLIB0050
 				atts |= FieldAttributes.NotSerialized;
+#pragma warning restore CS0001
 			}
 
 			return CreateField(name, fieldType, atts);
diff --git a/src/Castle.Core/DynamicProxy/Generators/Emitters/SimpleAST/IfNullExpression.cs b/src/Castle.Core/DynamicProxy/Generators/Emitters/SimpleAST/IfNullExpression.cs
@@ -21,11 +21,11 @@ namespace Castle.DynamicProxy.Generators.Emitters.SimpleAST
 
 	internal class IfNullExpression : IExpression, IStatement
 	{
-		private readonly IExpressionOrStatement ifNotNull;
+		private readonly IExpressionOrStatement? ifNotNull;
 		private readonly IExpressionOrStatement ifNull;
 		private readonly IExpression expression;
 
-		public IfNullExpression(IExpression expression, IExpressionOrStatement ifNull, IExpressionOrStatement ifNotNull = null)
+		public IfNullExpression(IExpression expression, IExpressionOrStatement ifNull, IExpressionOrStatement? ifNotNull = null)
 		{
 			this.expression = expression ?? throw new ArgumentNullException(nameof(expression));
 			this.ifNull = ifNull;
@@ -39,10 +39,7 @@ public void Emit(ILGenerator gen)
 			gen.Emit(OpCodes.Brtrue_S, notNull);
 			ifNull.Emit(gen);
 			gen.MarkLabel(notNull);
-			if (ifNotNull != null) // yeah, I know that reads funny :)
-			{
-				ifNotNull.Emit(gen);
-			}
+			ifNotNull?.Emit(gen);
 		}
 	}
 }
diff --git a/src/Castle.Core/DynamicProxy/Internal/TypeUtil.cs b/src/Castle.Core/DynamicProxy/Internal/TypeUtil.cs
@@ -138,7 +138,6 @@ public static Type[] GetAllInterfaces(this Type type)  // NOTE: also used by Win
 
 		internal static bool HasAnyOverridableDefaultImplementations(this Type interfaceType)
 		{
-			Debug.Assert(interfaceType != null);
 			Debug.Assert(interfaceType.IsInterface);
 
 			var cache = hasAnyOverridableDefaultImplementationsCache;
diff --git a/src/Castle.Core/DynamicProxy/ModuleScope.cs b/src/Castle.Core/DynamicProxy/ModuleScope.cs
@@ -165,7 +165,11 @@ public static byte[] GetKeyPair()
 
 				var length = (int)stream.Length;
 				var keyPair = new byte[length];
-				stream.Read(keyPair, 0, length);
+				var bytesRead = stream.Read(keyPair, 0, length);
+				if (bytesRead != length)
+				{
+					throw new IOException("Failed to read entire key pair from embedded resource.");
+				}
 				return keyPair;
 			}
 		}
diff --git a/src/Castle.Core/DynamicProxy/ProxyGenerator.cs b/src/Castle.Core/DynamicProxy/ProxyGenerator.cs
@@ -565,7 +565,14 @@ public virtual object CreateInterfaceProxyWithTargetInterface(Type interfaceToPr
 					{
 						var iUnknown = Marshal.GetIUnknownForObject(target); // Increment the reference count
 						var interfacePointer = IntPtr.Zero;
-						var result = Marshal.QueryInterface(iUnknown, ref interfaceId, out interfacePointer); // Increment the reference count
+						var result = Marshal.QueryInterface(
+							iUnknown,
+#if NET9_0_OR_GREATER
+							in interfaceId,
+#else
+							ref interfaceId,
+#endif
+							out interfacePointer); // Increment the reference count
 						var isInterfacePointerNull = interfacePointer == IntPtr.Zero;
 						Marshal.Release(iUnknown); // Decrement the reference count
 						if (!isInterfacePointerNull)

Original file line number	Diff line number	Diff line change
`@@ -2131,12 +2131,10 @@ public void WarnFormat(System.Exception exception, string format, params object[`
`2131`	`2131`	`public void WarnFormat(System.IFormatProvider formatProvider, string format, params object[] args) { }`
`2132`	`2132`	`public void WarnFormat(System.Exception exception, System.IFormatProvider formatProvider, string format, params object[] args) { }`
`2133`	`2133`	`}`
`2134`		`- [System.Serializable]`
`2135`	`2134`	`public class LoggerException : System.Exception`
`2136`	`2135`	`{`
`2137`	`2136`	`public LoggerException() { }`
`2138`	`2137`	`public LoggerException(string message) { }`
`2139`		`- protected LoggerException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }`
`2140`	`2138`	`public LoggerException(string message, System.Exception innerException) { }`
`2141`	`2139`	`}`
`2142`	`2140`	`public enum LoggerLevel`
`@@ -2331,12 +2329,10 @@ public interface IResourceFactory`
`2331`	`2329`	`Castle.Core.Resource.IResource Create(Castle.Core.Resource.CustomUri uri);`
`2332`	`2330`	`Castle.Core.Resource.IResource Create(Castle.Core.Resource.CustomUri uri, string basePath);`
`2333`	`2331`	`}`
`2334`		`- [System.Serializable]`
`2335`	`2332`	`public class ResourceException : System.Exception`
`2336`	`2333`	`{`
`2337`	`2334`	`public ResourceException() { }`
`2338`	`2335`	`public ResourceException(string message) { }`
`2339`		`- protected ResourceException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }`
`2340`	`2336`	`public ResourceException(string message, System.Exception innerException) { }`
`2341`	`2337`	`}`
`2342`	`2338`	`public class StaticContentResource : Castle.Core.Resource.AbstractResource`
`@@ -2449,7 +2445,6 @@ public System.Type CreateInterfaceProxyTypeWithTarget(System.Type interfaceToPro`
`2449`	`2445`	`public System.Type CreateInterfaceProxyTypeWithTargetInterface(System.Type interfaceToProxy, System.Type[]? additionalInterfacesToProxy, Castle.DynamicProxy.ProxyGenerationOptions options) { }`
`2450`	`2446`	`public System.Type CreateInterfaceProxyTypeWithoutTarget(System.Type interfaceToProxy, System.Type[]? additionalInterfacesToProxy, Castle.DynamicProxy.ProxyGenerationOptions options) { }`
`2451`	`2447`	`}`
`2452`		`- [System.Serializable]`
`2453`	`2448`	`public sealed class DynamicProxyException : System.Exception { }`
`2454`	`2449`	`public interface IChangeProxyTarget`
`2455`	`2450`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,9 @@ namespace Castle.Core.Logging`
`17`	`17`	`using System;`
`18`	`18`	`using System.Runtime.Serialization;`
`19`	`19`
	`20`	`+#if FEATURE_SERIALIZATION`
`20`	`21`	`[Serializable]`
	`22`	`+#endif`
`21`	`23`	`public class LoggerException : Exception`
`22`	`24`	`{`
`23`	`25`	`public LoggerException()`
`@@ -32,8 +34,10 @@ public LoggerException(string message, Exception innerException) : base(message,`
`32`	`34`	`{`
`33`	`35`	`}`
`34`	`36`
	`37`	`+#if FEATURE_SERIALIZATION`
`35`	`38`	`protected LoggerException(SerializationInfo info, StreamingContext context) : base(info, context)`
`36`	`39`	`{`
`37`	`40`	`}`
	`41`	`+#endif`
`38`	`42`	`}`
`39`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,9 @@ namespace Castle.DynamicProxy`
`23`	`23`	`// Prefer throwing Base Class Library exception types wherever appropriate.`
`24`	`24`	`// This exception type is to be used mostly when something inside DynamicProxy goes wrong.`
`25`	`25`	`// Think of it as a "failed assertion" / "bug" exception.`
	`26`	`+#if FEATURE_SERIALIZATION`
`26`	`27`	`[Serializable]`
	`28`	`+#endif`
`27`	`29`	`public sealed class DynamicProxyException : Exception`
`28`	`30`	`{`
`29`	`31`	`internal DynamicProxyException(string message) : base(message)`
`@@ -34,8 +36,10 @@ internal DynamicProxyException(string message, Exception innerException) : base(`
`34`	`36`	`{`
`35`	`37`	`}`
`36`	`38`
	`39`	`+#if FEATURE_SERIALIZATION`
`37`	`40`	`internal DynamicProxyException(SerializationInfo info, StreamingContext context) : base(info, context)`
`38`	`41`	`{`
`39`	`42`	`}`
	`43`	`+#endif`
`40`	`44`	`}`
`41`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,11 +21,11 @@ namespace Castle.DynamicProxy.Generators.Emitters.SimpleAST`
`21`	`21`
`22`	`22`	`internal class IfNullExpression : IExpression, IStatement`
`23`	`23`	`{`
`24`		`- private readonly IExpressionOrStatement ifNotNull;`
	`24`	`+ private readonly IExpressionOrStatement? ifNotNull;`
`25`	`25`	`private readonly IExpressionOrStatement ifNull;`
`26`	`26`	`private readonly IExpression expression;`
`27`	`27`
`28`		`- public IfNullExpression(IExpression expression, IExpressionOrStatement ifNull, IExpressionOrStatement ifNotNull = null)`
	`28`	`+ public IfNullExpression(IExpression expression, IExpressionOrStatement ifNull, IExpressionOrStatement? ifNotNull = null)`
`29`	`29`	`{`
`30`	`30`	`this.expression = expression ?? throw new ArgumentNullException(nameof(expression));`
`31`	`31`	`this.ifNull = ifNull;`
`@@ -39,10 +39,7 @@ public void Emit(ILGenerator gen)`
`39`	`39`	`gen.Emit(OpCodes.Brtrue_S, notNull);`
`40`	`40`	`ifNull.Emit(gen);`
`41`	`41`	`gen.MarkLabel(notNull);`
`42`		`- if (ifNotNull != null) // yeah, I know that reads funny :)`
`43`		`- {`
`44`		`- ifNotNull.Emit(gen);`
`45`		`- }`
	`42`	`+ ifNotNull?.Emit(gen);`
`46`	`43`	`}`
`47`	`44`	`}`
`48`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,6 @@ public static Type[] GetAllInterfaces(this Type type) // NOTE: also used by Win`
`138`	`138`
`139`	`139`	`internal static bool HasAnyOverridableDefaultImplementations(this Type interfaceType)`
`140`	`140`	`{`
`141`		`- Debug.Assert(interfaceType != null);`
`142`	`141`	`Debug.Assert(interfaceType.IsInterface);`
`143`	`142`
`144`	`143`	`var cache = hasAnyOverridableDefaultImplementationsCache;`
Original file line number	Diff line number	Diff line change
`@@ -165,7 +165,11 @@ public static byte[] GetKeyPair()`
`165`	`165`
`166`	`166`	`var length = (int)stream.Length;`
`167`	`167`	`var keyPair = new byte[length];`
`168`		`- stream.Read(keyPair, 0, length);`
	`168`	`+ var bytesRead = stream.Read(keyPair, 0, length);`
	`169`	`+ if (bytesRead != length)`
	`170`	`+ {`
	`171`	`+ throw new IOException("Failed to read entire key pair from embedded resource.");`
	`172`	`+ }`
`169`	`173`	`return keyPair;`
`170`	`174`	`}`
`171`	`175`	`}`