XkbAllocNames(3)

💖 NAME 💖

XkbAllocNames — allocate symbolic names structures. This is the XkbAllocNames(3) page, bestie, and it's here to help you allocate those names without doing the absolute most. 💅

---

✨ SYNOPSIS ✨

       Status XkbAllocNames (XkbDescPtr xkb, unsigned int which, int num_rg,
              int num_key_aliases);

---

🎀 ARGUMENTS 🎀

• xkb — keyboard description for which names are to be allocated.
• which — mask of names to be allocated.
• num_rg — total number of radio group names needed.
• num_key_aliases — total number of key aliases needed.

---

🦋 DESCRIPTION 🦋

Okay so real talk: ngl, most applications do not need to directly allocate symbolic names structures. If your application changes the number of key aliases or radio groups, or constructs a symbolic names structure without loading the necessary components from the X server, do not allocate a names structure directly using malloc or Xmalloc — that is not the move, bestie. Use XkbAllocNames instead. Periodt. 💅

XkbAllocNames can return BadAlloc, BadMatch, and BadValue errors. The which parameter is the bitwise inclusive OR of the valid names mask bits defined in Table 1. 🧾

🧾 Table 1 Symbolic Names Masks 🧾

Each row is giving mask bit → value → keyboard component → field, and every single one is iconic in its own way:

• XkbKeycodesNameMask — value (1<<0) — keyboard component Xkb->names — field keycodes
• XkbGeometryNameMask — value (1<<1) — keyboard component Xkb->names — field geometry
• XkbSymbolsNameMask — value (1<<2) — keyboard component Xkb->names — field symbols
• XkbPhysSymbolsNameMask — value (1<<3) — keyboard component Xkb->names — field phys_symbols
• XkbTypesNameMask — value (1<<4) — keyboard component Xkb->names — field type
• XkbCompatNameMask — value (1<<5) — keyboard component Xkb->names — field compat
• XkbKeyTypeNamesMask — value (1<<6) — keyboard component Xkb->map — field type[*].name
• XkbKTLevelNamesMask — value (1<<7) — keyboard component Xkb->map — field type[*].lvl_names[*]
• XkbIndicatorNamesMask — value (1<<8) — keyboard component Xkb->names — field indicators[*]
• XkbKeyNamesMask — value (1<<9) — keyboard component Xkb->names — field keys[*], num_keys
• XkbKeyAliasesMask — value (1<<10) — keyboard component Xkb->names — field key_aliases[*], num_key_aliases
• XkbVirtualModNamesMask — value (1<<11) — keyboard component Xkb->names — field vmods[*]
• XkbGroupNamesMask — value (1<<12) — keyboard component Xkb->names — field groups[*]
• XkbRGNamesMask — value (1<<13) — keyboard component Xkb->names — field radio_groups[*], num_rg
• XkbComponentNamesMask — value (0x3f) — keyboard component Xkb->names — field keycodes, geometry, symbols, physical symbols, types, and compatibility map
• XkbAllNamesMask — value (0x3fff) — keyboard component Xkb->names — field all name components

🚨 Bestie, do not free symbolic names structures directly using free or XFree. Use XkbFreeNames instead. That is the whole vibe check. 🫶

---

💅 DIAGNOSTICS 💅

• BadAlloc — Unable to allocate storage.
• BadMatch — A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid.
• BadValue — An argument is out of range.

---

🌈 SEE ALSO 🌈

• XkbFreeNames(3) — go see it, bestie. It's the names-freeing lore you need. ✨

---

Signing off from X Version 11 and libX11 1.8.14 — the footer didn't hand us a date, so no fake date, bestie 😌💅 bye!