Remove IMainFormForApiInit. Fixes and largely reverts f902c10.

Author: SuuperW

src/BizHawk.Client.Common/IMainFormForApi.cs

@@ -22,7 +22,7 @@ public interface IMainFormForApi
 		/// <remarks>only referenced from <see cref="EmuClientApi"/></remarks>
 		bool IsSeeking { get; }
 
-		/// <remarks>referenced from <see cref="EmuClientApi"/> and <c>LuaConsole</c></remarks>
+		/// <remarks>only referenced from <see cref="EmuClientApi"/></remarks>
 		bool IsTurboing { get; }
 
 		/// <remarks>only referenced from <see cref="EmuClientApi"/></remarks>
@@ -59,7 +59,7 @@ public interface IMainFormForApi
 		void FrameAdvance(bool discardApiHawkSurfaces = true);
 
 		/// <param name="forceWindowResize">Override <see cref="Common.Config.ResizeWithFramebuffer"/></param>
-		/// <remarks>referenced from <see cref="EmuClientApi"/> and <c>LuaConsole</c></remarks>
+		/// <remarks>only referenced from <see cref="EmuClientApi"/></remarks>
 		void FrameBufferResized(bool forceWindowResize = false);
 
 		/// <remarks>only referenced from <see cref="EmuClientApi"/></remarks>

src/BizHawk.Client.EmuHawk/Api/ApiManager.cs

@@ -34,20 +34,21 @@ static ApiManager()
 		private static ApiContainer Register(
 			IEmulatorServiceProvider serviceProvider,
 			Action<string> logCallback,
-			IMainFormForApiInit mainForm,
+			IMainFormForApi mainForm,
 			DisplayManagerBase displayManager,
 			InputManager inputManager,
 			IMovieSession movieSession,
 			ToolManager toolManager,
 			Config config,
 			IEmulator emulator,
-			IGameInfo game)
+			IGameInfo game,
+			IDialogController dialogController)
 		{
 			var avail = new Dictionary<Type, object>
 			{
 				[typeof(Action<string>)] = logCallback,
 				[typeof(IMainFormForApi)] = mainForm,
-				[typeof(IDialogController)] = mainForm.DialogController,
+				[typeof(IDialogController)] = dialogController,
 				[typeof(DisplayManagerBase)] = displayManager,
 				[typeof(InputManager)] = inputManager,
 				[typeof(IMovieSession)] = movieSession,
@@ -69,34 +70,36 @@ private static ApiContainer Register(
 
 		public static IExternalApiProvider Restart(
 			IEmulatorServiceProvider serviceProvider,
-			IMainFormForApiInit mainForm,
+			IMainFormForApi mainForm,
 			DisplayManagerBase displayManager,
 			InputManager inputManager,
 			IMovieSession movieSession,
 			ToolManager toolManager,
 			Config config,
 			IEmulator emulator,
-			IGameInfo game)
+			IGameInfo game,
+			IDialogController dialogController)
 		{
 			_container?.Dispose();
-			_container = Register(serviceProvider, Console.WriteLine, mainForm, displayManager, inputManager, movieSession, toolManager, config, emulator, game);
+			_container = Register(serviceProvider, Console.WriteLine, mainForm, displayManager, inputManager, movieSession, toolManager, config, emulator, game, dialogController);
 			return new BasicApiProvider(_container);
 		}
 
 		public static ApiContainer RestartLua(
 			IEmulatorServiceProvider serviceProvider,
 			Action<string> logCallback,
-			IMainFormForApiInit mainForm,
+			IMainFormForApi mainForm,
 			DisplayManagerBase displayManager,
 			InputManager inputManager,
 			IMovieSession movieSession,
 			ToolManager toolManager,
 			Config config,
 			IEmulator emulator,
-			IGameInfo game)
+			IGameInfo game,
+			IDialogController dialogController)
 		{
 			_luaContainer?.Dispose();
-			_luaContainer = Register(serviceProvider, logCallback, mainForm, displayManager, inputManager, movieSession, toolManager, config, emulator, game);
+			_luaContainer = Register(serviceProvider, logCallback, mainForm, displayManager, inputManager, movieSession, toolManager, config, emulator, game, dialogController);
 			return _luaContainer;
 		}
 	}

