Constify the syms_out argument to xkb_key_get_syms()
[platform/upstream/libxkbcommon.git] / src / xkballoc.h
1 /*
2 Copyright 2009  Dan Nicholson
3
4 Permission is hereby granted, free of charge, to any person obtaining a
5 copy of this software and associated documentation files (the "Software"),
6 to deal in the Software without restriction, including without limitation
7 the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 and/or sell copies of the Software, and to permit persons to whom the
9 Software is furnished to do so, subject to the following conditions:
10
11 The above copyright notice and this permission notice shall be included in
12 all copies or substantial portions of the Software.
13
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
18 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
19 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20
21 Except as contained in this notice, the names of the authors or their
22 institutions shall not be used in advertising or otherwise to promote the
23 sale, use or other dealings in this Software without prior written
24 authorization from the authors.
25 */
26
27 #ifndef _XKBALLOC_H_
28 #define _XKBALLOC_H_
29
30 #include <X11/X.h>
31 #include "xkbcommon/xkbcommon.h"
32 #include "XKBcommonint.h"
33
34 extern int
35 XkbcAllocCompatMap(struct xkb_keymap * xkb, unsigned which, unsigned nSI);
36
37 extern int
38 XkbcAllocNames(struct xkb_keymap * xkb, unsigned which, unsigned nTotalAliases);
39
40 extern int
41 XkbcAllocControls(struct xkb_keymap * xkb, unsigned which);
42
43 extern int
44 XkbcAllocIndicatorMaps(struct xkb_keymap * xkb);
45
46 extern struct xkb_keymap *
47 XkbcAllocKeyboard(struct xkb_context *context);
48
49 extern void
50 XkbcFreeKeyboard(struct xkb_keymap * xkb);
51
52 /***====================================================================***/
53
54 extern int
55 XkbcAllocClientMap(struct xkb_keymap * xkb, unsigned which, unsigned nTotalTypes);
56
57 extern int
58 XkbcAllocServerMap(struct xkb_keymap * xkb, unsigned which, unsigned nNewActions);
59
60 extern int
61 XkbcCopyKeyType(struct xkb_key_type * from, struct xkb_key_type *into);
62
63 extern Bool
64 XkbcResizeKeySyms(struct xkb_keymap * xkb, xkb_keycode_t key, uint32_t needed);
65
66 extern union xkb_action *
67 XkbcResizeKeyActions(struct xkb_keymap * xkb, xkb_keycode_t key, uint32_t needed);
68
69 extern void
70 XkbcFreeClientMap(struct xkb_keymap * xkb);
71
72 extern void
73 XkbcFreeServerMap(struct xkb_keymap * xkb);
74
75 extern unsigned int
76 xkb_key_get_syms_by_level(struct xkb_keymap *xkb, xkb_keycode_t key,
77                           unsigned int group, unsigned int level,
78                           const xkb_keysym_t **syms_out);
79
80 #endif /* _XKBALLOC_H_ */