Skip to content

Convert fonts in DMOD_ASSETS_PATHS into .dmvf files #322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JohnAmadis merged 1 commit into from
Oct 4, 2026
Merged

Convert fonts in DMOD_ASSETS_PATHS into .dmvf files #322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/cmake-functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,9 +335,11 @@ The following variables should be set before calling `dmod_add_executable` or `d
- `DMOD_MAL_IMPLS` - List of MAL (Module Abstraction Layer) interfaces implemented
- `DMOD_DIF_IMPLS` - List of DIF (Device Interface) implementations
- `DMOD_COMPRESSION_METHOD` - Compression method for DMFC files (default: "fastlz")
- `DMOD_ASSETS_PATHS` - List of directories with the sources of a module's assets (views, images). When set, they are converted into `DMOD_VIEWS_DIR` (default: `<build>/views`) by the `dmod_assets` target, which the module depends on - with tools `dmf-get` downloads at configure time, only for the kinds of files found:
- `DMOD_ASSETS_PATHS` - List of directories with the sources of a module's assets (views, images, fonts). When set, they are converted into `DMOD_VIEWS_DIR` (default: `<build>/views`) by the `dmod_assets` target, which the module depends on - with tools `dmf-get` downloads at configure time, only for the kinds of files found:
- `*.dmvs` views - `todmv` - `<name>.dmv`;
- images (`DMOD_IMAGE_EXTENSIONS`, default `png jpg jpeg jpe jfif bmp qoi gif tif tiff`) - `todmvi` with the `dmimg` decoder of each extension (`dmimg_png`, `dmimg_jpeg` for `.jpg`, ...; `DMOD_IMAGE_DECODERS` overrides the list) - `<name>.dmvi`, next to the views, so a view finds them by name. An optional `<image>.ini` next to an image (`logo.png.ini`) sets its conversion: `format` (`auto`, `rgb565`, `rgb565a8`, `argb8888`, `i8`, `a8`, `a4`), `size` (`WIDTHxHEIGHT`, scaled down to fit), `compression` (`fastlz`, `none`), `dither` (`on`/`off`). Keys before any section apply to every output; each `[section]` is an output `<section>.dmvi` of its own (e.g. `[logo]` and `[logo-mask]` from one image). Two sources of one output name are a configuration error.
- images (`DMOD_IMAGE_EXTENSIONS`, default `png jpg jpeg jpe jfif bmp qoi gif tif tiff`) - `todmvi` with the `dmimg` decoder of each extension (`dmimg_png`, `dmimg_jpeg` for `.jpg`, ...; `DMOD_IMAGE_DECODERS` overrides the list) - `<name>.dmvi`, next to the views, so a view finds them by name. An optional `<image>.ini` next to an image (`logo.png.ini`) sets its conversion: `format` (`auto`, `rgb565`, `rgb565a8`, `argb8888`, `i8`, `a8`, `a4`), `size` (`WIDTHxHEIGHT`, scaled down to fit), `compression` (`fastlz`, `none`), `dither` (`on`/`off`). Keys before any section apply to every output; each `[section]` is an output `<section>.dmvi` of its own (e.g. `[logo]` and `[logo-mask]` from one image). - fonts (`DMOD_FONT_EXTENSIONS`, default `ttf otf ttc`) - `todmvf` - `.dmvf`, next to the views. A font needs its `<font>.ini` (`Roboto-Regular.ttf.ini`), as a font is made for one pixel size: each `[section]` is an output `<section>.dmvf` with its `size` (pixel size, `4` ... `127`, required) and optional `chars` (codepoint ranges, e.g. `0x20-0x7E,0x104`; default: printable ASCII, Latin-1, Latin Extended-A). A font without an `.ini` is left out with a warning.

Two sources of one output name are a configuration error.

