113 lines
4 KiB
C
113 lines
4 KiB
C
// Copyright 2024-2025 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// https://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#pragma once
|
|
|
|
#include <stdint.h>
|
|
|
|
#if KEYCODE_STRING_ENABLE
|
|
|
|
/**
|
|
* @brief Formats a QMK keycode as a human-readable string.
|
|
*
|
|
* Given a keycode, like `KC_A`, this function returns a formatted string, like
|
|
* "KC_A". This is useful for debugging and diagnostics so that keys are more
|
|
* easily identified than they would be by raw numerical codes.
|
|
*
|
|
* @note The returned char* string should be used right away. The string memory
|
|
* is reused and will be overwritten by the next call to `keycode_string()`.
|
|
*
|
|
* Many common QMK keycodes are understood by this function, but not all.
|
|
* Recognized keycodes include:
|
|
*
|
|
* - Most basic keycodes, including letters `KC_A` - `KC_Z`, digits `KC_0` -
|
|
* `KC_9`, function keys `KC_F1` - `KC_F24`, and modifiers like `KC_LSFT`.
|
|
*
|
|
* - Modified basic keycodes, like `S(KC_1)` (Shift + 1 = !).
|
|
*
|
|
* - `MO`, `TO`, `TG`, `OSL`, `LM(layer,mod)`, `LT(layer,kc)` layer switches.
|
|
*
|
|
* - One-shot mod `OSM(mod)` keycodes.
|
|
*
|
|
* - Mod-tap `MT(mod, kc)` keycodes.
|
|
*
|
|
* - Tap dance keycodes `TD(i)`.
|
|
*
|
|
* - Unicode `UC(codepoint)` and Unicode Map `UM(i)` and `UP(i,j)` keycodes.
|
|
*
|
|
* - Keyboard range keycodes `QK_KB_*`.
|
|
*
|
|
* - User range (SAFE_RANGE) keycodes `QK_USER_*`.
|
|
*
|
|
* Keycodes involving mods like `OSM`, `LM`, `MT` are fully supported only where
|
|
* a single mod is applied.
|
|
*
|
|
* Unrecognized keycodes are printed numerically as hex values like `0x1ABC`.
|
|
*
|
|
* Optionally, use `keycode_string_names_user` or `keycode_string_names_kb` to
|
|
* define names for additional keycodes or override how any of the above are
|
|
* formatted.
|
|
*
|
|
* @param keycode QMK keycode.
|
|
* @return Stringified keycode.
|
|
*/
|
|
const char* get_keycode_string(uint16_t keycode);
|
|
|
|
/** Defines a human-readable name for a keycode. */
|
|
typedef struct {
|
|
uint16_t keycode;
|
|
const char* name;
|
|
} keycode_string_name_t;
|
|
|
|
/**
|
|
* @brief Names for additional keycodes for `get_keycode_string()`.
|
|
*
|
|
* @note The table *must* end with `KEYCODE_STRING_NAMES_END`.
|
|
*
|
|
* Define the `custom_keycode_names` table in your keymap.c to add names for
|
|
* additional keycodes to `keycode_string()`. This table may also be used to
|
|
* override how `keycode_string()` formats a keycode. For example, supposing
|
|
* keymap.c defines `MYMACRO1` and `MYMACRO2` as custom keycodes:
|
|
*
|
|
* const keycode_string_name_t* keycode_string_names_user =
|
|
* (keycode_string_name_t []){
|
|
* KEYCODE_STRING_NAME(MYMACRO1),
|
|
* KEYCODE_STRING_NAME(MYMACRO2),
|
|
* KEYCODE_STRING_NAME(KC_EXLM),
|
|
* KEYCODE_STRING_NAMES_END // End of table sentinel.
|
|
* };
|
|
*
|
|
* The above defines names for `MYMACRO1` and `MYMACRO2`, and overrides
|
|
* `KC_EXLM` to format as "KC_EXLM" instead of the default "S(KC_1)".
|
|
*/
|
|
extern const keycode_string_name_t* keycode_string_names_user;
|
|
/** Same as `keycode_string_names_user`, but for use at the keyboard level. */
|
|
extern const keycode_string_name_t* keycode_string_names_kb;
|
|
|
|
/** Helper to define a keycode_string_name_t. */
|
|
# define KEYCODE_STRING_NAME(kc) \
|
|
{ (kc), #kc }
|
|
/** Makes end-of-table sentinel for a table of keycode_string_name_t. */
|
|
# define KEYCODE_STRING_NAMES_END \
|
|
{ 0, NULL }
|
|
|
|
#else
|
|
|
|
// When keycode_string is disabled, fall back to printing keycodes numerically
|
|
// as decimal values, using get_u16_str() from quantum.c.
|
|
# define get_keycode_string(kc) get_u16_str(kc, ' ')
|
|
|
|
const char *get_u16_str(uint16_t curr_num, char curr_pad);
|
|
|
|
#endif // KEYCODE_STRING_ENABLE
|