[Generator] Add BindingTouchConfig to BindingTouch (#19485)

dustin-wojciechowski · GitHub Actions Autoformatter · web-flow · commit 31f5b9e33840 · 2023-11-20T13:46:44.000-08:00
This takes the variables instantiated at the beginning of the Main3
method and places them into their own class that will be used as a
parameter object to extract methods out of the rest of what's in the
Main3 method.

The CreateOptionSet() method is an example of what I have envisioned.
Also I renamed some of the values to be more helpful based on the
descriptions in the option set.

---------

Co-authored-by: GitHub Actions Autoformatter &lt;github-actions-autoformatter@xamarin.com&gt;
diff --git a/src/bgen/BindingTouch.cs b/src/bgen/BindingTouch.cs
@@ -205,41 +205,18 @@ static int Main2 (string [] args)
 		return touch.Main3 (args);
 	}
 
-	int Main3 (string [] args)
+	public OptionSet CreateOptionSet (BindingTouchConfig config)
 	{
-		bool show_help = false;
-		bool zero_copy = false;
-		string? basedir = null;
-		string? tmpdir = null;
-		string? ns = null;
-		bool delete_temp = true, debug = false;
-		bool unsafef = true;
-		bool external = false;
-		bool public_mode = true;
-		bool nostdlib = false;
-		bool? inline_selectors = null;
-		List<string> sources;
-		var resources = new List<string> ();
-		var linkwith = new List<string> ();
-		var api_sources = new List<string> ();
-		var core_sources = new List<string> ();
-		var extra_sources = new List<string> ();
-		var defines = new List<string> ();
-		string? generate_file_list = null;
-		bool process_enums = false;
-
-		ErrorHelper.ClearWarningLevels ();
-
-		var os = new OptionSet () {
-			{ "h|?|help", "Displays the help", v => show_help = true },
+		return new OptionSet () {
+			{ "h|?|help", "Displays the help", v => config.ShowHelp = true },
 			{ "a", "Include alpha bindings (Obsolete).", v => {}, true },
-			{ "outdir=", "Sets the output directory for the temporary binding files", v => { basedir = v; }},
+			{ "outdir=", "Sets the output directory for the temporary binding files", v => { config.BindingFilesOutputDirectory = v; }},
 			{ "o|out=", "Sets the name of the output library", v => outfile = v },
-			{ "tmpdir=", "Sets the working directory for temp files", v => { tmpdir = v; delete_temp = false; }},
-			{ "debug", "Generates a debugging build of the binding", v => debug = true },
-			{ "sourceonly=", "Only generates the source", v => generate_file_list = v },
-			{ "ns=", "Sets the namespace for storing helper classes", v => ns = v },
-			{ "unsafe", "Sets the unsafe flag for the build", v=> unsafef = true },
+			{ "tmpdir=", "Sets the working directory for temp files", v => { config.TemporaryFileDirectory = v; config.DeleteTemporaryFiles = false; }},
+			{ "debug", "Generates a debugging build of the binding", v => config.IsDebug = true },
+			{ "sourceonly=", "Only generates the source", v => config.GeneratedFileList = v },
+			{ "ns=", "Sets the namespace for storing helper classes", v => config.HelperClassNamespace = v },
+			{ "unsafe", "Sets the unsafe flag for the build", v=> config.IsUnsafe = true },
 			{ "core", "Use this to build product assemblies", v => BindThirdPartyLibrary = false },
 			{ "r|reference=", "Adds a reference", v => references.Add (v) },
 			{ "lib=", "Adds the directory to the search path for the compiler", v => libs.Add (v) },
@@ -252,24 +229,24 @@ int Main3 (string [] args)
 			},
 			{ "sdk=", "Sets the .NET SDK to use (Obsolete)", v => {}, true },
 			{ "new-style", "Build for Unified (Obsolete).", v => { Console.WriteLine ("The --new-style option is obsolete and ignored."); }, true},
-			{ "d=", "Defines a symbol", v => defines.Add (v) },
-			{ "api=", "Adds a API definition source file", v => api_sources.Add (v) },
-			{ "s=", "Adds a source file required to build the API", v => core_sources.Add (v) },
+			{ "d=", "Defines a symbol", v => config.Defines.Add (v) },
+			{ "api=", "Adds a API definition source file", v => config.ApiSources.Add (v) },
+			{ "s=", "Adds a source file required to build the API", v => config.CoreSources.Add (v) },
 			{ "q", "Quiet", v => ErrorHelper.Verbosity-- },
 			{ "v", "Sets verbose mode", v => ErrorHelper.Verbosity++ },
-			{ "x=", "Adds the specified file to the build, used after the core files are compiled", v => extra_sources.Add (v) },
-			{ "e", "Generates smaller classes that can not be subclassed (previously called 'external mode')", v => external = true },
-			{ "p", "Sets private mode", v => public_mode = false },
+			{ "x=", "Adds the specified file to the build, used after the core files are compiled", v => config.ExtraSources.Add (v) },
+			{ "e", "Generates smaller classes that can not be subclassed (previously called 'external mode')", v => config.IsExternal = true },
+			{ "p", "Sets private mode", v => config.IsPublicMode = false },
 			{ "baselib=", "Sets the base library", v => baselibdll = v },
 			{ "attributelib=", "Sets the attribute library", v => attributedll = v },
-			{ "use-zero-copy", v=> zero_copy = true },
-			{ "nostdlib", "Does not reference mscorlib.dll library", l => nostdlib = true },
+			{ "use-zero-copy", v=> config.UseZeroCopy = true },
+			{ "nostdlib", "Does not reference mscorlib.dll library", l => config.OmitStandardLibrary = true },
 			{ "no-mono-path", "Launches compiler with empty MONO_PATH", l => { }, true },
 			{ "native-exception-marshalling", "Enable the marshalling support for Objective-C exceptions", (v) => { /* no-op */} },
 			{ "inline-selectors:", "If Selector.GetHandle is inlined and does not need to be cached (enabled by default in Xamarin.iOS, disabled in Xamarin.Mac)",
-				v => inline_selectors = string.Equals ("true", v, StringComparison.OrdinalIgnoreCase) || string.IsNullOrEmpty (v)
+				v => config.InlineSelectors = string.Equals ("true", v, StringComparison.OrdinalIgnoreCase) || string.IsNullOrEmpty (v)
 			},
-			{ "process-enums", "Process enums as bindings, not external, types.", v => process_enums = true },
+			{ "process-enums", "Process enums as bindings, not external, types.", v => config.ProcessEnums = true },
 			{ "link-with=,", "Link with a native library {0:FILE} to the binding, embedded as a resource named {1:ID}",
 				(path, id) => {
 					if (path is null || path.Length == 0)
@@ -278,11 +255,11 @@ int Main3 (string [] args)
 					if (id is null || id.Length == 0)
 						id = Path.GetFileName (path);
 
-					if (linkwith.Contains (id))
+					if (config.LinkWith.Contains (id))
 						throw new Exception ("-link-with=FILE,ID cannot assign the same resource id to multiple libraries.");
 
-					resources.Add (string.Format ("-res:{0},{1}", path, id));
-					linkwith.Add (id);
+					config.Resources.Add (string.Format ("-res:{0},{1}", path, id));
+					config.LinkWith.Add (id);
 				}
 			},
 			{ "unified-full-profile", "Launches compiler pointing to XM Full Profile", l => { /* no-op*/ }, true },
@@ -321,16 +298,24 @@ int Main3 (string [] args)
 			{ "compiled-api-definition-assembly=", "An assembly with the compiled api definitions.", (v) => compiled_api_definition_assembly = v },
 			new Mono.Options.ResponseFileSource (),
 		};
+	}
+
+	int Main3 (string [] args)
+	{
+		ErrorHelper.ClearWarningLevels ();
+
+		BindingTouchConfig config = new ();
+		OptionSet os = CreateOptionSet (config);
 
 		try {
-			sources = os.Parse (args);
+			config.Sources = os.Parse (args);
 		} catch (Exception e) {
 			Console.Error.WriteLine ("{0}: {1}", ToolName, e.Message);
 			Console.Error.WriteLine ("see {0} --help for more information", ToolName);
 			return 1;
 		}
 
-		if (show_help) {
+		if (config.ShowHelp) {
 			ShowHelp (os);
 			return 0;
 		}
@@ -341,7 +326,7 @@ int Main3 (string [] args)
 		switch (target_framework.Value.Platform) {
 		case ApplePlatform.iOS:
 			CurrentPlatform = PlatformName.iOS;
-			nostdlib = true;
+			config.OmitStandardLibrary = true;
 			if (string.IsNullOrEmpty (baselibdll))
 				baselibdll = CurrentPlatform.GetPath ("lib/mono/Xamarin.iOS/Xamarin.iOS.dll");
 			if (!IsDotNet) {
@@ -351,7 +336,7 @@ int Main3 (string [] args)
 			break;
 		case ApplePlatform.TVOS:
 			CurrentPlatform = PlatformName.TvOS;
-			nostdlib = true;
+			config.OmitStandardLibrary = true;
 			if (string.IsNullOrEmpty (baselibdll))
 				baselibdll = CurrentPlatform.GetPath ("lib/mono/Xamarin.TVOS/Xamarin.TVOS.dll");
 			if (!IsDotNet) {
@@ -361,7 +346,7 @@ int Main3 (string [] args)
 			break;
 		case ApplePlatform.WatchOS:
 			CurrentPlatform = PlatformName.WatchOS;
-			nostdlib = true;
+			config.OmitStandardLibrary = true;
 			if (string.IsNullOrEmpty (baselibdll))
 				baselibdll = CurrentPlatform.GetPath ("lib/mono/Xamarin.WatchOS/Xamarin.WatchOS.dll");
 			if (!IsDotNet) {
@@ -371,7 +356,7 @@ int Main3 (string [] args)
 			break;
 		case ApplePlatform.MacCatalyst:
 			CurrentPlatform = PlatformName.MacCatalyst;
-			nostdlib = true;
+			config.OmitStandardLibrary = true;
 			if (string.IsNullOrEmpty (baselibdll))
 				baselibdll = CurrentPlatform.GetPath ("lib/mono/Xamarin.MacCatalyst/Xamarin.MacCatalyst.dll");
 			if (!IsDotNet) {
@@ -381,7 +366,7 @@ int Main3 (string [] args)
 			break;
 		case ApplePlatform.MacOSX:
 			CurrentPlatform = PlatformName.MacOSX;
-			nostdlib = true;
+			config.OmitStandardLibrary = true;
 			if (string.IsNullOrEmpty (baselibdll)) {
 				if (target_framework == TargetFramework.Xamarin_Mac_2_0_Mobile)
 					baselibdll = CurrentPlatform.GetPath ("lib", "reference", "mobile", "Xamarin.Mac.dll");
@@ -414,22 +399,22 @@ int Main3 (string [] args)
 			throw ErrorHelper.CreateError (1053, target_framework);
 		}
 
-		if (sources.Count > 0) {
-			api_sources.Insert (0, sources [0]);
-			for (int i = 1; i < sources.Count; i++)
-				core_sources.Insert (i - 1, sources [i]);
+		if (config.Sources.Count > 0) {
+			config.ApiSources.Insert (0, config.Sources [0]);
+			for (int i = 1; i < config.Sources.Count; i++)
+				config.CoreSources.Insert (i - 1, config.Sources [i]);
 		}
 
-		if (api_sources.Count == 0) {
+		if (config.ApiSources.Count == 0) {
 			Console.WriteLine ("Error: no api file provided");
 			ShowHelp (os);
 			return 1;
 		}
 
-		if (tmpdir is null)
-			tmpdir = GetWorkDir ();
+		if (config.TemporaryFileDirectory is null)
+			config.TemporaryFileDirectory = GetWorkDir ();
 
-		string firstApiDefinitionName = Path.GetFileNameWithoutExtension (api_sources [0]);
+		string firstApiDefinitionName = Path.GetFileNameWithoutExtension (config.ApiSources [0]);
 		firstApiDefinitionName = firstApiDefinitionName.Replace ('-', '_'); // This is not exhaustive, but common.
 		if (outfile is null)
 			outfile = firstApiDefinitionName + ".dll";
@@ -438,7 +423,7 @@ int Main3 (string [] args)
 		var paths = libs.Select ((v) => "-lib:" + v);
 
 		try {
-			var tmpass = GetCompiledApiBindingsAssembly (tmpdir, refs, nostdlib, api_sources, core_sources, defines, paths);
+			var tmpass = GetCompiledApiBindingsAssembly (config.TemporaryFileDirectory, refs, config.OmitStandardLibrary, config.ApiSources, config.CoreSources, config.Defines, paths);
 			universe = new MetadataLoadContext (
 				new SearchPathsAssemblyResolver (
 					GetLibraryDirectories ().ToArray (),
@@ -466,7 +451,7 @@ int Main3 (string [] args)
 #endif
 					continue;
 
-				if (!linkwith.Contains (linkWith.LibraryName)) {
+				if (!config.LinkWith.Contains (linkWith.LibraryName)) {
 					Console.Error.WriteLine ("Missing native library {0}, please use `--link-with' to specify the path to this library.", linkWith.LibraryName);
 					return 1;
 				}
@@ -497,7 +482,7 @@ int Main3 (string [] args)
 			var types = new List<Type> ();
 			var strong_dictionaries = new List<Type> ();
 			foreach (var t in api.GetTypes ()) {
-				if ((process_enums && t.IsEnum) ||
+				if ((config.ProcessEnums && t.IsEnum) ||
 					AttributeManager.HasAttribute<BaseTypeAttribute> (t) ||
 					AttributeManager.HasAttribute<ProtocolAttribute> (t) ||
 					AttributeManager.HasAttribute<StaticAttribute> (t) ||
@@ -509,55 +494,55 @@ int Main3 (string [] args)
 
 			namespaceCache ??= new NamespaceCache (
 				CurrentPlatform,
-				ns ?? firstApiDefinitionName,
+				config.HelperClassNamespace ?? firstApiDefinitionName,
 				skipSystemDrawing
 			);
 
-			var g = new Generator (this, public_mode, external, debug, types.ToArray (), strong_dictionaries.ToArray ()) {
-				BaseDir = basedir ?? tmpdir,
-				ZeroCopyStrings = zero_copy,
-				InlineSelectors = inline_selectors ?? (CurrentPlatform != PlatformName.MacOSX),
+			var g = new Generator (this, config.IsPublicMode, config.IsExternal, config.IsDebug, types.ToArray (), strong_dictionaries.ToArray ()) {
+				BaseDir = config.BindingFilesOutputDirectory ?? config.TemporaryFileDirectory,
+				ZeroCopyStrings = config.UseZeroCopy,
+				InlineSelectors = config.InlineSelectors ?? (CurrentPlatform != PlatformName.MacOSX),
 			};
 
 			g.Go ();
 
-			if (generate_file_list is not null) {
-				using (var f = File.CreateText (generate_file_list)) {
+			if (config.GeneratedFileList is not null) {
+				using (var f = File.CreateText (config.GeneratedFileList)) {
 					foreach (var x in g.GeneratedFiles.OrderBy ((v) => v))
 						f.WriteLine (x);
 				}
 				return 0;
 			}
 
 			var cargs = new List<string> ();
-			if (unsafef)
+			if (config.IsUnsafe)
 				cargs.Add ("-unsafe");
 			cargs.Add ("-target:library");
 			cargs.Add ("-out:" + outfile);
-			foreach (var def in defines)
+			foreach (var def in config.Defines)
 				cargs.Add ("-define:" + def);
 #if NET
 			cargs.Add ("-define:NET");
 #endif
 			cargs.AddRange (g.GeneratedFiles);
-			cargs.AddRange (core_sources);
-			cargs.AddRange (extra_sources);
+			cargs.AddRange (config.CoreSources);
+			cargs.AddRange (config.ExtraSources);
 			cargs.AddRange (refs);
 			cargs.Add ("-r:" + baselibdll);
-			cargs.AddRange (resources);
-			if (nostdlib) {
+			cargs.AddRange (config.Resources);
+			if (config.OmitStandardLibrary) {
 				cargs.Add ("-nostdlib");
 				cargs.Add ("-noconfig");
 			}
 			if (!string.IsNullOrEmpty (Path.GetDirectoryName (baselibdll)))
 				cargs.Add ("-lib:" + Path.GetDirectoryName (baselibdll));
 
-			AddNFloatUsing (cargs, tmpdir);
+			AddNFloatUsing (cargs, config.TemporaryFileDirectory);
 
-			Compile (cargs, 1000, tmpdir);
+			Compile (cargs, 1000, config.TemporaryFileDirectory);
 		} finally {
-			if (delete_temp)
-				Directory.Delete (tmpdir, true);
+			if (config.DeleteTemporaryFiles)
+				Directory.Delete (config.TemporaryFileDirectory, true);
 		}
 		return 0;
 	}
diff --git a/src/bgen/Models/BindingTouchConfig.cs b/src/bgen/Models/BindingTouchConfig.cs
@@ -0,0 +1,26 @@
+using System.Collections.Generic;
+#nullable enable
+
+public class BindingTouchConfig {
+	public bool ShowHelp = false;
+	public bool UseZeroCopy = false;
+	public string? BindingFilesOutputDirectory = null;
+	public string? TemporaryFileDirectory = null;
+	public string? HelperClassNamespace = null;
+	public bool DeleteTemporaryFiles = true;
+	public bool IsDebug = false;
+	public bool IsUnsafe = true;
+	public bool IsExternal = false;
+	public bool IsPublicMode = true;
+	public bool OmitStandardLibrary = false;
+	public bool? InlineSelectors = null;
+	public List<string> Sources = new ();
+	public List<string> Resources = new ();
+	public List<string> LinkWith = new ();
+	public List<string> ApiSources = new ();
+	public List<string> CoreSources = new ();
+	public List<string> ExtraSources = new ();
+	public List<string> Defines = new ();
+	public string? GeneratedFileList = null;
+	public bool ProcessEnums = false;
+}
diff --git a/src/generator.csproj b/src/generator.csproj
@@ -157,6 +157,7 @@
     <Compile Include="bgen\Extensions\StringExtensions.cs" />
     <Compile Include="bgen\Extensions\TypeExtensions.cs" />
     <Compile Include="bgen\Models\AsyncMethodInfo.cs" />
+    <Compile Include="bgen\Models\BindingTouchConfig.cs" />
     <Compile Include="bgen\Models\MarshalInfo.cs" />
     <Compile Include="bgen\Models\MarshalType.cs" />
     <Compile Include="bgen\Models\MarshalTypeList.cs" />
