1XkbFreeClientMap(3)              XKB FUNCTIONS             XkbFreeClientMap(3)
2
3
4

NAME

6       XkbFreeClientMap - Free memory used by the client map member of an Xkb‐
7       DescRec structure
8

SYNOPSIS

10       void  XkbFreeClientMap  (XkbDescPtr  xkb,  unsigned  int  which,   Bool
11              free_all);
12

ARGUMENTS

14       - xkb  keyboard description containing client map to free
15
16       - which
17              mask identifying components of map to free
18
19       - free_all
20              True => free all client components and map itself
21

DESCRIPTION

23       XkbFreeClientMap  frees the components of client map specified by which
24       in the XkbDescRec structure specified by the xkb parameter and sets the
25       corresponding  structure  component values to NULL. The which parameter
26       specifies a combination of the client map masks shown in Table 1.
27
28       If free_all is True, which is  ignored;  XkbFreeClientMap  frees  every
29       non-NULL  structure  component  in  the  client  map,  frees  the  Xkb‐
30       ClientMapRec structure referenced by the map member of the xkb  parame‐
31       ter, and sets the map member to NULL.
32
33
34                      Table 1 XkbAllocClientMap Masks
35       ──────────────────────────────────────────────────────────────
36       Mask                 Effect
37       ──────────────────────────────────────────────────────────────
38       XkbKeyTypesMask      The  type_count field specifies the num‐
39                            ber of entries to  preallocate  for  the
40                            types  field  of  the client map. If the
41                            type_count field is less than  XkbNumRe‐
42                            quiredTypes returns BadValue.
43
44       XkbKeySymsMask       The min_key_code and max_key_code fields
45                            of the xkb parameter are used  to  allo‐
46                            cate  the syms and key_sym_map fields of
47                            the client map. The fields are allocated
48                            to contain the maximum number of entries
49                            necessary     for     max_key_code     -
50                            min_key_code + 1 keys.
51
52       XkbModifierMapMask   The min_key_code and max_key_code fields
53                            of the xkb parameter are used  to  allo‐
54                            cate the modmap field of the client map.
55                            The field is allocated  to  contain  the
56                            maximum  number of entries necessary for
57                            max_key_code - min_key_code + 1 keys.
58
59       NOTE: The min_key_code and max_key_code fields  of  the  xkb  parameter
60       must  be legal values if the XkbKeySymsMask or XkbModifierMapMask masks
61       are set in the which  parameter.  If  they  are  not  valid,  XkbAlloc‐
62       ClientMap returns BadValue.
63

STRUCTURES

65       The  complete description of an Xkb keyboard is given by an XkbDescRec.
66       The component structures in the XkbDescRec represent the major Xkb com‐
67       ponents.
68
69       typedef struct {
70          struct _XDisplay * display;      /∗ connection to X server */
71          unsigned short     flags;        /∗ private to Xkb, do not modify */
72          unsigned short     device_spec;  /∗ device of interest */
73          KeyCode            min_key_code; /∗ minimum keycode for device */
74          KeyCode            max_key_code; /∗ maximum keycode for device */
75          XkbControlsPtr     ctrls;        /∗ controls */
76          XkbServerMapPtr    server;       /∗ server keymap */
77          XkbClientMapPtr    map;          /∗ client keymap */
78          XkbIndicatorPtr    indicators;   /∗ indicator map */
79          XkbNamesPtr        names;        /∗ names for all components */
80          XkbCompatMapPtr    compat;       /∗ compatibility map */
81          XkbGeometryPtr     geom;         /∗ physical geometry of keyboard */
82       } XkbDescRec, *XkbDescPtr;
83
84       The  display field points to an X display structure. The flags field is
85       private  to  the  library:  modifying  flags  may  yield  unpredictable
86       results.  The  device_spec field specifies the device identifier of the
87       keyboard input device, or XkbUseCoreKeyboard, which specifies the  core
88       keyboard  device.  The min_key_code and max_key_code fields specify the
89       least and greatest keycode that can be returned by the keyboard.
90
91       Each structure component has a corresponding mask bit that is  used  in
92       function  calls to indicate that the structure should be manipulated in
93       some manner, such as allocating it or freeing it. These masks and their
94       relationships to the fields in the XkbDescRec are shown in Table 2.
95
96
97               Table 2 Mask Bits for XkbDescRec
98       ──────────────────────────────────────────────────
99       Mask Bit               XkbDescRec Field   Value
100       ──────────────────────────────────────────────────
101       XkbControlsMask        ctrls              (1L<<0)
102       XkbServerMapMask       server             (1L<<1)
103       XkbIClientMapMask      map                (1L<<2)
104       XkbIndicatorMapMask    indicators         (1L<<3)
105       XkbNamesMask           names              (1L<<4)
106       XkbCompatMapMask       compat             (1L<<5)
107       XkbGeometryMask        geom               (1L<<6)
108       XkbAllComponentsMask   All Fields         (0x7f)
109
110       The  map field of the complete Xkb keyboard description is a pointer to
111       the Xkb client map, which is of type XkbClientMapRec:
112
113          typedef struct {                   /∗ Client Map */
114             unsigned char     size_types;   /∗ # occupied entries in types */
115             unsigned char     num_types;    /∗ # entries in types */
116             XkbKeyTypePtr     types;        /∗ vector of key types used by this keymap */
117             unsigned short    size_syms;    /∗ length of the syms array */
118             unsigned short    num_syms;     /∗ # entries in syms */
119             KeySym *          syms;         /∗ linear 2d tables of keysyms, 1 per key */
120             XkbSymMapPtr      key_sym_map;  /∗ 1 per keycode, maps keycode to syms */
121             unsigned char *   modmap;       /∗ 1 per keycode, real mods bound to key */
122       } XkbClientMapRec, *XkbClientMapPtr;
123
124

DIAGNOSTICS

126       BadValue       An argument is out of range
127

SEE ALSO

129       XkbAllocClientMap(3)
130
131
132
133X Version 11                     libX11 1.3.4              XkbFreeClientMap(3)
Impressum