docs/feature_unicode.md

   1 # Unicode Support
   2
   3 There are three Unicode keymap definition methods available in QMK:
   4
   5 ## `UNICODE_ENABLE`
   6
   7 Supports Unicode up to `0x7FFF`. This covers characters for most modern languages, as well as symbols, but it doesn't cover emoji. The keycode function is `UC(c)` in the keymap, where _c_ is the code point's number (preferably hexadecimal, up to 4 digits long). For example: `UC(0x45B)`, `UC(0x30C4)`.
   8
   9 ## `UNICODEMAP_ENABLE`
  10
  11 Supports Unicode up to `0x10FFFF` (all possible code points). You need to maintain a separate mapping table `const uint32_t PROGMEM unicode_map[] = {...}` in your keymap file. The keycode function is `X(i)`, where _i_ is an array index into the mapping table. The table may contain at most 16384 entries.
  12
  13 You may want to have an enum to make referencing easier. So, you could add something like this to your keymap file:
  14
  15 ```c
  16 enum unicode_names {
  17   BANG,
  18   IRONY,
  19   SNEK,
  20 };
  21
  22 const uint32_t PROGMEM unicode_map[] = {
  23   [BANG]  = 0x203D,  // ‽
  24   [IRONY] = 0x2E2E,  // ⸮
  25   [SNEK]  = 0x1F40D, // 🐍
  26 };
  27 ```
  28
  29 Then you can use `X(BANG)`, `X(SNEK)` etc. in your keymap.
  30
  31 ### Lower and Upper Case
  32
  33 Characters often come in lower and upper case pairs, for example: å, Å. To make inputting these characters easier, you can use `XP(i, j)` in your keymap, where _i_ and _j_ are the mapping table indices of the lower and upper case character, respectively. If you're holding down Shift or have Caps Lock turned on when you press the key, the second (upper case) character will be inserted; otherwise, the first (lower case) version will appear.
  34
  35 This is most useful when creating a keymap for an international layout with special characters. Instead of having to put the lower and upper case versions of a character on separate keys, you can have them both on the same key by using `XP`. This blends Unicode keys in with regular alphas.
  36
  37 Due to keycode size constraints, _i_ and _j_ can each only refer to one of the first 128 characters in your `unicode_map`. In other words, 0 ≤ _i_ ≤ 127 and 0 ≤ _j_ ≤ 127. This is enough for most use cases, but if you'd like to customize the index calculation, you can override the [`unicodemap_index()`](https://github.com/qmk/qmk_firmware/blob/71f640d47ee12c862c798e1f56392853c7b1c1a8/quantum/process_keycode/process_unicodemap.c#L40) function. This also allows you to, say, check Ctrl instead of Shift/Caps.
  38
  39 ## `UCIS_ENABLE`
  40
  41 Supports Unicode up to `0x10FFFF` (all possible code points). As with `UNICODEMAP`, you need to maintain a mapping table in your keymap file. However, there are no built-in keycodes for this feature — you have to add a keycode or function that calls `qk_ucis_start()`. Once this function has been called, you can type the corresponding mnemonic for your character, then hit Space or Enter to complete it, or Esc to cancel. If the mnemonic matches an entry in your table, the typed text will automatically be erased and the corresponding Unicode character inserted.
  42
  43 For instance, you could define a table like this in your keymap file:
  44
  45 ```c
  46 const qk_ucis_symbol_t ucis_symbol_table[] = UCIS_TABLE(
  47   UCIS_SYM("poop", 0x1F4A9), // 💩
  48   UCIS_SYM("rofl", 0x1F923), // 🤣
  49   UCIS_SYM("kiss", 0x1F619)  // 😙
  50 );
  51 ```
  52
  53 To use it, call `qk_ucis_start()`, then type "rofl" and hit Enter. QMK should erase the "rofl" text and insert the laughing emoji.
  54
  55 ### Customization
  56
  57 There are several functions that you can define in your keymap to customize the functionality of this feature.
  58
  59 * `void qk_ucis_start_user(void)` – This runs when you call the "start" function, and can be used to provide feedback. By default, it types out a keyboard emoji.
  60 * `void qk_ucis_success(uint8_t symbol_index)` – This runs when the input has matched something and has completed. By default, it doesn't do anything.
  61 * `void qk_ucis_symbol_fallback (void)` – This runs when the input doesn't match anything. By default, it falls back to trying that input as a Unicode code.
  62
  63 You can find the default implementations of these functions in [`process_ucis.c`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_ucis.c).
  64
  65 ## Input Modes
  66
  67 Unicode input in QMK works by inputting a sequence of characters to the OS, sort of like a macro. Unfortunately, the way this is done differs for each platform. Specifically, each platform requires a different combination of keys to trigger Unicode input. Therefore, a corresponding input mode has to be set in QMK.
  68
  69 The following input modes are available:
  70
  71 * **`UC_OSX`**: macOS built-in Unicode hex input. Supports code points up to `0xFFFF` (`0x10FFFF` with `UNICODEMAP`).
  72
  73   To enable, go to _System Preferences > Keyboard > Input Sources_, add _Unicode Hex Input_ to the list (it's under _Other_), then activate it from the input dropdown in the Menu Bar.
  74   By default, this mode uses the left Option key (`KC_LALT`) for Unicode input, but this can be changed by defining [`UNICODE_KEY_OSX`](#input-key-configuration) with another keycode.
  75
  76   !> Using the _Unicode Hex Input_ input source may disable some Option based shortcuts, such as Option + Left Arrow and Option + Right Arrow.
  77
  78 * **`UC_LNX`**: Linux built-in IBus Unicode input. Supports code points up to `0x10FFFF` (all possible code points).
  79
  80   Enabled by default and works almost anywhere on IBus-enabled distros. Without IBus, this mode works under GTK apps, but rarely anywhere else.
  81   By default, this mode uses Ctrl+Shift+U (`LCTL(LSFT(KC_U))`) to start Unicode input, but this can be changed by defining [`UNICODE_KEY_LNX`](#input-key-configuration) with another keycode. This might be required for IBus versions ≥1.5.15, where Ctrl+Shift+U behavior is consolidated into Ctrl+Shift+E.
  82
  83 * **`UC_WIN`**: _(not recommended)_ Windows built-in hex numpad Unicode input. Supports code points up to `0xFFFF`.
  84
  85   To enable, create a registry key under `HKEY_CURRENT_USER\Control Panel\Input Method\EnableHexNumpad` of type `REG_SZ` called `EnableHexNumpad` and set its value to `1`. This can be done from the Command Prompt by running `reg add "HKCU\Control Panel\Input Method" -v EnableHexNumpad -t REG_SZ -d 1` with administrator privileges. Reboot afterwards.
  86   This mode is not recommended because of reliability and compatibility issues; use the `UC_WINC` mode instead.
  87
  88 * **`UC_BSD`**: _(non implemented)_ Unicode input under BSD. Not implemented at this time. If you're a BSD user and want to help add support for it, please [open an issue on GitHub](https://github.com/qmk/qmk_firmware/issues).
  89
  90 * **`UC_WINC`**: Windows Unicode input using [WinCompose](https://github.com/samhocevar/wincompose). As of v0.9.0, supports code points up to `0x10FFFF` (all possible code points).
  91
  92   To enable, install the [latest release](https://github.com/samhocevar/wincompose/releases/latest). Once installed, WinCompose will automatically run on startup. Works reliably under all version of Windows supported by the app.
  93   By default, this mode uses right Alt (`KC_RALT`) as the Compose key, but this can be changed in the WinCompose settings and by defining [`UNICODE_KEY_WINC`](#input-key-configuration) with another keycode.
  94
  95 ### Switching Input Modes
  96
  97 There are two ways to set the input mode for Unicode: by keycode or by function. Keep in mind that both methods write to persistent storage (EEPROM), and are loaded each time the keyboard starts. So once you've set it the first time, you don't need to set it again unless you want to change it, or you've reset the EEPROM settings.
  98
  99 You can switch the input mode at any time by using one of the following keycodes. The easiest way is to add the ones you use to your keymap.
 100
 101 |Keycode               |Alias    |Input Mode  |Description                                                   |
 102 |----------------------|---------|------------|--------------------------------------------------------------|
 103 |`UNICODE_MODE_FORWARD`|`UC_MOD` |Next in list|[Cycle](#input-mode-cycling) through selected modes           |
 104 |`UNICODE_MODE_REVERSE`|`UC_RMOD`|Prev in list|[Cycle](#input-mode-cycling) through selected modes in reverse|
 105 |`UNICODE_MODE_OSX`    |`UC_M_OS`|`UC_OSX`    |Switch to macOS input                                         |
 106 |`UNICODE_MODE_LNX`    |`UC_M_LN`|`UC_LNX`    |Switch to Linux input                                         |
 107 |`UNICODE_MODE_WIN`    |`UC_M_WI`|`UC_WIN`    |Switch to Windows input                                       |
 108 |`UNICODE_MODE_BSD`    |`UC_M_BS`|`UC_BSD`    |Switch to BSD input (not implemented)                         |
 109 |`UNICODE_MODE_WINC`   |`UC_M_WC`|`UC_WINC`   |Switch to Windows input using WinCompose                      |
 110
 111 You can also switch the input mode by calling `set_unicode_input_mode(x)` in your code, where _x_ is one of the above input mode constants (e.g. `UC_LNX`). Since the function only needs to be called once, it's recommended that you do it in `eeconfig_init_user()` (or a similar function). For example:
 112
 113 ```c
 114 void eeconfig_init_user(void) {
 115   set_unicode_input_mode(UC_LNX);
 116 }
 117 ```
 118
 119 ### Audio Feedback
 120
 121 If you have the [Audio feature](feature_audio.md) enabled on the board, you can set melodies to be played when you press the above keys. That way you can have some audio feedback when switching input modes.
 122
 123 For instance, you can add these definitions to your `config.h` file:
 124
 125 ```c
 126 #define UNICODE_SONG_OSX  COIN_SOUND
 127 #define UNICODE_SONG_LNX  UNICODE_LINUX
 128 #define UNICODE_SONG_BSD  MARIO_GAMEOVER
 129 #define UNICODE_SONG_WIN  UNICODE_WINDOWS
 130 #define UNICODE_SONG_WINC UNICODE_WINDOWS
 131 ```
 132
 133 ### Additional Customization
 134
 135 Because Unicode is a large and versatile feature, there are a number of options you can customize to make it work better on your system.
 136
 137 #### Start and Finish Input Functions
 138
 139 The functions for starting and finishing Unicode input on your platform can be overridden locally. Possible uses include customizing input mode behavior if you don't use the default keys, or adding extra visual/audio feedback to Unicode input.
 140
 141 * `void unicode_input_start(void)` – This sends the initial sequence that tells your platform to enter Unicode input mode. For example, it presses Ctrl+Shift+U on Linux and holds the Option key on macOS.
 142 * `void unicode_input_finish(void)` – This is called to exit Unicode input mode, for example by pressing Space or releasing the Option key.
 143
 144 You can find the default implementations of these functions in [`process_unicode_common.c`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_unicode_common.c).
 145
 146 #### Input Key Configuration
 147
 148 You can customize the keys used to trigger Unicode input for macOS, Linux and WinCompose by adding corresponding defines to your `config.h`. The default values match the platforms' default settings, so you shouldn't need to change this unless Unicode input isn't working, or you want to use a different key (e.g. in order to free up left or right Alt).
 149
 150 |Define            |Type      |Default           |Example                                    |
 151 |------------------|----------|------------------|-------------------------------------------|
 152 |`UNICODE_KEY_OSX` |`uint8_t` |`KC_LALT`         |`#define UNICODE_KEY_OSX  KC_RALT`         |
 153 |`UNICODE_KEY_LNX` |`uint16_t`|`LCTL(LSFT(KC_U))`|`#define UNICODE_KEY_LNX  LCTL(LSFT(KC_E))`|
 154 |`UNICODE_KEY_WINC`|`uint8_t` |`KC_RALT`         |`#define UNICODE_KEY_WINC KC_RGUI`         |
 155
 156 #### Input Mode Cycling
 157
 158 You can choose which input modes are available for cycling through. By default, this is disabled. If you want to enable it, limiting it to just the modes you use makes sense. Note that the values in the list are comma-delimited.
 159
 160 ```c
 161 #define UNICODE_SELECTED_MODES UC_OSX, UC_LNX, UC_WIN, UC_WINC
 162 ```
 163
 164 You can cycle through the selected modes by using the `UC_MOD`/`UC_RMOD` keycodes, or by calling `cycle_unicode_input_mode(offset)` in your code (`offset` is how many modes to move forward by, so +1 corresponds to `UC_MOD`).
 165
 166 By default, when the keyboard boots, it will initialize the input mode to the last one you used. You can disable this and make it start with the first mode in the list every time by adding the following to your `config.h`:
 167
 168 ```c
 169 #define UNICODE_CYCLE_PERSIST false
 170 ```
 171
 172 !> Using `UNICODE_SELECTED_MODES` means you don't have to initially set the input mode in `matrix_init_user()` (or a similar function); the Unicode system will do that for you on startup. This has the added benefit of avoiding unnecessary writes to EEPROM.
 173
 174 ## `send_unicode_hex_string`
 175
 176 To type multiple characters for things like (ノಠ痊ಠ)ノ彡┻━┻, you can use `send_unicode_hex_string()` much like `SEND_STRING()` except you would use hex values separate by spaces.
 177 For example, the table flip seen above would be `send_unicode_hex_string("0028 30CE 0CA0 75CA 0CA0 0029 30CE 5F61 253B 2501 253B")`
 178
 179 There are many ways to get a hex code, but an easy one is [this site](https://r12a.github.io/app-conversion/). Just make sure to convert to hexadecimal, and that is your string.
 180
 181 ## Additional Language Support
 182
 183 In `quantum/keymap_extras/`, you'll see various language files - these work the same way as the alternative layout ones do. Most are defined by their two letter country/language code followed by an underscore and a 4-letter abbreviation of its name. `FR_UGRV` which will result in a `ù` when using a software-implemented AZERTY layout. It's currently difficult to send such characters in just the firmware.
 184
 185 ## International Characters on Windows
 186
 187 ### AutoHotkey allows Windows users to create custom hotkeys among others.
 188
 189 The method does not require Unicode support in the keyboard itself but depends instead of [AutoHotkey](https://autohotkey.com) running in the background.
 190
 191 First you need to select a modifier combination that is not in use by any of your programs.
 192 CtrlAltWin is not used very widely and should therefore be perfect for this.
 193 There is a macro defined for a mod-tab combo `LCAG_T`.
 194 Add this mod-tab combo to a key on your keyboard, e.g.: `LCAG_T(KC_TAB)`.
 195 This makes the key behave like a tab key if pressed and released immediately but changes it to the modifier if used with another key.
 196
 197 In the default script of AutoHotkey you can define custom hotkeys.
 198
 199     <^<!<#a::Send, ä
 200     <^<!<#<+a::Send, Ä
 201
 202 The hotkeys above are for the combination CtrlAltGui and CtrlAltGuiShift plus the letter a.
 203 AutoHotkey inserts the Text right of `Send, ` when this combination is pressed.
 204
 205 ### US International
 206
 207 If you enable the US International layout on the system, it will use punctuation to accent the characters.
 208
 209 For instance, typing "`a" will result in à.
 210
 211 You can find details on how to enable this [here](https://support.microsoft.com/en-us/help/17424/windows-change-keyboard-layout).