src/BizHawk.Client.EmuHawk/Api/IMainFormForApiInit.cs

@@ -12,7 +12,7 @@ public interface IMainFormForTools : IDialogController
 		/// <remarks>referenced by 3 or more tools</remarks>
 		string CurrentlyOpenRom { get; }
 
-		/// <remarks>referenced from <see cref="HexEditor"/> and RetroAchievements</remarks>
+		/// <remarks>only referenced from <see cref="HexEditor"/></remarks>
 		LoadRomArgs CurrentlyOpenRomArgs { get; }
 
 		/// <remarks>only referenced from <see cref="TAStudio"/></remarks>
@@ -27,6 +27,9 @@ public interface IMainFormForTools : IDialogController
 		/// <remarks>only referenced from <see cref="BasicBot"/></remarks>
 		bool InvisibleEmulation { get; set; }
 
+		/// <remarks>only referenced from <see cref="LuaConsole"/></remarks>
+		bool IsTurboing { get; }
+
 		/// <remarks>only referenced from <see cref="TAStudio"/></remarks>
 		bool IsFastForwarding { get; }
 
@@ -51,10 +54,14 @@ public interface IMainFormForTools : IDialogController
 		/// <remarks>only referenced from <see cref="TAStudio"/></remarks>
 		void FrameAdvance(bool discardApiHawkSurfaces = true);
 
+		/// <remarks>only referenced from <see cref="LuaConsole"/></remarks>
+		/// <param name="forceWindowResize">Override <see cref="Common.Config.ResizeWithFramebuffer"/></param>
+		void FrameBufferResized(bool forceWindowResize = false);
+
 		/// <remarks>only referenced from <see cref="BasicBot"/></remarks>
 		bool LoadQuickSave(int slot, bool suppressOSD = false);
 
-		/// <remarks>referenced from <see cref="MultiDiskBundler"/> and RetroAchievements</remarks>
+		/// <remarks>only referenced from <see cref="MultiDiskBundler"/></remarks>
 		bool LoadRom(string path, LoadRomArgs args);
 
 		/// <remarks>only referenced from <see cref="BookmarksBranchesBox"/></remarks>
@@ -96,7 +103,7 @@ public interface IMainFormForTools : IDialogController
 		/// <remarks>only referenced from <see cref="BookmarksBranchesBox"/></remarks>
 		void UpdateStatusSlots();
 
-		/// <remarks>referenced from <see cref="TAStudio"/> and RetroAchievements</remarks>
+		/// <remarks>only referenced from <see cref="TAStudio"/></remarks>
 		void UpdateWindowTitle();
 	}
 }

src/BizHawk.Client.EmuHawk/IMainFormForTools.cs

