1XkbFreeServerMap(3) XKB FUNCTIONS XkbFreeServerMap(3)
2
6 XkbFreeServerMap - Free memory used by the server member of an XkbDe‐
7 scRec structure
8
10 void XkbFreeServerMap (XkbDescPtr xkb, unsigned int which, Bool
11 free_all);
12
14 - xkb keyboard description containing server map to free
15 - which
17 mask identifying components of map to free
18 - free_all
20 True => free all server map components and server itself
21
23 The XkbFreeServerMap function frees the specified components of server
24 map in the XkbDescRec structure specified by the xkb parameter and sets
25 the corresponding structure component values to NULL. The which parame‐
26 ter specifies a combination of the server map masks and is a bitwise
27 inclusive OR of the masks listed in Table 1. If free_all is True, which
28 is ignored and XkbFreeServerMap frees every non-NULL structure compo‐
29 nent in the server map, frees the XkbServerMapRec structure referenced
30 by the server member of the xkb parameter, and sets the server member
31 to NULL.
32 Table 1 XkbAllocServerMap Masks
35 ─────────────────────────────────────────────────────────────────────
36 Mask Effect
37 ─────────────────────────────────────────────────────────────────────
38 XkbExplicitComponentsMask The min_key_code and max_key_code fields
39 of the xkb parameter are used to allo‐
40 cate the explicit field of the server
41 map.
42 XkbKeyActionsMask The min_key_code and max_key_code fields
44 of the xkb parameter are used to allo‐
45 cate the key_acts field of the server
46 map. The count_acts parameter is used to
47 allocate the acts field of the server
48 map.
49 XkbKeyBehaviorsMask The min_key_code and max_key_code fields
51 of the xkb parameter are used to allo‐
52 cate the behaviors field of the server
53 map.
54 XkbVirtualModMapMask The min_key_code and max_key_code fields
56 of the xkb parameter are used to allo‐
57 cate the vmodmap field of the server
58 map.
59
62 The complete description of an Xkb keyboard is given by an XkbDescRec.
63 The component structures in the XkbDescRec represent the major Xkb com‐
64 ponents.
65 typedef struct {
67 struct _XDisplay * display; /∗ connection to X server */
68 unsigned short flags; /∗ private to Xkb, do not modify */
69 unsigned short device_spec; /∗ device of interest */
70 KeyCode min_key_code; /∗ minimum keycode for device */
71 KeyCode max_key_code; /∗ maximum keycode for device */
72 XkbControlsPtr ctrls; /∗ controls */
73 XkbServerMapPtr server; /∗ server keymap */
74 XkbClientMapPtr map; /∗ client keymap */
75 XkbIndicatorPtr indicators; /∗ indicator map */
76 XkbNamesPtr names; /∗ names for all components */
77 XkbCompatMapPtr compat; /∗ compatibility map */
78 XkbGeometryPtr geom; /∗ physical geometry of keyboard */
79 } XkbDescRec, *XkbDescPtr;
80 The display field points to an X display structure. The flags field is
82 private to the library: modifying flags may yield unpredictable
83 results. The device_spec field specifies the device identifier of the
84 keyboard input device, or XkbUseCoreKeyboard, which specifies the core
85 keyboard device. The min_key_code and max_key_code fields specify the
86 least and greatest keycode that can be returned by the keyboard.
87 Each structure component has a corresponding mask bit that is used in
89 function calls to indicate that the structure should be manipulated in
90 some manner, such as allocating it or freeing it. These masks and their
91 relationships to the fields in the XkbDescRec are shown in Table 2.
92 Table 2 Mask Bits for XkbDescRec
95 ──────────────────────────────────────────────────
96 Mask Bit XkbDescRec Field Value
97 ──────────────────────────────────────────────────
98 XkbControlsMask ctrls (1L<<0)
99 XkbServerMapMask server (1L<<1)
100 XkbIClientMapMask map (1L<<2)
101 XkbIndicatorMapMask indicators (1L<<3)
102 XkbNamesMask names (1L<<4)
103 XkbCompatMapMask compat (1L<<5)
104 XkbGeometryMask geom (1L<<6)
105 XkbAllComponentsMask All Fields (0x7f)
106 The Xkb server map contains the information the server needs to inter‐
108 pret key events and is of type XkbServerMapRec:
109 #define XkbNumVirtualMods 16
111 typedef struct { /∗ Server Map */
113 unsigned short num_acts; /∗ # of occupied entries in acts */
114 unsigned short size_acts; /∗ # of entries in acts */
115 XkbAction * acts; /∗ linear 2d tables of key actions, 1 per keycode */
116 XkbBehavior * behaviors; /∗ key behaviors,1 per keycode */
117 unsigned short * key_acts; /∗ index into acts, 1 per keycode */
118 unsigned char * explicit; /∗ explicit overrides of core remapping, 1 per key */
119 unsigned char vmods[XkbNumVirtualMods]; /∗ real mods bound to virtual mods */
120 unsigned short * vmodmap; /∗ virtual mods bound to key, 1 per keycode*/
121 } XkbServerMapRec, *XkbServerMapPtr;
122X Version 11 libX11 1.6.5 XkbFreeServerMap(3)