deletion_chooser.lua

function plugindef()
    finaleplugin.RequireSelection = true
    finaleplugin.Author = "Carl Vine"
    finaleplugin.AuthorURL = "https://carlvine.com/lua"
    finaleplugin.Copyright = "CC0 https://creativecommons.org/publicdomain/zero/1.0/"
    finaleplugin.Version = "0.99c"
    finaleplugin.Date = "2024/05/14"
    finaleplugin.MinJWLuaVersion = 0.74
	finaleplugin.Notes = [[ 
        This script presents an alphabetical list of 24 individual types 
        of data to delete, each line beginning with a configurable _hotkey_. 
        Call the script, type the _hotkey_ and hit [Enter] or [Return]. 
        Half of the datatypes can be filtered by layer.

        __Delete Independently__: 

        > Articulations• | Articulations on Rests• | Chords | Cross Staff Entries•  
        > Custom Lines | Dynamics• | Expressions (Not Dynamics)•  
        > Expressions (All)• | Expressions (Measure-Attached) | Glissandos  
        > Hairpins | Lyrics• | MIDI Continuous Data | MIDI Note Data•  
        > Note Position Offsets• | Notehead Modifications• | Notes•  
        > Secondary Beam Breaks• | Slurs | Smart Shapes (Note Attached)•  
        > Smart Shapes (Beat Attached) | Smart Shapes (All) | Staff Styles  
        > Tuplets• | User Selected... | (• = filter by layer)

        To delete the same data as last time without a confirmation dialog 
        hold down [Shift] when starting the script. 

        __Expression Layers__  
        Expressions are not fixed to particular notes but can be 
        "assigned" to a specific note layer. This _assignment_ number
        is used for layer filtering here, and may not always correspond 
        to the note layer you expect. 
    ]]
    return "Deletion Chooser...", "Deletion Chooser", "Choose specific items to delete by keystroke"
end

local configuration = require("library.configuration")
local mixin = require("library.mixin")
local expression = require("library.expression")
local layer = require("library.layer")
local utils = require("library.utils")
local note_entry = require("library.note_entry")
local library = require("library.general_library")
local script_name = library.calc_script_name()
local refocus_document = false -- set to true if utils.show_notes_dialog is used

-- Mac / Windows menu command value ...
local clear_selected_items_menu = finenv.UI():IsOnMac() and 1296385394 or 16010

local dialog_options = { -- name key, HOTKEY, text description (ordered)
    { "CreateArticulations",     "A", "Articulations •" },
    { "rest_articulation",      "R", "Articulations on Rests •" },
    { "chords",                 "W", "Chords" },
    { "cross_staff",            "X", "Cross Staff Entries •" },
    { "shape_IsCustomLine",     "C", "Custom Lines" },
    { "expression_dynamic",     "D", "Dynamics •" },
    { "expression_not_dynamic", "E", "Expressions (Not Dynamics) •" },
    { "expression_all",         "F", "Expressions (All Note-Attached) •" },
    { "measure_attached",       "M", "Expressions (Measure-Attached)" },
    { "shape_IsGlissando",      "G", "Glissandos" },
    { "shape_IsHairpin",        "H", "Hairpins" },
    { "entry_lyrics",           "L", "Lyrics •" },
    { "midi_continuous",        "O", "MIDI Continuous Data" },
    { "CreatePerformanceMods",  "I", "MIDI Note Data •" },
    { "entry_position",         "Q", "Note Position Offsets •" },
    { "CreateNoteheadMods",     "J", "Notehead Modifications •" },
    { "notes",                  "N", "Notes •" },
    { "secondary_beam_breaks",  "K", "Secondary Beam Breaks •" },
    { "shape_IsSlur",           "S", "Slurs" },
    { "shape_IsEntryBased",     "P", "Smart Shapes (Note Attached) •" },
    { "shape_GetBeatAttached",  "B", "Smart Shapes (Beat Attached)" },
    { "shape_all",              "V", "Smart Shapes (All)" },
    { "staff_styles",           "Y", "Staff Styles (Current Score/Part)" },
    { "CreateTuplets",          "T", "Tuplets •", "TupletStartFlag" },
    { "user_selected",          "Z", "User Selected Items ..." },
}