The directory is passed to `mkdmrpkg` as `--views-dir`, so a `.dmr` can use `${views_dir}` to put the assets into the package, e.g. `views=./views => ${views_dir} [origin=${views_dir}]` (`dmf-get` installs them into a per-module directory). Other settings: `DMOD_VIEWS_TOOLS_NAME` (tools name used to fetch the tools, default `arch/x86_64`) and `DMOD_LOADER` (path to `dmod_loader`, which runs them; searched in the tools dir and `PATH` by default). `DMOD_FIXTURES_PATHS` is the old name of `DMOD_ASSETS_PATHS`: still read, with a warning, when `DMOD_ASSETS_PATHS` is not set.
- `DMOD_DMR_PATH` - Path to the `.dmr` resource file. When set, a release package is created in `build/packages/<moduleName>/` and zipped to `build/packages/<moduleName>.zip` after the build. Requires the `mkdmrpkg` tool (build with `-DDMOD_BUILD_TOOLS=ON`).
Expand Down
116 changes: 105 additions & 11 deletions scripts/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ function(to_snake_case INPUT_STRING OUTPUT_VARIABLE)
endfunction()

# ===========================================================================
# Assets conversion: views (.dmvs -> .dmv), images (-> .dmvi)
# Assets conversion: views (.dmvs -> .dmv), images (-> .dmvi), fonts (-> .dmvf)
# ===========================================================================
#
# DMOD_ASSETS_PATHS - list of directories with the sources of a module's
Expand All @@ -188,9 +188,11 @@ endfunction()
# images (DMOD_IMAGE_EXTENSIONS) todmvi -> <name>.dmvi, with the dmimg
# decoder of each extension
# (dmimg_png, dmimg_jpeg, ...)
# fonts (DMOD_FONT_EXTENSIONS) todmvf -> <section>.dmvf for each size in
# its .ini
#
# Everything is placed in DMOD_VIEWS_DIR (default: <build>/views) - images
# next to the views, so a view finds them by their names. DMOD_VIEWS_DIR is
# and fonts next to the views, so a view finds them by their names. DMOD_VIEWS_DIR is
# then available to .dmr files as ${views_dir} (see mkdmrpkg --views-dir).
#
# An image's conversion is set by an optional <image>.ini next to it (e.g.
Expand All @@ -203,6 +205,15 @@ endfunction()
# compression = fastlz | ... | none
# dither = on | off
#
# A font needs its <font>.ini (e.g. Roboto-Regular.ttf.ini), the same way:
# a font is made for one pixel size, so each output has one - each
# [section] a size, <section>.dmvf (without sections: <name>.dmvf). A font
# without an .ini is left out (with a warning):
#
# size = pixel size (em), 4 ... 127 - required
# chars = codepoint ranges, e.g. 0x20-0x7E,0x104 (default: printable
# ASCII, Latin-1, Latin Extended-A)
#
# Related variables:
# DMOD_VIEWS_DIR output directory of the converted assets
# DMOD_VIEWS_TOOLS_NAME tools name used to download the tools (host
Expand All @@ -213,6 +224,7 @@ endfunction()
# jfif bmp qoi gif tif tiff)
# DMOD_IMAGE_DECODERS decoder modules to download (default:
# dmimg_<format> of each extension found)
# DMOD_FONT_EXTENSIONS font file extensions (default: ttf otf ttc)
#
# DMOD_FIXTURES_PATHS is the old name of DMOD_ASSETS_PATHS - still read, with
# a warning, when DMOD_ASSETS_PATHS is not set.
Expand Down Expand Up @@ -279,14 +291,34 @@ function(_dmod_image_option iniPath key value outVar)
set(${outVar} "${ARGS}" PARENT_SCOPE)
endfunction()

# The outputs of an image - <prefix>_NAMES, and <prefix>_ARGS_<name> - from
# its .ini (see above), or one output with the defaults
function(_dmod_image_outputs source prefix)
# todmvf arguments of one font ini key (size is handled by _dmod_asset_outputs)
function(_dmod_font_option iniPath key value outVar)
set(ARGS "")
if(key STREQUAL "chars")
set(ARGS -c ${value})
else()
message(SEND_ERROR "${iniPath}: unknown key '${key}' (size, chars)")
endif()
set(${outVar} "${ARGS}" PARENT_SCOPE)
endfunction()

