Cleanup document: add option to remove empty groups/layers (#2552)

* cleanup document: add options to remove empty groups/layers

* cleanup document: add test run option

2 files changed, 47 insertions, 14 deletions

diff --git a/lib/extensions/cleanup.py b/lib/extensions/cleanup.py
index 4c350d62..e8a30c43 100644
--- a/lib/extensions/cleanup.py
+++ b/lib/extensions/cleanup.py
@@ -7,6 +7,7 @@ from inkex import NSS, Boolean, errormsg
 
 from ..elements import FillStitch, Stroke
 from ..i18n import _
+from ..svg.tags import SVG_GROUP_TAG
 from .base import InkstitchExtension
 
 
@@ -17,33 +18,59 @@ class Cleanup(InkstitchExtension):
         self.arg_parser.add_argument("-s", "--rm_stroke", dest="rm_stroke", type=Boolean, default=True)
         self.arg_parser.add_argument("-a", "--fill_threshold", dest="fill_threshold", type=int, default=20)
         self.arg_parser.add_argument("-l", "--stroke_threshold", dest="stroke_threshold", type=int, default=5)
+        self.arg_parser.add_argument("-g", "--rm_groups", dest="rm_groups", type=Boolean, default=True)
+        self.arg_parser.add_argument("-d", "--dry_run", dest="dry_run", type=Boolean, default=False)
 
     def effect(self):
         self.rm_fill = self.options.rm_fill
         self.rm_stroke = self.options.rm_stroke
         self.fill_threshold = self.options.fill_threshold
         self.stroke_threshold = self.options.stroke_threshold
+        self.rm_groups = self.options.rm_groups
+        self.dry_run = self.options.dry_run
 
         self.svg.selection.clear()
+        self.get_elements()
 
-        count = 0
+        self.elements_to_remove = []
         svg = self.document.getroot()
         empty_d_objects = svg.xpath(".//svg:path[@d='' or not(@d)]", namespaces=NSS)
         for empty in empty_d_objects:
-            empty.getparent().remove(empty)
-            count += 1
-
-        if not self.get_elements():
-            errormsg(_("%s elements removed" % count))
-            return
+            self.elements_to_remove.append(empty)
 
         for element in self.elements:
-            if (isinstance(element, FillStitch) and self.rm_fill and element.shape.area < self.fill_threshold):
-                element.node.getparent().remove(element.node)
-                count += 1
-            if (isinstance(element, Stroke) and self.rm_stroke and
+            if self.rm_fill and (isinstance(element, FillStitch) and element.shape.area < self.fill_threshold):
+                self.elements_to_remove.append(element.node)
+            if self.rm_stroke and (isinstance(element, Stroke) and
                element.shape.length < self.stroke_threshold and element.node.getparent() is not None):
-                element.node.getparent().remove(element.node)
-                count += 1
+                self.elements_to_remove.append(element.node)
+
+        self.groups_to_remove = []
+        if self.rm_groups:
+            for group in self.svg.iterdescendants(SVG_GROUP_TAG):
+                if len(group.getchildren()) == 0:
+                    self.groups_to_remove.append(group)
+
+        if self.dry_run:
+            self._dry_run()
+        else:
+            self._remove()
+
+    def _dry_run(self):
+        errormsg(_("%s elements to remove:" % len(self.elements_to_remove)))
+        for element in self.elements_to_remove:
+            errormsg(f" - { element.label }: {element.get_id()}")
+
+        errormsg("\n")
+        errormsg(_("%s groups/layers to remove:" % len(self.groups_to_remove)))
+        for group in self.groups_to_remove:
+            errormsg(f" - { group.label }: {group.get_id()}")
+
+    def _remove(self):
+        errormsg(_("%s elements removed" % len(self.elements_to_remove)))
+        for element in self.elements_to_remove:
+            element.getparent().remove(element)
 
-        errormsg(_("%s elements removed" % count))
+        errormsg(_("%s groups/layers removed" % len(self.groups_to_remove)))
+        for group in self.groups_to_remove:
+            group.getparent().remove(group)
diff --git a/templates/cleanup.xml b/templates/cleanup.xml
index ad594293..52e01185 100644
--- a/templates/cleanup.xml
+++ b/templates/cleanup.xml
@@ -9,6 +9,12 @@
     <param name="rm_stroke" type="boolean" gui-text="Remove Small strokes"
            gui-description="Removes small strokes shorter than defined by threshold.">true</param>
     <param name="stroke_threshold" type="int" gui-text="Stroke threshold (px)" min="2" max="800">5</param>
+    <param name="rm_groups" type="boolean" gui-text="Remove empty layers and groups">true</param>
+    <spacer />
+    <separator />
+    <spacer />
+    <param name="dry_run" type="boolean" gui-text="Test run"
+        gui-description="Only display labels and ids of affected elements and groups without removing them.">true</param>
     <param name="extension" type="string" gui-hidden="true">cleanup</param>
     <effect>
         <object-type>all</object-type>