Replace 2 ILuaLibraries methods with delegates on EventsLuaLibrary

Author: YoshiRulz

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

@@ -1,5 +1,3 @@
-using NLua;
-
 namespace BizHawk.Client.Common
 {
 	public interface ILuaLibraries
@@ -16,15 +14,6 @@ public interface ILuaLibraries
 
 		PathEntryCollection PathEntries { get; }
 
-		INamedLuaFunction CreateAndRegisterNamedFunction(
-			LuaFunction function,
-			string theEvent,
-			Action<string> logCallback,
-			LuaFile luaFile,
-			string name = null);
-
 		NLuaTableHelper GetTableHelper();
-
-		bool RemoveNamedFunctionMatching(Func<INamedLuaFunction, bool> predicate);
 	}
 }

src/BizHawk.Client.Common/lua/LuaHelperLibs/EventsLuaLibrary.cs

@@ -11,8 +11,21 @@ namespace BizHawk.Client.Common
 	[Description("A library for registering lua functions to emulator events.\n All events support multiple registered methods.\nAll registered event methods can be named and return a Guid when registered")]
 	public sealed class EventsLuaLibrary : LuaLibraryBase
 	{
+		public delegate INamedLuaFunction NLFAddCallback(
+			LuaFunction function,
+			string theEvent,
+			Action<string> logCallback,
+			LuaFile luaFile,
+			string name = null);
+
+		public delegate bool NLFRemoveCallback(Func<INamedLuaFunction, bool> predicate);
+
 		private static readonly string EMPTY_UUID_STR = Guid.Empty.ToString("D");
 
+		public NLFAddCallback CreateAndRegisterNamedFunction { get; set; }
+
+		public NLFRemoveCallback RemoveNamedFunctionMatching { get; set; }
+
 		[OptionalService]
 		private IInputPollable InputPollableCore { get; set; }
 
@@ -49,20 +62,20 @@ public bool CanUseCallbackParams(string subset = null)
 		[LuaMethodExample("local steveonf = event.onframeend(\r\n\tfunction()\r\n\t\tconsole.log( \"Calls the given lua function at the end of each frame, after all emulation and drawing has completed. Note: this is the default behavior of lua scripts\" );\r\n\tend\r\n\t, \"Frame name\" );")]
 		[LuaMethod("onframeend", "Calls the given lua function at the end of each frame, after all emulation and drawing has completed. Note: this is the default behavior of lua scripts")]
 		public string OnFrameEnd(LuaFunction luaf, string name = null)
-			=> _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_POSTFRAME, LogOutputCallback, CurrentFile, name)
+			=> CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_POSTFRAME, LogOutputCallback, CurrentFile, name: name)
 				.GuidStr;
 
 		[LuaMethodExample("local steveonf = event.onframestart(\r\n\tfunction()\r\n\t\tconsole.log( \"Calls the given lua function at the beginning of each frame before any emulation and drawing occurs\" );\r\n\tend\r\n\t, \"Frame name\" );")]
 		[LuaMethod("onframestart", "Calls the given lua function at the beginning of each frame before any emulation and drawing occurs")]
 		public string OnFrameStart(LuaFunction luaf, string name = null)
-			=> _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_PREFRAME, LogOutputCallback, CurrentFile, name)
+			=> CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_PREFRAME, LogOutputCallback, CurrentFile, name: name)
 				.GuidStr;
 
 		[LuaMethodExample("local steveoni = event.oninputpoll(\r\n\tfunction()\r\n\t\tconsole.log( \"Calls the given lua function after each time the emulator core polls for input\" );\r\n\tend\r\n\t, \"Frame name\" );")]
 		[LuaMethod("oninputpoll", "Calls the given lua function after each time the emulator core polls for input")]
 		public string OnInputPoll(LuaFunction luaf, string name = null)
 		{
-			var nlf = _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_INPUTPOLL, LogOutputCallback, CurrentFile, name);
+			var nlf = CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_INPUTPOLL, LogOutputCallback, CurrentFile, name: name);
 			//TODO should we bother registering the function if the service isn't supported? none of the other events work this way --yoshi
 
 			if (InputPollableCore != null)
