font mapper code complete

rpatters1 · rpatters1 · commit 24138cc072e0 · 2025-06-24T10:06:37.000-05:00
diff --git a/src/font_map_legacy.lua b/src/font_map_legacy.lua
@@ -18,6 +18,7 @@ end
 -- luacheck: ignore 11./global_dialog
 
 local utils = require("library.utils")
+local client = require("library.client")
 local library = require("library.general_library")
 local mixin = require("library.mixin")
 local smufl_glyphs = require("library.smufl_glyphs")
@@ -31,19 +32,14 @@ context = {
     current_directory = finenv.RunningLuaFolderPath()
 }
 
-local function format_codepoint(cp)
-    local codepoint_desc = "[" .. string.format("U+%04X", cp) .. "]"
-    local glyph_name = smufl_glyphs.get_glyph_info(cp)
-    if glyph_name then
-        return "'" .. glyph_name .. "' " .. codepoint_desc
+local function format_mapping(mapping)
+    local codepoint_desc = "[" .. utils.format_codepoint(mapping.codepoint) .. "]"
+    if mapping.glyph then
+        return "'" ..  mapping.glyph .. "' " .. codepoint_desc
     end
     return codepoint_desc
 end
 
-local function parse_codepoint(codepoint_string)
-    return tonumber(codepoint_string:match("U%+(%x+)"), 16)
-end
-
 local function enable_disable(dialog)
     local delable = #(dialog:GetControl("legacy_box"):GetText()) > 0
     local addable = delable and #(dialog:GetControl("smufl_box"):GetText()) > 0
@@ -90,7 +86,8 @@ end
 
 local function on_popup(popup)
     local legacy_codepoint = context.popup_keys[popup:GetSelectedItem() + 1] or 0
-    local smufl_codepoint = legacy_codepoint > 0 and context.current_mapping[legacy_codepoint] or 0
+    local current_mapping = legacy_codepoint > 0 and context.current_mapping[legacy_codepoint]
+    local smufl_codepoint = current_mapping and current_mapping.codepoint or 0
     local dialog = popup:GetParent()
     set_codepoint(dialog:GetControl("legacy_box"), legacy_codepoint)
     set_codepoint(dialog:GetControl("smufl_box"), smufl_codepoint)
@@ -105,7 +102,7 @@ local function update_popup(popup, current_codepoint)
     popup:Clear()
     local current_index
     for k, v in ipairs(context.popup_keys) do
-        popup:AddString(tostring(v) .. " maps to " .. format_codepoint(context.current_mapping[v]))
+        popup:AddString(tostring(v) .. " maps to " .. format_mapping(context.current_mapping[v]))
         if v == current_codepoint then
             current_index = k - 1
         end
@@ -138,7 +135,7 @@ local function on_select_file(control)
     local open_dialog = mixin.FCMFileOpenDialog(dialog:CreateChildUI())
         :SetWindowTitle(finale.FCString("Select existing JSON file"))
         :SetInitFolder(finale.FCString(context.current_directory))
-        :AddFilter(finale.FCString("*.json"), finale.FCString("Font Mapping"))
+        :AddFilter(finale.FCString("*.json"), finale.FCString("Legacy Font Mapping"))
     if not open_dialog:Execute() then
         return
     end
@@ -154,16 +151,27 @@ local function on_select_file(control)
         dialog:CreateChildUI():AlertError("Font " .. name .. " is a SMuFL font.", "SMuFL Font")
         return
     end
-    local file = io.open(selected_file.LuaString)
+    local file = io.open(client.encode_with_client_codepage(selected_file.LuaString))
     if file then
         local json_contents = file:read("*a")
         file:close()
         local json = cjson.decode(json_contents)
         context.current_directory = path
         change_font(dialog, font_info)
         context.current_mapping = {}
-        for _, v in pairs(json) do
-            context.current_mapping[tonumber(v.legacyCodepoint)] = parse_codepoint(v.codepoint)
+        for glyph, v in pairs(json) do
+            local t = {}
+            t.glyph = glyph
+            t.codepoint = utils.parse_codepoint(v.codepoint)
+            t.nameIsMakeMusic = v.nameIsMakeMusic
+            if t.codepoint == 0xFFFD then
+                local smufl_box = dialog:GetControl("smufl_box")
+                local _, info = smufl_glyphs.get_glyph_info(glyph, smufl_box:CreateFontInfo())
+                if info then
+                    t.codepoint = info.codepoint
+                end
+            end
+            context.current_mapping[tonumber(v.legacyCodepoint)] = t
         end
         update_popup(dialog:GetControl("mappings"))
     end
