Merge pull request finale-lua#673 from rpatters1/RGP-more-lint

lint fixes

Author: rpatters1

.luacheckrc

@@ -1,5 +1,5 @@
 -- luacheck: ignore 131
-include_files = { "src/**/*.lua"}
+include_files = { "src/**/*.lua", "samples/**/*.lua"}
 exclude_files = {
     "mobdebug.lua",
     "src/lunajson/**/*.lua",

samples/data_list_control.lua

@@ -90,15 +90,15 @@ x_inc = 70
 local toggle_row_colors = dlg:CreateButton(x, y)
 toggle_row_colors:SetText(finale.FCString("row colors"))
 toggle_row_colors:SetWidth(x_inc - x_sep)
-dlg:RegisterHandleControlEvent(toggle_row_colors, function(control)
+dlg:RegisterHandleControlEvent(toggle_row_colors, function(_control)
     data_list.AlternatingBackgroundRowColors = not data_list.AlternatingBackgroundRowColors
     data_list:SetKeyboardFocus()
 end)
 x = x + x_inc
 local select_row_random = dlg:CreateButton(x, y)
 select_row_random:SetText(finale.FCString("random row"))
 select_row_random:SetWidth(x_inc - x_sep)
-dlg:RegisterHandleControlEvent(select_row_random, function(control)
+dlg:RegisterHandleControlEvent(select_row_random, function(_control)
     local random_row_index = math.floor(math.random() * numrows)
     data_list:SelectLine(random_row_index)
     data_list:SetKeyboardFocus()
@@ -107,10 +107,10 @@ x = x + x_inc
 local unsel_first = dlg:CreateButton(x, y)
 unsel_first:SetText(finale.FCString("unsel 1st"))
 unsel_first:SetWidth(x_inc - x_sep)
-dlg:RegisterHandleControlEvent(unsel_first, function(control)
-    for x = 0, data_list:GetCount() - 1 do
-        if data_list:IsLineSelected(x) then
-            data_list:UnselectLine(x)
+dlg:RegisterHandleControlEvent(unsel_first, function(_control)
+    for rowx = 0, data_list:GetCount() - 1 do
+        if data_list:IsLineSelected(rowx) then
+            data_list:UnselectLine(rowx)
             break
         end
     end
@@ -120,12 +120,12 @@ x = x + x_inc
 local unsel_all = dlg:CreateButton(x, y)
 unsel_all:SetText(finale.FCString("unsel all"))
 unsel_all:SetWidth(x_inc - x_sep)
-dlg:RegisterHandleControlEvent(unsel_all, function(control)
+dlg:RegisterHandleControlEvent(unsel_all, function(_control)
     data_list:UnselectAll()
     data_list:SetKeyboardFocus()
 end)
-x = x + x_inc
-y = y + y_inc
+x = x + x_inc -- luacheck: ignore
+y = y + y_inc -- luacheck: ignore
 -- registrations
 local function on_item_selected()
     local index = data_list:GetSelectedLine()
@@ -139,23 +139,23 @@ local function on_item_selected()
         end
     end
 end
-dlg:RegisterHandleListDoubleClick(function(control)
+dlg:RegisterHandleListDoubleClick(function(_control)
     on_item_selected()
 end)
-dlg:RegisterHandleListEnterKey(function(control)
+dlg:RegisterHandleListEnterKey(function(_control)
     on_item_selected()
     return true
 end)
-dlg:RegisterHandleKeyboardCommand(function(control, character)
+dlg:RegisterHandleKeyboardCommand(function(_control, character)
     local charstr = utf8.char(character)
     show_kbd_command:SetText(finale.FCString(charstr))
     return charstr == "N" or charstr == "W" -- eat "N" and "W"
 end)
-dlg:RegisterHandleDataListSelect(function(control, line_index)
+dlg:RegisterHandleDataListSelect(function(_control, line_index)
     show_selection:SetText(finale.FCString("selected " .. line_index .. "(" .. data_list:GetSelectedLine() .. ")"))
 end)
 if usecheckboxes then
-    dlg:RegisterHandleDataListCheck(function(control, line_index, state)
+    dlg:RegisterHandleDataListCheck(function(_control, line_index, state)
         local state_str = state and "checked " or "unchecked "
         show_checkbox:SetText(finale.FCString(state_str .. line_index))
     end)
@@ -171,19 +171,19 @@ dlg:ExecuteModal(nil)
 
 local checked_str = ""
 local selected_str = ""
-for x = 0, data_list:GetCount() - 1 do
-    if data_list:IsLineSelected(x) then
+for rowx = 0, data_list:GetCount() - 1 do
+    if data_list:IsLineSelected(rowx) then
         if #selected_str > 0 then
             selected_str = selected_str .. ", "
         end
-        selected_str = selected_str .. x
+        selected_str = selected_str .. rowx
     end
-    local row = data_list:GetItemAt(x)
+    local row = data_list:GetItemAt(rowx)
     if row.Check then
         if #checked_str > 0 then
             checked_str = checked_str .. ", "
         end
-        checked_str = checked_str .. x
+        checked_str = checked_str .. rowx
     end
 end
 if finenv.ConsoleIsAvailable then

samples/modeless_dialog.lua

@@ -65,7 +65,7 @@ local function create_dialog()
         end)
 
     dlg:RegisterHandleControlEvent(do_something,
-        function(control)
+        function(_control)
             local grp1 = global_dialog:GetControl("radio1")
             print("radio group 1 selected item: " .. grp1:GetSelectedItem())
             local grp2 = global_dialog:GetControl("radio2")
@@ -128,7 +128,7 @@ local function create_dialog()
     )
 
     dlg:RegisterOSMenuCommandExecuted(function(menucmd, cmdtype)
-            local cmdstr = ""
+            local cmdstr
             if finenv.UI():IsOnMac() then
                 cmdstr = string.char(
                             bit32.extract(menucmd, 24, 8),

samples/text_editor_control.lua

@@ -1,6 +1,6 @@
 function plugindef()
     finaleplugin.RequireDocument = true -- Load Text Metrics crashes Finale (and doesn't work) if no document is open
-    finaleplugin.MinJWLuaVersion = 0.68
+    finaleplugin.MinJWLuaVersion = 0.71
     return "0--text_editor_control.lua"
 end
 
@@ -41,7 +41,7 @@ print(edit_text:GetControlID())
 local tabstop_width = calc_tab_width(edit_font, 4)
 edit_text:SetTabstopWidth(tabstop_width)
 edit_text:SetAutomaticEditing(true)
-dlg:RegisterHandleControlEvent(edit_text, function(control)
+dlg:RegisterHandleControlEvent(edit_text, function(_control)
 --        local finale.FCString = control:CreateEnigmaString()
 --        print("Got Enigma String: "..finale.FCString.LuaString)
     end)
@@ -53,7 +53,7 @@ local non_bmp_text = [[𝒜𝓈 𝒸𝒽
 𝓊𝓃𝓈𝑒
 𝓉𝓈 𝒾𝓃 𝓉𝒽𝑒 𝓋𝒶𝓈𝓉 𝒾𝓃𝓉𝓸 𝓉𝒽𝑒 𝓊𝓃𝓀𝓃𝑜𝓌𝓃
 𝒾𝓈 𝒶 𝒷𝑒𝒶𝓊𝓉𝒾𝒻𝓊𝓁 𝓂𝒶𝑔𝒾𝒸 𝑜𝒻 𝒸𝒽𝒶𝓇𝒶𝒸𝓉𝑒𝓇𝓈.]]
-local long_line_text = "This is a test. Now is the time for a very long string to come to the aid and comfort of their friends and enemies to create a very, very long string."
+local long_line_text = "This is a test. Now is the time for a very long string to come to the aid and comfort of their friends and enemies to create a very, very long string." -- luacheck: ignore
 local rtf_text = [[{\rtf1\ansi
 This is some {\b bold} text.
 This is some {\i italic} text.
@@ -80,40 +80,41 @@ dlg:RegisterHandleControlEvent(enabler, function(control)
     end)
 local visifier = dlg:CreateButton(90, 200)
 visifier:SetText(finale.FCString("Visible"))
-dlg:RegisterHandleControlEvent(visifier, function(control)
+dlg:RegisterHandleControlEvent(visifier, function(_control)
         edit_text:SetVisible(not edit_text:GetVisible())
         enabler:SetVisible(not enabler:GetVisible())
         edit_text:SetKeyboardFocus()
     end)
 local readonly = dlg:CreateButton(170, 200)
 readonly:SetText(finale.FCString("Readonly"))
-dlg:RegisterHandleControlEvent(readonly, function(control)
+dlg:RegisterHandleControlEvent(readonly, function(_control)
         edit_text:SetReadOnly(not edit_text:GetReadOnly())
         edit_text:SetKeyboardFocus()
     end)
 local sizer = dlg:CreateButton(250, 200)
 sizer:SetText(finale.FCString("Size"))
-dlg:RegisterHandleControlEvent(sizer, function(control)
-        if not glob_size then glob_size = 10 end
-        glob_size = glob_size * 1.25
-        edit_text:SetFontSizeForSelection(glob_size)
+local size_incrementer
+dlg:RegisterHandleControlEvent(sizer, function(_control)
+        if not size_incrementer then size_incrementer = 10 end
+        size_incrementer = size_incrementer * 1.25
+        edit_text:SetFontSizeForSelection(size_incrementer)
     end)
 local copier = dlg:CreateButton(330, 200)
 copier:SetText(finale.FCString("Copy"))
-dlg:RegisterHandleControlEvent(copier, function(control)
+dlg:RegisterHandleControlEvent(copier, function(_control)
         edit_text:TextToClipboard()
     end)
 local replacer = dlg:CreateButton(10, 225)
 replacer:SetText(finale.FCString("Replace"))
-dlg:RegisterHandleControlEvent(replacer, function(control)
+dlg:RegisterHandleControlEvent(replacer, function(_control)
         if not edit_text:ReplaceSelectedText(finale.FCString("*** replaced\ntext ***")) then
             print("ReplaceSelectedText failed because no selected text.")
         end
         edit_text:SetKeyboardFocus()
     end)
 local restorer = dlg:CreateButton(90, 225)
 restorer:SetText(finale.FCString("Restore"))
-dlg:RegisterHandleControlEvent(restorer, function(control)
+dlg:RegisterHandleControlEvent(restorer, function(_control)
 --        local vers1 = finale.FCVerseLyricsText()
 --        if not vers1:Load(1) then print("lyrics load failed") end
 --        local versstr = vers1:CreateString()
@@ -125,21 +126,21 @@ dlg:RegisterHandleControlEvent(restorer, function(control)
     end)
 local inserter = dlg:CreateButton(170, 225)
 inserter:SetText(finale.FCString("Insert"))
-dlg:RegisterHandleControlEvent(inserter, function(control)
+dlg:RegisterHandleControlEvent(inserter, function(_control)
         edit_text:InsertTextAtCursor(finale.FCString("*** inserted text ***"))
         edit_text:SetKeyboardFocus()
     end)
 local selectall = dlg:CreateButton(250, 225)
 selectall:SetText(finale.FCString("SelAll"))
-dlg:RegisterHandleControlEvent(selectall, function(control)
+dlg:RegisterHandleControlEvent(selectall, function(_control)
         local range = finale.FCRange()
         edit_text:GetTotalTextRange(range)
         edit_text:SetSelection(range)
         edit_text:SetKeyboardFocus()
     end)
 local tabber = dlg:CreateButton(10, 250)
 tabber:SetText(finale.FCString("Tabs"))
-dlg:RegisterHandleControlEvent(tabber, function(control)
+dlg:RegisterHandleControlEvent(tabber, function(_control)
         tabstop_width = tabstop_width - 12
         if tabstop_width < 12 then
             tabstop_width = 12
@@ -171,7 +172,7 @@ dlg:RegisterHandleControlEvent(italicer, function(control)
 local locinfo = dlg:CreateButton(330, 250)
 locinfo:SetText(finale.FCString("Loc."))
 locinfo:SetWidth(70)
-dlg:RegisterHandleControlEvent(locinfo, function(control)
+dlg:RegisterHandleControlEvent(locinfo, function(_control)
         local selrange = finale.FCRange()
         edit_text:GetSelection(selrange)
         local posrange = finale.FCRange()
@@ -195,7 +196,7 @@ wordonly:SetWidth(70)
 local igncase = dlg:CreateCheckbox(250, 275)
 igncase:SetText(finale.FCString("Ign Case"))
 igncase:SetWidth(70)
-dlg:RegisterHandleControlEvent(finder, function(control)
+dlg:RegisterHandleControlEvent(finder, function(_control)
         local str = finale.FCString()
         findtext:GetText(str)
         local options = 0
@@ -223,26 +224,44 @@ dlg:RegisterHandleControlEvent(finder, function(control)
 local dumper = dlg:CreateButton(330, 275)
 dumper:SetText(finale.FCString("DumpText"))
 dumper:SetWidth(70)
-dlg:RegisterHandleControlEvent(dumper, function(control)
+dlg:RegisterHandleControlEvent(dumper, function(_control)
         local range = finale.FCRange()
-        if not edit_text:GetSelection(range) then
+        edit_text:GetSelection(range)
+        if range.Length == 0 then
             edit_text:GetTotalTextRange(range)
         end
+        local raw_string = finale.FCString()
+        edit_text:GetTextInRange(raw_string, range)
+        print("Got Raw String: " .. raw_string.LuaString)
+        local utf16_string = finale.FCString()
+        local i = range.Start
+        while (i < range.End) do
+            local next_char = edit_text:CreateCharacterAtIndex(i)
+            if not next_char then
+                print("GetCharacterAtIndex failed")
+                break
+            end
+            utf16_string:AppendString(next_char)
+            i = i + next_char.Length
+        end
+        if utf16_string.Length > 0 then
+            print("Got Utf16 String: " .. utf16_string.LuaString)
+        end
         local fcstr = edit_text:CreateEnigmaString(range)
         print("Got Enigma String: "..fcstr.LuaString)
     end)
 local colorizer = dlg:CreateButton(10, 300)
 colorizer:SetText(finale.FCString("Sel2Red"))
 colorizer:SetWidth(90)
-dlg:RegisterHandleControlEvent(colorizer, function(control)
+dlg:RegisterHandleControlEvent(colorizer, function(_control)
         local range = finale.FCRange()
         edit_text:GetSelection(range)
         edit_text:SetTextColorInRange(247, 0, 0, range)
     end)
 local find2color = dlg:CreateButton(110, 300)
 find2color:SetText(finale.FCString("Find2Green"))
 find2color:SetWidth(90)
-dlg:RegisterHandleControlEvent(find2color, function(control)
+dlg:RegisterHandleControlEvent(find2color, function(_control)
         local str = finale.FCString()
         findtext:GetText(str)
         local options = 0
@@ -264,7 +283,7 @@ dlg:RegisterHandleControlEvent(find2color, function(control)
 local colorreporter = dlg:CreateButton(210, 300)
 colorreporter:SetText(finale.FCString("Color Starts"))
 colorreporter:SetWidth(90)
-dlg:RegisterHandleControlEvent(colorreporter, function(control)
+dlg:RegisterHandleControlEvent(colorreporter, function(_control)
         local ranges = edit_text:CreateTextColorChanges()
         if not ranges then
             print("No colors returned.")
@@ -281,7 +300,7 @@ dlg:RegisterHandleControlEvent(colorreporter, function(control)
     end)
 local colorreverter = dlg:CreateButton(310, 300)
 colorreverter:SetText(finale.FCString("Default"))
-dlg:RegisterHandleControlEvent(colorreverter, function(control)
+dlg:RegisterHandleControlEvent(colorreverter, function(_control)
         edit_text:SetFont(finale.FCFontInfo("Arial", 12))
         --local range = finale.FCRange()
         --edit_text:GetTotalTextRange(range)
@@ -296,11 +315,10 @@ curr_sel:SetWidth(200)
 dlg:RegisterTextSelectionChanged(function(control)
         local fstr = finale.FCString()
         control:GetSelectedText(fstr) -- if no selection, fstr is unchanged and empty
-        local seltext = fstr.LuaString
-        --print("Selected Text: "..seltext)
+        --print("Selected Text: "..fstr.LuaString)
         curr_sel:SetText(fstr)
     end)
-local ok = dlg:CreateOkButton()
+dlg:CreateOkButton()
 dlg:RegisterInitWindow(function()
         if init_with_rtf then
             edit_text:SetFont(finale.FCFontInfo("Arial", 12))

src/hairpin_creator.lua

@@ -132,18 +132,18 @@ local function extend_region_by_EDU(region, add_duration)
 end
 
 local function duration_gap(measureA, positionA, measureB, positionB)
-    local diff, duration = 0
+    local diff = 0
     if measureA == measureB then -- simple EDU offset
         diff = positionB - positionA
     elseif measureB < measureA then
-        duration = - positionB
+        local duration = - positionB
         while measureB < measureA do -- add up measures until they meet
             duration = duration + measure_width(measureB)
             measureB = measureB + 1
         end
         diff = - duration - positionA
     elseif measureA < measureB then
-        duration = - positionA
+        local duration = - positionA
         while measureA < measureB do
             duration = duration + measure_width(measureA)
             measureA = measureA + 1
@@ -245,15 +245,15 @@ end
 
 local function lowest_note_element(rgn)
     local lowest_vert = -13 * 12 -- at least to bottom of staff
-    local current_measure, top_of_staff, bottom_pos = 0, 0
+    local current_measure, top_of_staff = 0, 0
 
     for entry in eachentry(rgn) do
         if entry:IsNote() then
             if current_measure ~= entry.Measure then  -- new measure, new top of staff vertical
                 current_measure = entry.Measure
                 top_of_staff = calc_top_of_staff(current_measure, entry.Staff)
             end
-            bottom_pos = (entry:CalcLowestStaffPosition() * 12) - config.below_note_cushion
+            local bottom_pos = (entry:CalcLowestStaffPosition() * 12) - config.below_note_cushion
             if entry:CalcStemUp() then -- stem up
                 if lowest_vert > bottom_pos then
                     lowest_vert = bottom_pos
@@ -548,13 +548,13 @@ function create_dialog_box()
     }
 
     local dialog = mixin.FCXCustomLuaWindow():SetTitle("Hairpin Creator Configuration")
-    local y_step, y_current = 20
+    local y_step = 20
     local max_text_width = 385
     local x_offset = {0, 130, 155, 190}
     local mac_offset = finenv.UI():IsOnMac() and 3 or 0 -- horizontal offset for Mac Edit boxes
 
     for i, v in ipairs(dialog_options) do -- run through config parameters
-        y_current = y_step * i
+        local y_current = y_step * i
         local msg = string.gsub(v[1], "_", " ")
         if boolean_options[v[1]] then -- checkboxes
             dialog:CreateCheckbox(x_offset[1], y_current, v[1]):SetText(msg):SetWidth(x_offset[3]):SetCheck(config[v[1]] and 1 or 0)
@@ -573,7 +573,7 @@ function create_dialog_box()
     end
 
     -- measurement unit options
-    y_current = (#dialog_options + 1.6) * y_step
+    local y_current = (#dialog_options + 1.6) * y_step
     dialog:CreateStatic(x_offset[2] - 40, y_current):SetText("Units:")
     dialog:SetMeasurementUnit(config.measurement_unit)
     dialog:CreateMeasurementUnitPopup(x_offset[2], y_current)