Merge pull request #748 from cv-on-hub/cv-spacing-hack

Update music_spacing_hack.lua

Author: rpatters1

src/music_spacing_hack.lua src/music_spacing_options.luasrc/music_spacing_hack.lua renamed to src/music_spacing_options.lua

@@ -4,45 +4,51 @@ function plugindef()
     finaleplugin.Author = "Carl Vine"
     finaleplugin.AuthorURL = "http://carlvine.com/lua/"
     finaleplugin.Copyright = "https://creativecommons.org/licenses/by/4.0/"
-    finaleplugin.Version = "0.10"
-    finaleplugin.Date = "2024/05/03"
-    finaleplugin.MinJWLuaVersion = 0.62
+    finaleplugin.Version = "0.14"
+    finaleplugin.Date = "2024/07/21"
+    finaleplugin.MinJWLuaVersion = 0.70
     finaleplugin.Notes = [[
-        There's a couple of __Music Spacing__ options that I 
-        change frequently for different spacing scenarios. 
-        This little hack uses a couple of hotkeys 
-        to do that very quickly, without a mouse and without navigating 
-        the whole __Document__ → __Document Options__ → 
-        __Music Spacing__ → __Avoid Collision of__ → menu/dialog system.
+        Quickly change __music spacing__ options (with optional hotkeys). 
+        These options are otherwise only available using the messy combined 
+        menu/dialog/menu process of 
+        __Document__ → __Document Options__ → __Music Spacing__ → __Avoid Collision of__...
+
+        It also offers easy access to the __Automatic Music Spacing__ option 
+        which is otherwise only available at 
+        __Finale__ → __Settings__ → __Edit__ →  __Automatic Music Spacing__.
     ]]
-    return "Music Spacing Hack...",
-        "Music Spacing Hack",
-        "A keyboard hack to quickly change music spacing options"
+    return "Music Spacing Options...",
+        "Music Spacing Options",
+        "Quickly change music spacing options (with optional hotkeys)"
 end
 
 local config = {
+    dummy        = "dummy",
     window_pos_x = false,
     window_pos_y = false,
     measurement_unit = finale.MEASUREMENTUNIT_DEFAULT,
 }
