afiqzudinhadi
0f0861ffd4
CONFIG_ZMK_JAVELIN_STENO_DICT choices: - PLOVER (default) — downloads openstenoproject/plover main.json - LAPWING — downloads lapwing-base + lapwing-commands + lapwing-numbers - NONE — no auto-download, upload via USB or provide custom binary Set in corne.conf: CONFIG_ZMK_JAVELIN_STENO_DICT_LAPWING=y
354 lines
12 KiB
CMake
354 lines
12 KiB
CMake
if(CONFIG_ZMK_JAVELIN_STENO)
|
|
|
|
# Only compile on central side of split keyboards (or non-split)
|
|
if((NOT CONFIG_ZMK_SPLIT) OR CONFIG_ZMK_SPLIT_ROLE_CENTRAL)
|
|
|
|
# Patch javelin source for Zephyr compatibility
|
|
set(JAVELIN_SRC_DIR "${CMAKE_CURRENT_LIST_DIR}/javelin")
|
|
if(EXISTS "${JAVELIN_SRC_DIR}/dictionary/user_dictionary.h")
|
|
# Remove constexpr from StenoUserDictionaryData constructor
|
|
# (reinterpret_cast not allowed in constexpr on GCC)
|
|
execute_process(
|
|
COMMAND sed -i "s/constexpr StenoUserDictionaryData(const uint8_t/StenoUserDictionaryData(const uint8_t/"
|
|
"${JAVELIN_SRC_DIR}/dictionary/user_dictionary.h"
|
|
)
|
|
# Disable orthography cache (saves ~32KB RAM, avoids missing LockCache/UnlockCache)
|
|
execute_process(
|
|
COMMAND sed -i "s/#define USE_ORTHOGRAPHY_CACHE 1/#define USE_ORTHOGRAPHY_CACHE 0/"
|
|
"${JAVELIN_SRC_DIR}/orthography.h"
|
|
)
|
|
# Strip all test bodies from Javelin .cc files.
|
|
# TEST_BEGIN...TEST_END blocks contain code referencing
|
|
# RUN_TESTS-only APIs. Remove them entirely.
|
|
execute_process(
|
|
COMMAND python3 -c "
|
|
import glob, re, os
|
|
src = '${JAVELIN_SRC_DIR}'
|
|
pattern = re.compile(r'(?:^|\\n)(TEST_BEGIN\\(.*?TEST_END)', re.DOTALL)
|
|
count = 0
|
|
for f in glob.glob(os.path.join(src, '**/*.cc'), recursive=True):
|
|
t = open(f).read()
|
|
t2 = pattern.sub('', t)
|
|
if t2 != t:
|
|
open(f, 'w').write(t2)
|
|
count += 1
|
|
print(f'Stripped test blocks from {count} files')
|
|
"
|
|
)
|
|
message(STATUS "Javelin steno: source patches applied")
|
|
endif()
|
|
|
|
# Override dir MUST come before javelin/ so our unit_test.h is found first
|
|
zephyr_include_directories(include/javelin_overrides)
|
|
zephyr_include_directories(javelin)
|
|
zephyr_include_directories(include)
|
|
|
|
# Core engine sources
|
|
set(JAVELIN_CORE_SRC
|
|
javelin/asset_manager.cc
|
|
javelin/base64.cc
|
|
javelin/bit_field.cc
|
|
javelin/bit.cc
|
|
javelin/button_script_manager.cc
|
|
javelin/button_script.cc
|
|
javelin/console_input_buffer.cc
|
|
javelin/console.cc
|
|
javelin/container/cyclic_queue.cc
|
|
javelin/container/list.cc
|
|
javelin/crc32.cc
|
|
javelin/date_time.cc
|
|
javelin/engine_add_translation_mode.cc
|
|
javelin/engine_binding.cc
|
|
javelin/engine_console_mode.cc
|
|
javelin/engine_normal_mode.cc
|
|
javelin/engine.cc
|
|
javelin/flash.cc
|
|
javelin/hash.cc
|
|
javelin/host_layout.cc
|
|
javelin/key_code.cc
|
|
javelin/key_press_parser.cc
|
|
javelin/mem.cc
|
|
javelin/orthography.cc
|
|
javelin/pattern_component.cc
|
|
javelin/pattern.cc
|
|
javelin/pool_allocate.cc
|
|
javelin/random.cc
|
|
javelin/script_byte_code.cc
|
|
javelin/script_storage.cc
|
|
javelin/script.cc
|
|
javelin/segment_builder.cc
|
|
javelin/segment.cc
|
|
javelin/start_console_command_detector.cc
|
|
javelin/state.cc
|
|
javelin/steno_key_code_buffer_functions.cc
|
|
javelin/steno_key_code_buffer.cc
|
|
javelin/steno_key_code_emitter.cc
|
|
javelin/steno_key_code.cc
|
|
javelin/steno_key_state.cc
|
|
javelin/str.cc
|
|
javelin/stroke_history.cc
|
|
javelin/stroke_list_parser.cc
|
|
javelin/stroke.cc
|
|
javelin/system.cc
|
|
javelin/timer_manager.cc
|
|
javelin/unicode_script.cc
|
|
javelin/unicode.cc
|
|
javelin/utf8_pointer.cc
|
|
javelin/word_list.cc
|
|
javelin/wpm_tracker.cc
|
|
javelin/writer.cc
|
|
)
|
|
|
|
# Dictionary sources
|
|
set(JAVELIN_DICT_SRC
|
|
javelin/dictionary/cache_dictionary.cc
|
|
javelin/dictionary/compact_map_dictionary.cc
|
|
javelin/dictionary/debug_dictionary.cc
|
|
javelin/dictionary/dictionary_definition.cc
|
|
javelin/dictionary/dictionary_list.cc
|
|
javelin/dictionary/dictionary.cc
|
|
javelin/dictionary/emily_symbols_dictionary.cc
|
|
javelin/dictionary/full_map_dictionary.cc
|
|
javelin/dictionary/invalid_dictionary.cc
|
|
javelin/dictionary/jeff_numbers_dictionary.cc
|
|
javelin/dictionary/jeff_phrasing_dictionary_data.cc
|
|
javelin/dictionary/jeff_phrasing_dictionary.cc
|
|
javelin/dictionary/jeff_show_stroke_dictionary.cc
|
|
javelin/dictionary/orthospelling_data.cc
|
|
javelin/dictionary/orthospelling_dictionary.cc
|
|
javelin/dictionary/reverse_auto_suffix_dictionary.cc
|
|
javelin/dictionary/reverse_map_dictionary.cc
|
|
javelin/dictionary/reverse_prefix_dictionary.cc
|
|
javelin/dictionary/reverse_suffix_dictionary.cc
|
|
javelin/dictionary/unicode_dictionary.cc
|
|
javelin/dictionary/user_dictionary.cc
|
|
javelin/dictionary/wrapped_dictionary.cc
|
|
)
|
|
|
|
# Processor sources
|
|
set(JAVELIN_PROC_SRC
|
|
javelin/processor/all_up.cc
|
|
# javelin/processor/fake_processor.cc # test-only, uses RUN_TESTS APIs
|
|
javelin/processor/first_up.cc
|
|
javelin/processor/gemini.cc
|
|
javelin/processor/jeff_modifiers.cc
|
|
javelin/processor/paper_tape.cc
|
|
javelin/processor/passport.cc
|
|
javelin/processor/plover_hid.cc
|
|
javelin/processor/procat.cc
|
|
javelin/processor/processor_list.cc
|
|
javelin/processor/processor.cc
|
|
javelin/processor/repeat.cc
|
|
javelin/processor/tx_bolt.cc
|
|
)
|
|
|
|
# HAL sources (weak defaults — our shims override the critical ones)
|
|
set(JAVELIN_HAL_SRC
|
|
javelin/hal/ble.cc
|
|
javelin/hal/bootloader.cc
|
|
javelin/hal/connection.cc
|
|
javelin/hal/display.cc
|
|
javelin/hal/gpio.cc
|
|
javelin/hal/infrared.cc
|
|
javelin/hal/midi.cc
|
|
javelin/hal/mouse.cc
|
|
javelin/hal/power.cc
|
|
javelin/hal/rgb.cc
|
|
javelin/hal/rtc.cc
|
|
javelin/hal/serial_port.cc
|
|
javelin/hal/sound.cc
|
|
javelin/hal/usb_status.cc
|
|
)
|
|
|
|
# Font sources (needed by display/script subsystem)
|
|
set(JAVELIN_FONT_SRC
|
|
javelin/font/monochrome/data/default.cc
|
|
javelin/font/monochrome/data/dos.cc
|
|
javelin/font/monochrome/data/huge_digits.cc
|
|
javelin/font/monochrome/data/large_digits.cc
|
|
javelin/font/monochrome/data/large.cc
|
|
javelin/font/monochrome/data/medium_digits.cc
|
|
javelin/font/monochrome/data/small_digits.cc
|
|
javelin/font/monochrome/font.cc
|
|
)
|
|
|
|
# Split sources (ZMK handles split transport, but Javelin split types
|
|
# are referenced by other code)
|
|
set(JAVELIN_SPLIT_SRC
|
|
javelin/split/split_console.cc
|
|
javelin/split/split_key_state.cc
|
|
javelin/split/split_midi.cc
|
|
javelin/split/split_power_override.cc
|
|
javelin/split/split_serial_buffer.cc
|
|
javelin/split/split_usb_status.cc
|
|
javelin/split/split_version.cc
|
|
javelin/split/split.cc
|
|
)
|
|
|
|
# Platform shims (our ZMK implementations)
|
|
set(ZMK_SHIM_SRC
|
|
src/platform/zmk_key_shim.cc
|
|
src/platform/zmk_clock_shim.cc
|
|
src/platform/zmk_flash_shim.cc
|
|
src/platform/zmk_connection_shim.cc
|
|
src/platform/zmk_console_shim.cc
|
|
src/platform/zmk_stubs.cc
|
|
)
|
|
|
|
# ZMK behavior driver (C, not C++)
|
|
set(ZMK_BEHAVIOR_SRC
|
|
src/behaviors/behavior_javelin_steno.c
|
|
)
|
|
|
|
# Engine initialization
|
|
set(ZMK_INIT_SRC
|
|
src/engine_init.cc
|
|
)
|
|
|
|
# Pure Javelin sources (no ZMK deps) → separate library for C++23
|
|
set(JAVELIN_LIB_SRC
|
|
${JAVELIN_CORE_SRC}
|
|
${JAVELIN_DICT_SRC}
|
|
${JAVELIN_PROC_SRC}
|
|
${JAVELIN_HAL_SRC}
|
|
${JAVELIN_FONT_SRC}
|
|
${JAVELIN_SPLIT_SRC}
|
|
)
|
|
|
|
# Shims + init (need ZMK headers) → compiled into app target
|
|
set(ZMK_BRIDGE_SRC
|
|
${ZMK_SHIM_SRC}
|
|
${ZMK_INIT_SRC}
|
|
)
|
|
|
|
# Build everything as a Zephyr library for C++23.
|
|
zephyr_library_named(javelin_steno)
|
|
zephyr_library_sources(${JAVELIN_LIB_SRC} ${ZMK_BRIDGE_SRC})
|
|
# ZMK app headers aren't inherited by libraries — add manually
|
|
zephyr_library_include_directories(${APPLICATION_SOURCE_DIR}/include)
|
|
zephyr_library_compile_options(
|
|
-std=gnu++23
|
|
-fno-exceptions
|
|
-fno-rtti
|
|
-fno-threadsafe-statics
|
|
-Wno-invalid-constexpr
|
|
-fpermissive
|
|
)
|
|
zephyr_library_compile_definitions(
|
|
JAVELIN_USE_EMBEDDED_STENO=1
|
|
JAVELIN_USE_USER_DICTIONARY=1
|
|
JAVELIN_PLATFORM_ZEPHYR=1
|
|
JAVELIN_BOARD_CONFIG=<stddef.h>
|
|
M_PI=3.14159265358979323846
|
|
USE_ORTHOGRAPHY_CACHE=0
|
|
)
|
|
# Test suppression handled by include/javelin_overrides/unit_test.h
|
|
# which shadows Javelin's unit_test.h via include path ordering.
|
|
|
|
target_sources(app PRIVATE
|
|
${ZMK_BEHAVIOR_SRC}
|
|
)
|
|
|
|
# --- Dictionary binary embedding ---
|
|
# Priority: 1) JAVELIN_DICT_BIN cmake var
|
|
# 2) pre-compiled dicts/steno_dict.bin
|
|
# 3) auto-download based on Kconfig choice (Plover/Lapwing)
|
|
# 4) null placeholder (engine won't start)
|
|
|
|
set(DICT_DIR "${CMAKE_CURRENT_LIST_DIR}/dicts")
|
|
set(DICT_SRC_DIR "${CMAKE_CURRENT_LIST_DIR}/dicts_src")
|
|
set(COMPILER "${CMAKE_CURRENT_LIST_DIR}/tools/dict_compiler/compile_dict.py")
|
|
set(DICT_BIN "${DICT_DIR}/steno_dict.bin")
|
|
|
|
# Determine which dict to download based on Kconfig
|
|
if(CONFIG_ZMK_JAVELIN_STENO_DICT_PLOVER)
|
|
set(DICT_NAME "plover-main")
|
|
set(DICT_JSON "${DICT_SRC_DIR}/plover-main.json")
|
|
set(DICT_URLS
|
|
"https://raw.githubusercontent.com/openstenoproject/plover/main/plover/assets/main.json"
|
|
)
|
|
set(DICT_NAMES "plover-main")
|
|
elseif(CONFIG_ZMK_JAVELIN_STENO_DICT_LAPWING)
|
|
set(DICT_NAME "lapwing")
|
|
set(DICT_JSON "${DICT_SRC_DIR}/lapwing-base.json")
|
|
set(DICT_URLS
|
|
"https://raw.githubusercontent.com/aerickt/plover-lapwing-aio/main/plover_lapwing/dictionaries/lapwing-base.json"
|
|
"https://raw.githubusercontent.com/aerickt/plover-lapwing-aio/main/plover_lapwing/dictionaries/lapwing-commands.json"
|
|
"https://raw.githubusercontent.com/aerickt/plover-lapwing-aio/main/plover_lapwing/dictionaries/lapwing-numbers.json"
|
|
)
|
|
set(DICT_NAMES "lapwing-base" "lapwing-commands" "lapwing-numbers")
|
|
else()
|
|
set(DICT_NAME "none")
|
|
endif()
|
|
|
|
if(DEFINED JAVELIN_DICT_BIN)
|
|
set(DICT_BIN_PATH "${JAVELIN_DICT_BIN}")
|
|
elseif(EXISTS "${DICT_BIN}")
|
|
set(DICT_BIN_PATH "${DICT_BIN}")
|
|
elseif(NOT "${DICT_NAME}" STREQUAL "none")
|
|
# Auto-download + compile
|
|
file(MAKE_DIRECTORY "${DICT_SRC_DIR}")
|
|
set(DICT_JSONS "")
|
|
set(DICT_COMPILE_NAMES "")
|
|
list(LENGTH DICT_URLS DICT_COUNT)
|
|
math(EXPR DICT_LAST "${DICT_COUNT} - 1")
|
|
|
|
foreach(IDX RANGE ${DICT_LAST})
|
|
list(GET DICT_URLS ${IDX} URL)
|
|
list(GET DICT_NAMES ${IDX} NAME)
|
|
set(JSON_PATH "${DICT_SRC_DIR}/${NAME}.json")
|
|
|
|
if(NOT EXISTS "${JSON_PATH}")
|
|
message(STATUS "Javelin steno: downloading ${NAME}...")
|
|
file(DOWNLOAD "${URL}" "${JSON_PATH}" STATUS DL_STATUS TIMEOUT 30)
|
|
list(GET DL_STATUS 0 DL_RC)
|
|
if(NOT DL_RC EQUAL 0)
|
|
message(WARNING "Javelin steno: download failed for ${NAME}")
|
|
file(REMOVE "${JSON_PATH}")
|
|
endif()
|
|
else()
|
|
message(STATUS "Javelin steno: using cached ${NAME}")
|
|
endif()
|
|
|
|
if(EXISTS "${JSON_PATH}")
|
|
list(APPEND DICT_JSONS "${JSON_PATH}")
|
|
list(APPEND DICT_COMPILE_NAMES "-n" "${NAME}")
|
|
endif()
|
|
endforeach()
|
|
|
|
if(DICT_JSONS AND EXISTS "${COMPILER}")
|
|
message(STATUS "Javelin steno: compiling ${DICT_NAME} dictionary...")
|
|
execute_process(
|
|
COMMAND python3 "${COMPILER}" ${DICT_JSONS}
|
|
${DICT_COMPILE_NAMES} -o "${DICT_BIN}"
|
|
RESULT_VARIABLE COMPILE_RC
|
|
ERROR_VARIABLE COMPILE_ERR
|
|
)
|
|
if(COMPILE_RC EQUAL 0)
|
|
set(DICT_BIN_PATH "${DICT_BIN}")
|
|
message(STATUS "Javelin steno: ${DICT_NAME} dictionary compiled")
|
|
else()
|
|
message(WARNING "Javelin steno: compile failed: ${COMPILE_ERR}")
|
|
set(DICT_BIN_PATH "")
|
|
endif()
|
|
else()
|
|
set(DICT_BIN_PATH "")
|
|
endif()
|
|
else()
|
|
set(DICT_BIN_PATH "")
|
|
endif()
|
|
|
|
if(NOT "${DICT_BIN_PATH}" STREQUAL "")
|
|
set_source_files_properties(src/dict_embed.S PROPERTIES
|
|
COMPILE_DEFINITIONS "JAVELIN_DICT_BIN_PATH=\"${DICT_BIN_PATH}\""
|
|
)
|
|
message(STATUS "Javelin steno: embedding dictionary from ${DICT_BIN_PATH}")
|
|
else()
|
|
message(WARNING "Javelin steno: no dictionary — engine will not start")
|
|
endif()
|
|
|
|
target_sources(app PRIVATE src/dict_embed.S)
|
|
|
|
endif() # central role check
|
|
|
|
endif() # CONFIG_ZMK_JAVELIN_STENO
|