Initial undo/redo system in place. Class name is now undo/redo aware

ReClassNET · FransBouma · Jul 3, 2023 · Jul 3, 2023 · Jul 3, 2023 · Jul 3, 2023
commit fb7b4d69ba5e3ca0427304fa592cc4d48279eebe
diff --git a/ReClass.NET/Constants.cs b/ReClass.NET/Constants.cs
@@ -1,4 +1,4 @@
-namespace ReClassNET
+namespace ReClassNET
 {
 	public class Constants
 	{
@@ -39,5 +39,14 @@ public static class CommandLineOptions
 			public const string FileExtRegister = "registerfileext";
 			public const string FileExtUnregister = "unregisterfileext";
 		}
+
+		/// <summary>
+		/// Change type for commandified members in classes which is used to signal what change occurred exactly. As we don't use this feature of the commandified
+		/// class, this enum is defined to simply signal 'no specific change other than it changed' happened. 
+		/// </summary>
+		public enum GeneralPurposeChangeType
+		{
+			None
+		}
 	}
 }
diff --git a/ReClass.NET/Forms/MainForm.Designer.cs b/ReClass.NET/Forms/MainForm.Designer.cs
diff --git a/ReClass.NET/Forms/MainForm.Functions.cs b/ReClass.NET/Forms/MainForm.Functions.cs
@@ -16,6 +16,7 @@
 using ReClassNET.Nodes;
 using ReClassNET.Project;
 using ReClassNET.UI;
+using SD.Tools.Algorithmia.Commands;
 
 namespace ReClassNET.Forms
 {
@@ -213,6 +214,10 @@ public void LoadProjectFromPath(string path)
 		{
 			Contract.Requires(path != null);
 
+			CommandQueueManagerSingleton.GetInstance().ResetActiveCommandQueue();
+			CommandQueueManagerSingleton.GetInstance().BeginNonUndoablePeriod();		// we don't want to trigger undo/redo activity while loading
+			CommandQueueManagerSingleton.GetInstance().RaiseEvents = false;
+
 			var project = new ReClassNetProject();
 
 			LoadProjectFromPath(path, ref project);
@@ -224,6 +229,10 @@ public void LoadProjectFromPath(string path)
 			}
 
 			SetProject(project);
+
+			// Done loading, resume undo/redo activity
+			CommandQueueManagerSingleton.GetInstance().RaiseEvents = true;
+			CommandQueueManagerSingleton.GetInstance().EndNonUndoablePeriod();
 		}
 
 		/// <summary>Loads the file into the given project.</summary>

diff --git a/ReClass.NET/Forms/MainForm.cs b/ReClass.NET/Forms/MainForm.cs
@@ -22,6 +22,7 @@
 using ReClassNET.UI;
 using ReClassNET.Util;
 using ReClassNET.Util.Conversion;
+using SD.Tools.Algorithmia.Commands;
 
 namespace ReClassNET.Forms
 {
@@ -95,8 +96,11 @@ public MainForm()
 			};
 
 			pluginManager = new PluginManager(new DefaultPluginHost(this, Program.RemoteProcess, Program.Logger));
+
+			CommandQueueManagerSingleton.GetInstance().CommandQueueActionPerformed += OnCommandQueueActionPerformed;
 		}
 
+
 		protected override void OnLoad(EventArgs e)
 		{
 			base.OnLoad(e);
@@ -135,6 +139,8 @@ protected override void OnLoad(EventArgs e)
 			{
 				AttachToProcess(Program.CommandLineArgs[Constants.CommandLineOptions.AttachTo]);
 			}
+
+			SetStateOfUndoRedoButtons();
 		}
 
 		protected override void OnFormClosed(FormClosedEventArgs e)
@@ -1063,7 +1069,36 @@ private void initClassToolStripMenuItem_Click(object sender, EventArgs e)
 			{
 				return;
 			}
+
+			var cmd = new UndoablePeriodCommand("InitClassFromRTTI");
+			CommandQueueManagerSingleton.GetInstance().BeginUndoablePeriod(cmd);
 			memoryViewControl.InitCurrentClassFromRTTI(node as ClassNode);
