[CLSCompliant] (for F#/VB)

.global.editorconfig.ini

@@ -1,8 +1,59 @@
 is_global = true
 
+## misc. C# compiler/language warnings
+
 # Obsolete member 'memberA' overrides non-obsolete member 'memberB' (this simply doesn't work, see https://learn.microsoft.com/en-us/dotnet/csharp/misc/cs0809#methods-recognized-as-obsolete)
 dotnet_diagnostic.CS0809.severity = error
 
+## CLS compliance (F#/VB.NET compatibility) warnings
+
+# `__arglist` in CLS-compliant context
+dotnet_diagnostic.CS3000.severity = error
+# illegal parameter type (e.g. `uint`) in CLS-compliant context
+dotnet_diagnostic.CS3001.severity = error
+# illegal member return type (e.g. `uint`) in CLS-compliant context
+dotnet_diagnostic.CS3002.severity = error
+# illegal field(?) type (e.g. `uint`) in CLS-compliant context
+dotnet_diagnostic.CS3003.severity = error
+# type and member identifiers in CLS-compliant context can only contain certain characters(?)
+dotnet_diagnostic.CS3004.severity = error
+# type or member identifier collision in CLS-compliant context (case-insensitive comparison)
+dotnet_diagnostic.CS3005.severity = error
+# type or member identifier may not begin with '_' in CLS-compliant context
+dotnet_diagnostic.CS3008.severity = error
+# type with non-CLS-compliant supertype cannot be CLS-compliant
+dotnet_diagnostic.CS3009.severity = error
+# CLS-compliant interface may not have non-CLS-compliant members
+dotnet_diagnostic.CS3010.severity = error
+# member of CLS-compliant type must be CLS-compliant and/or concrete (non-`abstract`)
+dotnet_diagnostic.CS3011.severity = error
+# `[module:CLSCompliant]` compiled without `/target:module`
+dotnet_diagnostic.CS3012.severity = error
+# `[module:CLSCompliant]` missing when `[assembly:CLSCompliant]` present
+dotnet_diagnostic.CS3013.severity = error
+# `[CLSCompliant]` applied to member without `[assembly:CLSCompliant]` present
+dotnet_diagnostic.CS3014.severity = error
+# CLS-compliant `Attribute` subclass declares a constructor with illegal parameter types (e.g. `int[]`)
+dotnet_diagnostic.CS3015.severity = error
+# `[module:CLSCompliant]` doesn't match `[assembly:CLSCompliant]`
+dotnet_diagnostic.CS3017.severity = error
+# inner type with non-CLS-compliant outer type cannot be CLS-compliant
+dotnet_diagnostic.CS3018.severity = error
+# `[CLSCompliant]` applied to `internal` type or member
+dotnet_diagnostic.CS3019.severity = error
+# `[CLSCompliant]` applied to type without `[assembly:CLSCompliant]` present
+dotnet_diagnostic.CS3021.severity = error
+# `[CLSCompliant]` applied to parameter
+dotnet_diagnostic.CS3022.severity = error
+# `[CLSCompliant]` applied to member return type
+dotnet_diagnostic.CS3023.severity = error
+# type with non-CLS-compliant type parameter constraint cannot be CLS-compliant
+dotnet_diagnostic.CS3024.severity = error
+# `volatile` in CLS-compliant context
+dotnet_diagnostic.CS3026.severity = error
+# interface with non-CLS-compliant superinterface cannot be CLS-compliant
+dotnet_diagnostic.CS3027.severity = error
+
 ## BizHawk internal rules
 
 # Do not use anonymous delegates
@@ -73,6 +124,8 @@ dotnet_diagnostic.BHI3300.severity = error
 
 # Do not declare static members on generic types
 dotnet_diagnostic.CA1000.severity = error
+# Mark assemblies with CLSCompliantAttribute
+#dotnet_diagnostic.CA1014.severity = warning
 # Properties should not be write only
 dotnet_diagnostic.CA1044.severity = error
 # Do not raise exceptions in unexpected locations

ExternalProjects/AnalyzersCommon/DiagnosticDescriptorExtensions.cs

@@ -6,6 +6,7 @@ namespace BizHawk.Analyzers;
 using MI = System.Runtime.CompilerServices.MethodImplAttribute;
 using OAC = Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext;
 using SNAC = Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext;
+using SPC = Microsoft.CodeAnalysis.SourceProductionContext;
 
 public static class DDExtensions
 {
@@ -91,6 +92,10 @@ public static void ReportAt(this DD diag, Location location, OAC ctx, object?[]?
 	public static void ReportAt(this DD diag, Location location, SNAC ctx, object?[]? messageArgs = null)
 		=> ctx.ReportDiagnostic(Diagnostic.Create(diag, location, messageArgs: messageArgs));
 
+	[MI(AggressiveInlining)]
+	public static void ReportAt(this DD diag, Location location, SPC ctx, object?[]? messageArgs = null)
+		=> ctx.ReportDiagnostic(Diagnostic.Create(diag, location, messageArgs: messageArgs));
+
 	[MI(AggressiveInlining)]
 	public static void ReportAt(this DD diag, Location location, OAC ctx, string message)
 		=> diag.ReportAt(location, ctx, [ message ]);
@@ -167,6 +172,10 @@ public static void ReportAt(this DD diag, SyntaxNode location, OAC ctx, object?[
 	public static void ReportAt(this DD diag, SyntaxNode location, SNAC ctx, object?[]? messageArgs = null)
 		=> diag.ReportAt(location.GetLocation(), ctx, messageArgs);
 
+	[MI(AggressiveInlining)]
+	public static void ReportAt(this DD diag, SyntaxNode location, SPC ctx, object?[]? messageArgs = null)
+		=> diag.ReportAt(location.GetLocation(), ctx, messageArgs);
+
 	[MI(AggressiveInlining)]
 	public static void ReportAt(this DD diag, SyntaxNode location, OAC ctx, string message)
 		=> diag.ReportAt(location, ctx, [ message ]);
@@ -175,6 +184,10 @@ public static void ReportAt(this DD diag, SyntaxNode location, OAC ctx, string m
 	public static void ReportAt(this DD diag, SyntaxNode location, SNAC ctx, string message)
 		=> diag.ReportAt(location, ctx, [ message ]);
 
+	[MI(AggressiveInlining)]
+	public static void ReportAt(this DD diag, SyntaxNode location, SPC ctx, string message)
+		=> diag.ReportAt(location, ctx, [ message ]);
+
 	[MI(AggressiveInlining)]
 	public static void ReportAt(
 		this DD diag,

ExternalProjects/AnalyzersCommon/RoslynUtils.cs

@@ -50,9 +50,7 @@ public static IEnumerable<ITypeSymbol> AllEnclosingTypes(this ITypeSymbol? typeS
 
 	public static bool? GetIsCLSCompliant(this ITypeSymbol typeSym, ISymbol clsCompliantAttrSym)
 		=> typeSym.AllEnclosingTypes().Prepend(typeSym)
-			.Select(typeSym1 => typeSym1.GetAttributes()
-				.FirstOrDefault(ad => clsCompliantAttrSym.Matches(ad.AttributeClass))
-				?.ConstructorArguments[0].Value as bool?)
+			.Select(typeSym1 => typeSym1.GetOwnCLSCompliantValue(clsCompliantAttrSym))
 			.FirstOrDefault(static tristate => tristate is not null);
 
 	public static string GetMethodName(this ConversionOperatorDeclarationSyntax cods)
@@ -112,6 +110,10 @@ public static string GetMethodName(this OperatorDeclarationSyntax ods)
 			_ => throw new ArgumentException(paramName: nameof(ods), message: "pretend this is a BHI6660 unexpected token in AST (in this case, a new kind of operator was added to C#)"),
 		};
 
+	public static bool? GetOwnCLSCompliantValue(this ITypeSymbol typeSym, ISymbol clsCompliantAttrSym)
+		=> typeSym.GetAttributes().FirstOrDefault(ad => clsCompliantAttrSym.Matches(ad.AttributeClass))
+			?.ConstructorArguments[0].Value as bool?;
+
 	private static ITypeSymbol? GetThrownExceptionType(this SemanticModel model, ExpressionSyntax exprSyn)
 		=> exprSyn is ObjectCreationExpressionSyntax
 			? model.GetTypeInfo(exprSyn).Type

ExternalProjects/BizHawk.SrcGen.CLSCompliance/.gitignore

@@ -0,0 +1,2 @@
+/bin
+/obj

ExternalProjects/BizHawk.SrcGen.CLSCompliance/AutoderiveCLSComplianceAttribute.cs

@@ -0,0 +1,11 @@
+#pragma warning disable
+#nullable enable // for when this file is embedded
+
+using System;
+
+namespace BizHawk.SrcGen.CLSCompliance
+{
+	[AttributeUsage(AttributeTargets.Interface | AttributeTargets.Struct | AttributeTargets.Class)]
+	public sealed class AutoderiveCLSComplianceAttribute : Attribute {}
+}
+#pragma warning restore

ExternalProjects/BizHawk.SrcGen.CLSCompliance/BizHawk.SrcGen.CLSCompliance.csproj

@@ -0,0 +1,6 @@
+<Project Sdk="Microsoft.NET.Sdk">
+	<PropertyGroup>
+		<TargetFramework>netstandard2.0</TargetFramework>
+	</PropertyGroup>
+	<Import Project="../AnalyzersCommon.props" />
+</Project>

ExternalProjects/BizHawk.SrcGen.CLSCompliance/CLSComplianceGenerator.cs

@@ -0,0 +1,108 @@
+namespace BizHawk.SrcGen.CLSCompliance;
+
+using System.Collections.Generic;
+using System.Collections.Immutable;
+using System.Linq;
+using System.Text;
+
+using BizHawk.Analyzers;
+
+[Generator]
+public sealed class CLSComplianceGenerator : IIncrementalGenerator
+{
+	private static readonly DiagnosticDescriptor DiagTest = new(
+		id: "BHI1337",
+		title: "test",
+		messageFormat: "{0}",
+		category: "Usage",
+		defaultSeverity: DiagnosticSeverity.Warning,
+		isEnabledByDefault: true);
+
+	public void Initialize(IncrementalGeneratorInitializationContext context)
+	{
+		var declSyns0 = context.SyntaxProvider.CreateSyntaxProvider(
+			predicate: static (syntaxNode, _) => syntaxNode is TypeDeclarationSyntax, // excludes enums because they can't be `partial`; you'll have to add the attribute explicitly
+			transform: static (ctx, _) => (TypeDeclarationSyntax) ctx.Node);
+		context.RegisterSourceOutput(context.CompilationProvider.Combine(declSyns0.Collect()), Execute);
+	}
+
+	private static void Execute(
+		SourceProductionContext context,
+		(Compilation Compilation, ImmutableArray<TypeDeclarationSyntax> DeclSyns) receiver)
+	{
+		var clsCompliantAttrSym = receiver.Compilation.GetTypeByMetadataName(typeof(CLSCompliantAttribute).FullName)!;
+		bool? InheritedCLSCompliant(ITypeSymbol typeSym)
+			=> typeSym.AllBaseTypes().Select(typeSym1 => typeSym1.GetOwnCLSCompliantValue(clsCompliantAttrSym))
+				.FirstOrDefault(static tristate => tristate is not null);
+		string? NodesToNamespaceBlock(
+			IGrouping<string, (TypeDeclarationSyntax Syn, INamedTypeSymbol Sym, string Namespace)> group)
+		{
+			StringBuilder sb = new();
+			HashSet<string> seen = new(); // `DistinctBy` only exists in .NET Core >:(
+			foreach (var (syn, sym, _) in group)
+			{
+				if (!seen.Add(sym.Name)) continue; // dedup partials
+				if (sym.GetIsCLSCompliant(clsCompliantAttrSym) is not null) continue; // already set explicitly
+				var accessMod = "internal";
+				var hasPartial = false;
+				foreach (var mod in syn.Modifiers)
+				{
+					if (mod.Text is "public" or "internal" or "protected" or "private")
+					{
+						accessMod = mod.Text;
+						if (accessMod is not "public") break;
+					}
+					else if (mod.Text is "partial") hasPartial = true; // initially set this up for `static class`, `readonly struct`, etc. but it turns out you don't need to repeat them
+				}
+				if (accessMod is not "public") continue;
+				if (!hasPartial)
+				{
+//					DiagTest.ReportAt(syn, context, "make this type partial");
+					continue;
+				}
+				sb.AppendFormat(
+					"\t[CLSCompliant({0})]\n\t{1} partial {2} {3}{4} {{}}\n\n",
+					(InheritedCLSCompliant(sym) ?? true).ToString().ToLowerInvariant(),
+					accessMod,
+					syn switch
+					{
+						ClassDeclarationSyntax => "class",
+						InterfaceDeclarationSyntax => "interface",
+						RecordDeclarationSyntax rds => $"record {rds.ClassOrStructKeyword.Text}",
+						StructDeclarationSyntax => "struct",
+						_ => throw new InvalidOperationException("pretend this is a BHI6660 unexpected node in AST (in this case, a new kind of type declaration was added to C#)"),
+					},
+					syn.Identifier.Text,
+					syn.TypeParameterList?.ToString() ?? string.Empty);
+			}
+			return sb.Length is 0 ? null : $"\n\nnamespace {group.Key}\n{{\n{sb}}}";
+		}
+
+		var compilation = receiver.Compilation;
+		var clsCompliantSym = compilation.GetTypeByMetadataName(typeof(CLSCompliantAttribute).FullName)!;
+		List<(TypeDeclarationSyntax Syn, INamedTypeSymbol Sym, string Namespace)> typeDecls = new();
+		foreach (var tuple in receiver.DeclSyns
+			.Select(tds => (Syn: tds, Sym: compilation.GetSemanticModel(tds.SyntaxTree)!.GetDeclaredSymbol(tds, context.CancellationToken)!))
+			.Where(tuple => tuple.Sym.GetIsCLSCompliant(clsCompliantSym) is null))
+		{
+			var parentSyn = tuple.Syn.Parent;
+			var nds = parentSyn as NamespaceDeclarationSyntax;
+			if (nds is not null)
+			{
+				typeDecls.Add((
+					tuple.Syn,
+					tuple.Sym,
+					nds.Name.ToMetadataNameStr() ?? string.Empty));
+			}
+			else if (parentSyn is not null) // must be a type decl. with this as its inner class/struct
+			{
+				//TODO warn
+			}
+		}
+		var src = $"#pragma warning disable MA0104{string.Concat(
+			typeDecls.GroupBy(static tuple => tuple.Namespace)
+				.Select(NodesToNamespaceBlock)
+				.Where(static s => s is not null))}";
+		context.AddSource("CLSCompliance.cs", SourceText.From(src, Encoding.UTF8));
+	}
+}

ExternalProjects/BizHawk.SrcGen.CLSCompliance/build_debug.sh

@@ -0,0 +1 @@
+../.build_debug.sh

ExternalProjects/BizHawk.SrcGen.CLSCompliance/build_release.sh

@@ -0,0 +1 @@
+../.build_release.sh

src/BizHawk.Bizware.Graphics/BitmapBuffer.cs

@@ -422,6 +422,7 @@ private void LoadInternal(Stream stream, Bitmap bitmap, BitmapLoadOptions option
 		/// <summary>
 		/// Loads the BitmapBuffer from a source buffer, which is expected to be the right pixel format
 		/// </summary>
+		[CLSCompliant(false)]
 		public void LoadFrom(int width, int stride, int height, byte* data, BitmapLoadOptions options)
 		{
 			var cleanup = options.CleanupAlpha0;

src/BizHawk.Bizware.Input/OSTailoredKeyInputAdapter.cs

@@ -14,6 +14,7 @@ namespace BizHawk.Bizware.Input
 	public abstract class OSTailoredKeyMouseInputAdapter : IHostInputAdapter
 	{
 		private IKeyMouseInput? _keyMouseInput;
+		[CLSCompliant(false)] //TODO just needs renaming
 		protected Func<bool>? _getHandleAlternateKeyboardLayouts;
 
 		public abstract string Desc { get; }

src/BizHawk.Client.Common/Api/ApiContainer.cs

@@ -14,6 +14,7 @@ public ICommApi Comm
 		public IEmuClientApi EmuClient
 			=> Get<IEmuClientApi>();
 
+		[CLSCompliant(false)]
 		public IEmulationApi Emulation
 			=> Get<IEmulationApi>(); // requires IEmulator
 
@@ -26,15 +27,18 @@ public IInputApi Input
 		public IJoypadApi Joypad
 			=> Get<IJoypadApi>();
 
+		[CLSCompliant(false)]
 		public IMemoryApi Memory
 			=> Get<IMemoryApi>(); // requires IEmulator
 
+		[CLSCompliant(false)]
 		public IMemoryEventsApi? MemoryEvents
 			=> TryGet<IMemoryEventsApi>(); // requires IDebuggable
 
 		public IMemorySaveStateApi? MemorySaveState
 			=> TryGet<IMemorySaveStateApi>(); // requires IStatable
 
+		[CLSCompliant(false)]
 		public IMovieApi Movie
 			=> Get<IMovieApi>();
 

src/BizHawk.Client.Common/Api/Classes/EmulationApi.cs

@@ -18,6 +18,7 @@
 
 namespace BizHawk.Client.Common
 {
+	[CLSCompliant(false)]
 	[Description("A library for interacting with the currently loaded emulator core")]
 	public sealed class EmulationApi : IEmulationApi
 	{

src/BizHawk.Client.Common/Api/Classes/JoypadApi.cs

@@ -12,6 +12,7 @@ public sealed class JoypadApi : IJoypadApi
 
 		private readonly Action<string> LogCallback;
 
+		[CLSCompliant(MovieSession.CLS_IMOVIESESSION)]
 		public JoypadApi(Action<string> logCallback, InputManager inputManager, IMovieSession movieSession)
 		{
 			LogCallback = logCallback;

src/BizHawk.Client.Common/Api/Classes/MemoryApi.cs

@@ -7,6 +7,7 @@
 
 namespace BizHawk.Client.Common
 {
+	[CLSCompliant(false)]
 	public sealed class MemoryApi : IMemoryApi
 	{
 		[RequiredService]

src/BizHawk.Client.Common/Api/Classes/MemoryEventsApi.cs

@@ -2,6 +2,7 @@
 
 namespace BizHawk.Client.Common
 {
+	[CLSCompliant(false)]
 	public sealed class MemoryEventsApi : IMemoryEventsApi
 	{
 		[RequiredService]

src/BizHawk.Client.Common/Api/Classes/MovieApi.cs

@@ -6,6 +6,7 @@
 
 namespace BizHawk.Client.Common
 {
+	[CLSCompliant(false)]
 	public sealed class MovieApi : IMovieApi
 	{
 		private readonly IMainFormForApi _mainForm;

src/BizHawk.Client.Common/Api/Classes/UserDataApi.cs

@@ -21,6 +21,7 @@ public KeyCollectionType Keys
 			}
 		}
 
+		[CLSCompliant(MovieSession.CLS_IMOVIESESSION)]
 		public UserDataApi(IMovieSession movieSession) => _movieSession = movieSession;
 
 		/// <exception cref="InvalidOperationException">type of <paramref name="value"/> cannot be used in userdata</exception>

src/BizHawk.Client.Common/Api/ExternalToolAttributes.cs

@@ -35,6 +35,7 @@ public override bool NotApplicableTo(string romHash, string? sysID)
 		}
 
 		[AttributeUsage(AttributeTargets.Class)]
+		[CLSCompliant(false)] //TODO make [ExternalToolApplicability.SingleRom] multi-application
 		public sealed class RomList : ExternalToolApplicabilityAttributeBase
 		{
 			private readonly IList<string> _romHashes;

src/BizHawk.Client.Common/Api/Interfaces/IEmulationApi.cs

@@ -6,6 +6,7 @@
 
 namespace BizHawk.Client.Common
 {
+	[CLSCompliant(false)]
 	public interface IEmulationApi : IExternalApi
 	{
 		void DisplayVsync(bool enabled);

src/BizHawk.Client.Common/Api/Interfaces/IMemoryApi.cs

@@ -2,6 +2,7 @@
 
 namespace BizHawk.Client.Common
 {
+	[CLSCompliant(false)]
 	public interface IMemoryApi : IExternalApi
 	{
 		string MainMemoryName { get; }

src/BizHawk.Client.Common/Api/Interfaces/IMemoryEventsApi.cs

@@ -2,6 +2,7 @@
 
 namespace BizHawk.Client.Common
 {
+	[CLSCompliant(false)]
 	public interface IMemoryEventsApi : IExternalApi
 	{
 		void AddReadCallback(MemoryCallbackDelegate cb, uint? address, string domain);

src/BizHawk.Client.Common/Api/Interfaces/IMovieApi.cs

@@ -2,6 +2,7 @@
 
 namespace BizHawk.Client.Common
 {
+	[CLSCompliant(false)]
 	public interface IMovieApi : IExternalApi
 	{
 		bool StartsFromSavestate();