text: explicitly take mod_type in mod functions
[platform/upstream/libxkbcommon.git] / src / text.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 (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21  * DEALINGS IN THE SOFTWARE.
22  */
23
24 #ifndef TEXT_H
25 #define TEXT_H
26
27 typedef struct {
28     const char *name;
29     unsigned int value;
30 } LookupEntry;
31
32 bool
33 LookupString(const LookupEntry tab[], const char *string,
34               unsigned int *value_rtrn);
35
36 const char *
37 LookupValue(const LookupEntry tab[], unsigned int value);
38
39 extern const LookupEntry ctrlMaskNames[];
40 extern const LookupEntry modComponentMaskNames[];
41 extern const LookupEntry groupComponentMaskNames[];
42 extern const LookupEntry groupMaskNames[];
43 extern const LookupEntry groupNames[];
44 extern const LookupEntry levelNames[];
45 extern const LookupEntry buttonNames[];
46 extern const LookupEntry useModMapValueNames[];
47 extern const LookupEntry actionTypeNames[];
48 extern const LookupEntry symInterpretMatchMaskNames[];
49
50 const char *
51 ModMaskText(const struct xkb_keymap *keymap, xkb_mod_mask_t mask,
52             enum mod_type type);
53
54 const char *
55 ModIndexText(const struct xkb_keymap *keymap, xkb_mod_index_t ndx,
56              enum mod_type type);
57
58 xkb_mod_index_t
59 ModNameToIndex(const struct xkb_keymap *keymap, xkb_atom_t name,
60                enum mod_type type);
61
62 const char *
63 ActionTypeText(enum xkb_action_type type);
64
65 const char *
66 KeysymText(xkb_keysym_t sym);
67
68 const char *
69 KeyNameText(struct xkb_context *ctx, xkb_atom_t name);
70
71 const char *
72 SIMatchText(enum xkb_match_operation type);
73
74 #endif /* TEXT_H */