[RemoveTags] Minor rewrite

changed: defer tag collection to assfplus
fixed: group name and tag name conflict
fixed: inline tags except last did not work correctly when there was no start tags
changed: tags are removed inside transform only when it is explicitly specified
fixed: finding of correct start tag index
fixed: a bunch of niche errors that people will never encounter

Author: PhosCity

macros/phos.RemoveTags.moon

@@ -1,9 +1,10 @@
 export script_name = "Remove Tags"
 export script_description = "Dynamically remove tags based on selection"
-export script_version = "1.0.1"
+export script_version = "1.0.2"
 export script_author = "PhosCity"
 export script_namespace = "phos.RemoveTags"
 
+
 DependencyControl = require "l0.DependencyControl"
 depctrl = DependencyControl{
     feed: "https://raw.githubusercontent.com/PhosCity/Aegisub-Scripts/main/DependencyControl.json",
@@ -14,32 +15,33 @@ depctrl = DependencyControl{
             feed: "https: //raw.githubusercontent.com/TypesettingTools/ASSFoundation/master/DependencyControl.json"},
         {"l0.Functional", version: "0.6.0", url: "https://github.com/TypesettingTools/Functional",
             feed: "https://raw.githubusercontent.com/TypesettingTools/Functional/master/DependencyControl.json"},
+        {"phos.AssfPlus", version: "1.0.4", url: "https://github.com/PhosCity/Aegisub-Scripts",
+            feed: "https://raw.githubusercontent.com/PhosCity/Aegisub-Scripts/main/DependencyControl.json"},
     }
 }
-LineCollection, ASS, Functional = depctrl\requireModules!
-logger = depctrl\getLogger!
+LineCollection, ASS, Functional, AssfPlus = depctrl\requireModules!
 {:list} = Functional
 
 
