Merge branch 'develop'

7 files changed, 497 insertions, 121 deletions

diff --git a/quantum/unicode/ucis.c b/quantum/unicode/ucis.c
new file mode 100644
index 0000000000..32be785206
--- /dev/null
+++ b/quantum/unicode/ucis.c
@@ -0,0 +1,96 @@
+// Copyright 2023 QMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include "ucis.h"
+#include "unicode.h"
+#include "action.h"
+
+uint8_t count                        = 0;
+bool    active                       = false;
+char    input[UCIS_MAX_INPUT_LENGTH] = {0};
+
+void ucis_start(void) {
+    count  = 0;
+    active = true;
+
+    register_unicode(0x2328); // ⌨
+}
+
+bool ucis_active(void) {
+    return active;
+}
+
+uint8_t ucis_count(void) {
+    return count;
+}
+
+static char keycode_to_char(uint16_t keycode) {
+    if (keycode >= KC_A && keycode <= KC_Z) {
+        return 'a' + (keycode - KC_A);
+    } else if (keycode >= KC_1 && keycode <= KC_9) {
+        return '1' + (keycode - KC_1);
+    } else if (keycode == KC_0) {
+        return '0';
+    }
+    return 0;
+}
+
+bool ucis_add(uint16_t keycode) {
+    char c = keycode_to_char(keycode);
+    if (c) {
+        input[count++] = c;
+        return true;
+    }
+    return false;
+}
+
+bool ucis_remove_last(void) {
+    if (count) {
+        count--;
+        return true;
+    }
+
+    return false;
+}
+
+static bool match_mnemonic(char *mnemonic) {
+    for (uint8_t i = 0; input[i]; i++) {
+        if (i > count || input[i] != mnemonic[i]) {
+            return false;
+        }
+    }
+    return true;
+}
+
+void ucis_finish(void) {
+    uint8_t i     = 0;
+    bool    found = false;
+    for (; ucis_symbol_table[i].mnemonic; i++) {
+        if (match_mnemonic(ucis_symbol_table[i].mnemonic)) {
+            found = true;
+            break;
+        }
+    }
+
+    if (found) {
+        for (uint8_t j = 0; j <= count; j++) {
+            tap_code(KC_BACKSPACE);
+        }
+        register_ucis(i);
+    }
+
+    active = false;
+}
+
+void ucis_cancel(void) {
+    count  = 0;
+    active = false;
+}
+
+void register_ucis(uint8_t index) {
+    const uint32_t *code_points = ucis_symbol_table[index].code_points;
+
+    for (int i = 0; i < UCIS_MAX_CODE_POINTS && code_points[i]; i++) {
+        register_unicode(code_points[i]);
+    }
+}
diff --git a/quantum/unicode/ucis.h b/quantum/unicode/ucis.h
new file mode 100644
index 0000000000..5a4fa26784
--- /dev/null
+++ b/quantum/unicode/ucis.h
@@ -0,0 +1,97 @@
+// Copyright 2023 QMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include <stdbool.h>
+#include <stdint.h>
+
+/**
+ * \file
+ *
+ * \defgroup ucis UCIS
+ * \{
+ */
+
+#ifndef UCIS_MAX_INPUT_LENGTH
+#    define UCIS_MAX_INPUT_LENGTH 32
+#endif
+
+#ifndef UCIS_MAX_CODE_POINTS
+#    define UCIS_MAX_CODE_POINTS 3
+#endif
+
+typedef struct {
+    char*    mnemonic;
+    uint32_t code_points[UCIS_MAX_CODE_POINTS];
+} ucis_symbol_t;
+
+// clang-format off
+
+#define UCIS_TABLE(...) { \
+    __VA_ARGS__,          \
+    { NULL, {} }          \
+}
+
+#define UCIS_SYM(name, ...) {    \
+    .mnemonic    = name,         \
+    .code_points = {__VA_ARGS__} \
+}
+
+// clang-format on
+
+extern const ucis_symbol_t ucis_symbol_table[];
+
+/**
+ * \brief Begin the input sequence.
+ */
+void ucis_start(void);
+
+/**
+ * \brief Whether UCIS is currently active.
+ *
+ * \return `true` if UCIS is active.
+ */
+bool ucis_active(void);
+
+/**
+ * \brief Get the number of characters in the input sequence buffer.
+ *
+ * \return The current input sequence buffer length.
+ */
+uint8_t ucis_count(void);
+
+/**
+ * \brief Add the given keycode to the input sequence buffer.
+ *
+ * \param keycode The keycode to add. Must be between `KC_A` and `KC_Z`, or `KC_1` and `KC_0`.
+ *
+ * \return `true` if the keycode was added.
+ */
+bool ucis_add(uint16_t keycode);
+
+/**
+ * \brief Remove the last character from the input sequence.
+ *
+ * \return `true` if the sequence was not empty.
+ */
+bool ucis_remove_last(void);
+
+/**
+ * Mark the input sequence as complete, and attempt to match.
+ */
+void ucis_finish(void);
+
+/**
+ * \brief Cancel the input sequence.
+ */
+void ucis_cancel(void);
+
+/**
+ * Send the code point(s) for the given UCIS index.
+ *
+ * \param index The index into the UCIS symbol table.
+ */
+void register_ucis(uint8_t index);
+
+/** \} */
diff --git a/quantum/unicode/unicode.c b/quantum/unicode/unicode.c
index 35cb62e700..78a4cad585 100644
--- a/quantum/unicode/unicode.c
+++ b/quantum/unicode/unicode.c
@@ -25,6 +25,8 @@
 #include "wait.h"
 #include "send_string.h"
 #include "utf8.h"