local config = { -- user config data
    layer_num = 0,
    last_selected = 0, -- last selected menu item number (0-based)
    window_pos_x = false,
    window_pos_y = false,
    ignore_duplicates = 0,
}
for _, v in ipairs(dialog_options) do -- add HOTKEYS to CONFIG
    config[v[1]] = v[2] -- map NAME key onto HOTKEY
end

local function dialog_set_position(dialog)
    if config.window_pos_x and config.window_pos_y then
        dialog:StorePosition()
        dialog:SetRestorePositionOnlyData(config.window_pos_x, config.window_pos_y)
        dialog:RestorePosition()
    end
end

local function dialog_save_position(dialog)
    dialog:StorePosition()
    config.window_pos_x = dialog.StoredX
    config.window_pos_y = dialog.StoredY
    configuration.save_user_settings(script_name, config)
end

function shape_match_layer(shape, layer_num)
    if layer_num == 0 then return true end -- no layer filtering
    local left_seg = shape:GetTerminateSegmentLeft()
    local cell = finale.FCNoteEntryCell(left_seg.Measure, left_seg.Staff)
    cell:Load()
    -- assume both ends of the shape are on the same layer
    local entry = cell:FindEntryNumber(left_seg.EntryNumber)
    return (entry.LayerNumber == layer_num)
end

