meerk40t 0.9.3001__py2.py3-none-any.whl → 0.9.7020__py2.py3-none-any.whl

meerk40t/core/elements/undo_redo.py

@@ -1,58 +1,116 @@
-"""
-This is a giant list of console commands that deal with and often implement the elements system in the program.
-"""
-
-
-def plugin(kernel, lifecycle=None):
-    _ = kernel.translation
-    if lifecycle == "postboot":
-        init_commands(kernel)
-
-
-def init_commands(kernel):
-    self = kernel.elements
-
-    _ = kernel.translation
-
-    # ==========
-    # UNDO/REDO COMMANDS
-    # ==========
-    @self.console_command(
-        "save_restore_point",
-    )
-    def undo_mark(data=None, **kwgs):
-        self.undo.mark()
-
-    @self.console_command(
-        "undo",
-    )
-    def undo_undo(command, channel, _, **kwgs):
-        if not self.undo.undo():
-            # At bottom of stack.
-            channel("No undo available.")
-            return
-        self.validate_selected_area()
-        channel(f"Undo: {self.undo}")
-        self.signal("refresh_scene", "Scene")
-        self.signal("rebuild_tree")
-
-    @self.console_command(
-        "redo",
-    )
-    def undo_redo(command, channel, _, data=None, **kwgs):
-        if not self.undo.redo():
-            channel("No redo available.")
-            return
-        channel(f"Redo: {self.undo}")
-        self.validate_selected_area()
-        self.signal("refresh_scene", "Scene")
-        self.signal("rebuild_tree")
-
-    @self.console_command(
-        "undolist",
-    )
-    def undo_list(command, channel, _, **kwgs):
-        for entry in self.undo.undolist():
-            channel(entry)
-
-    # --------------------------- END COMMANDS ------------------------------
+"""
+This module provides a set of console commands for managing undo and redo operations within the application.
+These commands allow users to mark restore points, undo actions, redo actions, and list the available undo operations.
+
+Functions:
+- plugin(kernel, lifecycle=None): Initializes the plugin and sets up undo/redo commands.
+- init_commands(kernel): Initializes the undo/redo commands and defines the associated operations.
+- undo_mark(data=None, message=None, **kwgs): Marks a restore point in the undo stack with an optional message.
+  Args:
+    data: Additional data for the command (not used).
+    message: A message to associate with the restore point.
+- undo_undo(command, channel, _, **kwgs): Performs the undo operation, reverting the last action.
+  Args:
+    command: The command context.
+    channel: The communication channel for messages.
+- undo_redo(command, channel, _, data=None, **kwgs): Performs the redo operation, reapplying the last undone action.
+  Args:
+    command: The command context.
+    channel: The communication channel for messages.
+    data: Additional data for the command (not used).
+- undo_list(command, channel, _, **kwgs): Lists all available undo operations in the stack.
+  Args:
+    command: The command context.
+    channel: The communication channel for messages.
+"""
+
+
+def plugin(kernel, lifecycle=None):
+    _ = kernel.translation
+    if lifecycle == "postboot":
+        init_commands(kernel)
+
+
+def init_commands(kernel):
+    self = kernel.elements
+
+    _ = kernel.translation
+
+    # ==========
+    # UNDO/REDO COMMANDS
+    # ==========
+    @self.console_argument("message", type=str, default=None)
+    @self.console_command(
+        "save_restore_point",
+    )
+    def undo_mark(data=None, message=None, **kwgs):
+        self.undo.mark(message)
+
+    def statistics(channel):
+        def show_em(branch, message):
+            nodes = len(list(branch.flat()))
+            channel(f"{message}: {nodes}")
+
+        show_em(self.op_branch, "Operations")
+        show_em(self.elem_branch, "Elements")
+        show_em(self.reg_branch, "Regmarks")
+
+    @self.console_argument("index", type=str, default=None)
+    @self.console_command(
+        "undo",
+    )
+    def undo_undo(command, channel, _, index=None, **kwgs):
+        if index is not None:
+            try:
+                idx = int(index)
+            except ValueError:
+                idx = self.undo.find(index)
+            if  (idx < 0 or idx > len(self.undo._undo_stack)):
+                channel(f"Invalid index: {index}, performing standard undo")
+                index = None
+            else:
+                index = idx
+        if not self.undo.undo(index=index):
+            # At bottom of stack.
+            channel("No undo available.")
+            return
+        self.validate_selected_area()
+        channel(f"Undo: {self.undo}")
+        statistics(channel)
+        self.signal("refresh_scene", "Scene")
+        self.signal("rebuild_tree", "all")
+
+    @self.console_argument("index", type=str, default=None)
+    @self.console_command(
+        "redo",
+    )
+    def undo_redo(command, channel, _, data=None, index=None, **kwgs):
+        if index is not None:
+            try:
+                idx = int(index)
+            except ValueError:
+                idx = self.undo.find(index)
+            if  (idx < 0 or idx > len(self.undo._undo_stack)):
+                channel(f"Invalid index: {index}, performing standard redo")
+                index = None
+            else:
+                index = idx
+        with self.static("redo"):
+            redo_done = self.undo.redo(index=index)
+        if not redo_done:
+            channel("No redo available.")
+            return
+        self.validate_selected_area()
+        channel(f"Redo: {self.undo}")
+        statistics(channel)
+        self.signal("refresh_scene", "Scene")
+        self.signal("rebuild_tree", "all")
+
+    @self.console_command(
+        "undolist",
+    )
+    def undo_list(command, channel, _, **kwgs):
+        for entry in self.undo.undolist():
+            channel(entry)
+
+    # --------------------------- END COMMANDS ------------------------------