dsda: custom hook for P_Random()

Revert "Replace 2 `ILuaLibraries` methods with delegates on `EventsLuaLibrary`"
This reverts commit a85ef40.

reverting that one because it made it more painful to add custom hooks

Author: vadosnaprimer

Assets/dll/dsda.wbx.zst

@@ -1,3 +1,5 @@
+using NLua;
+
 namespace BizHawk.Client.Common
 {
 	public interface ILuaLibraries
@@ -12,6 +14,15 @@ 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/ILuaLibraries.cs

@@ -12,6 +12,8 @@ public interface INamedLuaFunction
 
 		MemoryCallbackDelegate MemCallback { get; }
 
+		Action<int> RandomCallback { get; }
+
 		string Name { get; }
 
 		Action OnRemove { get; set; }

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

@@ -0,0 +1,42 @@
+using System.ComponentModel;
+
+using BizHawk.Emulation.Common;
+using BizHawk.Emulation.Cores;
+using BizHawk.Emulation.Cores.Computers.Doom;
+
+using NLua;
+
+// ReSharper disable UnusedMember.Global
+// ReSharper disable UnusedAutoPropertyAccessor.Local
+namespace BizHawk.Client.Common
+{
+	[Description("Functions specific to Doom games (functions may not run when a Doom game is not loaded)")]
+	public sealed class DoomLuaLibrary : LuaLibraryBase
+	{
+		public DoomLuaLibrary(ILuaLibraries luaLibsImpl, ApiContainer apiContainer, Action<string> logOutputCallback)
+			: base(luaLibsImpl, apiContainer, logOutputCallback) { }
+
+		public override string Name => "doom";
+		private const string ERR_MSG_UNSUPPORTED_CORE = $"`doom.*` functions can only be used with {CoreNames.DSDA}";
+
+		[RequiredService]
+		private IEmulator Emulator { get; set; }
+
+		/// <exception cref="InvalidOperationException">loaded core is not DSDA-Doom</exception>
+		[LuaMethodExample("local rngcall = doom.onprandom(\r\n\tfunction()\r\n\t\tconsole.log( \"Calls the given lua function after each P_Random() call by Doom\" );\r\n\tend\r\n\t, \"Frame name\" );")]
+		[LuaMethod("onprandom", "Calls the given lua function after each P_Random() call by Doom")]
+		public string OnPrandom(LuaFunction luaf, string name = null)
+		{
+			if (Emulator is not DSDA)
+			{
+				throw new InvalidOperationException(ERR_MSG_UNSUPPORTED_CORE);
+			}
+
+			var callbacks = (Emulator as DSDA).RandomCallbacks;
+			var nlf = _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, "OnPrandom", LogOutputCallback, CurrentFile, name: name);
+			callbacks.Add(nlf.RandomCallback);
+			nlf.OnRemove += () => callbacks.Remove(nlf.RandomCallback);
+			return nlf.GuidStr;
+		}
+	}
+}

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

@@ -11,21 +11,8 @@ 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; }
 
@@ -75,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)
-			=> CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_POSTFRAME, LogOutputCallback, CurrentFile, name: name)
+			=> _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_POSTFRAME, LogOutputCallback, CurrentFile, 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)
-			=> CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_PREFRAME, LogOutputCallback, CurrentFile, name: name)
+			=> _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_PREFRAME, LogOutputCallback, CurrentFile, 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 = CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_INPUTPOLL, LogOutputCallback, CurrentFile, name: name);
+			var nlf = _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_INPUTPOLL, LogOutputCallback, CurrentFile, 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)
@@ -119,7 +106,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)
-			=> CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_LOADSTATE, LogOutputCallback, CurrentFile, name: name)
+			=> _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_LOADSTATE, LogOutputCallback, CurrentFile, name)
 				.GuidStr;
 
 		[LuaDeprecatedMethod]
@@ -154,7 +141,7 @@ public string OnBusExec(
 						return EMPTY_UUID_STR;
 					}
 
-					var nlf = CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMEXEC, LogOutputCallback, CurrentFile, name: name);
+					var nlf = _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMEXEC, LogOutputCallback, CurrentFile, name);
 					AddMemCallbackOnCore(nlf, MemoryCallbackType.Execute, scope, address);
 					return nlf.GuidStr;
 				}
@@ -198,7 +185,7 @@ public string OnBusExecAny(
 						return EMPTY_UUID_STR;
 					}
 
-					var nlf = CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMEXECANY, LogOutputCallback, CurrentFile, name: name);
+					var nlf = _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMEXECANY, LogOutputCallback, CurrentFile, name);
 					AddMemCallbackOnCore(nlf, MemoryCallbackType.Execute, scope, address: null);
 					return nlf.GuidStr;
 				}
@@ -242,7 +229,7 @@ public string OnBusRead(
 						return EMPTY_UUID_STR;
 					}
 
-					var nlf = CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMREAD, LogOutputCallback, CurrentFile, name: name);
+					var nlf = _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMREAD, LogOutputCallback, CurrentFile, name);
 					AddMemCallbackOnCore(nlf, MemoryCallbackType.Read, scope, address);
 					return nlf.GuidStr;
 				}
@@ -287,7 +274,7 @@ public string OnBusWrite(
 						return EMPTY_UUID_STR;
 					}
 
-					var nlf = CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMWRITE, LogOutputCallback, CurrentFile, name: name);
+					var nlf = _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_MEMWRITE, LogOutputCallback, CurrentFile, name);
 					AddMemCallbackOnCore(nlf, MemoryCallbackType.Write, scope, address);
 					return nlf.GuidStr;
 				}