---- Collects all the tags in the selected lines
----@param sub table subtitle object
----@param sel table selected lines
----@return table collection that has tagList, buttons, top row options, tag groups, hints and more
-collectTags = (sub, sel) ->
-    collection =
-        tagList: {}
-        startTagIndex: nil
-        buttons: {"Remove Tags", "Remove All", "Cancel"}
-        topRow: {start_tag: false, inline_tags: false, transforms: false, invert: true}
-        removeGroup: {color: false, alpha: false, rotation: false, scale: false, perspective: false, inline_except_last: false} 
-        removeGroupTags: {
+collectTags = (lines) ->
+
+    collection = AssfPlus.lineCollection.collectTags lines, true
+
+    with collection
+
+        .buttons = {"Remove Tags", "Remove All", "Cancel"}
+
+        .removeGroup = {color: false, alpha: false, rotation: false, scale: false, perspective: false, inline_except_last: .multiple_inline_tags}
+
+        .removeGroupTags = {
             color: {"color1", "color2", "color3", "color4"}
             alpha: {"alpha", "alpha1", "alpha2", "alpha3", "alpha4"}
             rotation: {"angle", "angle_x", "angle_y"}
             scale: {"fontsize", "scale_x", "scale_y"}
             perspective: {"angle", "angle_x", "angle_y", "shear_x", "shear_y"}
         }
-        hint: {
+
+        .hint = {
             color: "c, 1c, 2c, 3c, 4c"
             alpha: "alpha, 1a, 2a, 3a, 4a"
             rotation: "frz, frx, fry"
@@ -50,102 +52,48 @@ collectTags = (sub, sel) ->
             inline_tags: "Remove from inline tags only"
             transform: "Remove from transform only"
             invert: "Remove all except selected"
-        } 
+        }
+
+        .tagTypes.invert = true
+
+    for tag in *collection.tagList
+        with collection.removeGroup
+            if tag\match "color"
+                .color = true
+            elseif tag\match "alpha"
+                .alpha = true
+            elseif tag\match "angle"
+                .rotation = true
+                .perspective = true
+            elseif tag\match "shear" or tag == "origin"
+                .perspective = true
+            elseif tag\match "scale" or tag == "fontsize"
+                .scale = true
+
+    collection
 
-    lines = LineCollection sub, sel
-    return if #lines.lines == 0
-    lines\runCallback (lines, line, i) ->
-        aegisub.cancel! if aegisub.progress.is_cancelled!
-        aegisub.progress.task "Collecting tags from %d of %d lines..."\format i, #lines.lines if i%10==0
-        aegisub.progress.set 100*i/#lines.lines
-        data = ASS\parse line
-        tagSectionCount = data\getSectionCount ASS.Section.Tag
-        collection.removeGroup.inline_except_last = tagSectionCount > 2 if not collection.removeGroup.inline_except_last
-        collection.topRow.inline_tags = tagSectionCount > 1 if not collection.topRow.inline_tags
-
-        -- Determine if there is a tag at the start of the line
-        -- If we reach a Text section or Drawing section before we reach a Tag section, then there is no start tag block.
-        for j = 1, #data.sections
-            if data.sections[j].instanceOf[ASS.Section.Tag]
-                collection.topRow.start_tag = true
-                collection.startTagIndex = j
-                break
-            elseif data.sections[j].instanceOf[ASS.Section.Text] or data.sections[j].instanceOf[ASS.Section.Drawing]
-                break
-
-        -- Collect all the tags in the line
-
-        --- Determines which group a tag belongs to
-        ---@param tagName string name of tag as ASSFoundation understands it
-        tagSorter = (tagName) ->
-            with collection.removeGroup
-                if tagName\match "color"
-                    .color = true
-                elseif tagName\match "alpha"
-                    .alpha = true
-                elseif tagName\match "angle"
-                    .rotation = true
-                    .perspective = true
-                elseif tagName\match "shear" or tagName == "origin"
-                    .perspective = true
-                elseif tagName\match "scale" or tagName == "fontsize"
-                    .scale = true
-
-        for tag in *data\getTags!
-            tagName = tag.__tag.name
-            table.insert collection.tagList, tagName
-            tagSorter tagName
-
-            if tag.class == ASS.Tag.Transform
-                collection.topRow.transforms = true
-                for transformTag in *tag.tags\getTags!
-                    table.insert collection.tagList, transformTag.__tag.name
-                    tagSorter transformTag.__tag.name
-
-    -- No tags could be found in the selected lines
-    if #collection.tagList == 0
-        aegisub.dialog.display { { class: "label", label: "No tags found in the selected lines." } }, { "Close" }, { cancel: "Close" }
-        aegisub.cancel!
-
-    -- Insert a button for removing transform if transform tag exists in the line
-    -- table.insert collection.buttons, 3, "Transform" if collection.topRow.transforms
-
-    -- Deduplicate the taglist
-    collection.tagList = list.uniq collection.tagList
-
-    -- Sort the taglist
-    collection.tagList = [tag for tag in *(list.join(ASS.tagSortOrder, {"transform"})) when list.find collection.tagList, (value) -> value == tag ]
-    return collection
-
-
---- Dynamically creates a gui depending on the options set in collection table
----@param collection table collection table
----@return table dialog table
----@return table collection updated
 createGui = (collection) ->
+
     y, dialog = 0, {}
-    -- Left portion of the GUI
     for key, value in pairs collection.removeGroup
         continue unless value
-        table.insert collection.buttons, 1, "Remove Group" if y == 0
         label = ("Remove all #{key}")\gsub "_", " "
-        dialog[#dialog+1]= {x: 0, y: y, class: "checkbox", label: label, name: key, hint: collection.hint[key]}
+        dialog[#dialog+1]= {x: 0, y: y, class: "checkbox", label: label, name: "group_"..key, hint: collection.hint[key]}
         y += 1
 
-    -- Right portion of the GUI
     startX = 0
-    startX = 1 if collection.buttons[1] == "Remove Group"
+    if #dialog > 0
+        table.insert collection.buttons, 1, "Remove Group"
+        startX = 1
     x = startX
 
-    for key in *[ item for item in *{"start_tag", "inline_tags", "transforms", "invert"} when collection.topRow[item]]       -- Manually sorting since lua doesn't loop through table in order
+    for key in *[ item for item in *{"start_tag", "inline_tags", "transforms", "invert"} when collection.tagTypes[item]]       -- Manually sorting since lua doesn't loop through table in order
         label = key\gsub("^%l", string.upper)\gsub("_%l", string.upper)\gsub("_", " ")
         dialog[#dialog+1]= {x: x, y: 0, class: "checkbox", label: label, name: key, hint: collection.hint[key]}
         x += 1
 
-	-- Determine the number of columns in gui
     column = math.max math.ceil(math.sqrt #collection.tagList), x
 
-	-- Dynamically create gui
     count = 0
     for y = 1, column
         for x = startX, column + startX - 1
@@ -154,49 +102,29 @@ createGui = (collection) ->
             label = (ASS.toFriendlyName[collection.tagList[count]])\gsub("\\1c%s+", "")\gsub("\\", "")
             dialog[#dialog+1] = {x: x, y: y, class: "checkbox", label: label, name: collection.tagList[count]}
 
-    return dialog, collection
-
-
---- Removes tags in a line
----@param data table line content object from ASSFoundation
----@param tags table list of tags that must be removed from the line
----@param start integer index of tag block from which to start removing tags
----@param end_ integer index of tag block upto which to remove tags
----@param transforms table ASSFoundation transform tag object
----@param transformOnly boolean should tags only be removed inside transform
----@return table data updated line content object
-removeTags = (data, tags, start, end_, transforms, transformOnly) ->
-    data\removeTags tags, start, end_ unless transformOnly
-    if #transforms > 0
-        for _, tr in ipairs transforms
-            toRemove = {}
-            for index, tag in ipairs tr.tags.tags
-                for i in *tags
-                    table.insert toRemove, index if tag.__tag.name == i and i != "transform"
-            list.removeIndices tr.tags.tags, toRemove
-    data
-
-
---- Main processing function that gathers and executes all other functions
----@param sub table subtitle object
----@param sel table selected lines
-main = (sub, sel) ->
-    collection = collectTags sub, sel
-    dialog, collection = createGui collection
     btn, res = aegisub.dialog.display dialog, collection.buttons, {"cancel": "Cancel"}
     aegisub.cancel! unless btn
 
+    btn, res
+
+main = (sub, sel) ->
+
     lines = LineCollection sub, sel
     return if #lines.lines == 0
+
+    collection = collectTags lines
+
+    btn, res = createGui collection
+
     lines\runCallback (lines, line, i) ->
-        aegisub.cancel! if aegisub.progress.is_cancelled!
-        aegisub.progress.task "Removing tags from %d of %d lines..."\format i, #lines.lines if i%10==0
-        aegisub.progress.set 100*i/#lines.lines
+
+        AssfPlus._util.checkCancellation!
+        AssfPlus._util.progress "Removing tags", i, #lines.lines
+
         data = ASS\parse line
         tagSectionCount = data\getSectionCount ASS.Section.Tag
         transforms = data\getTags "transform"
         switch btn
-            -- when "Transform" then removeTransformSection sub, sel
 
             when "Remove All"
                 if res.start_tag
@@ -207,34 +135,42 @@ main = (sub, sel) ->
                     data\stripTags!
 
             when "Remove Group"
-                if res["inline_except_last"]
-                    data\removeTags _, (collection.startTagIndex and collection.startTagIndex + 1 or 1), tagSectionCount - 1
+
+                if res["group_inline_except_last"]
+                    data\removeTags _, (collection.tagTypes.start_tag and 2 or 1), tagSectionCount - 1
+
                 else
                     start, end_, tagsToDelete = 1, tagSectionCount, {}
                     end_ = 1 if res.start_tag
                     start = 2 if res.inline_tags
                     for key, value in pairs collection.removeGroupTags
-                        continue unless res[key]
+                        continue unless res["group_" .. key]
                         tagsToDelete = list.join tagsToDelete, value
                     tagsToDelete = list.diff ASS.tagSortOrder, tagsToDelete if res.invert
-                    data = removeTags(data, tagsToDelete, start, end_, transforms)
+                    data\removeTags tagsToDelete, start, end_
 
             when "Remove Tags"
+
                 local tagsToDelete
                 if res.invert
                     tagsToDelete = [tag for tag in *collection.tagList when not res[tag]]
                 else
                     tagsToDelete = [tag for tag in *collection.tagList when res[tag]]
+
                 if res.start_tag
-                    data = removeTags(data, tagsToDelete, 1, 1, transforms)
+                    data\removeTags tagsToDelete, 1, 1
+
                 elseif res.inline_tags
-                    data\removeTags(tagsToDelete, 2, tagSectionCount)
+                    data\removeTags tagsToDelete, 2, tagSectionCount
+
                 elseif res.transforms
-                    data = removeTags(data, tagsToDelete, 1, 1, transforms, true)
+                    for tr in *transforms
+                        tr.tags\removeTags tagsToDelete
+
                 else
-                    data = removeTags(data, tagsToDelete, _, _, transforms)
-        data\cleanTags 2
+                    data\removeTags tagsToDelete
+
         data\commit!
     lines\replaceLines!
 
-depctrl\registerMacro main
+depctrl\registerMacro main