[build] enable CA1305 for most projects (#7993)

Context: b1079a0
Context: https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1305
Context: https://learn.microsoft.com/dotnet/csharp/tutorials/string-interpolation#how-to-create-a-culture-specific-result-string-with-string-interpolation

In b1079a0, we found a real bug where omitting
`CultureInfo.InvariantCulture` caused problems under certain locales.

Let's take this a step further by making `CA1305` a build error.
In every case I found, it seemed that invariant culture was fine, and
some might be bugs?

This also catches cases like this that use the current culture:

	$"My integer: {x}"

Where we should do this instead:

	FormattableString.Invariant($"My integer: {x}")

Only a single instance for displaying a localized string/error
message from MSBuild seemed like it needed the current culture:

	string.Format (CultureInfo.CurrentCulture, Resources.XA2000, assembly);

And this one might not even matter, as `assembly` is a string.

For on-device app execution, add a new
`Android.Util.Log.FormatProvider` property, which is used by all the
log methods.  This mirrors [`TextWriter.FormatProvider`][1]:

	namespace Android.Util {
	    partial class Log {
	        public static IFormatProvider FormatProvider { get; set; } = CultureInfo.CurrentCulture;
	        public static int Debug (string tag, string format, params object[] args) =>
	            Debug (tag, string.Format (FormatProvider, format, args));
	    }
	}

Some projects that are not shipped I didn't enable yet, to keep this
change smaller:

  * Projects in `build-tools`

  * MSBuild test projects

  * Use `src/.editorconfig`; see also
    [`.editorconfig` File hierarchy and precedence][0]

Finally, `build-tools/automation/guardian/source.gdnsuppress` needed
to be updated because the existing `Log.Wtf()` methods were changed
to use the new `Log.FormatProvider` property.

[0]: https://learn.microsoft.com/visualstudio/ide/create-portable-custom-editor-options#file-hierarchy-and-precedence
[1]: https://learn.microsoft.com/en-us/dotnet/api/system.io.textwriter.formatprovider?view=net-8.0

Author: jonathanpeppers

build-tools/automation/guardian/source.gdnsuppress

@@ -4,7 +4,7 @@
     "default": {
       "name": "default",
       "createdDate": "2023-02-22 23:55:29Z",
-      "lastUpdatedDate": "2023-02-22 23:55:29Z"
+      "lastUpdatedDate": "2023-05-04 13:54:18Z"
     }
   },
   "results": {
@@ -78,8 +78,8 @@
       "expirationDate": null,
       "type": null
     },