local function delete_selected(delete_type)
    local rgn = finenv.Region()
    local layer_num = config.layer_num

    if delete_type == "user_selected" then -- access Finale menu: Edit → "Clear Selected Items"
        if not finenv.UI():ExecuteOSMenuCommand(clear_selected_items_menu) then
            finenv.UI():AlertError("RGP Lua couldn't identify the Finale menu item "
                .. "\"Edit\" → \"Clear Selected Items...\"", "Error")
        end
    --
    elseif delete_type:find("shape") then -- SMART SHAPE of some description
        -- both beat-attached and note-attached with RGPLua 0.68+
        for mark in loadallforregion(finale.FCSmartShapeMeasureMarks(), rgn) do
            local shape = mark:CreateSmartShape()
            local test = delete_type:sub(7) -- extract shape "function" from type key value
            if shape and (test == "all" or shape[test](shape)) then
                if (not shape:IsEntryBased()) or shape_match_layer(shape, layer_num) then
                    shape:DeleteData()
                end
            end
        end
    --
    elseif delete_type:find("express") then -- EXPRESSION of some kind
        local expressions = finale.FCExpressions()
        expressions:LoadAllForRegion(rgn)
        for exp in eachbackwards(expressions) do
            if layer_num == 0 or exp.LayerAssignment == 0 or layer_num == exp.LayerAssignment then
                if exp.StaffGroupID == 0 and -- ??? not exp:IsShape() and 
                (      (delete_type == "expression_all")
                    or (delete_type == "expression_dynamic" and expression.is_dynamic(exp))
                    or (delete_type == "expression_not_dynamic" and not expression.is_dynamic(exp))
                )
                then
                    exp:DeleteData()
                end
            end
        end
    --
    elseif delete_type == "midi_continuous" then -- MIDI CONTINUOUS data
        local midi_ex = finale.FCMidiExpressions()
        midi_ex:LoadAllForRegion(rgn)
        for exp in eachbackwards(midi_ex) do
            exp:DeleteData()
        end
    --
    elseif delete_type == "chords" then -- CHORDS
        local chords = finale.FCChords()
        chords:LoadAllForRegion(rgn)
        for chord in eachbackwards(chords) do
            if chord then chord:DeleteData() end
        end
    --
    elseif delete_type == "notes" then -- NOTES
        for entry in eachentrysaved(rgn, layer_num) do
            if entry:IsNote() then note_entry.make_rest(entry) end
        end
        for m, s in eachcell(rgn) do
            local c = finale.FCNoteEntryCell(m, s)
            c:Load()
            c:ReduceEntries()
            c:Save()
        end
    --
    elseif delete_type == "measure_attached" then -- MEASURE-ATTACHED EXPRESSIONS type
        local measures = finale.FCMeasures()
        measures:LoadRegion(rgn)
        for measure in each(measures) do
            for exp in eachbackwards(measure:CreateExpressions()) do
                if exp.StaffGroupID > 0 then
                    exp:DeleteData()
                end
            end
            local m_exp = finale.FCExpression()
            if not m_exp:Load(measure.ItemNo, 0) then
                measure.ExpressionFlag = false -- no expressions left
                measure:Save()
            end
        end
    --
    elseif delete_type == "staff_styles" then -- STAFF STYLES
        for staff_number in eachstaff(rgn) do
            local style_assign = finale.FCStaffStyleAssigns()
            style_assign:LoadAllForItem(staff_number)
            for style in eachbackwards(style_assign) do
                local ss = { L = style.StartMeasure, R = style.EndMeasure }
                local rr = { L = rgn.StartMeasure, R = rgn.EndMeasure }
                if (ss.L <= rr.R and ss.R >= rr.L) then -- this style is in range
                    if (ss.L >= rr.L) and (ss.R <= rr.R) then
                        style:DeleteData() -- selection encloses style
                    else
                        if ss.L >= rr.L then -- (ss.R > rr.R) so move LH to right of selection
                            style.StartMeasure = rr.R + 1
                            style:Save()
                        else -- ss.L < rr.L: style starts before selection
                            style.EndMeasure = rr.L - 1
                            style:Save() -- move LH side to before selection
                            if ss.R > rr.R then -- continues to right of selection
                                local style_copy = mixin.FCMStaffStyleAssign()
                                style_copy:SetStyleID(style.StyleID) -- copy it
                                    :SetStartMeasure(rr.R + 1) -- move past selection
                                    :SetEndMeasure(ss.R)
                                    :SaveNew(staff_number)
                            end
                        end
                    end
                end
            end
        end
    --
    else -- ENTRY-attached datatypes remain: step through the selection
        -- local elements
        local create_flags = {
            CreateArticulations   = "ArticulationFlag",
            CreateTuplets         = "TupletStartFlag",
            CreatePerformanceMods = "PerformanceDataFlag",
        }
        local function delete_entry_mod(entry, type)
            local mod = finale[type]()
            mod:SetNoteEntry(entry)
            while mod:LoadFirst() do mod:DeleteData() end
        end
        local function delete_create_mods(entry, type)
            local mods = entry[type](entry)
            for m in eachbackwards(mods) do
                m:DeleteData()
            end
            mods:ClearAll()
            if create_flags[type] then entry[create_flags[type]] = false end
        end
        --
        for entry in eachentrysaved(rgn, layer_num) do
            --
            if delete_type == "entry_position" then -- Note Position Offsets
                entry.ManualPosition = 0
            --
            elseif delete_type:sub(1, 6) == "Create" then
                delete_create_mods(entry, delete_type) -- Articulations / MIDI / Noteheads / Tuplets
            elseif entry:IsRest() and entry.ArticulationFlag
                    and delete_type == "rest_articulation" then -- Articulations on rests
                delete_create_mods(entry, "CreateArticulations")
            --
            elseif delete_type == "entry_lyrics" and entry.LyricFlag then -- Lyrics
                for _, v in ipairs{"FCChorusSyllable", "FCSectionSyllable", "FCVerseSyllable"} do
                    delete_entry_mod(entry, v)
                end
            --
            elseif delete_type == "secondary_beam_breaks" then -- Secondary Beam Breaks
                delete_entry_mod(entry, "FCSecondaryBeamBreakMod")
            --
            elseif delete_type == "cross_staff" then -- Cross-Staff
                entry.ManualPosition = 0
                if entry:IsRest() then
                    entry:SetRestDisplacement(0)
                    entry.FloatingRest = true
                else
                    entry.ReverseUpStem = false
                    entry.ReverseDownStem = false
                    entry.FreezeBeam = false
                    entry.FreezeStem = false
                    for i = entry.Count, 1, -1 do
                        finale.FCCrossStaffMod():EraseAt(entry:GetItemAt(i - 1))
                    end
                    delete_entry_mod(entry, "FCCrossStaffMod")
                    if entry.StemDetailFlag then
                        delete_entry_mod(entry, "FCStemMod")
                    end
                    -- "CLEAR" beam settings (instead of erase)
                    local beam = finale.FCBeamMod(false)
                    for _, v in ipairs{true, false} do
                        beam:SetNoteEntry(entry)
                        beam:UseUpStemData(v)
                        if beam:LoadFirst() then
                            beam:SetDefaultMode()
                            beam.LeftVerticalOffset = 0
                            beam.RightVerticalOffset = 0
                            beam.LeftHorizontalOffset = 0
                            beam.RightHorizontalOffset = 0
                            beam.Thickness = -1
                            beam:Save()
                        end
                    end
                end
                entry.CrossStaff = false
            end
        end
    end