@@ -206,13 +214,21 @@ local function on_add_mapping(control)
     local legacy_point = get_codepoint(dialog:GetControl("legacy_box"))
     if legacy_point == 0 then return end
     local smufl_point = get_codepoint(dialog:GetControl("smufl_box"))
-    if (smufl_point == 0) then return end
-    if context.current_mapping[legacy_point] then
-        if finale.YESRETURN ~= dialog:CreateChildUI():AlertYesNo("Symbol " .. legacy_point .. " is already mapped to " .. format_codepoint(smufl_point) .. ". Continue?", "Already Mapped") then
+    if smufl_point == 0 then return end
+    local current_mapping = context.current_mapping[legacy_point]
+    if current_mapping then
+        if finale.YESRETURN ~= dialog:CreateChildUI():AlertYesNo("Symbol " .. legacy_point .. " is already mapped to " .. format_mapping(current_mapping) .. ". Continue?", "Already Mapped") then
             return
         end
     end
-    context.current_mapping[legacy_point] = smufl_point
+    current_mapping = {codepoint = smufl_point}
+    local glyph, info = smufl_glyphs.get_glyph_info(smufl_point, dialog:GetControl("smufl_box"):CreateFontInfo())
+    if info then
+        current_mapping.glyph = glyph
+    else
+        current_mapping.glyph = utils.format_codepoint(smufl_point)
+    end
+    context.current_mapping[legacy_point] = current_mapping
     update_popup(popup, legacy_point)
 end
 
@@ -228,6 +244,84 @@ local function on_delete_mapping(control)
     end
 end
 
+-- use hand-crafted json encoder to control order of elements
+local function emit_json(mapping, reverse_lookup)
+    local function quote(str)
+        return '"' .. tostring(str):gsub('\\', '\\\\'):gsub('"', '\\"') .. '"'
+    end
+
+    local function emit_entry(entry, legacy_codepoint)
+        local parts = {}
+        if type(entry.nameIsMakeMusic) == "boolean" then
+            table.insert(parts, '\t\t"nameIsMakeMusic": ' .. tostring(entry.nameIsMakeMusic))
+        end
+        if entry.codepoint then
+            table.insert(parts, '\t\t"codepoint": ' .. quote(utils.format_codepoint(entry.codepoint)))
+        end
+        table.insert(parts, '\t\t"legacyCodepoint": ' .. quote(tostring(legacy_codepoint)))
+        if entry.description then
+            table.insert(parts, '\t\t"description": ' .. quote(entry.description))
+        else
+            table.insert(parts, '\t\t"description": ' .. quote(""))
+        end
+        return "{\n" .. table.concat(parts, ",\n") .. "\n\t}"
+    end
+
+    local lines = { "{" }
+    local first = true
+    for key, entry in pairsbykeys(mapping) do
+        if reverse_lookup[entry.glyph] then
+            if not first then
+                lines[#lines] = lines[#lines] .. ","  -- ← append comma to previous line
+            end
+            table.insert(lines, "\t" .. quote(entry.glyph) .. ": " .. emit_entry(entry, key))
+            first = false
+        end
+    end
+    table.insert(lines, "}")
+    return table.concat(lines, "\n")
+end
+
+local function on_save(control)
+    local dialog = control:GetParent()
+    if type(context.current_mapping) ~= "table" or not next(context.current_mapping) then
+        dialog:CreateChildUI():AlertInfo("Nothing has been mapped.", "No Mapping")
+        return
+    end
+    local save_dialog = finale.FCFileSaveAsDialog(dialog:CreateChildUI())
+    save_dialog:SetWindowTitle(finale.FCString("Save mapping as"))
+    save_dialog:AddFilter(finale.FCString("*.json"), finale.FCString("Legacy Font Mapping"))
+    save_dialog:SetInitFolder(finale.FCString(context.current_directory))
+    save_dialog:SetFileName(finale.FCString(context.current_font.Name .. ".json"))
+    save_dialog:AssureFileExtension("json")
+    if not save_dialog:Execute() then
+        return
+    end
+    local path_fstr = finale.FCString()
+    save_dialog:GetFileName(path_fstr)
+    local reverse_lookup = {}
+    for legacy_codepoint, info in pairs(context.current_mapping) do
+        if type(info.glyph) ~= "string" then
+            dialog:CreateChildUI():AlertError("No glyph name found for legacy codepoint " .. legacy_codepoint .. ".",
+            "No Glyph Name")
+            return
+        elseif reverse_lookup[info.glyph] then
+            if finale.YESRETURN ~= dialog:CreateChildUI():AlertYesNo("Glyph name " .. info.glyph .. " is mapped more than once. Continue?", "Duplicate Glyph Name") then
+                return
+            end
+        end
+        reverse_lookup[info.glyph] = true
+    end
+    local result = emit_json(context.current_mapping, reverse_lookup)
+    local file = io.open(client.encode_with_client_codepage(path_fstr.LuaString), "w")
+    if not file then
+        dialog:CreateChildUI():AlertError("Unable to write to file " .. path_fstr.LuaString .. ".", "File Error")
+        return
+    end
+    file:write(result)
+    file:close()
+end
+
 function font_map_legacy()
     local dialog = mixin.FCXCustomLuaWindow()
         :SetTitle("Map Legacy Fonts to SMuFL")
@@ -283,14 +377,14 @@ function font_map_legacy()
             on_symbol_select(control:GetParent():GetControl("legacy_box"))
         end)
     dialog:CreateButton(0, current_y + editor_height / 2 - button_height, "add_mapping")