@@ -45,7 +45,7 @@
 namespace BizHawk.Client.EmuHawk
 {
 	public partial class MainForm : FormBase, IDialogParent,
-		IMainFormForApiInit, IMainFormForRetroAchievements, IMainFormForTools
+		IMainFormForApi, IMainFormForRetroAchievements, IMainFormForTools
 	{
 		private const string FMT_STR_DUMP_STATUS_MENUITEM_LABEL = "Dump Status Report{0}...";
 
@@ -1227,7 +1227,7 @@ private set
 
 		internal readonly ExternalToolManager ExtToolManager;
 
-		public ToolManager Tools { get; }
+		private readonly ToolManager Tools;
 
 		private IControlMainform ToolControllingSavestates => Tools.FirstOrNull<IControlMainform>(tool => tool.WantsToControlSavestates);
 		private IControlMainform ToolControllingRewind => Tools.FirstOrNull<IControlMainform>(tool => tool.WantsToControlRewind);

src/BizHawk.Client.EmuHawk/MainForm.cs

@@ -27,7 +27,9 @@ public sealed class FormsLuaLibrary : LuaLibraryBase
 		public FormsLuaLibrary(ILuaLibraries luaLibsImpl, ApiContainer apiContainer, Action<string> logOutputCallback)
 			: base(luaLibsImpl, apiContainer, logOutputCallback) {}
 
-		public IDialogParent MainForm { get; set; }
+		public IDialogParent DialogParent { get; set; }
+
+		public Form OwnerForm { get; set; }
 
 		public override string Name => "forms";
 
@@ -295,7 +297,7 @@ public long NewForm(
 			form.MaximizeBox = false;
 			form.FormBorderStyle = FormBorderStyle.FixedDialog;
 			form.Icon = SystemIcons.Application;
-			form.Owner = (Form) MainForm;
+			form.Owner = OwnerForm;
 			form.Show();
 
 			form.FormClosed += (o, e) =>
@@ -325,7 +327,7 @@ public string OpenFile(
 			string filter = null)
 		{
 			if (initialDirectory is null && fileName is not null) initialDirectory = Path.GetDirectoryName(fileName);
-			var result = MainForm.ShowFileOpenDialog(
+			var result = DialogParent.ShowFileOpenDialog(
 				filterStr: filter ?? FilesystemFilter.AllFilesEntry,
 				initDir: initialDirectory ?? PathEntries.LuaAbsolutePath(),
 				initFileName: fileName);

src/BizHawk.Client.EmuHawk/tools/Lua/Libraries/FormsLuaLibrary.cs

@@ -50,7 +50,7 @@ public static Icon ToolIcon
 
 		public ToolDialogSettings.ColumnList Columns { get; set; }
 
-		internal new IMainFormForApiInit MainForm { get; set; }
+		internal IMainFormForApi MainFormForApi { get; set; }
 
 		public class LuaConsoleSettings
 		{
@@ -190,13 +190,26 @@ public override void Restart()
 		{
 			List<LuaFile> runningScripts = new();
 
+			ApiContainer apiContainer = ApiManager.RestartLua(
+				Emulator.ServiceProvider,
+				WriteToOutputWindow,
+				MainFormForApi,
+				DisplayManager,
+				InputManager,
+				MovieSession,
+				Tools,
+				Config,
+				Emulator,
+				Game,
+				DialogController);
+
 			// Things we need to do with the existing LuaImp before we can make a new one
 			if (LuaImp is not null)
 			{
 				if (LuaImp.IsRebootingCore)
 				{
 					// Even if the lua console is self-rebooting from client.reboot_core() we still want to re-inject dependencies
-					LuaImp.Restart(Emulator.ServiceProvider, Config, Emulator, Game);
+					LuaImp.Restart(Emulator.ServiceProvider, Config, apiContainer);
 					return;
 				}
 
@@ -216,12 +229,10 @@ public override void Restart()
 				newScripts,
 				registeredFuncList,
 				Emulator.ServiceProvider,
-				MainForm,
-				DisplayManager,
-				InputManager,
+				MainFormForApi,
 				Config,
-				Emulator,
-				Game);
+				Tools,
+				apiContainer);
 
 			InputBox.AutoCompleteCustomSource.Clear();
 			InputBox.AutoCompleteCustomSource.AddRange(LuaImp.Docs.Where(static f => f.SuggestInREPL)

src/BizHawk.Client.EmuHawk/tools/Lua/LuaConsole.cs

@@ -23,12 +23,10 @@ public LuaLibraries(
 			LuaFileList scriptList,
 			LuaFunctionList registeredFuncList,
 			IEmulatorServiceProvider serviceProvider,
-			IMainFormForApiInit mainForm,
-			DisplayManagerBase displayManager,
-			InputManager inputManager,
+			IMainFormForApi mainForm,
 			Config config,
-			IEmulator emulator,
-			IGameInfo game)
+			ToolManager toolManager,
+			ApiContainer apiContainer)
 		{
 			if (!IsAvailable)
 			{
@@ -57,15 +55,13 @@ void EnumerateLuaFunctions(string name, Type type, LuaLibraryBase instance)
 			}
 
 			_th = new NLuaTableHelper(_lua, LogToLuaConsole);
-			_displayManager = displayManager;
-			_inputManager = inputManager;
 			_mainForm = mainForm;
 			LuaWait = new AutoResetEvent(false);
 			PathEntries = config.PathEntries;
 			RegisteredFunctions = registeredFuncList;
 			ScriptList = scriptList;
 			Docs.Clear();
-			_apiContainer = ApiManager.RestartLua(serviceProvider, LogToLuaConsole, _mainForm, _displayManager, _inputManager, _mainForm.MovieSession, _mainForm.Tools, config, emulator, game);
+			_apiContainer = apiContainer;
 
 			// Register lua libraries
 			foreach (var lib in ReflectionCache_Biz_Cli_Com.Types.Concat(ReflectionCache.Types)
@@ -94,7 +90,7 @@ void EnumerateLuaFunctions(string name, Type type, LuaLibraryBase instance)
 					else if (instance is ConsoleLuaLibrary consoleLib)
 					{
 						consoleLib.AllAPINames = new(() => string.Join("\n", Docs.Select(static lf => lf.Name)) + "\n"); // Docs may not be fully populated now, depending on order of ReflectionCache.Types, but definitely will be when this is read
-						consoleLib.Tools = _mainForm.Tools;
+						consoleLib.Tools = toolManager;
 						_logToLuaConsoleCallback = consoleLib.Log;
 					}
 					else if (instance is DoomLuaLibrary doomLib)
@@ -108,7 +104,15 @@ void EnumerateLuaFunctions(string name, Type type, LuaLibraryBase instance)
 					}
 					else if (instance is FormsLuaLibrary formsLib)
 					{
-						formsLib.MainForm = _mainForm;
+						// We want to not give tools/apis explicit references to Windows Forms.
+						// But this Lua API actually needs one, because it creates Windows Forms.
+						// If we ever have another frontend framework, this library should not be used. So we check its type.
+						if (mainForm is MainForm mainAsForm)
+						{
+							formsLib.DialogParent = mainAsForm;
+							formsLib.OwnerForm = mainAsForm;
+						}
+						else continue;
 					}
 					else if (instance is GuiLuaLibrary guiLib)
 					{
@@ -122,7 +126,7 @@ void EnumerateLuaFunctions(string name, Type type, LuaLibraryBase instance)
 					}
 					else if (instance is TAStudioLuaLibrary tastudioLib)
 					{
-						tastudioLib.Tools = _mainForm.Tools;
+						tastudioLib.Tools = toolManager;
 					}
 
 					EnumerateLuaFunctions(instance.Name, lib, instance);
@@ -159,13 +163,9 @@ void EnumerateLuaFunctions(string name, Type type, LuaLibraryBase instance)
 
 		private ApiContainer _apiContainer;
 
-		private readonly DisplayManagerBase _displayManager;
-
 		private GuiApi GuiAPI => (GuiApi)_apiContainer.Gui;
 
-		private readonly InputManager _inputManager;
-
-		private readonly IMainFormForApiInit _mainForm;
+		private readonly IMainFormForApi _mainForm;
 
 		private Lua _lua = new();
 		private LuaThread _currThread;
@@ -201,10 +201,9 @@ void EnumerateLuaFunctions(string name, Type type, LuaLibraryBase instance)
 		public void Restart(
 			IEmulatorServiceProvider newServiceProvider,
 			Config config,
-			IEmulator emulator,
-			IGameInfo game)
+			ApiContainer apiContainer)
 		{
-			_apiContainer = ApiManager.RestartLua(newServiceProvider, LogToLuaConsole, _mainForm, _displayManager, _inputManager, _mainForm.MovieSession, _mainForm.Tools, config, emulator, game);
+			_apiContainer = apiContainer;
 			PathEntries = config.PathEntries;
 			foreach (var lib in Libraries.Values)
 			{

src/BizHawk.Client.EmuHawk/tools/Lua/LuaLibraries.cs

@@ -68,7 +68,8 @@ private IExternalApiProvider GetOrInitApiProvider()
 				this,
 				_config,
 				_emulator,
-				_game);
+				_game,
+				_owner.DialogController);
 
 		/// <summary>
 		/// Loads the tool dialog T (T must implements <see cref="IToolForm"/>) , if it does not exist it will be created, if it is already open, it will be focused
@@ -96,7 +97,9 @@ private void SetBaseProperties(IToolForm form)
 			f.Config = _config;
 			if (form is not ToolFormBase tool) return;
 			tool.SetToolFormBaseProps(_displayManager, _inputManager, _owner, _movieSession, this, _game);
-			if (form is LuaConsole luaConsole) luaConsole.MainForm = _owner; // could go via ServiceProvider but nah
+
+			// Lua is a special case, being the only tool that currently uses this.
+			if (form is LuaConsole luaConsole) luaConsole.MainFormForApi = _owner;
 		}
 
 		/// <summary>