XkbGetUpdatedMap(3)

📦
version 1.8.14 · 8 versions
, in alpine 3.24, arch rolling, nixos 26.05, nixpkgs unstable

💅 XkbGetUpdatedMap 💅

okay bestie, welcome to the XKB FUNCTIONS manual — this is the page for XkbGetUpdatedMap, and it’s giving “refresh my keyboard lore” energy. ✨

🌸 NAME 🌸

XkbGetUpdatedMap — update the client or server map information in an existing keyboard description. 💖

✨ SYNOPSIS ✨

Status XkbGetUpdatedMap (Display *display, unsigned int which,
       XkbDescPtr xkb);

🎀 ARGUMENTS 🎀

  • display — connection to X server.
  • which — mask selecting subcomponents to populate.
  • xkb — keyboard description to be updated.

🦋 DESCRIPTION 🦋

so the which parameter is a bitwise inclusive OR of the masks in Table 1 — yes, stack those bits, bestie. 💅

If the needed components of the xkb structure are not already allocated, XkbGetUpdatedMap allocates them. XkbGetUpdatedMap fetches the requested information for the device specified in the XkbDescRec passed in the xkb parameter.

🧾 Table 1: Xkb Mapping Component Masks and Convenience Functions

here’s the full lineup, with mask / value / map / fields / convenience functions all accounted for:

  • XkbKeyTypesMask — value (1<<0); map client; fields types, size_types, num_types; convenience functions XkbGetKeyTypes, XkbResizeKeyType, XkbCopyKeyType, XkbCopyKeyTypes.
  • XkbKeySymsMask — value (1<<1); map client; fields syms, size_syms, num_syms, key_sym_map; convenience functions XkbGetKeySyms, XkbResizeKeySyms, XkbChangeTypesOfKey.
  • XkbModifierMapMask — value (1<<2); map client; field modmap; convenience function XkbGetKeyModifierMap.
  • XkbExplicitComponentsMask — value (1<<3); map server; field explicit; convenience function XkbGetKeyExplicitComponents.
  • XkbKeyActionsMask — value (1<<4); map server; fields key_acts, acts, num_acts, size_acts; convenience functions XkbGetKeyActions, XkbResizeKeyActions.
  • XkbKeyBehaviorsMask — value (1<<5); map server; field behaviors; convenience function XkbGetKeyBehaviors.
  • XkbVirtualModsMask — value (1<<6); map server; field vmods; convenience function XkbGetVirtualMods.
  • XkbVirtualModMapMask — value (1<<7); map server; field vmodmap; convenience function XkbGetVirtualModMap.

XkbGetUpdatedMap is synchronous — it queries the server for the desired information, waits for a reply, and then returns. If successful, it returns Success. If unsuccessful, it returns one of the following:

  • BadAlloc — unable to allocate a component in the XkbDescRec structure.
  • BadValue — some mask bits in which are undefined.
  • BadImplementation — a compatible version of the Xkb extension is not available in the server or the reply from the server was invalid.

🫶 RETURN VALUES 🫶

  • Success — The XkbGetUpdatedMap function returns Success if a reply is received to the server query for the desired information.

👑 STRUCTURES 👑

The complete description of an Xkb keyboard is given by an XkbDescRec. The component structures in the XkbDescRec represent the major Xkb components.

typedef struct {
   struct _XDisplay * display;      /* connection to X server */
   unsigned short     flags;        /* private to Xkb, do not modify */
   unsigned short     device_spec;  /* device of interest */
   KeyCode            min_key_code; /* minimum keycode for device */
   KeyCode            max_key_code; /* maximum keycode for device */
   XkbControlsPtr     ctrls;        /* controls */
   XkbServerMapPtr    server;       /* server keymap */
   XkbClientMapPtr    map;          /* client keymap */
   XkbIndicatorPtr    indicators;   /* indicator map */
   XkbNamesPtr        names;        /* names for all components */
   XkbCompatMapPtr    compat;       /* compatibility map */
   XkbGeometryPtr     geom;         /* physical geometry of keyboard */
} XkbDescRec, *XkbDescPtr;

The display field points to an X display structure. The flags field is private to the library: modifying flags may yield unpredictable results. 🙈 The device_spec field specifies the device identifier of the keyboard input device, or XkbUseCoreKeyboard, which specifies the core keyboard device. The min_key_code and max_key_code fields specify the least and greatest keycode that can be returned by the keyboard.

Each structure component has a corresponding mask bit that is used in function calls to indicate that the structure should be manipulated in some manner, such as allocating it or freeing it. These masks and their relationships to the fields in the XkbDescRec are shown in Table 2.

🧾 Table 2: Mask Bits for XkbDescRec

  • XkbControlsMask — XkbDescRec field ctrls, value (1L<<0).
  • XkbServerMapMask — XkbDescRec field server, value (1L<<1).
  • XkbIClientMapMask — XkbDescRec field map, value (1L<<2).
  • XkbIndicatorMapMask — XkbDescRec field indicators, value (1L<<3).
  • XkbNamesMask — XkbDescRec field names, value (1L<<4).
  • XkbCompatMapMask — XkbDescRec field compat, value (1L<<5).
  • XkbGeometryMask — XkbDescRec field geom, value (1L<<6).
  • XkbAllComponentsMask — XkbDescRec field All Fields, value (0x7f).

💀 DIAGNOSTICS 💀

  • BadAlloc — Unable to allocate storage.
  • BadImplementation — Invalid reply from server.
  • BadValue — An argument is out of range.

🌈 SEE ALSO 🌈

okay that’s the whole lore dump, bestie 🫶 this cutie comes from X Version 11 and libX11 1.8.14, and the page is XkbGetUpdatedMap(3) — the footer’s date slot is lowkey blank in this copy, no cap. 💜

📦 where this page comes from