-    "58fab4dfef38677720e955e546a6af108332c65daafb0d043ad9d93442300a30": {
-      "signature": "58fab4dfef38677720e955e546a6af108332c65daafb0d043ad9d93442300a30",
+    "6d1fb3a483eb491710d6a09ed0b4bab47f13942d0c6fc744e6683614a66604ab": {
+      "signature": "6d1fb3a483eb491710d6a09ed0b4bab47f13942d0c6fc744e6683614a66604ab",
       "alternativeSignatures": [],
       "target": "src/Mono.Android/Android.Util/Log.cs",
       "memberOf": [
@@ -134,8 +134,8 @@
       "expirationDate": null,
       "type": null
     },
-    "06af52be6b6f87455b1db2eb6e631e783f1dacaf607c9b5f34cdee669992c8b5": {
-      "signature": "06af52be6b6f87455b1db2eb6e631e783f1dacaf607c9b5f34cdee669992c8b5",
+    "1b38e026fae90da4ae2fe9151c9c1ebd73c8b3c2c5f072ceae390a3ceec2fb97": {
+      "signature": "1b38e026fae90da4ae2fe9151c9c1ebd73c8b3c2c5f072ceae390a3ceec2fb97",
       "alternativeSignatures": [],
       "target": "src/Mono.Android/Android.Util/Log.cs",
       "memberOf": [

src/.editorconfig

@@ -0,0 +1,2 @@
+[*.{cs,vb}]
+dotnet_diagnostic.CA1305.severity = error		# Specify IFormatProvider

src/Mono.Android.Export/Mono.CodeGeneration/CodeCustomAttribute.cs

@@ -42,7 +42,7 @@ public static CodeCustomAttribute Create (Type attributeType, Type [] ctorArgTyp
 				if (members [i] == null)
 					members [i] = attributeType.GetProperty (namedArgNames [i]);
 				if (members [i] == null)
-					throw new ArgumentException (String.Format ("Named argument {0} was not found in attribute type {1}", namedArgNames [i], attributeType));
+					throw new ArgumentException (FormattableString.Invariant ($"Named argument {namedArgNames [i]} was not found in attribute type {attributeType}"));
 			}
 
 			CodeLiteral [] args = new CodeLiteral [ctorArgs.Length];
@@ -64,7 +64,7 @@ public static CodeCustomAttribute Create (Type attributeType, Type [] ctorArgTyp
 			ArrayList fvalues = new ArrayList ();
 			for (int i = 0; i < members.Length; i++) {
 				if (members [i] == null)
-					throw new ArgumentException (String.Format ("MemberInfo at {0} was null for type {1}.", i, attributeType));
+					throw new ArgumentException (FormattableString.Invariant ($"MemberInfo at {i} was null for type {attributeType}."));
 				if (members [i] is PropertyInfo) {
 					props.Add ((PropertyInfo) members [i]);
 					pvalues.Add (values [i].Value);

src/Mono.Android/Android.Graphics/Color.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
+using System.Globalization;
 using System.Linq.Expressions;
 using System.Reflection;
 using System.Text;
@@ -64,7 +65,7 @@ public int ToArgb ()
 
 		public override string ToString ()
 		{
-			return String.Format ("Color [A={0}, R={1}, G={2}, B={3}]", A, R, G, B);
+			return FormattableString.Invariant ($"Color [A={A}, R={R}, G={G}, B={B}]");
 		}
 
 		public override bool Equals (object obj)
@@ -217,9 +218,8 @@ private static void CheckRGBValues (int red, int green, int blue)
 
 		private static ArgumentException CreateColorArgumentException (int value, string color)
 		{
-			return new ArgumentException (string.Format ("'{0}' is not a valid"
-				+ " value for '{1}'. '{1}' should be greater or equal to 0 and"
-				+ " less than or equal to 255.", value, color));
+			return new ArgumentException (FormattableString.Invariant (
+				$"'{value}' is not a valid  value for '{color}'. '{color}' should be greater or equal to 0 and less than or equal to 255."));
 		}
 
 		public static Color ParseColor (string colorString)

src/Mono.Android/Android.Runtime/AndroidEnvironment.cs

@@ -188,7 +188,8 @@ static bool TrustEvaluateSsl (List <byte[]> certsRawData)
 			if (certStore == null)
 				return null;
 
-			var alias = string.Format ("{0}:{1:x8}.0", userStore ? "user" : "system", hash);
+			var store = userStore ? "user" : "system";
+			var alias = FormattableString.Invariant ($"{store}:{hash:x8}.0");
 			var certificate = certStore.GetCertificate (alias);
 			if (certificate == null)
 				return null;
@@ -220,7 +221,7 @@ static void NotifyTimeZoneChanged ()
 				try {
 					clearInfo.Method ();
 				} catch (Exception e) {
-					Logger.Log (LogLevel.Warn, "MonoAndroid", string.Format ("Ignoring exception from {0}: {1}", clearInfo.Description, e));
+					Logger.Log (LogLevel.Warn, "MonoAndroid", FormattableString.Invariant ($"Ignoring exception from {clearInfo.Description}: {e}"));
 				}
 			}
 		}
@@ -426,11 +427,7 @@ public Uri GetProxy (Uri destination)
 				if (address == null) // FIXME
 					return destination;
 
-#if ANDROID_19
-				return new Uri (string.Format ("http://{0}:{1}/", address.HostString, address.Port));
-#else
-				return new Uri (string.Format ("http://{0}:{1}/", address.HostName, address.Port));
-#endif
+				return new Uri (FormattableString.Invariant ($"http://{address.HostString}:{address.Port}/"));
 			}
 
 			public bool IsBypassed (Uri host)

src/Mono.Android/Android.Runtime/AndroidRuntime.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.Globalization;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 using System.Runtime.Versioning;
@@ -165,7 +166,7 @@ public override IntPtr ReleaseLocalReference (ref JniObjectReference value, ref
 
 		public override void WriteGlobalReferenceLine (string format, params object?[] args)
 		{
-			RuntimeNativeMethods._monodroid_gref_log (string.Format (format, args));
+			RuntimeNativeMethods._monodroid_gref_log (string.Format (CultureInfo.InvariantCulture, format, args));
 		}
 
 		public override JniObjectReference CreateGlobalReference (JniObjectReference value)
@@ -530,7 +531,7 @@ public void RegisterNativeMembers (JniType nativeClass, Type type, ReadOnlySpan<
 								}
 
 							if (minfo == null)
-								throw new InvalidOperationException (String.Format ("Specified managed method '{0}' was not found. Signature: {1}", mname.ToString (), signature.ToString ()));
+								throw new InvalidOperationException (FormattableString.Invariant ($"Specified managed method '{mname.ToString ()}' was not found. Signature: {signature.ToString ()}"));
 							callback = CreateDynamicCallback (minfo);
 							needToRegisterNatives = true;
 						} else {
@@ -659,9 +660,8 @@ internal void AddPeer (IJavaPeerable value, JniObjectReference reference, IntPtr
 					if (JniEnvironment.Types.IsSameObject (value.PeerReference, target!.PeerReference)) {
 						found = true;
 						if (Logger.LogGlobalRef) {
-							Logger.Log (LogLevel.Info, "monodroid-gref",
-									string.Format ("warning: not replacing previous registered handle {0} with handle {1} for key_handle 0x{2}",
-										target.PeerReference.ToString (), reference.ToString (), hash.ToString ("x")));
+							Logger.Log (LogLevel.Info, "monodroid-gref", FormattableString.Invariant (
+								$"warning: not replacing previous registered handle {target.PeerReference} with handle {reference} for key_handle 0x{hash:x}"));
 						}
 					}
 				}
@@ -704,10 +704,9 @@ internal void AddPeer (IJavaPeerable value, IntPtr handle, JniHandleOwnership tr
 			}
 
 			if (Logger.LogGlobalRef) {
-				RuntimeNativeMethods._monodroid_gref_log ("handle 0x" + handleField.ToString ("x") +
-						"; key_handle 0x" + hash.ToString ("x") +
-						": Java Type: `" + JNIEnv.GetClassNameFromInstance (handleField) + "`; " +
-						"MCW type: `" + value.GetType ().FullName + "`\n");
+				RuntimeNativeMethods._monodroid_gref_log (
+					FormattableString.Invariant (
+						$"handle 0x{handleField:x}; key_handle 0x{hash:x}: Java Type: `{JNIEnv.GetClassNameFromInstance (handleField)}`; MCW type: `{value.GetType ().FullName}`\n"));
 			}
 		}
 

src/Mono.Android/Android.Runtime/JNIEnv.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.Globalization;
 using System.IO;
 using System.Reflection;
 using System.Runtime.CompilerServices;
@@ -262,8 +263,8 @@ public static unsafe void InvokeConstructor (IntPtr instance, string jniCtorSign
 			try {
 				IntPtr ctor = JNIEnv.GetMethodID (lrefClass, "<init>", jniCtorSignature);
 				if (ctor == IntPtr.Zero)
-					throw new ArgumentException (string.Format ("Could not find constructor JNI signature '{0}' on type '{1}'.",
-								jniCtorSignature, Java.Interop.TypeManager.GetClassName (lrefClass)));
+					throw new ArgumentException (FormattableString.Invariant (
+						$"Could not find constructor JNI signature '{jniCtorSignature}' on type '{Java.Interop.TypeManager.GetClassName (lrefClass)}'."));
 				CallNonvirtualVoidMethod (instance, lrefClass, ctor, constructorParameters);
 			} finally {
 				DeleteLocalRef (lrefClass);
@@ -280,8 +281,8 @@ public static unsafe IntPtr CreateInstance (IntPtr jniClass, string signature, J
 		{
 			IntPtr ctor = JNIEnv.GetMethodID (jniClass, "<init>", signature);
 			if (ctor == IntPtr.Zero)
-				throw new ArgumentException (string.Format ("Could not find constructor JNI signature '{0}' on type '{1}'.",
-							signature, Java.Interop.TypeManager.GetClassName (jniClass)));
+				throw new ArgumentException (FormattableString.Invariant (
+					$"Could not find constructor JNI signature '{signature}' on type '{Java.Interop.TypeManager.GetClassName (jniClass)}'."));
 			return JNIEnv.NewObject (jniClass, ctor, constructorParameters);
 		}
 
@@ -627,9 +628,8 @@ static void AssertCompatibleArrayTypes (Type sourceType, IntPtr destArray)
 			IntPtr lrefDest   = GetObjectClass (destArray);
 			try {
 				if (!IsAssignableFrom (grefSource, lrefDest)) {
-					throw new InvalidCastException (string.Format ("Unable to cast from '{0}' to '{1}'.",
-								Java.Interop.TypeManager.GetClassName (grefSource),
-								Java.Interop.TypeManager.GetClassName (lrefDest)));
+					throw new InvalidCastException (FormattableString.Invariant (
+						$"Unable to cast from '{Java.Interop.TypeManager.GetClassName (grefSource)}' to '{Java.Interop.TypeManager.GetClassName (lrefDest)}'."));
 				}
 			} finally {
 				DeleteGlobalRef (grefSource);
@@ -643,9 +643,8 @@ static void AssertCompatibleArrayTypes (IntPtr sourceArray, Type destType)
 			IntPtr lrefSource = GetObjectClass (sourceArray);
 			try {
 				if (!IsAssignableFrom (lrefSource, grefDest)) {
-					throw new InvalidCastException (string.Format ("Unable to cast from '{0}' to '{1}'.",
-								Java.Interop.TypeManager.GetClassName (lrefSource),
-								Java.Interop.TypeManager.GetClassName (grefDest)));
+					throw new InvalidCastException (FormattableString.Invariant (
+						$"Unable to cast from '{Java.Interop.TypeManager.GetClassName (lrefSource)}' to '{Java.Interop.TypeManager.GetClassName (grefDest)}'."));
 				}
 			} finally {
 				DeleteGlobalRef (grefDest);
@@ -1145,7 +1144,7 @@ static int _GetArrayLength (IntPtr array_ptr)
 				ret [i] = value;
 				ret [i] = targetType == null || targetType.IsInstanceOfType (value)
 					? value
-					: Convert.ChangeType (value, targetType);
+					: Convert.ChangeType (value, targetType, CultureInfo.InvariantCulture);
 			}
 
 			return ret;

src/Mono.Android/Android.Runtime/XmlReaderPullParser.cs

@@ -461,8 +461,9 @@ public string PositionDescription {
 				var xi = r as IXmlLineInfo;
 				var loc = xi == null || !xi.HasLineInfo () ?
 					"(location N/A)" :
-					String.Format ("({0}, {1})", xi.LineNumber, xi.LinePosition);
-				return String.Format ("Node {0} at {1} {2}", r.NodeType, String.IsNullOrEmpty (r.BaseURI) ? null : r.BaseURI, loc);
+					FormattableString.Invariant ($"({xi.LineNumber}, {xi.LinePosition})");
+				var uri = string.IsNullOrEmpty (r.BaseURI) ? null : r.BaseURI;
+				return FormattableString.Invariant ($"Node {r.NodeType} at {uri} {loc}");
 			}
 		}
 

src/Mono.Android/Android.Util/Log.cs

@@ -1,13 +1,22 @@
 using System;
+using System.Globalization;
 using Android.Runtime;
 
 namespace Android.Util {
 
 	public partial class Log {
 
+		/// <summary>
+		/// IFormatProvider passed to any underlying string.Format() calls. Defaults to System.Globalization.CultureInfo.CurrentCulture.
+		/// </summary>
+#if ANDROID_34
+		public
+#endif  // ANDROID_34
+		static IFormatProvider FormatProvider { get; set; } = CultureInfo.CurrentCulture;
+
 		public static int Debug (string tag, string format, params object[] args)
 		{
-			return Debug (tag, string.Format (format, args));
+			return Debug (tag, string.Format (FormatProvider, format, args));
 		}
 
 		public static int Debug (string tag, Java.Lang.Throwable tr, string msg)
@@ -17,12 +26,12 @@ public static int Debug (string tag, Java.Lang.Throwable tr, string msg)
 
 		public static int Debug (string tag, Java.Lang.Throwable tr, string format, params object[] args)
 		{
-			return Debug (tag, string.Format (format, args), tr);
+			return Debug (tag, string.Format (FormatProvider, format, args), tr);
 		}
 
 		public static int Error (string tag, string format, params object[] args)
 		{
-			return Error (tag, string.Format (format, args));
+			return Error (tag, string.Format (FormatProvider, format, args));
 		}
 
 		public static int Error (string tag, Java.Lang.Throwable tr, string msg)
@@ -32,12 +41,12 @@ public static int Error (string tag, Java.Lang.Throwable tr, string msg)
 
 		public static int Error (string tag, Java.Lang.Throwable tr, string format, params object[] args)
 		{
-			return Error (tag, string.Format (format, args), tr);
+			return Error (tag, string.Format (FormatProvider, format, args), tr);
 		}
 
 		public static int Info (string tag, string format, params object[] args)
 		{
-			return Info (tag, string.Format (format, args));
+			return Info (tag, string.Format (FormatProvider, format, args));
 		}
 
 		public static int Info (string tag, Java.Lang.Throwable tr, string msg)
@@ -47,17 +56,17 @@ public static int Info (string tag, Java.Lang.Throwable tr, string msg)
 
 		public static int Info (string tag, Java.Lang.Throwable tr, string format, params object[] args)
 		{
-			return Info (tag, string.Format (format, args), tr);
+			return Info (tag, string.Format (FormatProvider, format, args), tr);
 		}
 
 		public static int WriteLine (LogPriority priority, string tag, string format, params object[] args)
 		{
-			return WriteLine (priority, tag, string.Format (format, args));
+			return WriteLine (priority, tag, string.Format (FormatProvider, format, args));
 		}
 
 		public static int Verbose (string tag, string format, params object[] args)
 		{
-			return Verbose (tag, string.Format (format, args));
+			return Verbose (tag, string.Format (FormatProvider, format, args));
 		}
 
 		public static int Verbose (string tag, Java.Lang.Throwable tr, string msg)
@@ -67,12 +76,12 @@ public static int Verbose (string tag, Java.Lang.Throwable tr, string msg)
 
 		public static int Verbose (string tag, Java.Lang.Throwable tr, string format, params object[] args)
 		{
-			return Verbose (tag, string.Format (format, args), tr);
+			return Verbose (tag, string.Format (FormatProvider, format, args), tr);
 		}
 
 		public static int Warn (string tag, string format, params object[] args)
 		{
-			return Warn (tag, string.Format (format, args));
+			return Warn (tag, string.Format (FormatProvider, format, args));
 		}
 
 		public static int Warn (string tag, Java.Lang.Throwable tr, string msg)
@@ -82,12 +91,12 @@ public static int Warn (string tag, Java.Lang.Throwable tr, string msg)
 
 		public static int Warn (string tag, Java.Lang.Throwable tr, string format, params object[] args)
 		{
-			return Warn (tag, string.Format (format, args), tr);
+			return Warn (tag, string.Format (FormatProvider, format, args), tr);
 		}
 
 		public static int Wtf (string tag, string format, params object[] args)
 		{
-			return Wtf (tag, string.Format (format, args));
+			return Wtf (tag, string.Format (FormatProvider, format, args));
 		}
 
 		public static int Wtf (string tag, Java.Lang.Throwable tr, string msg)
@@ -97,7 +106,7 @@ public static int Wtf (string tag, Java.Lang.Throwable tr, string msg)
 
 		public static int Wtf (string tag, Java.Lang.Throwable tr, string format, params object[] args)
 		{
-			return Wtf (tag, string.Format (format, args), tr);
+			return Wtf (tag, string.Format (FormatProvider, format, args), tr);
 		}
 	}
 }