lyrics_baseline_spacing.lua

function plugindef()
    finaleplugin.RequireSelection = false
    finaleplugin.Author = "Jacob Winkler" 
    finaleplugin.Copyright = "©2022 Jacob Winkler"
    finaleplugin.AuthorEmail = "jacob.winkler@mac.com"
    finaleplugin.Version = "1.0.1"
    finaleplugin.Date = "2022-07-02"
    return "Lyrics - Space Baselines", "Lyrics - Space Baselines", "Lyrics - Space Baselines"
end



local configuration = require("library.configuration")

config = {all_lyrics = "true"}

local script_name = "lyrics_baseline_spacing"

configuration.get_user_settings(script_name, config, true)

function lyrics_spacing(title)
    local independent_lyrics = false
    local baseline_verse = finale.FCBaseline()
    baseline_verse:LoadDefaultForLyricNumber(finale.BASELINEMODE_LYRICSVERSE,1)
    local verse1_start = -baseline_verse.VerticalOffset
    baseline_verse:LoadDefaultForLyricNumber(finale.BASELINEMODE_LYRICSVERSE,2)
    local verse_gap =  -baseline_verse.VerticalOffset - verse1_start
    --
    local baseline_chorus = finale.FCBaseline()
    baseline_chorus:LoadDefaultForLyricNumber(finale.BASELINEMODE_LYRICSCHORUS,1)
    local chorus1_start = -baseline_chorus.VerticalOffset
    baseline_chorus:LoadDefaultForLyricNumber(finale.BASELINEMODE_LYRICSCHORUS,2)
    local chorus_gap =  -baseline_chorus.VerticalOffset - chorus1_start
    --
    local baseline_section = finale.FCBaseline()
    baseline_section:LoadDefaultForLyricNumber(finale.BASELINEMODE_LYRICSSECTION,1)
    local section1_start = -baseline_section.VerticalOffset
    baseline_section:LoadDefaultForLyricNumber(finale.BASELINEMODE_LYRICSSECTION,2)
    local section_gap = -baseline_section.VerticalOffset - section1_start
    --
    local row_h = 20
    local col_w = 60
    local col_gap = 10
    local str = finale.FCString()
    str.LuaString = title
    local dialog = finale.FCCustomLuaWindow()
    dialog:SetTitle(str)

    local row = {}
    for i = 1, 100 do
        row[i] = (i -1) * row_h
    end
--
    local col = {}
    for i = 1, 20 do
        col[i] = (i - 1) * col_w
    end
--

    local function add_ctrl(dialog, ctrl_type, text, x, y, h, w) -- luacheck: ignore dialog
        str.LuaString = tostring(text)
        local ctrl
        if ctrl_type == "checkbox" then
            ctrl = dialog:CreateCheckbox(x, y)
        elseif ctrl_type == "edit" then
            ctrl = dialog:CreateEdit(x, y - 2)
        elseif ctrl_type == "static" then
            ctrl = dialog:CreateStatic(x, y)
        end
        if ctrl_type == "edit" then
            ctrl:SetHeight(h - 2)
            ctrl:SetWidth(w - col_gap)
        else
            ctrl:SetHeight(h)
            ctrl:SetWidth(w)
        end
        ctrl:SetText(str)
        return ctrl
    end
    