-local checks = { -- prefs Property key; hotkey; text description; type
+local checks = { -- spacing_prefs Property key; hotkey; text description; type
     { "AvoidArticulations", "A", "Articulations" },
-    { "AvoidChords",      "S", "Chords" },
-    { "AvoidClefs",       "D", "Clefs" },
-    { "AvoidHiddenNotes", "W", "Hidden Notes" },
-    { "AvoidLedgerLines", "E", "Ledger Lines" },
-    { "AvoidLyrics",      "R", "Lyrics" },
+    { "AvoidChords",        "S", "Chords" },
+    { "AvoidClefs",         "D", "Clefs" },
+    { "AvoidHiddenNotes",   "W", "Hidden Notes" },
+    { "AvoidLedgerLines",   "E", "Ledger Lines" },
+    { "AvoidLyrics",        "R", "Lyrics" },
 }
 local unisons = {
-    { finale.UNISSPACE_NONE,               "X", "None" },
-    { finale.UNISSPACE_DIFFERENTNOTEHEADS, "V", "Different Noteheads" },
-    { finale.UNISSPACE_ALLNOTEHEADS,       "B", "All Noteheads" },
+    { finale.UNISSPACE_NONE,               "V", "None" },
+    { finale.UNISSPACE_DIFFERENTNOTEHEADS, "B", "Different Noteheads" },
+    { finale.UNISSPACE_ALLNOTEHEADS,       "N", "All Noteheads" },
 }
 local others = {
-    {"change_hotkeys",        "H", "Change Hotkeys"},
-    {"AutomaticMusicSpacing", "Z", "Automatic Music Spacing"},
-    {"script_info",           "Q", "Show Script Info"}
+    { "change_hotkeys", "H", "Change Hotkeys" },
+    { "auto_spacing",   "Z", "Automatic Music Spacing" },
+    { "script_info",    "Q", "Show Script Info" },
+    { "manual_pos",     "X", "Manual Positioning" }
 }
+local manual_pos = { "Clear", "Incorporate", "Ignore" } -- 0 .. 1 .. 2 popup
+
 -- copy hotkeys to config
 for _, t in ipairs{checks, unisons, others} do
     for _, v in ipairs(t) do
@@ -57,9 +63,9 @@ local library = require("library.general_library")
 local script_name = library.calc_script_name()
 local name = plugindef():gsub("%.%.%.", "")
 local refocus_document = false
-local prefs = finale.FCMusicSpacingPrefs()
+local spacing_prefs = finale.FCMusicSpacingPrefs()
+spacing_prefs:LoadFirst()
 local gen_prefs = finale.FCGeneralPrefs()
-prefs:LoadFirst()
 gen_prefs:LoadFirst()
 configuration.get_user_settings(script_name, config)
 
@@ -160,12 +166,12 @@ local function run_the_dialog()
     local m_offset = finenv.UI():IsOnMac() and 3 or 0
     local saved
 
-    local dialog = mixin.FCXCustomLuaWindow():SetTitle(name:sub(1, -5))
+    local dialog = mixin.FCXCustomLuaWindow():SetTitle(name:sub(1, 13))
     dialog:SetMeasurementUnit(config.measurement_unit)
         -- local functions
         local function dy(diff) y = y + (diff and diff or 17) end
         local function show_info()
-            utils.show_notes_dialog(dialog, "About " .. name, 300, 150)
+            utils.show_notes_dialog(dialog, "About " .. name, 300, 175)
             refocus_document = true
         end
         local function cstat(cx, cy, ctext, cwide, cname)
@@ -175,14 +181,22 @@ local function run_the_dialog()
             dialog:CreateCheckbox(cx, cy, cname):SetText(ctext):SetWidth(cwide):SetCheck(check)
         end
         local function toggle_check(id)
-            local ctl = dialog:GetControl(id)
-            ctl:SetCheck((ctl:GetCheck() + 1) % 2)
+            local c = dialog:GetControl(id)
+            c:SetCheck((c:GetCheck() + 1) % 2)
         end
         local function toggle_unison(id)
             for i = unisons[1][1], unisons[3][1] do
                 dialog:GetControl(tostring(i)):SetCheck(i == id and 1 or 0)
             end
         end
+        local function fill_pos_popup()
+            local popup = dialog:GetControl(others[4][1])
+            popup:Clear()
+            for _, v in ipairs(manual_pos) do
+                popup:AddString(v .. " (" .. config.manual_pos .. ")")
+            end
+            popup:SetSelectedItem(spacing_prefs.ManualPositioning) -- 0, 1 or 2
+        end
         local function change_keys()
             local ok, is_duplicate = true, true
             while ok and is_duplicate do -- wait for good choice in reassign()
@@ -191,109 +205,114 @@ local function run_the_dialog()
             if ok then
                 for _, t in ipairs{checks, unisons, others} do
                     for _, v in ipairs(t) do
-                        if v[1] ~= "script_info" then
+                        if v[1] ~= "script_info" and v[1] ~= "manual_pos" then
                             dialog:GetControl("T" .. v[1]):SetText(config[tostring(v[1])])
                         end
                     end
                 end
             else -- re-seed hotkeys from user config
                 configuration.get_user_settings(script_name, config)
             end
+            fill_pos_popup()
             dialog:GetControl("max_width"):SetKeyboardFocus()
         end
         local function key_check(ctl)
             local s = ctl:GetText():upper()
-            if s:find("[^.P0-9]") then
-                if s:find(config.change_hotkeys) then
-                    change_keys()
-                elseif s:find(config.AutomaticMusicSpacing) then
-                    toggle_check("AutomaticMusicSpacing")
+            if s:find("[^ .P0-9]") then
+                if s:find(config.change_hotkeys) then change_keys()
+                elseif s:find(config.auto_spacing) then toggle_check("auto_spacing")
                 elseif s:find(config.script_info) then show_info()
+                elseif s:find(config.manual_pos) then -- toggle ManPosn Popup
+                    local c = dialog:GetControl(others[4][1])
+                    c:SetSelectedItem((c:GetSelectedItem() + 1) % 3)
                 else
                     local matched = false
-                    for _, array in ipairs{{checks, toggle_check}, {unisons, toggle_unison}} do
+                    for _, t in ipairs{{checks, toggle_check}, {unisons, toggle_unison}} do
                         if not matched then
-                            for _, v in ipairs(array[1]) do
+                            for _, v in ipairs(t[1]) do
                                 if s:find(config[tostring(v[1])]) then
-                                    array[2](v[1])
+                                    t[2](v[1]) -- run the matching toggle subroutine
                                     matched = true
                                     break
                                 end
                             end
                         end
                     end
                 end
-            else -- save new "clean" numnber
+            else -- save new "clean" number
                 saved = s:sub(1, 8):lower() -- 8-chars max
             end
             ctl:SetText(saved)
         end
-    cstat(0, y, "THE " .. name:upper(), 160, "title")
+    cstat(10, y, name:upper(), 155, "title")
     dy(25)
     cstat(0, y, "Avoid Collisions of:", x[3])
     dialog:CreateButton(x[2] + x[3] - 50, y, "q"):SetText("?"):SetWidth(20)
         :AddHandleCommand(function() show_info() end)
     dy()
     for _, v in ipairs(checks) do
         cstat(0, y, config[v[1]], x[1], "T" .. v[1])
-        ccheck(x[1], y, v[1], v[3], x[3], (prefs[v[1]] and 1 or 0))
+        ccheck(x[1], y, v[1], v[3], x[3], (spacing_prefs[v[1]] and 1 or 0))
         dy()
     end
     cstat(x[1], y, "Unison Noteheads:", x[3])
     dy()
     for _, v in ipairs(unisons) do
         local id = tostring(v[1])
         cstat(x[1], y, config[id], x[2], "T" .. v[1])
-        ccheck(x[2], y, id, v[3], x[3] - x[1], (prefs.UnisonsMode == v[1]) and 1 or 0)
-        dialog:GetControl(id)
-            :AddHandleCommand(function() toggle_unison(v[1]) end)
+        ccheck(x[2], y, id, v[3], x[3] - x[1], (spacing_prefs.UnisonsMode == v[1]) and 1 or 0)
+        dialog:GetControl(id):AddHandleCommand(function() toggle_unison(v[1]) end)
         dy()
     end
     dy(8)
     cstat(0, y, "Max Width:", x[2] + 25)
-    dialog:CreateMeasurementEdit(x[2] + 27, y - m_offset, "max_width")
-        :SetWidth(90):SetMeasurementInteger(prefs.MaxMeasureWidth)
+    dialog:CreateMeasurementEdit(x[2] + 27, y - m_offset, "max_width"):SetWidth(105)
+        :SetMeasurementInteger(spacing_prefs.MaxMeasureWidth)
         :AddHandleCommand(function(self) key_check(self) end)
     saved = dialog:GetControl("max_width"):GetText()
     dy(25)
     cstat(x[2] - 10, y, "Units:", 37)
-    dialog:CreateMeasurementUnitPopup(x[2] + 27, y, "popup"):SetWidth(90)
+    dialog:CreateMeasurementUnitPopup(x[2] + 27, y, "popup"):SetWidth(105)
         :AddHandleCommand(function()
             saved = dialog:GetControl("max_width"):GetText()
         end)
     dy(25)
+    cstat(3, y, "Man. Posn:", x[2] + 27) -- "Manual Positioning" popup
+    local manpos = dialog:CreatePopup(x[2] + 27, y, others[4][1]):SetWidth(105)
+    fill_pos_popup() -- add menu items
+    dy(25)
     cstat(0, y, config.change_hotkeys, x[2], "Tchange_hotkeys")
     dialog:CreateButton(x[1], y):SetText("Change Hotkeys"):SetWidth(100)
         :AddHandleCommand(function() change_keys() end)
     dy(22)
-    local val = others[2]
+    local val = others[2] -- AUTOMATIC MUSIC SPACING
     cstat(0, y, config[val[1]], x[1], "T" .. val[1])
-    ccheck(x[1], y, val[1], val[3], x[3], (gen_prefs[val[1]] and 1 or 0))
+    ccheck(x[1], y, val[1], val[3], x[3], (gen_prefs.AutomaticMusicSpacing and 1 or 0))
 
     dialog:CreateOkButton()
     dialog:CreateCancelButton()
     dialog_set_position(dialog)
     dialog:RegisterInitWindow(function(self)
         self:GetControl("max_width"):SetKeyboardFocus()
-        local q = self:GetControl("q")
-        local bold = q:CreateFontInfo():SetBold(true)
-        q:SetFont(bold)
+        local bold = self:GetControl("q"):CreateFontInfo():SetBold(true)
+        self:GetControl("q"):SetFont(bold)
         self:GetControl("title"):SetFont(bold)
     end)
     dialog:RegisterHandleOkButtonPressed(function(self)
         for _, v in ipairs(checks) do
-            prefs[v[1]] = (self:GetControl(v[1]):GetCheck() == 1)
+            spacing_prefs[v[1]] = (self:GetControl(v[1]):GetCheck() == 1)
         end
         for _, v in ipairs(unisons) do
             if (self:GetControl(tostring(v[1])):GetCheck() == 1) then
-                prefs.UnisonsMode = v[1] -- matched the active Mode setting
+                spacing_prefs.UnisonsMode = v[1] -- matched the active Mode setting
                 break
             end
         end
         local n = self:GetControl("max_width"):GetMeasurementInteger()
-        prefs.MaxMeasureWidth = math.max(n, 50)
-        prefs:Save()
-        gen_prefs.AutomaticMusicSpacing = (self:GetControl("AutomaticMusicSpacing"):GetCheck() == 1)
+        spacing_prefs.MaxMeasureWidth = math.max(n, 50)
+        spacing_prefs.ManualPositioning = manpos:GetSelectedItem()
+        spacing_prefs:Save()
+        gen_prefs.AutomaticMusicSpacing = (self:GetControl("auto_spacing"):GetCheck() == 1)
         gen_prefs:Save()
         config.measurement_unit = self:GetMeasurementUnit()
     end)