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