Lua - tastudio library - supress lua console updates when invoking ta…

…studio methods that cause tool udpates, fixes #2172
TASEmulators · Sep 27, 2020 · e4d4c3a · e4d4c3a
1 parent b5cf9cb
commit e4d4c3a
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 28 deletions.
diff --git a/src/BizHawk.Client.EmuHawk/tools/Lua/Libraries/ClientLuaLibrary.cs b/src/BizHawk.Client.EmuHawk/tools/Lua/Libraries/ClientLuaLibrary.cs
@@ -104,13 +104,13 @@ public void SeekFrame(int frame)
 			bool wasPaused = MainForm.EmulatorPaused;
 
 			// can't re-enter lua while doing this
-			GlobalWin.Tools.LuaConsole.LuaImp.SuppressLua = true;
+			GlobalWin.Tools.LuaConsole?.LuaImp.SupressUpdate();
 			while (Emulator.Frame != frame)
 			{
 				MainForm.SeekFrameAdvance();
 			}
 
-			GlobalWin.Tools.LuaConsole.LuaImp.SuppressLua = false;
+			GlobalWin.Tools.LuaConsole?.LuaImp.EnableUpdate();
 
 			if (!wasPaused)
 			{

diff --git a/src/BizHawk.Client.EmuHawk/tools/Lua/Libraries/SaveStateLuaLibrary.cs b/src/BizHawk.Client.EmuHawk/tools/Lua/Libraries/SaveStateLuaLibrary.cs
@@ -21,37 +21,23 @@ public SaveStateLuaLibrary(Lua lua, Action<string> logOutputCallback)
 		public void Load(string path, bool suppressOSD = false)
 		{
 			// TODO: find a non-global way to access LuaImp from Lua libraries!
-			var luaImp = GlobalWin.Tools.LuaConsole?.LuaImp;
-			if (luaImp != null)
-			{
-				luaImp.SuppressLua = true;
-			}
+			GlobalWin.Tools.LuaConsole?.LuaImp.SupressUpdate();
 
 			APIs.SaveState.Load(path, suppressOSD);
 
-			if (luaImp != null)
-			{
-				luaImp.SuppressLua = false;
-			}
+			GlobalWin.Tools.LuaConsole?.LuaImp.EnableUpdate();
 		}
 
 		[LuaMethodExample("savestate.loadslot( 7 );")]
 		[LuaMethod("loadslot", "Loads the savestate at the given slot number (must be an integer between 0 and 9). If EmuHawk is deferring quicksaves, to TAStudio for example, that form will do what it likes with the slot number.")]
 		public void LoadSlot(int slotNum, bool suppressOSD = false)
 		{
 			// TODO: find a non-global way to access LuaImp from Lua libraries!
-			var luaImp = GlobalWin.Tools.LuaConsole?.LuaImp;
-			if (luaImp != null)
-			{
-				luaImp.SuppressLua = true;
-			}
+			GlobalWin.Tools.LuaConsole?.LuaImp.SupressUpdate();
 
 			APIs.SaveState.LoadSlot(slotNum, suppressOSD);
 
-			if (luaImp != null)
-			{
-				luaImp.SuppressLua = false;
-			}
+			GlobalWin.Tools.LuaConsole?.LuaImp.EnableUpdate();
 		}
 
 		[LuaMethodExample("savestate.save( \"C:\\state.bin\" );")]

diff --git a/src/BizHawk.Client.EmuHawk/tools/Lua/Libraries/TAStudioLuaLibrary.cs b/src/BizHawk.Client.EmuHawk/tools/Lua/Libraries/TAStudioLuaLibrary.cs
@@ -137,6 +137,9 @@ public void SetPlayback(object frame)
 		{
 			if (Engaged())
 			{
+				// TODO: find a non-global way to access LuaImp from Lua libraries!
+				GlobalWin.Tools.LuaConsole?.LuaImp.SupressUpdate();
+
 				int f;
 				if (frame is double frameNumber)
 				{
@@ -157,6 +160,8 @@ public void SetPlayback(object frame)
 				{
 					Tastudio.GoToFrame(f, true);
 				}
+
+				GlobalWin.Tools.LuaConsole?.LuaImp.EnableUpdate();
 			}
 		}
 
@@ -289,6 +294,9 @@ public void ApplyInputChanges()
 		{
 			if (Engaged())
 			{
+				// TODO: find a non-global way to access LuaImp from Lua libraries!
+				GlobalWin.Tools.LuaConsole?.LuaImp.SupressUpdate();
+
 				if (_changeList.Count > 0)
 				{
 					int size = _changeList.Count;
@@ -324,6 +332,8 @@ public void ApplyInputChanges()
 					Tastudio.JumpToGreenzone();
 					Tastudio.DoAutoRestore();
 				}
+
+				GlobalWin.Tools.LuaConsole?.LuaImp.EnableUpdate();
 			}
 		}
 
@@ -418,7 +428,12 @@ public void LoadBranch(int index)
 		{
 			if (Engaged())
 			{
+				// TODO: find a non-global way to access LuaImp from Lua libraries!
+				GlobalWin.Tools.LuaConsole?.LuaImp.SupressUpdate();
+
 				Tastudio.LoadBranchByIndex(index);
+
+				GlobalWin.Tools.LuaConsole?.LuaImp.EnableUpdate();
 			}
 		}
 

diff --git a/src/BizHawk.Client.EmuHawk/tools/Lua/LuaConsole.cs b/src/BizHawk.Client.EmuHawk/tools/Lua/LuaConsole.cs
@@ -559,7 +559,7 @@ public bool LoadLuaSession(string path)
 
 		protected override void UpdateBefore()
 		{
-			if (LuaImp.SuppressLua)
+			if (LuaImp.IsUpdateSupressed)
 			{
 				return;
 			}
@@ -570,7 +570,7 @@ protected override void UpdateBefore()
 
 		protected override void UpdateAfter()
 		{
-			if (LuaImp.SuppressLua)
+			if (LuaImp.IsUpdateSupressed)
 			{
 				return;
 			}
@@ -607,7 +607,7 @@ public void ResumeScripts(bool includeFrameWaiters)
 				return;
 			}
 
-			if (LuaImp.SuppressLua)
+			if (LuaImp.IsUpdateSupressed)
 			{
 				return;
 			}

diff --git a/src/BizHawk.Client.EmuHawk/tools/Lua/LuaLibraries.cs b/src/BizHawk.Client.EmuHawk/tools/Lua/LuaLibraries.cs
@@ -18,7 +18,19 @@ public abstract class LuaLibraries
 		public readonly LuaFileList ScriptList = new LuaFileList();
 
 		public bool IsRebootingCore { get; set; } // pretty hacky.. we don't want a lua script to be able to restart itself by rebooting the core
-		public bool SuppressLua { get; set; }
+
+		public bool IsUpdateSupressed { get; private set;}
+
+		public void SupressUpdate()
+		{
+			IsUpdateSupressed = true;
+		}
+
+		public void EnableUpdate()
+		{
+			IsUpdateSupressed = false;
+		}
+
 		public EventWaitHandle LuaWait { get; protected set; }
 
 		public abstract void CallExitEvent(LuaFile lf);

diff --git a/src/BizHawk.Client.EmuHawk/tools/Lua/Win32LuaLibraries.cs b/src/BizHawk.Client.EmuHawk/tools/Lua/Win32LuaLibraries.cs
@@ -107,15 +107,15 @@ public override void Restart(IEmulatorServiceProvider newServiceProvider)
 
 		public override void StartLuaDrawing()
 		{
-			if (ScriptList.Count != 0 && GuiLibrary.SurfaceIsNull && !SuppressLua)
+			if (ScriptList.Count != 0 && GuiLibrary.SurfaceIsNull && !IsUpdateSupressed)
 			{
 				GuiLibrary.DrawNew("emu");
 			}
 		}
 
 		public override void EndLuaDrawing()
 		{
-			if (ScriptList.Count != 0 && !SuppressLua)
+			if (ScriptList.Count != 0 && !IsUpdateSupressed)
 			{
 				GuiLibrary.DrawFinish();
 			}
@@ -142,15 +142,15 @@ public override void CallLoadStateEvent(string name)
 
 		public override void CallFrameBeforeEvent()
 		{
-			if (!SuppressLua)
+			if (!IsUpdateSupressed)
 			{
 				EventsLibrary.CallFrameBeforeEvent();
 			}
 		}
 
 		public override void CallFrameAfterEvent()
 		{
-			if (!SuppressLua)
+			if (!IsUpdateSupressed)
 			{
 				EventsLibrary.CallFrameAfterEvent();
 			}