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;
  87     struct xkb_key *key;
  88
  89     if (!keymap || --keymap->refcnt > 0)
  90         return;
  91
  92     for (i = 0; i < keymap->num_types; i++) {
  93         free(keymap->types[i].map);
  94         free(keymap->types[i].level_names);
  95     }
  96     free(keymap->types);
  97     darray_foreach(key, keymap->keys) {
  98         free(key->sym_index);
  99         free(key->num_syms);
 100         free(key->syms);
 101         free(key->actions);
 102         free(key->kt_index);
 103     }
 104     darray_free(keymap->keys);
 105     darray_free(keymap->sym_interpret);
 106     darray_free(keymap->key_aliases);
 107     darray_free(keymap->group_names);
 108     free(keymap->keycodes_section_name);
 109     free(keymap->symbols_section_name);
 110     free(keymap->types_section_name);
 111     free(keymap->compat_section_name);
 112     xkb_context_unref(keymap->ctx);
 113     free(keymap);
 114 }
 115
 116 /**
 117  * Returns the total number of modifiers active in the keymap.
 118  */
 119 XKB_EXPORT xkb_mod_index_t
 120 xkb_keymap_num_mods(struct xkb_keymap *keymap)
 121 {
 122     xkb_mod_index_t i;
 123
 124     for (i = 0; i < XKB_NUM_VIRTUAL_MODS; i++)
 125         if (!keymap->vmod_names[i])
 126             break;
 127
 128     /* We always have all the core modifiers (for now), plus any virtual
 129      * modifiers we may have defined. */
 130     return i + XKB_NUM_CORE_MODS;
 131 }
 132
 133 /**
 134  * Return the name for a given modifier.
 135  */
 136 XKB_EXPORT const char *
 137 xkb_keymap_mod_get_name(struct xkb_keymap *keymap, xkb_mod_index_t idx)
 138 {
 139     const char *name;
 140
 141     if (idx >= xkb_keymap_num_mods(keymap))
 142         return NULL;
 143
 144     /* First try to find a legacy modifier name.  If that fails, try to
 145      * find a virtual mod name. */
 146     name = ModIndexToName(idx);
 147     if (!name)
 148         name = xkb_atom_text(keymap->ctx,
 149                              keymap->vmod_names[idx - XKB_NUM_CORE_MODS]);
 150
 151     return name;
 152 }
 153
 154 /**
 155  * Returns the index for a named modifier.
 156  */
 157 XKB_EXPORT xkb_mod_index_t
 158 xkb_keymap_mod_get_index(struct xkb_keymap *keymap, const char *name)
 159 {
 160     xkb_mod_index_t i;
 161     xkb_atom_t atom;
 162
 163     i = ModNameToIndex(name);
 164     if (i != XKB_MOD_INVALID)
 165         return i;
 166
 167     atom = xkb_atom_lookup(keymap->ctx, name);
 168     if (atom == XKB_ATOM_NONE)
 169         return XKB_MOD_INVALID;
 170
 171     for (i = 0; i < XKB_NUM_VIRTUAL_MODS; i++) {
 172         if (keymap->vmod_names[i] == XKB_ATOM_NONE)
 173             break;
 174         if (keymap->vmod_names[i] == atom)
 175             return i + XKB_NUM_CORE_MODS;
 176     }
 177
 178     return XKB_MOD_INVALID;
 179 }
 180
 181 /**
 182  * Return the total number of active groups in the keymap.
 183  */
 184 XKB_EXPORT xkb_layout_index_t
 185 xkb_keymap_num_layouts(struct xkb_keymap *keymap)
 186 {
 187     return keymap->num_groups;
 188 }
 189
 190 /**
 191  * Returns the name for a given group.
 192  */
 193 XKB_EXPORT const char *
 194 xkb_keymap_layout_get_name(struct xkb_keymap *keymap, xkb_layout_index_t idx)
 195 {
 196     if (idx >= xkb_keymap_num_layouts(keymap) ||
 197         idx >= darray_size(keymap->group_names))
 198         return NULL;
 199
 200     return xkb_atom_text(keymap->ctx, darray_item(keymap->group_names, idx));
 201 }
 202
 203 /**
 204  * Returns the index for a named layout.
 205  */
 206 XKB_EXPORT xkb_layout_index_t
 207 xkb_keymap_layout_get_index(struct xkb_keymap *keymap, const char *name)
 208 {
 209     xkb_atom_t atom = xkb_atom_lookup(keymap->ctx, name);
 210     xkb_atom_t *group_name;
 211     xkb_layout_index_t i;
 212
 213     if (atom == XKB_ATOM_NONE)
 214         return XKB_LAYOUT_INVALID;
 215
 216     darray_enumerate(i, group_name, keymap->group_names)
 217         if (*group_name == atom)
 218             return i;
 219
 220     return XKB_LAYOUT_INVALID;
 221 }
 222
 223 /**
 224  * Returns the number of layouts active for a particular key.
 225  */
 226 XKB_EXPORT xkb_layout_index_t
 227 xkb_keymap_num_layouts_for_key(struct xkb_keymap *keymap, xkb_keycode_t kc)
 228 {
 229     const struct xkb_key *key = XkbKey(keymap, kc);
 230
 231     if (!key)
 232         return 0;
 233
 234     return key->num_groups;
 235 }
 236
 237 /**
 238  * Returns the number of levels active for a particular key and layout.
 239  */
 240 XKB_EXPORT xkb_level_index_t
 241 xkb_keymap_num_levels_for_key(struct xkb_keymap *keymap, xkb_keycode_t kc,
 242                               xkb_layout_index_t layout)
 243 {
 244     const struct xkb_key *key = XkbKey(keymap, kc);
 245
 246     if (!key)
 247         return 0;
 248
 249     return XkbKeyGroupWidth(keymap, key, layout);
 250 }
 251
 252 /**
 253  * Return the total number of active LEDs in the keymap.
 254  */
 255 XKB_EXPORT xkb_led_index_t
 256 xkb_keymap_num_leds(struct xkb_keymap *keymap)
 257 {
 258     xkb_led_index_t ret = 0;
 259     xkb_led_index_t i;
 260
 261     for (i = 0; i < XKB_NUM_INDICATORS; i++)
 262         if (keymap->indicators[i].which_groups ||
 263             keymap->indicators[i].which_mods ||
 264             keymap->indicators[i].ctrls)
 265             ret++;
 266
 267     return ret;
 268 }
 269
 270 /**
 271  * Returns the name for a given group.
 272  */
 273 XKB_EXPORT const char *
 274 xkb_keymap_led_get_name(struct xkb_keymap *keymap, xkb_led_index_t idx)
 275 {
 276     if (idx >= xkb_keymap_num_leds(keymap))
 277         return NULL;
 278
 279     return xkb_atom_text(keymap->ctx, keymap->indicators[idx].name);
 280 }
 281
 282 /**
 283  * Returns the index for a named group.
 284  */
 285 XKB_EXPORT xkb_layout_index_t
 286 xkb_keymap_led_get_index(struct xkb_keymap *keymap, const char *name)
 287 {
 288     xkb_led_index_t num_leds = xkb_keymap_num_leds(keymap);
 289     xkb_atom_t atom = xkb_atom_lookup(keymap->ctx, name);
 290     xkb_led_index_t i;
 291
 292     if (atom == XKB_ATOM_NONE)
 293         return XKB_LED_INVALID;
 294
 295     for (i = 0; i < num_leds; i++)
 296         if (keymap->indicators[i].name == atom)
 297             return i;
 298
 299     return XKB_LED_INVALID;
 300 }
 301
 302 /**
 303  * As below, but takes an explicit layout/level rather than state.
 304  */
 305 XKB_EXPORT int
 306 xkb_keymap_key_get_syms_by_level(struct xkb_keymap *keymap,
 307                                  xkb_keycode_t kc,
 308                                  xkb_layout_index_t layout,
 309                                  xkb_level_index_t level,
 310                                  const xkb_keysym_t **syms_out)
 311 {
 312     const struct xkb_key *key = XkbKey(keymap, kc);
 313     int num_syms;
 314
 315     if (!key)
 316         goto err;
 317     if (layout >= key->num_groups)
 318         goto err;
 319     if (level >= XkbKeyGroupWidth(keymap, key, layout))
 320         goto err;
 321
 322     num_syms = XkbKeyNumSyms(key, layout, level);
 323     if (num_syms == 0)
 324         goto err;
 325
 326     *syms_out = XkbKeySymEntry(key, layout, level);
 327     return num_syms;
 328
 329 err:
 330     *syms_out = NULL;
 331     return 0;
 332 }
 333
 334 /**
 335  * Simple boolean specifying whether or not the key should repeat.
 336  */
 337 XKB_EXPORT int
 338 xkb_keymap_key_repeats(struct xkb_keymap *keymap, xkb_keycode_t kc)
 339 {
 340     const struct xkb_key *key = XkbKey(keymap, kc);
 341
 342     if (!key)
 343         return 0;
 344
 345     return key->repeats;
 346 }