chore: autopublish 2025-06-24T16:15:42Z

Author: github-actions[bot]

docs/library/client.md

@@ -61,7 +61,7 @@ version.
 client.supports(feature)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/client.lua#L130)
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/client.lua#L134)
 
 Checks the client supports a given feature. Returns true if the client
 supports the feature, false otherwise.
@@ -84,7 +84,7 @@ For a list of valid features, see the [`features` table in the codebase](https:/
 client.assert_supports(feature)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/client.lua#L151)
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/client.lua#L155)
 
 Asserts that the client supports a given feature. If the client doesn't
 support the feature, this function will throw an friendly error then
@@ -108,7 +108,7 @@ For a list of valid features, see the [`features` table in the codebase](https:/
 client.encode_with_client_codepage(input_string)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/client.lua#L180)
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/client.lua#L184)
 
 If the client supports `luaosutils`, the filepath is encoded from utf8 to the current client
 encoding. On macOS, this is always also utf8, so the situation where the string may be re-encoded
@@ -134,7 +134,7 @@ with the client codepage.
 client.encode_with_utf8_codepage(input_string)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/client.lua#L206)
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/client.lua#L210)
 
 If the client supports `luaosutils`, the filepath is encoded from the current client encoding
 to utf8. On macOS, the client encoding is always also utf8, so the situation where the string may
@@ -160,7 +160,7 @@ with the client codepage.
 client.execute(command)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/client.lua#L228)
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/client.lua#L232)
 
 If the client supports `luaosutils`, the command is executed using `luaosutils.execute`. Otherwise it uses `io.popen`.
 In either case, the output from the command is returned.

docs/library/general_library.md

@@ -17,7 +17,8 @@
 - [get_score()](#get_score)
 - [get_page_format_prefs()](#get_page_format_prefs)
 - [get_smufl_font_list()](#get_smufl_font_list)
-- [get_smufl_metadata_file(font_info)](#get_smufl_metadata_file)
+- [get_smufl_metadata_file(font_info_or_name)](#get_smufl_metadata_file)
+- [get_smufl_metadata_json(font_info_or_name)](#get_smufl_metadata_json)
 - [is_font_smufl_font(font_info)](#is_font_smufl_font)
 - [simple_input(title, text, default)](#simple_input)
 - [is_finale_object(object)](#is_finale_object)
@@ -288,26 +289,44 @@ the .json files for each font. The table is in the format:
 ### get_smufl_metadata_file
 
 ```lua
-library.get_smufl_metadata_file(font_info)
+library.get_smufl_metadata_file(font_info_or_name)
 ```
 
 [View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L375)
 
 | Input | Type | Description |
 | ----- | ---- | ----------- |
-| `font_info` (optional) | `FCFontInfo` | if non-nil, the font to search for; if nil, search for the Default Music Font |
+| `font_info_or_name` (optional) | `FCFontInfo` | or (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 |
 
 | Return type | Description |
 | ----------- | ----------- |
 | `file handle\\|nil` |  |
 
+### get_smufl_metadata_json
+
+```lua
+library.get_smufl_metadata_json(font_info_or_name)
+```
+
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L-1)
+
+@ [string] the key of the subtable to return from the json
+
+| Input | Type | Description |
+| ----- | ---- | ----------- |
+| `font_info_or_name` (optional) | `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 |
+
+| Return type | Description |
+| ----------- | ----------- |
+| `table\\|nil` |  |
+
 ### is_font_smufl_font
 
 ```lua
 library.is_font_smufl_font(font_info)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L400)
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L431)
 
 | Input | Type | Description |
 | ----- | ---- | ----------- |
@@ -323,7 +342,7 @@ library.is_font_smufl_font(font_info)
 library.simple_input(title, text, default)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L430)
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L461)
 
 Creates a simple dialog box with a single 'edit' field for entering values into a script, similar to the old UserValueInput command. Will automatically resize the width to accomodate longer strings.
 
@@ -341,7 +360,7 @@ Creates a simple dialog box with a single 'edit' field for entering values into
 library.is_finale_object(object)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L475)
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L506)
 
 Attempts to determine if an object is a Finale object through ducktyping
 
@@ -359,7 +378,7 @@ Attempts to determine if an object is a Finale object through ducktyping
 library.get_parent_class(classname)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L488)
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L519)
 
 Returns the name of the parent of a class.
 
@@ -377,7 +396,7 @@ Returns the name of the parent of a class.
 library.get_class_name(object)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L523)
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L556)
 
 Returns the real class name of a Finale object. Some classes in older JW/RGPLua versions have incorrect class names, so this function attempts to resolve them with ducktyping
 
@@ -395,7 +414,7 @@ Returns the real class name of a Finale object. Some classes in older JW/RGPLua
 library.system_indent_set_to_prefs(system, page_format_prefs)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L555)
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L588)
 
 Sets the system to match the indentation in the page preferences currently in effect. (For score or part.)
 The page preferences may be provided optionally to avoid loading them for each call.
