Make xkb_keymap_num_leds return the index range instead of active count
[platform/upstream/libxkbcommon.git] / src / keymap.c
1 /**
2  * Copyright © 2012 Intel Corporation
3  * Copyright © 2012 Ran Benita <ran234@gmail.com>
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the next
13  * paragraph) shall be included in all copies or substantial portions of the
14  * Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  * DEALINGS IN THE SOFTWARE.
23  *
24  * Author: Daniel Stone <daniel@fooishbar.org>
25  */
26
27 /************************************************************
28  * Copyright (c) 1993 by Silicon Graphics Computer Systems, Inc.
29  *
30  * Permission to use, copy, modify, and distribute this
31  * software and its documentation for any purpose and without
32  * fee is hereby granted, provided that the above copyright
33  * notice appear in all copies and that both that copyright
34  * notice and this permission notice appear in supporting
35  * documentation, and that the name of Silicon Graphics not be
36  * used in advertising or publicity pertaining to distribution
37  * of the software without specific prior written permission.
38  * Silicon Graphics makes no representation about the suitability
39  * of this software for any purpose. It is provided "as is"
40  * without any express or implied warranty.
41  *
42  * SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
43  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
44  * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
45  * GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
46  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
47  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
48  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION  WITH
49  * THE USE OR PERFORMANCE OF THIS SOFTWARE.
50  *
51  * ********************************************************/
52
53 #include "keymap.h"
54 #include "text.h"
55
56 struct xkb_keymap *
57 xkb_keymap_new(struct xkb_context *ctx,
58                enum xkb_keymap_format format,
59                enum xkb_keymap_compile_flags flags)
60 {
61     struct xkb_keymap *keymap;
62
63     keymap = calloc(1, sizeof(*keymap));
64     if (!keymap)
65         return NULL;
66
67     keymap->refcnt = 1;
68     keymap->ctx = xkb_context_ref(ctx);
69
70     keymap->format = format;
71     keymap->flags = flags;
72
73     return keymap;
74 }
75
76 XKB_EXPORT struct xkb_keymap *
77 xkb_keymap_ref(struct xkb_keymap *keymap)
78 {
79     keymap->refcnt++;
80     return keymap;
81 }
82
83 XKB_EXPORT void
84 xkb_keymap_unref(struct xkb_keymap *keymap)
85 {
86     unsigned int i, j;
87     struct xkb_key *key;
88
89     if (!keymap || --keymap->refcnt > 0)
90         return;
91
92     if (keymap->keys) {
93         xkb_foreach_key(key, keymap) {
94             for (i = 0; i < key->num_groups; i++) {
95                 for (j = 0; j < XkbKeyGroupWidth(key, i); j++)
96                     if (key->groups[i].levels[j].num_syms > 1)
97                         free(key->groups[i].levels[j].u.syms);
98                 free(key->groups[i].levels);
99             }
100             free(key->groups);
101         }
102         free(keymap->keys);
103     }
104     for (i = 0; i < keymap->num_types; i++) {
105         free(keymap->types[i].map);
106         free(keymap->types[i].level_names);
107     }
108     free(keymap->types);
109     darray_free(keymap->sym_interprets);
110     darray_free(keymap->key_aliases);
111     darray_free(keymap->group_names);
112     darray_free(keymap->mods);
113     darray_free(keymap->indicators);
114     free(keymap->keycodes_section_name);
115     free(keymap->symbols_section_name);
116     free(keymap->types_section_name);
117     free(keymap->compat_section_name);
118     xkb_context_unref(keymap->ctx);
119     free(keymap);
120 }
121
122 /**
123  * Returns the total number of modifiers active in the keymap.
124  */
125 XKB_EXPORT xkb_mod_index_t
126 xkb_keymap_num_mods(struct xkb_keymap *keymap)
127 {
128     return darray_size(keymap->mods);
129 }
130
131 /**
132  * Return the name for a given modifier.
133  */
134 XKB_EXPORT const char *
135 xkb_keymap_mod_get_name(struct xkb_keymap *keymap, xkb_mod_index_t idx)
136 {
137     if (idx >= darray_size(keymap->mods))
138         return NULL;
139
140     return xkb_atom_text(keymap->ctx, darray_item(keymap->mods, idx).name);
141 }
142
143 /**
144  * Returns the index for a named modifier.
145  */
146 XKB_EXPORT xkb_mod_index_t
147 xkb_keymap_mod_get_index(struct xkb_keymap *keymap, const char *name)
148 {
149     xkb_mod_index_t i;
150     xkb_atom_t atom;
151     const struct xkb_mod *mod;
152
153     atom = xkb_atom_lookup(keymap->ctx, name);
154     if (atom == XKB_ATOM_NONE)
155         return XKB_MOD_INVALID;
156
157     darray_enumerate(i, mod, keymap->mods)
158         if (mod->name == atom)
159             return i;
160
161     return XKB_MOD_INVALID;
162 }
163
164 /**
165  * Return the total number of active groups in the keymap.
166  */
167 XKB_EXPORT xkb_layout_index_t
168 xkb_keymap_num_layouts(struct xkb_keymap *keymap)
169 {
170     return keymap->num_groups;
171 }
172
173 /**
174  * Returns the name for a given group.
175  */
176 XKB_EXPORT const char *
177 xkb_keymap_layout_get_name(struct xkb_keymap *keymap, xkb_layout_index_t idx)
178 {
179     if (idx >= xkb_keymap_num_layouts(keymap) ||
180         idx >= darray_size(keymap->group_names))
181         return NULL;
182
183     return xkb_atom_text(keymap->ctx, darray_item(keymap->group_names, idx));
184 }
185
186 /**
187  * Returns the index for a named layout.
188  */
189 XKB_EXPORT xkb_layout_index_t
190 xkb_keymap_layout_get_index(struct xkb_keymap *keymap, const char *name)
191 {
192     xkb_atom_t atom = xkb_atom_lookup(keymap->ctx, name);
193     xkb_atom_t *group_name;
194     xkb_layout_index_t i;
195
196     if (atom == XKB_ATOM_NONE)
197         return XKB_LAYOUT_INVALID;
198
199     darray_enumerate(i, group_name, keymap->group_names)
200         if (*group_name == atom)
201             return i;
202
203     return XKB_LAYOUT_INVALID;
204 }
205
206 /**
207  * Returns the number of layouts active for a particular key.
208  */
209 XKB_EXPORT xkb_layout_index_t
210 xkb_keymap_num_layouts_for_key(struct xkb_keymap *keymap, xkb_keycode_t kc)
211 {
212     const struct xkb_key *key = XkbKey(keymap, kc);
213
214     if (!key)
215         return 0;
216
217     return key->num_groups;
218 }
219
220 /**
221  * Returns the number of levels active for a particular key and layout.
222  */
223 XKB_EXPORT xkb_level_index_t
224 xkb_keymap_num_levels_for_key(struct xkb_keymap *keymap, xkb_keycode_t kc,
225                               xkb_layout_index_t layout)
226 {
227     const struct xkb_key *key = XkbKey(keymap, kc);
228
229     if (!key)
230         return 0;
231
232     return XkbKeyGroupWidth(key, layout);
233 }
234
235 /**
236  * Return the total number of LEDs in the keymap.
237  */
238 XKB_EXPORT xkb_led_index_t
239 xkb_keymap_num_leds(struct xkb_keymap *keymap)
240 {
241     return darray_size(keymap->indicators);
242 }
243
244 /**
245  * Returns the name for a given group.
246  */
247 XKB_EXPORT const char *
248 xkb_keymap_led_get_name(struct xkb_keymap *keymap, xkb_led_index_t idx)
249 {
250     if (idx >= darray_size(keymap->indicators))
251         return NULL;
252
253     return xkb_atom_text(keymap->ctx,
254                          darray_item(keymap->indicators, idx).name);
255 }
256
257 /**
258  * Returns the index for a named group.
259  */
260 XKB_EXPORT xkb_led_index_t
261 xkb_keymap_led_get_index(struct xkb_keymap *keymap, const char *name)
262 {
263     xkb_atom_t atom = xkb_atom_lookup(keymap->ctx, name);
264     xkb_led_index_t i;
265     const struct xkb_indicator_map *led;
266
267     if (atom == XKB_ATOM_NONE)
268         return XKB_LED_INVALID;
269
270     darray_enumerate(i, led, keymap->indicators)
271         if (led->name == atom)
272             return i;
273
274     return XKB_LED_INVALID;
275 }
276
277 /**
278  * As below, but takes an explicit layout/level rather than state.
279  */
280 XKB_EXPORT int
281 xkb_keymap_key_get_syms_by_level(struct xkb_keymap *keymap,
282                                  xkb_keycode_t kc,
283                                  xkb_layout_index_t layout,
284                                  xkb_level_index_t level,
285                                  const xkb_keysym_t **syms_out)
286 {
287     const struct xkb_key *key = XkbKey(keymap, kc);
288     int num_syms;
289
290     if (!key)
291         goto err;
292     if (layout >= key->num_groups)
293         goto err;
294     if (level >= XkbKeyGroupWidth(key, layout))
295         goto err;
296
297     num_syms = key->groups[layout].levels[level].num_syms;
298     if (num_syms == 0)
299         goto err;
300
301     if (num_syms == 1)
302         *syms_out = &key->groups[layout].levels[level].u.sym;
303     else
304         *syms_out = key->groups[layout].levels[level].u.syms;
305
306     return num_syms;
307
308 err:
309     *syms_out = NULL;
310     return 0;
311 }
312
313 /**
314  * Simple boolean specifying whether or not the key should repeat.
315  */
316 XKB_EXPORT int
317 xkb_keymap_key_repeats(struct xkb_keymap *keymap, xkb_keycode_t kc)
318 {
319     const struct xkb_key *key = XkbKey(keymap, kc);
320
321     if (!key)
322         return 0;
323
324     return key->repeats;
325 }