end

local function reassign_keys(parent, selected)
    local y_step, x_wide = 17, 180
    local offset = finenv.UI():IsOnMac() and 3 or 0
    local dialog = mixin.FCXCustomLuaWindow():SetTitle("Reassign Hotkeys")
    local is_duplicate, errors = false, {}
    local y = 0
    for _, v in ipairs(dialog_options) do -- add all options with keycodes
        dialog:CreateEdit(0, y - offset, v[1]):SetText(config[v[1]]):SetWidth(20)
            :AddHandleCommand(function(self)
                local s = self:GetText():sub(-1):upper()
                self:SetText(s):SetKeyboardFocus()
            end)
        dialog:CreateStatic(25, y):SetText(v[3]):SetWidth(x_wide)
        y = y + y_step
    end
    y = y + 7
    local ignore = dialog:CreateCheckbox(0, y):SetWidth(x_wide)
        :SetText("Ignore duplicate assignments"):SetCheck(config.ignore_duplicates or 0)
    dialog:CreateOkButton():SetText("Save")
    dialog:CreateCancelButton()
    dialog:RegisterInitWindow(function(self) self:GetControl(selected):SetKeyboardFocus() end)
    dialog_set_position(dialog)
    dialog:RegisterHandleOkButtonPressed(function(self)
        local assigned = {}
        for _, v in ipairs(dialog_options) do
            local key = self:GetControl(v[1]):GetText()
            if key == "" then key = "?" end -- not null
            config[v[1]] = key -- save for another possible run-through
            config.ignore_duplicates = ignore:GetCheck()
            if config.ignore_duplicates == 0 then -- DON'T IGNORE duplicates
                if assigned[key] then -- previously assigned
                    is_duplicate = true
                    if not errors[key] then errors[key] = { assigned[key] } end
                    table.insert(errors[key], v[3])
                else
                    assigned[key] = v[3] -- flag key assigned
                end
            end
        end
        if is_duplicate then -- list reassignment duplications
            local msg = ""
            for k, v in pairs(errors) do
                if msg ~= "" then msg = msg .. "\n\n" end
                msg = msg .. "Key \"" .. k .. "\" is assigned to: "
                for i, w in ipairs(v) do
                    if i > 1 then msg = msg .. " and " end
                    msg = msg .. "\"" .. w .. "\""
                end
            end
            dialog:CreateChildUI():AlertError(msg, "Duplicate Key Assignment")
        end
    end)
    local ok = (dialog:ExecuteModal(parent) == finale.EXECMODAL_OK)
    refocus_document = true
    return ok, is_duplicate
end

