XkbFreeCompatMap(3)

💖 XkbFreeCompatMap 💖

okay so bestie, welcome to XkbFreeCompatMap from the XKB FUNCTIONS manual 🫶 this one is literally about freeing an entire compatibility map or just the selected little pieces of one. main character energy, but make it memory management 💅

---

🌸 NAME 🌸

XkbFreeCompatMap — free a whole compatibility map or selected portions of one ✨

🦋 SYNOPSIS 🦋

       void XkbFreeCompatMap (XkbDescPtr xkb, unsigned int which, Bool
              free_map);

🎀 ARGUMENTS 🎀

• xkb — the Xkb description where you want to free the compatibility map 💖
• which — a mask of compatibility map components to free 🧚
• free_map — True means free the XkbCompatMap structure itself 😭

💜 DESCRIPTION 💜

so which tells the function which compatibility map components to free, iykyk — see XkbGetCompatMap for the full lore 🔥 which is an inclusive OR of the bits shown in Table 1, no cap.

Table 1 — Compatibility Map Component Masks

• XkbSymInterpMask — value (1<<0) — affecting Symbol interpretations 🌸
• XkbGroupCompatMask — value (1<<1) — affecting Group maps 🌈
• XkbAllCompatMask — value (0x3) — affecting All compatibility map components 👑

free_map indicates whether the XkbCompatMap structure itself should be freed. If free_map is True, which is ignored, all non-NULL compatibility map components are freed, and the compat field in the XkbDescRec referenced by xkb is set to NULL 💀 periodt.

bestie, this is the part where which gets absolutely ignored if free_map is True — the whole compatibility map situation gets cleaned up, and compat goes to NULL 🙈

---

🧚 STRUCTURES 🧚

okay, struct soup time — here’s the exact XkbCompatMapRec situation:

typedef struct _XkbCompatMapRec {
    XkbSymInterpretPtr    sym_interpret;            /* symbol based key semantics*/
    XkbModsRec            groups[XkbNumKbdGroups];  /* group => modifier map */
    unsigned short        num_si;                   /* # structures used in sym_interpret */
    unsigned short        size_si;                  /* # structures allocated in sym_interpret */
} XkbCompatMapRec, *XkbCompatMapPtr;

the complete description of an Xkb keyboard is given by an XkbDescRec 🦋 the component structures in the XkbDescRec represent the major Xkb components outlined in Figure 1.1 ✨

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 �� so don’t touch, bestie.

warning: flags 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 🔢 the other fields specify structure components of the keyboard description and are described in detail in other sections of this document 📚 Table 2 identifies the subsequent sections of this document that discuss the individual components of the XkbDescRec 👑

Table 2 — XkbDescRec Component References

• ctrls — for more info: Chapter 10 🌸
• server — for more info: Chapter 16 🌈
• map — for more info: Chapter 15 🦋
• indicators — for more info: Chapter 8 ⭐
• names — for more info: Chapter 18 🎀
• compat — for more info: Chapter 17 💜
• geom — for more info: Chapter 13 💅

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 3 🫶

Table 3 — 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) 👑

---

🌟 SEE ALSO 🌟

• XkbGetCompatMap(3) — the bestie that gets the compatibility map in the first place 💖

---

okay bestie, that’s the whole page — signing off from X Version 11, libX11 1.8.14, with no separate date line in this footer, so that’s the vibe 🎀✨💅 periodt