@@ -91,7 +104,7 @@ private void LogNotImplemented()
 		[LuaMethodExample("local steveonl = event.onloadstate(\r\n\tfunction()\r\n\tconsole.log( \"Fires after a state is loaded. Receives a lua function name, and registers it to the event immediately following a successful savestate event\" );\r\nend\", \"Frame name\" );")]
 		[LuaMethod("onloadstate", "Fires after a state is loaded. Your callback can have 1 parameter, which will be the name of the loaded state.")]
 		public string OnLoadState(LuaFunction luaf, string name = null)
-			=> _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_LOADSTATE, LogOutputCallback, CurrentFile, name)
+			=> CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_LOADSTATE, LogOutputCallback, CurrentFile, name: name)
 				.GuidStr;
 
 		[LuaDeprecatedMethod]
@@ -126,7 +139,7 @@ public string OnBusExec(
 						return EMPTY_UUID_STR;
 					}
 
-					var nlf = _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMEXEC, LogOutputCallback, CurrentFile, name);
+					var nlf = CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMEXEC, LogOutputCallback, CurrentFile, name: name);
 					DebuggableCore.MemoryCallbacks.Add(
 						new MemoryCallback(ProcessScope(scope), MemoryCallbackType.Execute, "Lua Hook", nlf.MemCallback, address, null));
 					return nlf.GuidStr;
@@ -171,7 +184,7 @@ public string OnBusExecAny(
 						return EMPTY_UUID_STR;
 					}
 
-					var nlf = _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMEXECANY, LogOutputCallback, CurrentFile, name);
+					var nlf = CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMEXECANY, LogOutputCallback, CurrentFile, name: name);
 					DebuggableCore.MemoryCallbacks.Add(new MemoryCallback(
 						ProcessScope(scope),
 						MemoryCallbackType.Execute,
@@ -222,7 +235,7 @@ public string OnBusRead(
 						return EMPTY_UUID_STR;
 					}
 
-					var nlf = _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMREAD, LogOutputCallback, CurrentFile, name);
+					var nlf = CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMREAD, LogOutputCallback, CurrentFile, name: name);
 					DebuggableCore.MemoryCallbacks.Add(
 						new MemoryCallback(ProcessScope(scope), MemoryCallbackType.Read, "Lua Hook", nlf.MemCallback, address, null));
 					return nlf.GuidStr;
@@ -268,7 +281,7 @@ public string OnBusWrite(
 						return EMPTY_UUID_STR;
 					}
 
-					var nlf = _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMWRITE, LogOutputCallback, CurrentFile, name);
+					var nlf = CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMWRITE, LogOutputCallback, CurrentFile, name: name);
 					DebuggableCore.MemoryCallbacks.Add(
 						new MemoryCallback(ProcessScope(scope), MemoryCallbackType.Write, "Lua Hook", nlf.MemCallback, address, null));
 					return nlf.GuidStr;
@@ -287,33 +300,33 @@ public string OnBusWrite(
 		[LuaMethodExample("local steveons = event.onsavestate(\r\n\tfunction()\r\n\t\tconsole.log( \"Fires after a state is saved\" );\r\n\tend\r\n\t, \"Frame name\" );")]
 		[LuaMethod("onsavestate", "Fires after a state is saved. Your callback can have 1 parameter, which will be the name of the saved state.")]
 		public string OnSaveState(LuaFunction luaf, string name = null)
-			=> _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_SAVESTATE, LogOutputCallback, CurrentFile, name)
+			=> CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_SAVESTATE, LogOutputCallback, CurrentFile, name: name)
 				.GuidStr;
 
 		[LuaMethodExample("local steveone = event.onexit(\r\n\tfunction()\r\n\t\tconsole.log( \"Fires after the calling script has stopped\" );\r\n\tend\r\n\t, \"Frame name\" );")]
 		[LuaMethod("onexit", "Fires after the calling script has stopped")]
 		public string OnExit(LuaFunction luaf, string name = null)