local function user_chooses()
    local y_step = 17
    local box_wide = 236
    local box_high = (#dialog_options * y_step) + 5
    local x_off = box_wide / 4
    local y = box_high + 27
    local max = layer.max_layers()
    local offset = finenv.UI():IsOnMac() and 3 or 0
    local name = plugindef():gsub("%.%.%.", "")

    local dialog = mixin.FCXCustomLuaWindow():SetTitle(name)
    dialog:CreateStatic(0, 0):SetText("Delete data of type:"):SetWidth(box_wide)
    local key_list = dialog:CreateListBox(0, 20):SetWidth(box_wide):SetHeight(box_high)
        -- local functions
        local function show_info()
            utils.show_notes_dialog(dialog, "About " .. name, 500, 325)
            refocus_document = true
        end
        local function fill_key_list()
            local join = finenv.UI():IsOnMac() and "\t" or ":  "
            key_list:Clear()
            for _, v in ipairs(dialog_options) do
                key_list:AddString(config[v[1]] .. join .. v[3])
            end
            key_list:SetSelectedItem(config.last_selected or 0)
        end
        local function change_keys()
            local ok, is_duplicate = true, true
            local selected = dialog_options[key_list:GetSelectedItem() + 1][1]
            while ok and is_duplicate do -- wait for valid choice in reassign_keys()
                ok, is_duplicate = reassign_keys(dialog, selected)
            end
            if ok then
                fill_key_list() -- update hotkey choices
            else -- "forget" the rejected choices
                configuration.get_user_settings(script_name, config)
            end
        end

    fill_key_list()
    dialog:CreateStatic(0, y):SetWidth(x_off * 3):SetText("For data types marked [•]:")
    y = y + y_step
    dialog:CreateStatic(0, y):SetWidth(x_off + 36):SetText("Active Layer 1-" .. max)
    local save_layer = tostring(config.layer_num) or "0"
    local layer_num = dialog:CreateEdit(x_off + 37, y - offset):SetWidth(20):SetText(save_layer)
        :AddHandleCommand(function(self)
            local val = self:GetText():lower()
            if val:find("[^0-" .. max .. "]") then
                if val:find("[?q]") then show_info()
                elseif val:find("r") then change_keys()
                end
            elseif val ~= "" then
                save_layer = val:sub(-1)
            end
            self:SetText(save_layer):SetKeyboardFocus()
        end)
    dialog:CreateStatic(x_off + 60, y):SetWidth(x_off):SetText("(0 = all)")
    y = y + y_step + 2
    dialog:CreateButton(0, y):SetText("Reassign Hotkeys"):SetWidth(x_off * 2)
        :AddHandleCommand(function() change_keys() end)
    local q = dialog:CreateButton(box_wide - 20, y):SetText("?"):SetWidth(20)
        :AddHandleCommand(function() show_info() end)
    dialog:CreateOkButton():SetText("Select")
    dialog:CreateCancelButton()
    dialog_set_position(dialog)
    dialog:RegisterHandleOkButtonPressed(function()
            config.last_selected = key_list:GetSelectedItem() -- save list choice
            config.layer_num = layer_num:GetInteger()
        end)
    dialog:RegisterCloseWindow(function(self) dialog_save_position(self) end)
    dialog:RegisterInitWindow(function()
        q:SetFont(q:CreateFontInfo():SetBold(true))
        key_list:SetKeyboardFocus()
    end)
    return (dialog:ExecuteModal(nil) == finale.EXECMODAL_OK)
end

local function select_delete_type()
    configuration.get_user_settings(script_name, config, true)
    local qim = finenv.QueryInvokedModifierKeys
    local mod_key = qim and (qim(finale.CMDMODKEY_ALT) or qim(finale.CMDMODKEY_SHIFT))

    if mod_key or user_chooses() then
        local type = dialog_options[config.last_selected + 1][1]
        delete_selected(type)
    end
    if refocus_document then finenv.UI():ActivateDocumentWindow() end
end

select_delete_type()