@@ -305,33 +292,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)
-			=> CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_SAVESTATE, LogOutputCallback, CurrentFile, name: name)
+			=> _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_SAVESTATE, LogOutputCallback, CurrentFile, 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)
-			=> CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_ENGINESTOP, LogOutputCallback, CurrentFile, name: name)
+			=> _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_ENGINESTOP, LogOutputCallback, CurrentFile, 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)
-			=> CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_CONSOLECLOSE, LogOutputCallback, CurrentFile, name: name)
+			=> _luaLibsImpl.CreateAndRegisterNamedFunction(luaf, NamedLuaFunction.EVENT_TYPE_CONSOLECLOSE, LogOutputCallback, CurrentFile, 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 RemoveNamedFunctionMatching(nlf => nlf.Guid == parsed);
+			return _luaLibsImpl.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)
-			=> RemoveNamedFunctionMatching(nlf => nlf.Name == name);
+			=> _luaLibsImpl.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.Common/lua/LuaHelperLibs/EventsLuaLibrary.cs

@@ -93,6 +93,18 @@ public NamedLuaFunction(LuaFunction function, string theEvent, Action<string> lo
 					luaLibraries.IsInInputOrMemoryCallback = false;
 				}
 			};
+			RandomCallback = (pr_class) =>
+			{
+				luaLibraries.IsInInputOrMemoryCallback = true;
+				try
+				{
+					Callback([pr_class]);
+				}
+				finally
+				{
+					luaLibraries.IsInInputOrMemoryCallback = false;
+				}
+			};
 		}
 
 		public void DetachFromScript()
@@ -125,6 +137,8 @@ public string GuidStr
 
 		public MemoryCallbackDelegate MemCallback { get; }
 
+		public Action<int> RandomCallback { get; }
+
 		public void Call(string name = null)
 		{
 			LuaSandbox.Sandbox(LuaFile.Thread, () =>

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

@@ -97,11 +97,6 @@ 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;
@@ -309,7 +304,7 @@ public void Close()
 			_lua = null;
 		}
 
-		private INamedLuaFunction CreateAndRegisterNamedFunction(
+		public INamedLuaFunction CreateAndRegisterNamedFunction(
 			LuaFunction function,
 			string theEvent,
 			Action<string> logCallback,
@@ -321,7 +316,7 @@ private INamedLuaFunction CreateAndRegisterNamedFunction(
 			return nlf;
 		}
 
-		private bool RemoveNamedFunctionMatching(Func<INamedLuaFunction, bool> predicate)
+		public bool RemoveNamedFunctionMatching(Func<INamedLuaFunction, bool> predicate)
 		{
 			if (RegisteredFunctions.FirstOrDefault(predicate) is not NamedLuaFunction nlf) return false;
 			RegisteredFunctions.Remove(nlf);

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

@@ -257,6 +257,8 @@ public bool FrameAdvance(IController controller, bool renderVideo, bool renderAu
 				RenderVideo = Convert.ToInt32(renderVideo)
 			};
 
+			_core.dsda_set_random_callback(RandomCallbacks.Count > 0 ? _randomCallback : null);
+
 			IsLagFrame = _core.dsda_frame_advance(
 				automapButtons,
 				players,

src/BizHawk.Emulation.Cores/Computers/Doom/DSDA.IEmulator.cs

@@ -139,6 +139,17 @@ public DSDA(CoreLoadParameters<DoomSettings, DoomSyncSettings> lp)
 				}
 			}
 
+			_randomCallback = (pr_class) =>
+			{
+				if (RandomCallbacks.Count > 0)
+				{
+					foreach (var cb in RandomCallbacks)
+					{
+						cb(pr_class);
+					}
+				}
+			};
+
 			_elf = new WaterboxHost(new WaterboxOptions
 			{
 				Path = PathUtils.DllDirectoryPath,
@@ -156,7 +167,7 @@ public DSDA(CoreLoadParameters<DoomSettings, DoomSyncSettings> lp)
 			{
 				var callingConventionAdapter = CallingConventionAdapters.MakeWaterbox(
 				[
-					_loadCallback
+					_loadCallback, _randomCallback
 				], _elf);
 
 				using (_elf.EnterExit())
@@ -250,6 +261,8 @@ public DSDA(CoreLoadParameters<DoomSettings, DoomSyncSettings> lp)
 				}
 
 				ControllerDefinition = CreateControllerDefinition(_syncSettings);
+
+				_core.dsda_set_random_callback(RandomCallbacks.Count > 0 ? _randomCallback : null);
 			}
 			catch
 			{
@@ -347,6 +360,9 @@ private static bool PlayerPresent(DoomSyncSettings syncSettings, int port) =>
 		private List<IRomAsset> _wadFiles;
 		private List<IRomAsset> _pwadFiles;
 		private LibDSDA.GameMode _gameMode;
+		private LibDSDA.random_cb _randomCallback;
+
+		public List<Action<int>> RandomCallbacks = [ ];
 
 		public string RomDetails { get; } // IRomInfo
 

src/BizHawk.Emulation.Cores/Computers/Doom/DSDA.cs

@@ -147,5 +147,11 @@ public abstract bool dsda_frame_advance(
 			PackedPlayerInput[] playerInputs,
 			ref PackedPlayerInput walkcamInputs,
 			ref PackedRenderInfo renderInfo);
+
+		[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
+		public delegate void random_cb(int pr_class);
+
+		[BizImport(CallingConvention.Cdecl)]
+		public abstract void dsda_set_random_callback(random_cb cb);
 	}
 }