--    local control = add_ctrl(dialog, "static", "TESTING!", col[1], row[2], row_h, col_w, 0, 0)
    local verse_static = add_ctrl(dialog, "static", "All Lyrics", col[3], row[1], row_h, col_w)
    local chorus_static = add_ctrl(dialog, "static", "", col[4], row[1], row_h, col_w)
    local section_static = add_ctrl(dialog, "static", "", col[5], row[1], row_h, col_w)
    --
    add_ctrl(dialog, "static", "Lyric 1 baseline:", col[1] + 31, row[2], row_h, col_w * 2)
    local verse1_edit = add_ctrl(dialog, "edit", verse1_start, col[3], row[2], row_h, col_w)  
    local chorus1_edit = add_ctrl(dialog, "edit", chorus1_start, col[4], row[2], row_h, col_w)  
    local section1_edit = add_ctrl(dialog, "edit", section1_start, col[5], row[2], row_h, col_w)
    --
    add_ctrl(dialog, "static", "Gap:", col[2] + 29, row[3], row_h, col_w)
    local verse_gap_edit = add_ctrl(dialog, "edit", verse_gap, col[3], row[3], row_h, col_w)  
    local chorus_gap_edit = add_ctrl(dialog, "edit", chorus_gap, col[4], row[3], row_h, col_w)  
    local section_gap_edit = add_ctrl(dialog, "edit", section_gap, col[5], row[3], row_h, col_w)  
    --
    add_ctrl(dialog, "static", "Edit all:", col[2] + 14, row[4], row_h, col_w)
    local all_lyrics_check = add_ctrl(dialog, "checkbox", "", col[3], row[4], row_h, col_w * 2) 

    dialog:CreateOkButton()
    dialog:CreateCancelButton()
    --
    local function apply()
        if config.all_lyrics == true then
            verse1_edit:GetText(str)
            chorus1_edit:SetText(str)
            section1_edit:SetText(str)
            --
            verse_gap_edit:GetText(str)
            chorus_gap_edit:SetText(str)
            section_gap_edit:SetText(str)
        end

        verse1_edit:GetText(str)
        verse1_start = tonumber(str.LuaString) or 0
        chorus1_edit:GetText(str)
        chorus1_start = tonumber(str.LuaString) or 0
        section1_edit:GetText(str)
        section1_start = tonumber(str.LuaString) or 0
--
        verse_gap_edit:GetText(str)
        verse_gap = tonumber(str.LuaString) or 0
        chorus_gap_edit:GetText(str)
        chorus_gap = tonumber(str.LuaString) or 0
        section_gap_edit:GetText(str)
        section_gap = tonumber(str.LuaString) or 0
        --
        for i = 1, 100, 1 do
            baseline_verse:LoadDefaultForLyricNumber(finale.BASELINEMODE_LYRICSVERSE,i)
            baseline_verse.VerticalOffset = -verse1_start - (verse_gap * (i - 1))
            baseline_verse:Save()
            --
            baseline_chorus:LoadDefaultForLyricNumber(finale.BASELINEMODE_LYRICSCHORUS,i)
            baseline_chorus.VerticalOffset = -chorus1_start - (chorus_gap * (i - 1))
            baseline_chorus:Save()
            --
            baseline_section:LoadDefaultForLyricNumber(finale.BASELINEMODE_LYRICSSECTION,i)
            baseline_section.VerticalOffset = -section1_start - (section_gap * (i - 1))
            baseline_section:Save()
        end
    end

    local function update()
        if not config.all_lyrics then
            independent_lyrics = true
            str.LuaString = "Verse"
            verse_static:SetText(str)
            str.LuaString = "Chorus"
            chorus_static:SetText(str)
            str.LuaString = "Section"
            section_static:SetText(str)
            all_lyrics_check:SetCheck(0)
        else
            independent_lyrics = false
            str.LuaString = "All Lyrics"
            verse_static:SetText(str)
            str.LuaString = ""
            chorus_static:SetText(str)
            section_static:SetText(str)
            all_lyrics_check:SetCheck(1)
        end
        chorus1_edit:SetEnable(independent_lyrics)
        section1_edit:SetEnable(independent_lyrics)
        chorus_gap_edit:SetEnable(independent_lyrics)
        section_gap_edit:SetEnable(independent_lyrics)
        --
    end

    local function callback(ctrl)
        if ctrl:GetControlID() == all_lyrics_check:GetControlID()  then

            if all_lyrics_check:GetCheck() == 1 then
                config.all_lyrics = true
            else
                config.all_lyrics = false
            end
            update()
        end
    end -- callback
    --
    dialog:RegisterHandleCommand(callback)
    --
    update()
    if dialog:ExecuteModal(nil) == finale.EXECMODAL_OK then
        apply()
        configuration.save_user_settings(script_name, config)
    end
end -- lyrics_spacing()

lyrics_spacing("Lyrics - Space Baselines")