-        :SetText("Add Mapping")
-        :SetWidth(120)
+        :SetText("Add/Update Mapping")
+        :SetWidth(140)
         :SetEnable(false)
         :AssureNoHorizontalOverlap(dialog:GetControl("legacy_box"), editor_width / 2)
         :AddHandleCommand(on_add_mapping)
     dialog:CreateButton(0, current_y + editor_height / 2 + y_increment, "delete_mapping")
         :SetText("Delete Mapping")
-        :SetWidth(120)
+        :SetWidth(140)
         :SetEnable(false)
         :AssureNoHorizontalOverlap(dialog:GetControl("legacy_box"), editor_width / 2)
         :AddHandleCommand(on_delete_mapping)
@@ -311,8 +405,16 @@ function font_map_legacy()
     dialog:CreatePopup(0, current_y, "mappings")
         :StretchToAlignWithRight()
         :AddHandleCommand(on_popup)
-    -- close button
-    dialog:CreateCancelButton("cancel"):SetText("Close")
+    current_y = current_y + button_height + y_increment
+    -- save and close buttons
+    dialog:CreateButton(0, current_y, "save")
+        :SetText("Save...")
+        :DoAutoResizeWidth(0)
+        :AddHandleCommand(on_save)
+    dialog:CreateCloseButton(0, current_y, "close")
+        :SetText("Close")
+        :DoAutoResizeWidth(0)
+        :HorizontallyAlignRightWithFurthest()
     -- registrations
     dialog:RegisterInitWindow(function(self)
         on_smufl_popup(self:GetControl("smufl_list"))
diff --git a/src/library/client.lua b/src/library/client.lua
@@ -111,6 +111,10 @@ local features = {
     luaosutils = {
         test = finenv.EmbeddedLuaOSUtils,
         error = requires_later_plugin_version("the embedded luaosutils library")
+    },
+    cjson = {
+        test = client.get_lua_plugin_version() >= 0.67,
+        error = requires_plugin_version("0.67", "the embedded cjson library"),
     }
 }
 
diff --git a/src/library/general_library.lua b/src/library/general_library.lua
@@ -397,6 +397,31 @@ function library.get_smufl_metadata_file(font_info_or_name)
     return try_prefix(calc_smufl_directory(false))
 end
 
+--[[
+% get_smufl_metadata_json
+
+@ [font_info_or_name] (FCFontInfo|string) if non-nil, the font to search for; if nil, search for the Default Music Font; if string, search for the font by name
+@ [string] the key of the subtable to return from the json
+: (table|nil)
+]]
+function library.get_smufl_metadata_table(font_info_or_name, subkey)
+    if not client.assert_supports("cjson") then
+        return
+    end
+    local cjson = require("cjson")
+    local json_file = library.get_smufl_metadata_file(font_info_or_name)
+    if not json_file then
+        return nil
+    end
+    local contents = json_file:read("*a")
+    json_file:close()
+    local json_table = cjson.decode(contents)
+    if json_table and subkey then
+        return json_table[subkey]
+    end
+    return json_table
+end
+
 --[[
 % is_font_smufl_font
 
diff --git a/src/library/smufl_glyphs.lua b/src/library/smufl_glyphs.lua
@@ -8,7 +8,6 @@ local smufl_glyphs = {}
 
 local utils = require("library.utils")
 local library = require("library.general_library")
-local cjson = require("cjson")
 
 local glyphs = {
     ["articStaccatissimoWedgeBelow"] = {codepoint = 0xE4A9, description = "Staccatissimo wedge below"},
@@ -5880,55 +5879,55 @@ local by_codepoint = {
     [0xEAF5] = "beamAccelRit2",
 }
 
-local function parse_codepoint(codepoint)
-    return tonumber(codepoint:match("U%+(%x+)"), 16)
-end
-
--- Add Finale Maestro optional glyphs.
-local font_metadata_file = library.get_smufl_metadata_file("Finale Maestro")
-if font_metadata_file then
-    local content = font_metadata_file:read("*a")
-    font_metadata_file:close()
-    local font_metadata = cjson.decode(content)
-    local optional_glyphs = font_metadata["optionalGlyphs"]
-    if optional_glyphs then
-        for name, info in pairs(optional_glyphs) do
-            if info.codepoint then
-                local codepoint = parse_codepoint(info.codepoint)
-                if codepoint and not glyphs[name] then
-                    glyphs[name] = {codepoint = codepoint, description = ""}
-                    by_codepoint[codepoint] = name
-                end
-            end
-        end
-    end
-end
-
 --[[
 % get_glyph_info
 
 Returns the SMuFL glyph name and a new table containing the `codepoint` and its `description`.
 
-@ codepoint_or_name (string) or (number) the name or codepoint for a SMuFL glyph
+@ codepoint_or_name (string|number) the name or codepoint for a SMuFL glyph
+@ [font_info_or_name] (string) or (font_info) the SMuFL font to search for optional glyphs
 : (string) The glyph name
 : (table) The glyph information
 ]]
-function smufl_glyphs.get_glyph_info(codepoint_or_name)
-    local name, info
+function smufl_glyphs.get_glyph_info(codepoint_or_name, font_info_or_name)
+    local name
     if type(codepoint_or_name) == "number" then
         name = by_codepoint[codepoint_or_name]
-        info = name and glyphs[name]
     elseif type(codepoint_or_name) == "string" then
         name = codepoint_or_name
-        info = glyphs[codepoint_or_name]
+    end
+    local info = name and glyphs[name]
+    if not info and font_info_or_name then
+        local optional_glyphs = library.get_smufl_metadata_table(font_info_or_name, "optionalGlyphs")
+        if optional_glyphs then
+            if type(codepoint_or_name) == "number" then
+                for k, v in pairs(optional_glyphs) do
+                    if v.codepoint then
+                        local codepoint = utils.parse_codepoint(v.codepoint)
+                        if codepoint == codepoint_or_name then
+                            name = k
+                            info = { codepoint = codepoint, description = "", optional = true }
+                            break
+                        end
+                    end
+                end
+            elseif type(codepoint_or_name) == "string" then
+                name = codepoint_or_name
+                local optinfo = optional_glyphs[name]
+                if optinfo and optinfo.codepoint then
+                    local codepoint = utils.parse_codepoint(optinfo.codepoint)
+                    info = codepoint and {codepoint = codepoint, description = "", optional = true}
+                end
+            end
+        end
     end
     return name, info and utils.copy_table(info) or nil
 end
 
 --[[
 % iterate_glyphs
 
-Returns an iterator over all SMuFL glyphs.
+Returns an iterator over the standard SMuFL glyphs as defined in glyphnames.json.
 
 Each iteration returns:
 1. The glyph name (string)
diff --git a/src/library/utils.lua b/src/library/utils.lua
diff --git a/src/smufl_load_engraving_defaults.lua b/src/smufl_load_engraving_defaults.lua

Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,10 @@ local features = {`
`111`	`111`	`luaosutils = {`
`112`	`112`	`test = finenv.EmbeddedLuaOSUtils,`
`113`	`113`	`error = requires_later_plugin_version("the embedded luaosutils library")`
	`114`	`+ },`
	`115`	`+ cjson = {`
	`116`	`+ test = client.get_lua_plugin_version() >= 0.67,`
	`117`	`+ error = requires_plugin_version("0.67", "the embedded cjson library"),`
`114`	`118`	`}`
`115`	`119`	`}`
`116`	`120`