# The outputs of an asset of a kind (image, font) - <prefix>_NAMES, and
# <prefix>_ARGS_<name>, for fonts also <prefix>_SIZE_<name> - from its .ini
# (see above). Without an .ini: one output with the defaults (an image), or
# none (a font - it has no size).
function(_dmod_asset_outputs kind source prefix)
get_filename_component(NAME "${source}" NAME_WE)
set(INI "${source}.ini")
set(COMMON "")
set(COMMON_SIZE "")
set(SECTIONS "")
if(EXISTS "${INI}")
set(${prefix}_NAMES "" PARENT_SCOPE)
if(NOT EXISTS "${INI}")
if(kind STREQUAL "font")
message(WARNING "${source}: no ${INI} with its sizes - the font is left out")
return()
endif()
else()
set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${INI}")
file(STRINGS "${INI}" LINES)
set(SECTION "")
Expand All @@ -299,8 +331,24 @@ function(_dmod_image_outputs source prefix)
set(SECTION "${CMAKE_MATCH_1}")
list(APPEND SECTIONS "${SECTION}")
set(ARGS_${SECTION} "")
set(SIZE_${SECTION} "")
elseif(LINE MATCHES "^([A-Za-z_]+)[ \t]*=[ \t]*(.*)$")
_dmod_image_option("${INI}" "${CMAKE_MATCH_1}" "${CMAKE_MATCH_2}" OPTION_ARGS)
set(KEY "${CMAKE_MATCH_1}")
set(VALUE "${CMAKE_MATCH_2}")
set(OPTION_ARGS "")
if(kind STREQUAL "font" AND KEY STREQUAL "size")
if(NOT VALUE MATCHES "^[0-9]+$" OR VALUE LESS 4 OR VALUE GREATER 127)
message(SEND_ERROR "${INI}: size is 4 ... 127, not '${VALUE}'")
elseif(SECTION STREQUAL "")
set(COMMON_SIZE "${VALUE}")
else()
set(SIZE_${SECTION} "${VALUE}")
endif()
elseif(kind STREQUAL "font")
_dmod_font_option("${INI}" "${KEY}" "${VALUE}" OPTION_ARGS)
else()
_dmod_image_option("${INI}" "${KEY}" "${VALUE}" OPTION_ARGS)
endif()
if(SECTION STREQUAL "")
list(APPEND COMMON ${OPTION_ARGS})
else()
Expand All @@ -314,9 +362,20 @@ function(_dmod_image_outputs source prefix)
if(NOT SECTIONS)
set(SECTIONS "${NAME}")
set(ARGS_${NAME} "")
set(SIZE_${NAME} "")
endif()
foreach(SECTION ${SECTIONS})
set(${prefix}_ARGS_${SECTION} ${COMMON} ${ARGS_${SECTION}} PARENT_SCOPE)
if(kind STREQUAL "font")
set(SIZE "${SIZE_${SECTION}}")
if(SIZE STREQUAL "")
set(SIZE "${COMMON_SIZE}")
endif()
if(SIZE STREQUAL "")
message(SEND_ERROR "${INI}: [${SECTION}] has no size")
endif()
set(${prefix}_SIZE_${SECTION} "${SIZE}" PARENT_SCOPE)
endif()
endforeach()
set(${prefix}_NAMES ${SECTIONS} PARENT_SCOPE)
endfunction()
Expand Down Expand Up @@ -346,6 +405,9 @@ function(dmod_setup_assets moduleName)
if(NOT DEFINED DMOD_IMAGE_EXTENSIONS OR "${DMOD_IMAGE_EXTENSIONS}" STREQUAL "")
set(DMOD_IMAGE_EXTENSIONS png jpg jpeg jpe jfif bmp qoi gif tif tiff)
endif()
if(NOT DEFINED DMOD_FONT_EXTENSIONS OR "${DMOD_FONT_EXTENSIONS}" STREQUAL "")
set(DMOD_FONT_EXTENSIONS ttf otf ttc)
endif()