+#include "debug.h"
+#include "quantum.h"
 
 #if defined(AUDIO_ENABLE)
 #    include "audio.h"
@@ -71,16 +73,8 @@ static int8_t  selected_count = ARRAY_SIZE(selected);
 static int8_t  selected_index;
 #endif
 
-/** \brief unicode input mode set at user level
- *
- * Run user code on unicode input mode change
- */
 __attribute__((weak)) void unicode_input_mode_set_user(uint8_t input_mode) {}
 
-/** \brief unicode input mode set at keyboard level
- *
- *  Run keyboard code on unicode input mode change
- */
 __attribute__((weak)) void unicode_input_mode_set_kb(uint8_t input_mode) {
     unicode_input_mode_set_user(input_mode);
 }
@@ -170,6 +164,10 @@ uint8_t get_unicode_input_mode(void) {
     return unicode_config.input_mode;
 }
 
+static void persist_unicode_input_mode(void) {
+    eeprom_update_byte(EECONFIG_UNICODEMODE, unicode_config.input_mode);
+}
+
 void set_unicode_input_mode(uint8_t mode) {
     unicode_config.input_mode = mode;
     persist_unicode_input_mode();
@@ -180,26 +178,34 @@ void set_unicode_input_mode(uint8_t mode) {
     dprintf("Unicode input mode set to: %u\n", unicode_config.input_mode);
 }
 
-void cycle_unicode_input_mode(int8_t offset) {
+static void cycle_unicode_input_mode(int8_t offset) {
 #if UNICODE_SELECTED_MODES != -1
     selected_index = (selected_index + offset) % selected_count;
     if (selected_index < 0) {
         selected_index += selected_count;
     }
+
     unicode_config.input_mode = selected[selected_index];
+
 #    if UNICODE_CYCLE_PERSIST
     persist_unicode_input_mode();
 #    endif
+
 #    ifdef AUDIO_ENABLE
     unicode_play_song(unicode_config.input_mode);
 #    endif
+
     unicode_input_mode_set_kb(unicode_config.input_mode);
     dprintf("Unicode input mode cycle to: %u\n", unicode_config.input_mode);
 #endif
 }
 
-void persist_unicode_input_mode(void) {
-    eeprom_update_byte(EECONFIG_UNICODEMODE, unicode_config.input_mode);
+void unicode_input_mode_step(void) {
+    cycle_unicode_input_mode(1);
+}
+
+void unicode_input_mode_step_reverse(void) {
+    cycle_unicode_input_mode(-1);
 }
 
 __attribute__((weak)) void unicode_input_start(void) {
diff --git a/quantum/unicode/unicode.h b/quantum/unicode/unicode.h
index 06505d87c0..90a54c8b18 100644
--- a/quantum/unicode/unicode.h
+++ b/quantum/unicode/unicode.h
@@ -17,8 +17,14 @@
 #pragma once
 
 #include <stdint.h>
+#include "unicode_keycodes.h"
 
-#include "quantum.h"
+/**
+ * \file
+ *
+ * \defgroup unicode Unicode
+ * \{
+ */
 
 typedef union {
     uint8_t raw;
@@ -42,127 +48,87 @@ enum unicode_input_modes {
     UNICODE_MODE_COUNT // Number of available input modes (always leave at the end)
 };
 
-void    unicode_input_mode_init(void);
+void unicode_input_mode_init(void);
+
+/**
+ * \brief Get the current Unicode input mode.
+ *
+ * \return The currently active Unicode input mode.
+ */
 uint8_t get_unicode_input_mode(void);
-void    set_unicode_input_mode(uint8_t mode);
-void    cycle_unicode_input_mode(int8_t offset);
-void    persist_unicode_input_mode(void);
 
+/**
+ * \brief Set the Unicode input mode.
+ *
+ * \param mode The input mode to set.
+ */
+void set_unicode_input_mode(uint8_t mode);
+
+/**
+ * \brief Change to the next Unicode input mode.
+ */
+void unicode_input_mode_step(void);
+
+/**
+ * \brief Change to the previous Unicode input mode.
+ */
+void unicode_input_mode_step_reverse(void);
+
+/**
+ * \brief User-level callback, invoked when the input mode is changed.
+ *
+ * \param input_mode The new input mode.
+ */
 void unicode_input_mode_set_user(uint8_t input_mode);
+
+/**
+ * \brief Keyboard-level callback, invoked when the input mode is changed.
+ *
+ * \param input_mode The new input mode.
+ */
 void unicode_input_mode_set_kb(uint8_t input_mode);
 
+/**
+ * \brief Begin the Unicode input sequence. The exact behavior depends on the currently selected input mode.
+ */
 void unicode_input_start(void);
+
+/**
+ * \brief Complete the Unicode input sequence. The exact behavior depends on the currently selected input mode.
+ */
 void unicode_input_finish(void);
+
+/**
+ * \brief Cancel the Unicode input sequence. The exact behavior depends on the currently selected input mode.
+ */
 void unicode_input_cancel(void);
 
+/**
+ * \brief Send a 16-bit hex number.
+ *
+ * \param hex The number to send.
+ */
 void register_hex(uint16_t hex);
+
+/**
+ * \brief Send a 32-bit hex number.
+ *
+ * \param hex The number to send.
+ */
 void register_hex32(uint32_t hex);
+
+/**
+ * \brief Input a single Unicode character. A surrogate pair will be sent if required by the input mode.
+ *
+ * \param code_point The code point of the character to send.
+ */
 void register_unicode(uint32_t code_point);
 
+/**
+ * \brief Send a string containing Unicode characters.
+ *
+ * \param str The string to send.
+ */
 void send_unicode_string(const char *str);
 
-// clang-format off
-
-#define UC_BSPC UC(0x0008) // (backspace)
-
-#define UC_SPC  UC(0x0020) // (space)
-#define UC_EXLM UC(0x0021) // !
-#define UC_DQUT UC(0x0022) // "
-#define UC_HASH UC(0x0023) // #
-#define UC_DLR  UC(0x0024) // $
-#define UC_PERC UC(0x0025) // %
-#define UC_AMPR UC(0x0026) // &
-#define UC_QUOT UC(0x0027) // '
-#define UC_LPRN UC(0x0028) // (
-#define UC_RPRN UC(0x0029) // )
-#define UC_ASTR UC(0x002A) // *
-#define UC_PLUS UC(0x002B) // +
-#define UC_COMM UC(0x002C) // ,
-#define UC_DASH UC(0x002D) // -
-#define UC_DOT  UC(0x002E) // .
-#define UC_SLSH UC(0x002F) // /
-
-#define UC_0    UC(0x0030) // 0
-#define UC_1    UC(0x0031) // 1
-#define UC_2    UC(0x0032) // 2
-#define UC_3    UC(0x0033) // 3
-#define UC_4    UC(0x0034) // 4
-#define UC_5    UC(0x0035) // 5
-#define UC_6    UC(0x0036) // 6
-#define UC_7    UC(0x0037) // 7
-#define UC_8    UC(0x0038) // 8
-#define UC_9    UC(0x0039) // 9
-#define UC_COLN UC(0x003A) // :
-#define UC_SCLN UC(0x003B) // ;
-#define UC_LT   UC(0x003C) // <
-#define UC_EQL  UC(0x003D) // =
-#define UC_GT   UC(0x003E) // >
-#define UC_QUES UC(0x003F) // ?
-
-#define UC_AT   UC(0x0040) // @
-#define UC_A    UC(0x0041) // A
-#define UC_B    UC(0x0042) // B
-#define UC_C    UC(0x0043) // C
-#define UC_D    UC(0x0044) // D
-#define UC_E    UC(0x0045) // E
-#define UC_F    UC(0x0046) // F
-#define UC_G    UC(0x0047) // G
-#define UC_H    UC(0x0048) // H
-#define UC_I    UC(0x0049) // I
-#define UC_J    UC(0x004A) // J
-#define UC_K    UC(0x004B) // K
-#define UC_L    UC(0x004C) // L
-#define UC_M    UC(0x004D) // M
-#define UC_N    UC(0x004E) // N
-#define UC_O    UC(0x004F) // O
-
-#define UC_P    UC(0x0050) // P
-#define UC_Q    UC(0x0051) // Q
-#define UC_R    UC(0x0052) // R
-#define UC_S    UC(0x0053) // S
-#define UC_T    UC(0x0054) // T
-#define UC_U    UC(0x0055) // U
-#define UC_V    UC(0x0056) // V
-#define UC_W    UC(0x0057) // W
-#define UC_X    UC(0x0058) // X
-#define UC_Y    UC(0x0059) // Y
-#define UC_Z    UC(0x005A) // Z
-#define UC_LBRC UC(0x005B) // [
-#define UC_BSLS UC(0x005C) // (backslash)
-#define UC_RBRC UC(0x005D) // ]
-#define UC_CIRM UC(0x005E) // ^
-#define UC_UNDR UC(0x005F) // _
-
-#define UC_GRV  UC(0x0060) // `
-#define UC_a    UC(0x0061) // a
-#define UC_b    UC(0x0062) // b
-#define UC_c    UC(0x0063) // c
-#define UC_d    UC(0x0064) // d
-#define UC_e    UC(0x0065) // e
-#define UC_f    UC(0x0066) // f
-#define UC_g    UC(0x0067) // g
-#define UC_h    UC(0x0068) // h
-#define UC_i    UC(0x0069) // i
-#define UC_j    UC(0x006A) // j
-#define UC_k    UC(0x006B) // k
-#define UC_l    UC(0x006C) // l
-#define UC_m    UC(0x006D) // m
-#define UC_n    UC(0x006E) // n
-#define UC_o    UC(0x006F) // o
-
-#define UC_p    UC(0x0070) // p
-#define UC_q    UC(0x0071) // q
-#define UC_r    UC(0x0072) // r
-#define UC_s    UC(0x0073) // s
-#define UC_t    UC(0x0074) // t
-#define UC_u    UC(0x0075) // u
-#define UC_v    UC(0x0076) // v
-#define UC_w    UC(0x0077) // w
-#define UC_x    UC(0x0078) // x
-#define UC_y    UC(0x0079) // y
-#define UC_z    UC(0x007A) // z
-#define UC_LCBR UC(0x007B) // {
-#define UC_PIPE UC(0x007C) // |
-#define UC_RCBR UC(0x007D) // }
-#define UC_TILD UC(0x007E) // ~
-#define UC_DEL  UC(0x007F) // (delete)
+/** \} */
diff --git a/quantum/unicode/unicode_keycodes.h b/quantum/unicode/unicode_keycodes.h
new file mode 100644
index 0000000000..acc176cb6f
--- /dev/null
+++ b/quantum/unicode/unicode_keycodes.h
@@ -0,0 +1,125 @@
+/* Copyright 2023 QMK
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include "quantum_keycodes.h"
+
+// clang-format off
+
+#define UC_BSPC UC(0x0008) // (backspace)
+
+#define UC_SPC  UC(0x0020) // (space)
+#define UC_EXLM UC(0x0021) // !
+#define UC_DQUT UC(0x0022) // "
+#define UC_HASH UC(0x0023) // #
+#define UC_DLR  UC(0x0024) // $
+#define UC_PERC UC(0x0025) // %
+#define UC_AMPR UC(0x0026) // &
+#define UC_QUOT UC(0x0027) // '
+#define UC_LPRN UC(0x0028) // (
+#define UC_RPRN UC(0x0029) // )
+#define UC_ASTR UC(0x002A) // *
+#define UC_PLUS UC(0x002B) // +
+#define UC_COMM UC(0x002C) // ,
+#define UC_DASH UC(0x002D) // -
+#define UC_DOT  UC(0x002E) // .
+#define UC_SLSH UC(0x002F) // /
+
+#define UC_0    UC(0x0030) // 0
+#define UC_1    UC(0x0031) // 1
+#define UC_2    UC(0x0032) // 2
+#define UC_3    UC(0x0033) // 3
+#define UC_4    UC(0x0034) // 4
+#define UC_5    UC(0x0035) // 5
+#define UC_6    UC(0x0036) // 6
+#define UC_7    UC(0x0037) // 7
+#define UC_8    UC(0x0038) // 8
+#define UC_9    UC(0x0039) // 9
+#define UC_COLN UC(0x003A) // :
+#define UC_SCLN UC(0x003B) // ;
+#define UC_LT   UC(0x003C) // <
+#define UC_EQL  UC(0x003D) // =
+#define UC_GT   UC(0x003E) // >
+#define UC_QUES UC(0x003F) // ?
+
+#define UC_AT   UC(0x0040) // @
+#define UC_A    UC(0x0041) // A
+#define UC_B    UC(0x0042) // B
+#define UC_C    UC(0x0043) // C
+#define UC_D    UC(0x0044) // D
+#define UC_E    UC(0x0045) // E
+#define UC_F    UC(0x0046) // F
+#define UC_G    UC(0x0047) // G
+#define UC_H    UC(0x0048) // H
+#define UC_I    UC(0x0049) // I
+#define UC_J    UC(0x004A) // J
+#define UC_K    UC(0x004B) // K
+#define UC_L    UC(0x004C) // L
+#define UC_M    UC(0x004D) // M
+#define UC_N    UC(0x004E) // N
+#define UC_O    UC(0x004F) // O
+
+#define UC_P    UC(0x0050) // P
+#define UC_Q    UC(0x0051) // Q
+#define UC_R    UC(0x0052) // R
+#define UC_S    UC(0x0053) // S
+#define UC_T    UC(0x0054) // T
+#define UC_U    UC(0x0055) // U
+#define UC_V    UC(0x0056) // V
+#define UC_W    UC(0x0057) // W
+#define UC_X    UC(0x0058) // X
+#define UC_Y    UC(0x0059) // Y
+#define UC_Z    UC(0x005A) // Z
+#define UC_LBRC UC(0x005B) // [
+#define UC_BSLS UC(0x005C) // (backslash)
+#define UC_RBRC UC(0x005D) // ]
+#define UC_CIRM UC(0x005E) // ^
+#define UC_UNDR UC(0x005F) // _
+
+#define UC_GRV  UC(0x0060) // `
+#define UC_a    UC(0x0061) // a
+#define UC_b    UC(0x0062) // b
+#define UC_c    UC(0x0063) // c
+#define UC_d    UC(0x0064) // d
+#define UC_e    UC(0x0065) // e
+#define UC_f    UC(0x0066) // f
+#define UC_g    UC(0x0067) // g
+#define UC_h    UC(0x0068) // h
+#define UC_i    UC(0x0069) // i
+#define UC_j    UC(0x006A) // j
+#define UC_k    UC(0x006B) // k
+#define UC_l    UC(0x006C) // l
+#define UC_m    UC(0x006D) // m
+#define UC_n    UC(0x006E) // n
+#define UC_o    UC(0x006F) // o
+
+#define UC_p    UC(0x0070) // p
+#define UC_q    UC(0x0071) // q
+#define UC_r    UC(0x0072) // r
+#define UC_s    UC(0x0073) // s
+#define UC_t    UC(0x0074) // t
+#define UC_u    UC(0x0075) // u
+#define UC_v    UC(0x0076) // v
+#define UC_w    UC(0x0077) // w
+#define UC_x    UC(0x0078) // x
+#define UC_y    UC(0x0079) // y
+#define UC_z    UC(0x007A) // z
+#define UC_LCBR UC(0x007B) // {
+#define UC_PIPE UC(0x007C) // |
+#define UC_RCBR UC(0x007D) // }
+#define UC_TILD UC(0x007E) // ~
+#define UC_DEL  UC(0x007F) // (delete)
diff --git a/quantum/unicode/unicodemap.c b/quantum/unicode/unicodemap.c
new file mode 100644
index 0000000000..2f618056a2
--- /dev/null
+++ b/quantum/unicode/unicodemap.c
@@ -0,0 +1,43 @@
+// Copyright 2023 QMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include "unicodemap.h"
+#include "unicode.h"
+#include "keycodes.h"
+#include "quantum_keycodes.h"
+#include "modifiers.h"
+#include "host.h"
+#include "action_util.h"
+
+uint8_t unicodemap_index(uint16_t keycode) {
+    if (keycode >= QK_UNICODEMAP_PAIR) {
+        // Keycode is a pair: extract index based on Shift / Caps Lock state
+        uint16_t index;
+
+        uint8_t mods = get_mods() | get_weak_mods();
+#ifndef NO_ACTION_ONESHOT
+        mods |= get_oneshot_mods();
+#endif
+
+        bool shift = mods & MOD_MASK_SHIFT;
+        bool caps  = host_keyboard_led_state().caps_lock;
+        if (shift ^ caps) {
+            index = QK_UNICODEMAP_PAIR_GET_SHIFTED_INDEX(keycode);
+        } else {
+            index = QK_UNICODEMAP_PAIR_GET_UNSHIFTED_INDEX(keycode);
+        }
+
+        return index;
+    } else {
+        // Keycode is a regular index
+        return QK_UNICODEMAP_GET_INDEX(keycode);
+    }
+}
+
+uint32_t unicodemap_get_code_point(uint8_t index) {
+    return pgm_read_dword(unicode_map + index);
+}
+
+void register_unicodemap(uint8_t index) {
+    register_unicode(unicodemap_get_code_point(index));
+}
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);
+
+/** \} */