+			CommandQueueManagerSingleton.GetInstance().EndUndoablePeriod(cmd);
+		}
+
+
+		private void SetStateOfUndoRedoButtons()
+		{
+			undoToolbarMenuItem.Enabled = CommandQueueManagerSingleton.GetInstance().CanUndo(Program.CommandQueueID);
+			redoToolbarMenuItem.Enabled = CommandQueueManagerSingleton.GetInstance().CanDo(Program.CommandQueueID);
+		}
+
+
+		private void OnCommandQueueActionPerformed(object sender, CommandQueueActionPerformedEventArgs e)
+		{
+			SetStateOfUndoRedoButtons();
+		}
+
+
+		private void undoToolbarMenuItem_Click(object sender, EventArgs e)
+		{
+			CommandQueueManagerSingleton.GetInstance().UndoLastCommand();
+		}
+
+
+		private void redoToolbarMenuItem_Click(object sender, EventArgs e)
+		{
+			CommandQueueManagerSingleton.GetInstance().RedoLastCommand();
 		}
 	}
 }
diff --git a/ReClass.NET/Nodes/BaseNode.cs b/ReClass.NET/Nodes/BaseNode.cs
@@ -7,6 +7,8 @@
 using ReClassNET.Extensions;
 using ReClassNET.UI;
 using ReClassNET.Util;
+using SD.Tools.Algorithmia.GeneralDataStructures;
+using SD.Tools.Algorithmia.GeneralDataStructures.EventArguments;
 
 namespace ReClassNET.Nodes
 {
@@ -24,14 +26,26 @@ public abstract class BaseNode
 
 		private static int nodeIndex = 0;
 
-		private string name = string.Empty;
+		//private string name = string.Empty;
+		private CommandifiedMember<string, Constants.GeneralPurposeChangeType> name;
 		private string comment = string.Empty;
 
 		/// <summary>Gets or sets the offset of the node.</summary>
 		public int Offset { get; set; }
 
 		/// <summary>Gets or sets the name of the node. If a new name was set the property changed event gets fired.</summary>
-		public virtual string Name { get => name; set { if (value != null && name != value) { name = value; NameChanged?.Invoke(this); } } }
+		public virtual string Name
+		{
+			get => name.MemberValue;
+			set
+			{
+				if (value == null)
+				{
+					return;
+				}
+				name.MemberValue = value;
+			}
+		}
 
 		/// <summary>Gets or sets the comment of the node.</summary>
 		public string Comment { get => comment; set { if (value != null && comment != value) { comment = value; CommentChanged?.Invoke(this); } } }
@@ -100,12 +114,15 @@ protected BaseNode()
 			Contract.Ensures(name != null);
 			Contract.Ensures(comment != null);
 
-			Name = $"N{nodeIndex++:X08}";
+			name = new CommandifiedMember<string, Constants.GeneralPurposeChangeType>("Name", Constants.GeneralPurposeChangeType.None, $"N{nodeIndex++:X08}");
+			name.ValueChanged += Name_ValueChanged;
 			Comment = string.Empty;
 
 			LevelsOpen[0] = true;
 		}
 
+		private void Name_ValueChanged(object sender, MemberChangedEventArgs<Constants.GeneralPurposeChangeType, string> e) => NameChanged?.Invoke(this);
+
 		public abstract void GetUserInterfaceInfo(out string name, out Image icon);
 
 		public virtual bool UseMemoryPreviewToolTip(HotSpot spot, out IntPtr address)

diff --git a/ReClass.NET/Program.cs b/ReClass.NET/Program.cs
@@ -11,6 +11,7 @@
 using ReClassNET.Native;
 using ReClassNET.UI;
 using ReClassNET.Util;
+using SD.Tools.Algorithmia.Commands;
 
 namespace ReClassNET
 {
@@ -34,10 +35,13 @@ public static class Program
 
 		public static FontEx MonoSpaceFont { get; private set; }
 
+		public static Guid CommandQueueID { get; private set; }
+
 		[STAThread]
 		static void Main(string[] args)
 		{
 			DesignMode = false; // The designer doesn't call Main()
+			CommandQueueID = Guid.NewGuid();
 
 			CommandLineArgs = new CommandLineArgs(args);
 
@@ -63,6 +67,11 @@ static void Main(string[] args)
 			Application.EnableVisualStyles();
 			Application.SetCompatibleTextRenderingDefault(false);
 
+			// switch is set to false, so Do actions during Undo actions are ignored.
+			CommandQueueManager.ThrowExceptionOnDoDuringUndo = false;
+			// activate our command queue stack. We're only changing things from the main thread so we don't need multiple stacks.
+			CommandQueueManagerSingleton.GetInstance().ActivateCommandQueueStack(CommandQueueID);
+
 			CultureInfo.DefaultThreadCurrentCulture = CultureInfo.InvariantCulture;
 
 			Settings = SettingsSerializer.Load();