NAME
XkbFreeClientMap - Free memory used by the client map member of an Xkb‐ DescRec structure SYNOPSIS void XkbFreeClientMap (XkbDescPtr xkb, unsigned int which, Bool freeall); ARGUMENTS
- xkb keyboard description containing client map to free
- which mask identifying components of map to free
- freeall True => free all client components and map itself DESCRIPTION XkbFreeClientMap frees the components of client map specified by which in the XkbDescRec structure specified by the xkb parameter and sets the corresponding structure component values to NULL. The which parameter specifies a combination of the client map masks shown in Table 1. If freeall is True, which is ignored; XkbFreeClientMap frees every
non-NULL structure component in the client map, frees the Xkb‐ ClientMapRec structure referenced by the map member of the xkb parame‐ ter, and sets the map member to NULL. Table 1 XkbAllocClientMap Masks ────────────────────────────────────────────────────────────── Mask Effect ────────────────────────────────────────────────────────────── XkbKeyTypesMask The typecount field specifies the num‐ ber of entries to preallocate for the types field of the client map. If the typecount field is less than XkbNumRe‐ quiredTypes returns BadValue. XkbKeySymsMask The minkeycode and maxkeycode fields of the xkb parameter are used to allo‐ cate the syms and keysymmap fields of the client map. The fields are allocated to contain the maximum number of entries
necessary for maxkeycode - minkeycode + 1 keys. XkbModifierMapMask The minkeycode and maxkeycode fields of the xkb parameter are used to allo‐ cate the modmap field of the client map. The field is allocated to contain the maximum number of entries necessary for
maxkeycode - minkeycode + 1 keys. NOTE: The minkeycode and maxkeycode fields of the xkb parameter must be legal values if the XkbKeySymsMask or XkbModifierMapMask masks are set in the which parameter. If they are not valid, XkbAlloc‐ ClientMap returns BadValue. STRUCTURES The complete description of an Xkb keyboard is given by an XkbDescRec. The component structures in the XkbDescRec represent the major Xkb com‐ ponents. typedef struct { struct XDisplay * display; /∗ connection to X server */ unsigned short flags; /∗ private to Xkb, do not modify */ unsigned short devicespec; /∗ device of interest */ KeyCode minkeycode; /∗ minimum keycode for device */ KeyCode maxkeycode; /∗ 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 devicespec field specifies the device identifier of the keyboard input device, or XkbUseCoreKeyboard, which specifies the core keyboard device. The minkeycode and maxkeycode 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 ────────────────────────────────────────────────── Mask Bit XkbDescRec Field Value ────────────────────────────────────────────────── XkbControlsMask ctrls (1L<<0) XkbServerMapMask server (1L<<1) XkbIClientMapMask map (1L<<2) XkbIndicatorMapMask indicators (1L<<3) XkbNamesMask names (1L<<4) XkbCompatMapMask compat (1L<<5) XkbGeometryMask geom (1L<<6) XkbAllComponentsMask All Fields (0x7f) The map field of the complete Xkb keyboard description is a pointer to the Xkb client map, which is of type XkbClientMapRec: typedef struct { /∗ Client Map */
unsigned char sizetypes; /∗ # occupied entries in types */
unsigned char numtypes; /∗ # entries in types */ XkbKeyTypePtr types; /∗ vector of key types used by this keymap */ unsigned short sizesyms; /∗ length of the syms array */
unsigned short numsyms; /∗ # entries in syms */ KeySym * syms; /∗ linear 2d tables of keysyms, 1 per key */ XkbSymMapPtr keysymmap; /∗ 1 per keycode, maps keycode to syms */ unsigned char * modmap; /∗ 1 per keycode, real mods bound to key */ } XkbClientMapRec, *XkbClientMapPtr; DIAGNOSTICS BadValue An argument is out of range SEE ALSO XkbAllocClientMap(3) X Version 11 libX11 1.6.5 XkbFreeClientMap(3)