Improve handling of Lua script callbacks

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

@@ -4,27 +4,29 @@
 using System.Linq;
 using System.Reflection;
 
-using BizHawk.Client.Common;
 using BizHawk.Emulation.Common;
 
-namespace BizHawk.Client.EmuHawk
+namespace BizHawk.Client.Common
 {
 	public static class ApiManager
 	{
-		private static readonly IReadOnlyList<(Type ImplType, Type InterfaceType, ConstructorInfo Ctor, Type[] CtorTypes)> _apiTypes;
+		private static readonly List<(Type ImplType, Type InterfaceType, ConstructorInfo Ctor, Type[] CtorTypes)> _apiTypes = new();
 
 		static ApiManager()
 		{
-			var list = new List<(Type, Type, ConstructorInfo, Type[])>();
-			foreach (var implType in ReflectionCache_Biz_Cli_Com.Types.Concat(ReflectionCache.Types)
+			foreach (var implType in ReflectionCache_Biz_Cli_Com.Types
 				.Where(t => /*t.IsClass &&*/t.IsSealed)) // small optimisation; api impl. types are all sealed classes
 			{
-				var interfaceType = implType.GetInterfaces().FirstOrDefault(t => typeof(IExternalApi).IsAssignableFrom(t) && t != typeof(IExternalApi));
-				if (interfaceType == null) continue; // if we couldn't determine what it's implementing, then it's not an api impl. type
-				var ctor = implType.GetConstructors().Single();
-				list.Add((implType, interfaceType, ctor, ctor.GetParameters().Select(pi => pi.ParameterType).ToArray()));
+				AddApiType(implType);
 			}
-			_apiTypes = list.ToArray();
+		}
+
+		public static void AddApiType(Type type)
+		{
+			var interfaceType = type.GetInterfaces().FirstOrDefault(t => typeof(IExternalApi).IsAssignableFrom(t) && t != typeof(IExternalApi));
+			if (interfaceType == null) return; // if we couldn't determine what it's implementing, then it's not an api impl. type
+			var ctor = type.GetConstructors().Single();
+			_apiTypes.Add((type, interfaceType, ctor, ctor.GetParameters().Select(pi => pi.ParameterType).ToArray()));
 		}
 
 		private static ApiContainer? _container;
@@ -38,7 +40,7 @@ private static ApiContainer Register(
 			DisplayManagerBase displayManager,
 			InputManager inputManager,
 			IMovieSession movieSession,
-			ToolManager toolManager,
+			IToolLoader toolManager,
 			Config config,
 			IEmulator emulator,
 			IGameInfo game,
@@ -52,7 +54,7 @@ private static ApiContainer Register(
 				[typeof(DisplayManagerBase)] = displayManager,
 				[typeof(InputManager)] = inputManager,
 				[typeof(IMovieSession)] = movieSession,
-				[typeof(ToolManager)] = toolManager,
+				[typeof(IToolLoader)] = toolManager,
 				[typeof(Config)] = config,
 				[typeof(IEmulator)] = emulator,
 				[typeof(IGameInfo)] = game,
@@ -74,7 +76,7 @@ public static IExternalApiProvider Restart(
 			DisplayManagerBase displayManager,
 			InputManager inputManager,
 			IMovieSession movieSession,
-			ToolManager toolManager,
+			IToolLoader toolManager,
 			Config config,
 			IEmulator emulator,
 			IGameInfo game,
@@ -92,7 +94,7 @@ public static ApiContainer RestartLua(
 			DisplayManagerBase displayManager,
 			InputManager inputManager,
 			IMovieSession movieSession,
-			ToolManager toolManager,
+			IToolLoader toolManager,
 			Config config,
 			IEmulator emulator,
 			IGameInfo game,

src/BizHawk.Client.Common/IMainFormForTools.cs

@@ -0,0 +1,105 @@
+using BizHawk.Bizware.Graphics;
+using BizHawk.Emulation.Common;
+
+namespace BizHawk.Client.Common
+{
+	public interface IMainFormForTools : IDialogController
+	{
+		/// <remarks>referenced by 3 or more tools</remarks>
+		CheatCollection CheatList { get; }
+
+		/// <remarks>referenced by 3 or more tools</remarks>
+		string CurrentlyOpenRom { get; }
+
+		/// <remarks>referenced from HexEditor and RetroAchievements</remarks>
+		LoadRomArgs CurrentlyOpenRomArgs { get; }
+
+		/// <remarks>only referenced from TAStudio</remarks>
+		bool EmulatorPaused { get; }
+
+		/// <remarks>only referenced from PlaybackBox</remarks>
+		bool HoldFrameAdvance { get; set; }
+
+		/// <remarks>only referenced from BasicBot</remarks>
+		bool InvisibleEmulation { get; set; }
+
+		/// <remarks>only referenced from LuaConsole</remarks>
+		bool IsTurboing { get; }
+
+		/// <remarks>only referenced from TAStudio</remarks>
+		bool IsFastForwarding { get; }
+
+		/// <remarks>referenced from PlayMovie and TAStudio</remarks>
+		int? PauseOnFrame { get; set; }
+
+		/// <remarks>only referenced from PlaybackBox</remarks>
+		bool PressRewind { get; set; }
+
+		/// <remarks>referenced from BookmarksBranchesBox and VideoWriterChooserForm</remarks>
+		BitmapBuffer CaptureOSD();
+
+		/// <remarks>only referenced from TAStudio</remarks>
+		void DisableRewind();
+
+		/// <remarks>only referenced from TAStudio</remarks>
+		void EnableRewind(bool enabled);
+
+		/// <remarks>only referenced from TAStudio</remarks>
+		bool EnsureCoreIsAccurate();
+
+		/// <remarks>only referenced from TAStudio</remarks>
+		void FrameAdvance(bool discardApiHawkSurfaces = true);
+
+		/// <remarks>only referenced from LuaConsole</remarks>
+		/// <param name="forceWindowResize">Override <see cref="Common.Config.ResizeWithFramebuffer"/></param>
+		void FrameBufferResized(bool forceWindowResize = false);
+
+		/// <remarks>only referenced from BasicBot</remarks>
+		bool LoadQuickSave(int slot, bool suppressOSD = false);
+
+		/// <remarks>referenced from MultiDiskBundler and RetroAchievements</remarks>
+		bool LoadRom(string path, LoadRomArgs args);
+
+		/// <remarks>only referenced from BookmarksBranchesBox</remarks>
+		BitmapBuffer MakeScreenshotImage();
+
+		/// <remarks>referenced from ToolFormBase</remarks>
+		void MaybePauseFromMenuOpened();
+
+		/// <remarks>referenced from ToolFormBase</remarks>
+		void MaybeUnpauseFromMenuClosed();
+
+		/// <remarks>referenced by 3 or more tools</remarks>
+		void PauseEmulator();
+
+		/// <remarks>only referenced from TAStudio</remarks>
+		bool BlockFrameAdvance { get; set; }
+
+		/// <remarks>referenced from PlaybackBox and TAStudio</remarks>
+		void SetMainformMovieInfo();
+
+		/// <remarks>referenced by 3 or more tools</remarks>
+		bool StartNewMovie(IMovie movie, bool newMovie);
+
+		/// <remarks>only referenced from BasicBot</remarks>
+		void Throttle();
+
+		/// <remarks>only referenced from TAStudio</remarks>
+		void TogglePause();
+
+		/// <remarks>referenced by 3 or more tools</remarks>
+		void UnpauseEmulator();
+
+		/// <remarks>only referenced from BasicBot</remarks>
+		void Unthrottle();
+
+		/// <remarks>only referenced from LogWindow</remarks>
+		void UpdateDumpInfo(RomStatus? newStatus = null);
+
+		/// <remarks>only referenced from BookmarksBranchesBox</remarks>
+		void UpdateStatusSlots();
+
+		/// <remarks>only referenced from TAStudio</remarks>
+		void UpdateWindowTitle();
+	}
+}

src/BizHawk.Client.Common/lua/ApiGroup.cs

@@ -0,0 +1,25 @@
+namespace BizHawk.Client.Common
+{
+	[Flags]
+	public enum ApiGroup
+	{
+		NONE = 0,
+
+		/// <summary>
+		/// yield or frameadvance
+		/// </summary>
+		YIELDING = 1,
+
+		/// <summary>
+		/// any method that may result in (re)booting a core, such as loading a ROM
+		/// </summary>
+		BOOTING = 2,
+
+		/// <summary>
+		/// any method that may result in saving or loading a savestate
+		/// </summary>
+		STATES = 4,
+
+		PROHIBITED_MID_FRAME = YIELDING | BOOTING | STATES,
+	}
+}

src/BizHawk.Client.Common/lua/CommonLibs/ClientLuaLibrary.cs

@@ -17,6 +17,8 @@ namespace BizHawk.Client.Common
 	[Description("A library for manipulating the EmuHawk client UI")]
 	public sealed class ClientLuaLibrary : LuaLibraryBase
 	{
+		public Lazy<string> AllAPINames { get; set; }
+
 		[OptionalService]
 		private IVideoProvider VideoProvider { get; set; }
 
@@ -70,7 +72,7 @@ public void ClearAutohold()
 		[LuaMethod("closerom", "Closes the loaded Rom")]
 		public void CloseRom()
 		{
-			if (_luaLibsImpl.IsInInputOrMemoryCallback)
+			if (_luaLibsImpl.ProhibitedApis.HasFlag(ApiGroup.BOOTING))
 			{
 				throw new InvalidOperationException("client.closerom() is not allowed during input/memory callbacks");
 			}
@@ -111,6 +113,11 @@ public void SeekFrame(int frame)
 		public int GetApproxFramerate()
 			=> APIs.EmuClient.GetApproxFramerate();
 
+		[LuaMethodExample("local stconget = client.getluafunctionslist( );")]
+		[LuaMethod("getluafunctionslist", "returns a list of implemented functions")]
+		public string GetLuaFunctionsList()
+			=> AllAPINames.Value;
+
 		[LuaMethodExample("local incliget = client.gettargetscanlineintensity( );")]
 		[LuaMethod("gettargetscanlineintensity", "Gets the current scanline intensity setting, used for the scanline display filter")]
 		public int GetTargetScanlineIntensity()
@@ -193,7 +200,7 @@ public void OpenRamSearch()
 		[LuaMethod("openrom", "Loads a ROM from the given path. Returns true if the ROM was successfully loaded, otherwise false.")]
 		public bool OpenRom(string path)
 		{
-			if (_luaLibsImpl.IsInInputOrMemoryCallback)
+			if (_luaLibsImpl.ProhibitedApis.HasFlag(ApiGroup.BOOTING))
 			{
 				throw new InvalidOperationException("client.openrom() is not allowed during input/memory callbacks");
 			}
@@ -233,7 +240,7 @@ public void PauseAv()
 		[LuaMethod("reboot_core", "Reboots the currently loaded core")]
 		public void RebootCore()
 		{
-			if (_luaLibsImpl.IsInInputOrMemoryCallback)
+			if (_luaLibsImpl.ProhibitedApis.HasFlag(ApiGroup.BOOTING))
 			{
 				throw new InvalidOperationException("client.reboot_core() is not allowed during input/memory callbacks");
 			}

src/BizHawk.Client.Common/lua/CommonLibs/MemorySavestateLuaLibrary.cs

@@ -13,7 +13,7 @@ public MemorySavestateLuaLibrary(ILuaLibraries luaLibsImpl, ApiContainer apiCont
 		[LuaMethod("savecorestate", "creates a core savestate and stores it in memory.  Note: a core savestate is only the raw data from the core, and not extras such as movie input logs, or framebuffers. Returns a unique identifer for the savestate")]
 		public string SaveCoreStateToMemory()
 		{
-			if (_luaLibsImpl.IsInInputOrMemoryCallback)
+			if (_luaLibsImpl.ProhibitedApis.HasFlag(ApiGroup.STATES))
 			{
 				throw new InvalidOperationException("memorysavestate.savecorestate() is not allowed during input/memory callbacks");
 			}
@@ -25,7 +25,7 @@ public string SaveCoreStateToMemory()
 		[LuaMethod("loadcorestate", "loads an in memory state with the given identifier")]
 		public void LoadCoreStateFromMemory(string identifier)
 		{
-			if (_luaLibsImpl.IsInInputOrMemoryCallback)
+			if (_luaLibsImpl.ProhibitedApis.HasFlag(ApiGroup.STATES))
 			{
 				throw new InvalidOperationException("memorysavestate.loadcorestate() is not allowed during input/memory callbacks");
 			}

src/BizHawk.Client.Common/lua/CommonLibs/MovieLuaLibrary.cs

@@ -73,7 +73,7 @@ public string Mode()
 		[LuaMethod("play_from_start", "Resets the core to frame 0 with the currently loaded movie in playback mode. If a path to a movie is specified, attempts to load it, then continues with playback if it was successful. Returns true iff successful.")]
 		public bool PlayFromStart(string path = "")
 		{
-			if (_luaLibsImpl.IsInInputOrMemoryCallback)
+			if (_luaLibsImpl.ProhibitedApis.HasFlag(ApiGroup.BOOTING))
 			{
 				throw new InvalidOperationException("movie.play_from_start() is not allowed during input/memory callbacks");
 			}

src/BizHawk.Client.Common/lua/CommonLibs/SaveStateLuaLibrary.cs

@@ -11,7 +11,7 @@ public SaveStateLuaLibrary(ILuaLibraries luaLibsImpl, ApiContainer apiContainer,
 		[LuaMethod("load", "Loads a savestate with the given path. Returns true iff succeeded. If EmuHawk is deferring quicksaves, to TAStudio for example, that form will do what it likes (and the path is ignored).")]
 		public bool Load(string path, bool suppressOSD = false)
 		{
-			if (_luaLibsImpl.IsInInputOrMemoryCallback)
+			if (_luaLibsImpl.ProhibitedApis.HasFlag(ApiGroup.STATES))
 			{
 				throw new InvalidOperationException("savestate.load() is not allowed during input/memory callbacks");
 			}
@@ -35,7 +35,7 @@ public bool Load(string path, bool suppressOSD = false)
 		[LuaMethod("loadslot", "Loads the savestate at the given slot number (must be an integer between 1 and 10). Returns true iff succeeded. If EmuHawk is deferring quicksaves, to TAStudio for example, that form will do what it likes with the slot number.")]
 		public bool LoadSlot(int slotNum, bool suppressOSD = false)
 		{
-			if (_luaLibsImpl.IsInInputOrMemoryCallback)
+			if (_luaLibsImpl.ProhibitedApis.HasFlag(ApiGroup.STATES))
 			{
 				throw new InvalidOperationException("savestate.loadslot() is not allowed during input/memory callbacks");
 			}
@@ -59,7 +59,7 @@ public bool LoadSlot(int slotNum, bool suppressOSD = false)
 		[LuaMethod("save", "Saves a state at the given path. If EmuHawk is deferring quicksaves, to TAStudio for example, that form will do what it likes (and the path is ignored).")]
 		public bool Save(string path, bool suppressOSD = false)
 		{
-			if (_luaLibsImpl.IsInInputOrMemoryCallback)
+			if (_luaLibsImpl.ProhibitedApis.HasFlag(ApiGroup.STATES))
 			{
 				throw new InvalidOperationException("savestate.save() is not allowed during input/memory callbacks");
 			}
@@ -78,7 +78,7 @@ public bool Save(string path, bool suppressOSD = false)
 		[LuaMethod("saveslot", "Saves a state at the given save slot (must be an integer between 1 and 10). If EmuHawk is deferring quicksaves, to TAStudio for example, that form will do what it likes with the slot number.")]
 		public bool SaveSlot(int slotNum, bool suppressOSD = false)
 		{
-			if (_luaLibsImpl.IsInInputOrMemoryCallback)
+			if (_luaLibsImpl.ProhibitedApis.HasFlag(ApiGroup.STATES))
 			{
 				throw new InvalidOperationException("savestate.saveslot() is not allowed during input/memory callbacks");
 			}

src/BizHawk.Client.Common/lua/ILuaLibraries.cs

@@ -2,16 +2,19 @@ namespace BizHawk.Client.Common
 {
 	public interface ILuaLibraries
 	{
+		LuaFile CurrentFile { get; }
+
 		/// <remarks>pretty hacky... we don't want a lua script to be able to restart itself by rebooting the core</remarks>
 		bool IsRebootingCore { get; set; }
 
 		bool IsUpdateSupressed { get; set; }
 
-		/// <remarks>not really sure if this is the right place to put it, multiple different places need this...</remarks>
-		bool IsInInputOrMemoryCallback { get; set; }
-
 		PathEntryCollection PathEntries { get; }
 
+		ApiGroup ProhibitedApis { get; }
+
 		NLuaTableHelper GetTableHelper();
+
+		void Sandbox(LuaFile luaFile, Action callback, Action<string> exceptionCallback = null, ApiGroup prohibitedApis = ApiGroup.NONE);
 	}
 }

src/BizHawk.Client.Common/lua/INamedLuaFunction.cs

@@ -1,28 +1,27 @@
-using BizHawk.Emulation.Common;
-
 namespace BizHawk.Client.Common
 {
 	public interface INamedLuaFunction
 	{
-		Action InputCallback { get; }
-
 		Guid Guid { get; }
 
 		string GuidStr { get; }
 
-		MemoryCallbackDelegate MemCallback { get; }
-
-		/// <summary>for <c>doom.on_prandom</c>; single param: info on what changed the RNG index</summary>
-		Action<string> RandomCallback { get; }
-
-		/// <summary>for <c>doom.on_intercept</c>; single param: blockmap block the intercept happened in</summary>
-		Action<int> InterceptCallback { get; }
-
-		/// <summary>for <c>doom.on_use and doom.on_cross</c>; two params: pointers to activated line and to mobj that triggered it</summary>
-		Action<long, long> LineCallback { get; }
-
 		string Name { get; }
 
+		/// <summary>
+		/// Will be called when the Lua function is unregistered / removed from the list of active callbacks.
+		/// The intended use case is to support callback systems that don't directly support Lua.
+		/// Here's what that looks like:
+		/// 1) A NamedLuaFunction is created and added to it's owner's list of registered functions, as normal with all Lua functions.
+		/// 2) A C# function is created for this specific NamedLuaFunction, which calls the Lua function via <see cref="Call(object[])"/> and possibly does other related Lua setup and cleanup tasks.
+		/// 3) That C# function is added to the non-Lua callback system.
+		/// 4) <see cref="OnRemove"/> is assigned an <see cref="Action"/> that removes the C# function from the non-Lua callback.
+		/// </summary>
 		Action OnRemove { get; set; }
+
+		/// <summary>
+		/// Calls the Lua function with the given arguments.
+		/// </summary>
+		object[] Call(params object[] args);
 	}
 }

src/BizHawk.Client.Common/lua/IPrintingLibrary.cs

@@ -0,0 +1,7 @@
+namespace BizHawk.Client.Common
+{
+	public interface IPrintingLibrary
+	{
+		void Log(params object[] outputs);
+	}
+}