diff options
author | Ryan <[email protected]> | 2023-08-27 13:30:19 +1000 |
---|---|---|
committer | GitHub <[email protected]> | 2023-08-27 13:30:19 +1000 |
commit | 70e34e491c297231a3f987fd69760d38e79dbfa4 (patch) | |
tree | a3fe26ea27c9d020142f4c248fa0bab5d32c1f9c /quantum/unicode/unicodemap.h | |
parent | 95681b8ff4a92aacd0249e124d34cf16e510175e (diff) | |
download | qmk_firmware-70e34e491c297231a3f987fd69760d38e79dbfa4.tar.gz qmk_firmware-70e34e491c297231a3f987fd69760d38e79dbfa4.zip |
Unicode, Unicodemap and UCIS refactor (#21659)
Diffstat (limited to 'quantum/unicode/unicodemap.h')
-rw-r--r-- | quantum/unicode/unicodemap.h | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/quantum/unicode/unicodemap.h b/quantum/unicode/unicodemap.h new file mode 100644 index 0000000000..00d2aec8fa --- /dev/null +++ b/quantum/unicode/unicodemap.h @@ -0,0 +1,43 @@ +// Copyright 2023 QMK +// SPDX-License-Identifier: GPL-2.0-or-later + +#pragma once + +#include <stdint.h> +#include "progmem.h" + +/** + * \file + * + * \defgroup unicodemap Unicode Map + * \{ + */ + +extern const uint32_t unicode_map[] PROGMEM; + +/** + * \brief Get the index into the `unicode_map` array for the given keycode, respecting shift state for pair keycodes. + * + * \param keycode The Unicode Map keycode to get the index of. + * + * \return An index into the `unicode_map` array. + */ +uint8_t unicodemap_index(uint16_t keycode); + +/** + * \brief Get the code point for the given index in the `unicode_map` array. + * + * \param index The index into the `unicode_map` array. + * + * \return A Unicode code point value. + */ +uint32_t unicodemap_get_code_point(uint8_t index); + +/** + * \brief Send the code point for the given index in the `unicode_map` array. + * + * \param index The index into the `unicode_map` array. + */ +void register_unicodemap(uint8_t index); + +/** \} */ |