2 * Copyright © 2012 Intel Corporation
3 * Copyright © 2012 Ran Benita <ran234@gmail.com>
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:
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
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.
24 * Author: Daniel Stone <daniel@fooishbar.org>
27 /************************************************************
28 * Copyright (c) 1993 by Silicon Graphics Computer Systems, Inc.
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.
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.
51 * ********************************************************/
57 xkb_keymap_new(struct xkb_context *ctx,
58 enum xkb_keymap_format format,
59 enum xkb_keymap_compile_flags flags)
61 struct xkb_keymap *keymap;
63 keymap = calloc(1, sizeof(*keymap));
68 keymap->ctx = xkb_context_ref(ctx);
70 keymap->format = format;
71 keymap->flags = flags;
76 XKB_EXPORT struct xkb_keymap *
77 xkb_keymap_ref(struct xkb_keymap *keymap)
84 xkb_keymap_unref(struct xkb_keymap *keymap)
89 if (!keymap || --keymap->refcnt > 0)
92 for (i = 0; i < keymap->num_types; i++) {
93 free(keymap->types[i].map);
94 free(keymap->types[i].level_names);
97 darray_foreach(key, keymap->keys) {
104 darray_free(keymap->keys);
105 darray_free(keymap->sym_interpret);
106 darray_free(keymap->key_aliases);
107 free(keymap->keycodes_section_name);
108 free(keymap->symbols_section_name);
109 free(keymap->types_section_name);
110 free(keymap->compat_section_name);
111 xkb_context_unref(keymap->ctx);
116 * Returns the total number of modifiers active in the keymap.
118 XKB_EXPORT xkb_mod_index_t
119 xkb_keymap_num_mods(struct xkb_keymap *keymap)
123 for (i = 0; i < XKB_NUM_VIRTUAL_MODS; i++)
124 if (!keymap->vmod_names[i])
127 /* We always have all the core modifiers (for now), plus any virtual
128 * modifiers we may have defined. */
129 return i + XKB_NUM_CORE_MODS;
133 * Return the name for a given modifier.
135 XKB_EXPORT const char *
136 xkb_keymap_mod_get_name(struct xkb_keymap *keymap, xkb_mod_index_t idx)
140 if (idx >= xkb_keymap_num_mods(keymap))
143 /* First try to find a legacy modifier name. If that fails, try to
144 * find a virtual mod name. */
145 name = ModIndexToName(idx);
147 name = xkb_atom_text(keymap->ctx,
148 keymap->vmod_names[idx - XKB_NUM_CORE_MODS]);
154 * Returns the index for a named modifier.
156 XKB_EXPORT xkb_mod_index_t
157 xkb_keymap_mod_get_index(struct xkb_keymap *keymap, const char *name)
162 i = ModNameToIndex(name);
163 if (i != XKB_MOD_INVALID)
166 atom = xkb_atom_lookup(keymap->ctx, name);
167 if (atom == XKB_ATOM_NONE)
168 return XKB_MOD_INVALID;
170 for (i = 0; i < XKB_NUM_VIRTUAL_MODS; i++) {
171 if (keymap->vmod_names[i] == XKB_ATOM_NONE)
173 if (keymap->vmod_names[i] == atom)
174 return i + XKB_NUM_CORE_MODS;
177 return XKB_MOD_INVALID;
181 * Return the total number of active groups in the keymap.
183 XKB_EXPORT xkb_layout_index_t
184 xkb_keymap_num_layouts(struct xkb_keymap *keymap)
186 return keymap->num_groups;
190 * Returns the name for a given group.
192 XKB_EXPORT const char *
193 xkb_keymap_layout_get_name(struct xkb_keymap *keymap, xkb_layout_index_t idx)
195 if (idx >= xkb_keymap_num_layouts(keymap))
198 return xkb_atom_text(keymap->ctx, keymap->group_names[idx]);
202 * Returns the index for a named layout.
204 XKB_EXPORT xkb_layout_index_t
205 xkb_keymap_layout_get_index(struct xkb_keymap *keymap, const char *name)
207 xkb_layout_index_t num_groups = xkb_keymap_num_layouts(keymap);
208 xkb_atom_t atom = xkb_atom_lookup(keymap->ctx, name);
209 xkb_layout_index_t i;
211 if (atom == XKB_ATOM_NONE)
212 return XKB_LAYOUT_INVALID;
214 for (i = 0; i < num_groups; i++)
215 if (keymap->group_names[i] == atom)
218 return XKB_LAYOUT_INVALID;
222 * Returns the number of layouts active for a particular key.
224 XKB_EXPORT xkb_layout_index_t
225 xkb_keymap_num_layouts_for_key(struct xkb_keymap *keymap, xkb_keycode_t kc)
227 const struct xkb_key *key = XkbKey(keymap, kc);
232 return key->num_groups;
236 * Returns the number of levels active for a particular key and layout.
238 XKB_EXPORT xkb_level_index_t
239 xkb_keymap_num_levels_for_key(struct xkb_keymap *keymap, xkb_keycode_t kc,
240 xkb_layout_index_t layout)
242 const struct xkb_key *key = XkbKey(keymap, kc);
247 return XkbKeyGroupWidth(keymap, key, layout);
251 * Return the total number of active LEDs in the keymap.
253 XKB_EXPORT xkb_led_index_t
254 xkb_keymap_num_leds(struct xkb_keymap *keymap)
256 xkb_led_index_t ret = 0;
259 for (i = 0; i < XKB_NUM_INDICATORS; i++)
260 if (keymap->indicators[i].which_groups ||
261 keymap->indicators[i].which_mods ||
262 keymap->indicators[i].ctrls)
269 * Returns the name for a given group.
271 XKB_EXPORT const char *
272 xkb_keymap_led_get_name(struct xkb_keymap *keymap, xkb_led_index_t idx)
274 if (idx >= xkb_keymap_num_leds(keymap))
277 return xkb_atom_text(keymap->ctx, keymap->indicators[idx].name);
281 * Returns the index for a named group.
283 XKB_EXPORT xkb_layout_index_t
284 xkb_keymap_led_get_index(struct xkb_keymap *keymap, const char *name)
286 xkb_led_index_t num_leds = xkb_keymap_num_leds(keymap);
287 xkb_atom_t atom = xkb_atom_lookup(keymap->ctx, name);
290 if (atom == XKB_ATOM_NONE)
291 return XKB_LED_INVALID;
293 for (i = 0; i < num_leds; i++)
294 if (keymap->indicators[i].name == atom)
297 return XKB_LED_INVALID;
301 * As below, but takes an explicit layout/level rather than state.
304 xkb_keymap_key_get_syms_by_level(struct xkb_keymap *keymap,
306 xkb_layout_index_t layout,
307 xkb_level_index_t level,
308 const xkb_keysym_t **syms_out)
310 const struct xkb_key *key = XkbKey(keymap, kc);
315 if (layout >= key->num_groups)
317 if (level >= XkbKeyGroupWidth(keymap, key, layout))
320 num_syms = XkbKeyNumSyms(key, layout, level);
324 *syms_out = XkbKeySymEntry(key, layout, level);
333 * Simple boolean specifying whether or not the key should repeat.
336 xkb_keymap_key_repeats(struct xkb_keymap *keymap, xkb_keycode_t kc)
338 const struct xkb_key *key = XkbKey(keymap, kc);