qmk/qmk_firmware
1
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2026-09-30 05:50:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

Attempt at simplifying interface.

Browse Source
This commit is contained in:
Pascal Getreuer
2025-01-21 23:55:16 -08:00
parent 45f573f335
commit 8eaf67de76
10 changed files with 152 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files
quantum/keycode_string.c
+27 -16
View File
@@ -17,8 +17,10 @@
#include <string.h>
#include "bitwise.h"
#include "keycode.h"
#include "keymap_introspection.h"
#include "progmem.h"
#include "quantum_keycodes.h"
#include "util.h"
typedef int_fast8_t index_t;
@@ -89,16 +91,16 @@ static const keycode_string_name_t keycode_names[] = {
KEYCODE_STRING_NAME(QK_LLCK),
#endif // LAYER_LOCK_ENABLE
KEYCODE_STRING_NAME(DB_TOGG),
KEYCODE_STRING_NAMES_END
};
// clang-format on
__attribute__((weak)) const keycode_string_name_t empty_table[] = {KEYCODE_STRING_NAMES_END};
static const keycode_string_name_t* keycode_names_get(uint16_t i) {
if (i >= ARRAY_SIZE(keycode_names)) {
return NULL;
}
return &keycode_names[i];
}
/** Users can override this to define names of additional keycodes. */
__attribute__((weak)) const keycode_string_name_t* keycode_string_names_user = empty_table;
/** Keyboard vendors can override this to define names of additional keycodes. */
__attribute__((weak)) const keycode_string_name_t* keycode_string_names_kb = empty_table;
/** Names of the 4 mods on each hand. */
static const char* mod_names[4] = {PSTR("CTL"), PSTR("SFT"), PSTR("ALT"), PSTR("GUI")};
/** Internal buffer for holding a stringified keycode. */
@@ -107,17 +109,21 @@ static char buffer[32];
static index_t buffer_len;
/**
* @brief Finds the name of a keycode in `table` or returns NULL.
* @brief Finds the name of a keycode in table or returns NULL.
*
* The last entry of the table must be `KEYCODE_STRING_NAMES_END`.
* The function arg `table_get(i)` is called as `table_get(0)`, `table_get(1)`,
* `table_get(2)`, etc., until it returns NULL or once the keycode is found.
*
* @param table A table of keycode_string_name_t to be searched.
* @param table_get Function to get the table entries.
* @return Name string for the keycode, or NULL if not found.
*/
static const char* find_keycode_name(const keycode_string_name_t* table, uint16_t keycode) {
for (; table->keycode; ++table) {
if (table->keycode == keycode) {
return table->name;
static const char* find_keycode_name(const keycode_string_name_t* (*table_get)(uint16_t), uint16_t keycode) {
for (uint16_t i = 0;; ++i) {
const keycode_string_name_t* entry = table_get(i);
if (entry == NULL) {
break;
} else if (entry->keycode == keycode) {
return entry->name;
}
}
return NULL;
@@ -206,19 +212,24 @@ static void append_unary_keycode(const char* name, const char* param) {
/** Stringifies `keycode` and appends it to `buffer`. */
static void append_keycode(uint16_t keycode) {
const char* keycode_name;
#ifdef KEYCODE_STRING_NAMES_USER
// In case there is overlap among tables, search `keycode_string_names_user`
// first so that it takes precedence.
const char* keycode_name = find_keycode_name(keycode_string_names_user, keycode);
keycode_name = find_keycode_name(keycode_string_names_user_get, keycode);
if (keycode_name) {
append_P(keycode_name);
return;
}
keycode_name = find_keycode_name(keycode_string_names_kb, keycode);
#endif // KEYCODE_STRING_NAMES_USER
#ifdef KEYCODE_STRING_NAMES_KB
keycode_name = find_keycode_name(keycode_string_names_kb_get, keycode);
if (keycode_name) {
append_P(keycode_name);
return;
}
keycode_name = find_keycode_name(keycode_names, keycode);
#endif // KEYCODE_STRING_NAMES_KB
keycode_name = find_keycode_name(keycode_names_get, keycode);
if (keycode_name) {
append_P(keycode_name);
return;
quantum/keycode_string.h
+6 -7
View File
@@ -65,10 +65,11 @@
const char* get_keycode_string(uint16_t keycode);
/** Defines a human-readable name for a keycode. */
typedef struct {
typedef struct keycode_string_name_t {
uint16_t keycode;
const char* name;
} keycode_string_name_t;
// typedef struct keycode_string_name_t keycode_string_name_t;
/**
* @brief Names for additional keycodes for `get_keycode_string()`.
@@ -90,16 +91,14 @@ typedef struct {
* 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;
// 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;
// extern const keycode_string_name_t* keycode_string_names_kb;
/** Helper to define a keycode_string_name_t. */
# define KEYCODE_STRING_NAME(kc) \
{ (kc), PSTR(#kc) }
# define KEYCODE_STRING_NAME(kc) {(kc), PSTR(#kc)}
/** Makes end-of-table sentinel for a table of keycode_string_name_t. */
# define KEYCODE_STRING_NAMES_END \
{ 0, NULL }
# define KEYCODE_STRING_NAMES_END {0, NULL}
#else
quantum/keymap_introspection.c
+33
View File
@@ -171,3 +171,36 @@ __attribute__((weak)) const key_override_t* key_override_get(uint16_t key_overri
}
#endif // defined(KEY_OVERRIDE_ENABLE)
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Keycode String
#if defined(KEYCODE_STRING_ENABLE)
# if defined(KEYCODE_STRING_NAMES_USER)
const keycode_string_name_t* keycode_string_names_user_get_raw(uint16_t i) {
if (i >= ARRAY_SIZE(keycode_string_names_user)) {
return NULL;
}
return (const keycode_string_name_t*)&keycode_string_names_user[i];
}
__attribute__((weak)) const keycode_string_name_t* keycode_string_names_user_get(uint16_t i) {
return keycode_string_names_user_get_raw(i);
}
# endif // defined(KEYCODE_STRING_NAMES_USER)
# if defined(KEYCODE_STRING_NAMES_KB)
const keycode_string_name_t* keycode_string_names_kb_get_raw(uint16_t i) {
if (i >= ARRAY_SIZE(keycode_string_names_kb)) {
return NULL;
}
return (const keycode_string_name_t*)&keycode_string_names_kb[i];
}
__attribute__((weak)) const keycode_string_name_t* keycode_string_names_kb_get(uint16_t i) {
return keycode_string_names_kb_get_raw(i);
}
# endif // defined(KEYCODE_STRING_NAMES_KB)
#endif // defined(KEYCODE_STRING_ENABLE)
quantum/keymap_introspection.h
+24
View File
@@ -109,3 +109,27 @@ const key_override_t* key_override_get_raw(uint16_t key_override_idx);
const key_override_t* key_override_get(uint16_t key_override_idx);
#endif // defined(KEY_OVERRIDE_ENABLE)
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Keycode String
#if defined(KEYCODE_STRING_ENABLE)
struct keycode_string_name_t;
typedef struct keycode_string_name_t keycode_string_name_t;
# if defined(KEYCODE_STRING_NAMES_USER)
// Get the user-level keycode names, stored in firmware.
const keycode_string_name_t* keycode_string_names_user_get_raw(uint16_t i);
// Get the user-level keycode names, potentially stored dynamically.
const keycode_string_name_t* keycode_string_names_user_get(uint16_t i);
# endif // defined(KEYCODE_STRING_NAMES_USER)
# if defined(KEYCODE_STRING_NAMES_KB)
// Get the kb-level keycode names, stored in firmware.
const keycode_string_name_t* keycode_string_names_kb_get_raw(uint16_t i);
// Get the kb-level keycode names, potentially stored dynamically.
const keycode_string_name_t* keycode_string_names_kb_get(uint16_t i);
# endif // defined(KEYCODE_STRING_NAMES_KB)
#endif // defined(KEYCODE_STRING_ENABLE)