Update ostinato_maker.lua

Couldn't work out how to "resolve" the previous PR so started fresh. Converted all global variables to local, assorted minor improvements. Now shouldn't require any LINT warnings.

Author: asherber

src/ostinato_maker.lua

@@ -4,8 +4,8 @@ function plugindef()
     finaleplugin.Author = "Carl Vine after Michael McClennan & Jacob Winkler"
     finaleplugin.AuthorURL = "https://carlvine.com/lua/"
     finaleplugin.Copyright = "https://creativecommons.org/licenses/by/4.0/"
-    finaleplugin.Version = "v0.13"
-    finaleplugin.Date = "2024/01/15"
+    finaleplugin.Version = "v0.19"
+    finaleplugin.Date = "2024/01/31"
     finaleplugin.MinJWLuaVersion = 0.62
     finaleplugin.Notes = [[
         Copy the current selection and paste it consecutively 
@@ -57,24 +57,25 @@ Key Commands:
 info_notes = info_notes:gsub("\n%s*", " "):gsub("*", "\n"):gsub("@t", "\t")
     .. "\n(" .. finaleplugin.Version .. ")"
 
---luacheck: ignore 11./global_dialog 11./global_selection
-global_timer_id = 1
-
 local configuration = require("library.configuration")
 local mixin = require("library.mixin")
-local script_name = "ostinato_maker"
+local library = require("library.general_library")
+local script_name = library.calc_script_name()
+local dialog, current_selection
 
 local config = {
-    num_repeats  =   1,
+    num_repeats  = 1,
+    timer_id     = 1,
     window_pos_x = false,
     window_pos_y = false,
 }
 local dialog_options = { -- and populate config values (unchecked)
-    "copy_articulations", "copy_expressions", "copy_smartshapes", "copy_lyrics", "copy_chords"
+    "copy_articulations", "copy_expressions", "copy_smartshapes",
+    "copy_lyrics", "copy_chords"
 }
 for _, v in ipairs(dialog_options) do config[v] = 0 end -- (default unchecked)
 
-local bounds = { -- primary region selection boundary
+local bounds = { -- primary region selection boundary properties
     "StartStaff", "StartMeasure", "StartMeasurePos",
     "EndStaff",   "EndMeasure",   "EndMeasurePos",
 }
@@ -87,15 +88,15 @@ local function copy_region_bounds()
     return copy
 end
 
-function dialog_set_position(dialog)
+local function dialog_set_position()
     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
 
-function dialog_save_position(dialog)
+local function dialog_save_position()
     dialog:StorePosition()
     config.window_pos_x = dialog.StoredX
     config.window_pos_y = dialog.StoredY
@@ -276,8 +277,9 @@ local function paste_many_copies()
     local undo_str = "Ostinato Maker " .. selection_id()
     finenv.StartNewUndoBlock(undo_str, false)
     --  ---- DO THE WORK
-    if rgn.EndMeasurePos >= measure_duration(rgn.EndMeasure) then
-        rgn.EndMeasurePos = measure_duration(rgn.EndMeasure) - 1
+    local m_d = measure_duration(rgn.EndMeasure)
+    if rgn.EndMeasurePos >= m_d then
+        rgn.EndMeasurePos = m_d - 1
     end
     rgn:CopyMusic() -- save a copy of the current selection
     local duration = region_duration(rgn)
@@ -309,35 +311,36 @@ end
 local function on_timer()
     local changed = false
     for _, v in ipairs(bounds) do
-        if global_selection[v] ~= finenv.Region()[v] then
+        if current_selection[v] ~= finenv.Region()[v] then
             changed = true
             break
         end
     end
     if changed then
-        global_selection = copy_region_bounds()
-        global_dialog:GetControl("info")
+        current_selection = copy_region_bounds()
+        dialog:GetControl("info")
             :SetText("Selection " .. selection_id() .. "\n" .. staff_id())
     end
 end
 
-local function create_dialog_box()
+local function create_dialog()
     local edit_x, e_wide, y_step = 110, 40, 18
     local y_offset = finenv.UI():IsOnMac() and 3 or 0
-    local save_rpt, answer = config.num_repeats, {}
-    local dialog = mixin.FCXCustomLuaWindow():SetTitle(plugindef())
+    local save_rpt = config.num_repeats
+    local name = plugindef():gsub("%.%.%.", "")
+    dialog = mixin.FCXCustomLuaWindow():SetTitle(name)
     local y = 0
     local function flip_check(id)
-        local ctl = answer[dialog_options[id]]
+        local ctl = dialog:GetControl(dialog_options[id])
         ctl:SetCheck((ctl:GetCheck() + 1) % 2)
     end
     local function check_all_state(state)
         for _, v in ipairs(dialog_options) do
-            answer[v]:SetCheck(state)
+            dialog:GetControl(v):SetCheck(state)
         end
     end
     local function info_dialog()
-        finenv.UI():AlertInfo(info_notes, "About " .. plugindef())
+        finenv.UI():AlertInfo(info_notes, "About " .. name)
     end
     local function key_check(ctl) -- some stray key commands
         local s = ctl:GetText():lower()
@@ -370,40 +373,39 @@ local function create_dialog_box()
         :AddHandleCommand(function(self) key_check(self) end)
     dialog:CreateStatic(e_wide, y + 2):SetText("times"):SetWidth(edit_x)
     for _, v in ipairs(dialog_options) do
-        answer[v] = dialog:CreateCheckbox(edit_x, y):SetCheck(config[v])
+        dialog:CreateCheckbox(edit_x, y, v):SetCheck(config[v])
            :SetText(v:sub(6, -1):gsub("^%l", string.upper)):SetWidth(90)
         y = y + y_step
     end
     local q = dialog:CreateButton(0, y - 19):SetText("?"):SetWidth(20)
         :AddHandleCommand(function() info_dialog() end)
     dialog:CreateOkButton()
     dialog:CreateCancelButton()
-    dialog_set_position(dialog)
+    dialog_set_position()
     dialog:RegisterHandleTimer(on_timer)
     dialog:RegisterInitWindow(function()
         q:SetFont(q:CreateFontInfo():SetBold(true))
         num_repeats:SetKeyboardFocus()
-        dialog:SetTimer(global_timer_id, 125)
+        dialog:SetTimer(config.timer_id, 125)
     end)
     dialog:RegisterCloseWindow(function()
-        dialog_save_position(dialog)
-        dialog:StopTimer(global_timer_id)
+        dialog_save_position()
+        dialog:StopTimer(config.timer_id)
     end)
     dialog:RegisterHandleOkButtonPressed(function()
         config.num_repeats = num_repeats:GetInteger()
         for _, v in ipairs(dialog_options) do
-            config[v] = answer[v]:GetCheck()
+            config[v] = dialog:GetControl(v):GetCheck()
         end
         paste_many_copies()
     end)
-    return dialog
 end
 
 local function make_ostinato()
     configuration.get_user_settings(script_name, config, true)
-    global_selection = global_selection or copy_region_bounds()
-    global_dialog = global_dialog or create_dialog_box()
-    global_dialog:RunModeless()
+    current_selection = copy_region_bounds()
+    create_dialog()
+    dialog:RunModeless()
 end
 
 make_ostinato()