@@ -415,7 +434,7 @@ The page preferences may be provided optionally to avoid loading them for each c
 library.calc_script_filepath()
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L579)
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L612)
 
 Returns the full filepath of the running script.
 
@@ -429,7 +448,7 @@ Returns the full filepath of the running script.
 library.calc_script_name(include_extension)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L600)
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L633)
 
 Returns the running script name, with or without extension.
 
@@ -447,7 +466,7 @@ Returns the running script name, with or without extension.
 library.get_default_music_font_name()
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L622)
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/general_library.lua#L655)
 
 Fetches the default music font from document options and processes the name into a usable format.
 

docs/library/smufl_glyphs.md

@@ -0,0 +1,47 @@
+# SMuFL Glyphs
+
+Provides immediate Lua access to the glyph names in the SMuFL `glyphnames.json` file.
+The `glyphs` and `by_codepoint` tables were programmatically generated from it.
+
+## Functions
+
+- [get_glyph_info(codepoint_or_name, font_info_or_name)](#get_glyph_info)
+- [iterate_glyphs()](#iterate_glyphs)
+
+### get_glyph_info
+
+```lua
+smufl_glyphs.get_glyph_info(codepoint_or_name, font_info_or_name)
+```
+
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/smufl_glyphs.lua#L5892)
+
+Returns the SMuFL glyph name and a new table containing the `codepoint` and its `description`.
+
+| Input | Type | Description |
+| ----- | ---- | ----------- |
+| `codepoint_or_name` | `string\|number` | the name or codepoint for a SMuFL glyph |
+| `font_info_or_name` (optional) | `string` | or (font_info) the SMuFL font to search for optional glyphs |
+
+| Return type | Description |
+| ----------- | ----------- |
+| `string` | The glyph name |
+| `table` | The glyph information |
+
+### iterate_glyphs
+
+```lua
+smufl_glyphs.iterate_glyphs()
+```
+
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/smufl_glyphs.lua#L5938)
+
+Returns an iterator over the standard SMuFL glyphs as defined in glyphnames.json.
+
+Each iteration returns:
+1. The glyph name (string)
+2. A new table with `codepoint` and `description`
+
+| Return type | Description |
+| ----------- | ----------- |
+| `function` | An iterator over (string, table) |

docs/library/utils.md

@@ -25,6 +25,8 @@ A library of general Lua utility functions.
 - [win_mac(windows_value, mac_value)](#win_mac)
 - [split_file_path(full_path)](#split_file_path)
 - [eachfile(directory_path)](#eachfile)
+- [parse_codepoint(codepoint_string)](#parse_codepoint)
+- [format_codepoint(codepoint)](#format_codepoint)
 
 ### copy_table
 
@@ -424,3 +426,39 @@ Generates a runtime error for plugin versions before RGP Lua 0.68.
 | Return type | Description |
 | ----------- | ----------- |
 | `function` | iterator function to be used in for loop. |
+
+### parse_codepoint
+
+```lua
+utility_functions.parse_codepoint(codepoint_string)
+```
+
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/utils.lua#L568)
+
+Returns a Unicode codepoint as a number.
+
+| Input | Type | Description |
+| ----- | ---- | ----------- |
+| `codepoint_string` | `string` | A string in the form "U+FFFF" representing the codepoint |
+
+| Return type | Description |
+| ----------- | ----------- |
+| `number` | the codepoint as a number |
+
+### format_codepoint
+
+```lua
+utility_functions.format_codepoint(codepoint)
+```
+
+[View source](https://github.com/finale-lua/lua-scripts/tree/refs/heads/master/src/library/utils.lua#L580)
+
+Formats a Unicode codepoint into a string like "U+FFFF"
+
+| Input | Type | Description |
+| ----- | ---- | ----------- |
+| `codepoint` | `number` | A string in the form "U+FFFF" representing the codepoint |
+
+| Return type | Description |
+| ----------- | ----------- |
+| `number` | the codepoint as a number |