XkbResizeKeySyms(3)

✨ XkbResizeKeySyms(3) ✨

Okay bestie, welcome to XkbResizeKeySyms(3), straight out of the XKB FUNCTIONS corner of the X manual. This is the little function that changes the number of symbols bound to a key, and yes, it’s giving β€œallocator era” πŸ’….


πŸŽ€ NAME πŸŽ€

XkbResizeKeySyms β€” change the number of symbols bound to a key


🌸 SYNOPSIS 🌸

KeySym * XkbResizeKeySyms (XkbDescRec *xkb, int key, int needed);

πŸ¦‹ ARGUMENTS πŸ¦‹

  • xkb β€” the keyboard description you want to change, bestie.
  • key β€” the keycode for the key you’re modifying.
  • needed β€” the new number of keysyms required for that key. Like, the target count.

πŸ’– DESCRIPTION πŸ’–

So XkbResizeKeySyms reserves the space needed for needed keysyms and returns a pointer to the beginning of the new array that holds the keysyms. It adjusts the offset field of the key_sym_map entry for the key if necessary, and it can also change the syms, num_syms, and size_syms fields of xkb->map if it is necessary to reallocate the syms array. Lowkey important: XkbResizeKeySyms does not modify either the width or the number of groups associated with the key. Periodt.

If needed is greater than the current number of keysyms for the key, XkbResizeKeySyms initializes all new keysyms in the array to NoSymbol. Fresh slots, no mystery vibes ✨.

Because the number of symbols needed by a key is normally computed as width * number of groups, and XkbResizeKeySyms does not modify either the width or number of groups for the key, a discrepancy exists upon return from XkbResizeKeySyms between the space allocated for the keysyms and the number required. The unused entries in the list of symbols returned by XkbResizeKeySyms are not preserved across future calls to any of the map editing functions, so you must update the key symbol mapping β€” which updates the width and number of groups for the key β€” before calling another allocator function. A call to XkbChangeTypesOfKey will update the mapping. That’s the main-character step, don’t skip it 🫢.

If any allocation errors occur while resizing the number of symbols bound to the key, XkbResizeKeySyms returns NULL. Not a slay, but a fact 😭.


🌈 SEE ALSO 🌈


πŸ‘‘ NOTES πŸ‘‘

A change to the number of symbols bound to a key should be accompanied by a change in the number of actions bound to a key. Refer to XkbResizeKeyActions for more information on changing the number of actions bound to a key. Matching energy, matching counts, iykyk πŸ’œ.


xoxo, this page came to you from X Version 11 and libX11 1.8.14 β€” that’s the footer energy, bestie, no extra date invented, just the version and source doing their little sign-off πŸŽ€πŸ’–

πŸ“¦ where this page comes from