# The assets are converted once per project - later modules only depend on the target
get_property(VIEWS_TARGET_READY GLOBAL PROPERTY DMOD_ASSETS_TARGET_READY)
Expand All @@ -358,6 +420,7 @@ function(dmod_setup_assets moduleName)
# Collect the sources
set(VIEW_SOURCES "")
set(IMAGE_SOURCES "")
set(FONT_SOURCES "")
foreach(ASSETS_PATH ${DMOD_ASSETS_PATHS})
if(NOT IS_ABSOLUTE "${ASSETS_PATH}")
set(ASSETS_PATH "${CMAKE_SOURCE_DIR}/${ASSETS_PATH}")
Expand All @@ -373,13 +436,17 @@ function(dmod_setup_assets moduleName)
get_filename_component(EXT "${FOUND}" LAST_EXT)
string(TOLOWER "${EXT}" EXT)
string(REGEX REPLACE "^\\." "" EXT "${EXT}")
if(NOT IS_DIRECTORY "${FOUND}" AND EXT IN_LIST DMOD_IMAGE_EXTENSIONS)
if(IS_DIRECTORY "${FOUND}")
continue()
elseif(EXT IN_LIST DMOD_IMAGE_EXTENSIONS)
list(APPEND IMAGE_SOURCES "${FOUND}")
elseif(EXT IN_LIST DMOD_FONT_EXTENSIONS)
list(APPEND FONT_SOURCES "${FOUND}")
endif()
endforeach()
set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${ASSETS_PATH}")
endforeach()
if(NOT VIEW_SOURCES AND NOT IMAGE_SOURCES)
if(NOT VIEW_SOURCES AND NOT IMAGE_SOURCES AND NOT FONT_SOURCES)
message(STATUS "DMOD_ASSETS_PATHS: no assets found in ${DMOD_ASSETS_PATHS}")
return()
endif()
Expand Down Expand Up @@ -458,7 +525,7 @@ function(dmod_setup_assets moduleName)
if(EXISTS "${IMAGE_SOURCE}.ini")
list(APPEND IMAGE_DEPENDS "${IMAGE_SOURCE}.ini")
endif()
_dmod_image_outputs("${IMAGE_SOURCE}" IMAGE)
_dmod_asset_outputs(image "${IMAGE_SOURCE}" IMAGE)
foreach(OUTPUT_NAME ${IMAGE_NAMES})
set(IMAGE_OUTPUT "${DMOD_VIEWS_DIR}/${OUTPUT_NAME}.dmvi")
add_custom_command(
Expand All @@ -473,6 +540,33 @@ function(dmod_setup_assets moduleName)
endforeach()
endforeach()

# Fonts: todmvf
if(FONT_SOURCES)
set(TODMVF_DIR "${CMAKE_BINARY_DIR}/todmvf")
_dmod_assets_tool(todmvf "${TODMVF_DIR}" TODMVF_DMF)
if(NOT TODMVF_DMF)
message(WARNING "Fonts will not be converted")
set(FONT_SOURCES "")
endif()
endif()
foreach(FONT_SOURCE ${FONT_SOURCES})
get_filename_component(FONT_FILE "${FONT_SOURCE}" NAME)
_dmod_asset_outputs(font "${FONT_SOURCE}" FONT)
foreach(OUTPUT_NAME ${FONT_NAMES})
set(FONT_OUTPUT "${DMOD_VIEWS_DIR}/${OUTPUT_NAME}.dmvf")
add_custom_command(
OUTPUT "${FONT_OUTPUT}"
COMMAND ${CMAKE_COMMAND} -E env DMOD_DMF_DIR=${TODMVF_DIR}
${DMOD_LOADER} ${TODMVF_DMF} --args -q ${FONT_ARGS_${OUTPUT_NAME}} -o ${FONT_OUTPUT}
${FONT_SOURCE} ${FONT_SIZE_${OUTPUT_NAME}}
DEPENDS "${FONT_SOURCE}" "${FONT_SOURCE}.ini"
COMMENT "Converting font ${FONT_FILE} to ${OUTPUT_NAME}.dmvf"
VERBATIM
)
list(APPEND OUTPUTS "${FONT_OUTPUT}")
endforeach()
endforeach()

# Two sources of one output
set(SEEN "")
foreach(OUTPUT ${OUTPUTS})
Expand All @@ -488,7 +582,7 @@ function(dmod_setup_assets moduleName)
add_custom_target(dmod_assets ALL DEPENDS ${OUTPUTS})
set_property(GLOBAL PROPERTY DMOD_ASSETS_TARGET_READY TRUE)
add_dependencies(${moduleName} dmod_assets)
message(STATUS "Assets: converting ${VIEW_SOURCES} ${IMAGE_SOURCES} to ${DMOD_VIEWS_DIR}")
message(STATUS "Assets: converting ${VIEW_SOURCES} ${IMAGE_SOURCES} ${FONT_SOURCES} to ${DMOD_VIEWS_DIR}")
set(DMOD_VIEWS_ENABLED TRUE PARENT_SCOPE)
endfunction()

Expand Down
Loading