-			=> _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_ENGINESTOP, LogOutputCallback, CurrentFile, name)
+			=> CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_ENGINESTOP, LogOutputCallback, CurrentFile, name: name)
 				.GuidStr;
 
 		[LuaMethodExample("local closeGuid = event.onconsoleclose(\r\n\tfunction()\r\n\t\tconsole.log( \"Fires when the emulator console closes\" );\r\n\tend\r\n\t, \"Frame name\" );")]
 		[LuaMethod("onconsoleclose", "Fires when the emulator console closes")]
 		public string OnConsoleClose(LuaFunction luaf, string name = null)
-			=> _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_CONSOLECLOSE, LogOutputCallback, CurrentFile, name)
+			=> CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_CONSOLECLOSE, LogOutputCallback, CurrentFile, name: name)
 				.GuidStr;
 
 		[LuaMethodExample("if ( event.unregisterbyid( \"4d1810b7 - 0d28 - 4acb - 9d8b - d87721641551\" ) ) then\r\n\tconsole.log( \"Removes the registered function that matches the guid.If a function is found and remove the function will return true.If unable to find a match, the function will return false.\" );\r\nend;")]
 		[LuaMethod("unregisterbyid", "Removes the registered function that matches the guid. If a function is found and remove the function will return true. If unable to find a match, the function will return false.")]
 		public bool UnregisterById(string guid)
 		{
 			Guid parsed = new(guid);
-			return _luaLibsImpl.RemoveNamedFunctionMatching(nlf => nlf.Guid == parsed);
+			return RemoveNamedFunctionMatching(nlf => nlf.Guid == parsed);
 		}
 
 		[LuaMethodExample("if ( event.unregisterbyname( \"Function name\" ) ) then\r\n\tconsole.log( \"Removes the first registered function that matches Name.If a function is found and remove the function will return true.If unable to find a match, the function will return false.\" );\r\nend;")]
 		[LuaMethod("unregisterbyname", "Removes the first registered function that matches Name. If a function is found and remove the function will return true. If unable to find a match, the function will return false.")]
 		public bool UnregisterByName(string name)
-			=> _luaLibsImpl.RemoveNamedFunctionMatching(nlf => nlf.Name == name);
+			=> RemoveNamedFunctionMatching(nlf => nlf.Name == name);
 
 		[LuaMethodExample("local scopes = event.availableScopes();")]
 		[LuaMethod("availableScopes", "Lists the available scopes that can be specified for on_bus_* events")]

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

@@ -98,6 +98,11 @@ void EnumerateLuaFunctions(string name, Type type, LuaLibraryBase instance)
 						consoleLib.Tools = _mainForm.Tools;
 						_logToLuaConsoleCallback = consoleLib.Log;
 					}
+					else if (instance is EventsLuaLibrary eventsLib)
+					{
+						eventsLib.CreateAndRegisterNamedFunction = CreateAndRegisterNamedFunction;
+						eventsLib.RemoveNamedFunctionMatching = RemoveNamedFunctionMatching;
+					}
 					else if (instance is FormsLuaLibrary formsLib)
 					{
 						formsLib.MainForm = _mainForm;
@@ -305,7 +310,7 @@ public void Close()
 			_lua = null;
 		}
 
-		public INamedLuaFunction CreateAndRegisterNamedFunction(
+		private INamedLuaFunction CreateAndRegisterNamedFunction(
 			LuaFunction function,
 			string theEvent,
 			Action<string> logCallback,
@@ -317,7 +322,7 @@ public INamedLuaFunction CreateAndRegisterNamedFunction(
 			return nlf;
 		}
 
-		public bool RemoveNamedFunctionMatching(Func<INamedLuaFunction, bool> predicate)
+		private bool RemoveNamedFunctionMatching(Func<INamedLuaFunction, bool> predicate)
 		{
 			var nlf = (NamedLuaFunction)RegisteredFunctions.FirstOrDefault(predicate);
 			if (nlf == null) return false;