src/map.c

   1 /**
   2  * Copyright © 2012 Intel Corporation
   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  * Author: Daniel Stone <daniel@fooishbar.org>
  24  */
  25
  26 /************************************************************
  27  * Copyright (c) 1993 by Silicon Graphics Computer Systems, Inc.
  28  *
  29  * Permission to use, copy, modify, and distribute this
  30  * software and its documentation for any purpose and without
  31  * fee is hereby granted, provided that the above copyright
  32  * notice appear in all copies and that both that copyright
  33  * notice and this permission notice appear in supporting
  34  * documentation, and that the name of Silicon Graphics not be
  35  * used in advertising or publicity pertaining to distribution
  36  * of the software without specific prior written permission.
  37  * Silicon Graphics makes no representation about the suitability
  38  * of this software for any purpose. It is provided "as is"
  39  * without any express or implied warranty.
  40  *
  41  * SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
  42  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  43  * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
  44  * GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
  45  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  46  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  47  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION  WITH
  48  * THE USE OR PERFORMANCE OF THIS SOFTWARE.
  49  *
  50  * ********************************************************/
  51
  52 #ifdef HAVE_CONFIG_H
  53 #include <config.h>
  54 #endif
  55
  56 #include "utils.h"
  57 #include "xkbcommon/xkbcommon.h"
  58 #include "XKBcommonint.h"
  59 #include "xkballoc.h"
  60
  61 /**
  62  * Returns the total number of modifiers active in the keymap.
  63  */
  64 xkb_mod_index_t
  65 xkb_map_num_mods(struct xkb_keymap *xkb)
  66 {
  67     xkb_mod_index_t i;
  68
  69     for (i = 0; i < XkbNumVirtualMods; i++)
  70         if (!xkb->names->vmods[i])
  71             break;
  72
  73     /* We always have all the core modifiers (for now), plus any virtual
  74      * modifiers we may have defined, and then shift to one-based indexing. */
  75     return i + Mod5MapIndex + 1;
  76 }
  77
  78 /**
  79  * Return the name for a given modifier.
  80  */
  81 const char *
  82 xkb_map_mod_get_name(struct xkb_keymap *xkb, xkb_mod_index_t idx)
  83 {
  84     if (idx >= xkb_map_num_mods(xkb))
  85         return NULL;
  86
  87     /* First try to find a legacy modifier name. */
  88     switch (idx) {
  89     case ShiftMapIndex:
  90         return "Shift";
  91     case ControlMapIndex:
  92         return "Control";
  93     case LockMapIndex:
  94         return "Caps Lock";
  95     case Mod1MapIndex:
  96         return "Mod1";
  97     case Mod2MapIndex:
  98         return "Mod2";
  99     case Mod3MapIndex:
 100         return "Mod3";
 101     case Mod4MapIndex:
 102         return "Mod4";
 103     case Mod5MapIndex:
 104         return "Mod5";
 105     default:
 106         break;
 107     }
 108
 109     /* If that fails, try to find a virtual mod name. */
 110     return xkb->names->vmods[idx - Mod5MapIndex];
 111 }
 112
 113 /**
 114  * Returns the index for a named modifier.
 115  */
 116 xkb_mod_index_t
 117 xkb_map_mod_get_index(struct xkb_keymap *xkb, const char *name)
 118 {
 119     xkb_mod_index_t i;
 120
 121     if (strcasecmp(name, "Shift") == 0)
 122         return ShiftMapIndex;
 123     if (strcasecmp(name, "Control") == 0)
 124         return ControlMapIndex;
 125     if (strcasecmp(name, "Caps Lock") == 0)
 126         return LockMapIndex;
 127     if (strcasecmp(name, "Mod1") == 0)
 128         return Mod1MapIndex;
 129     if (strcasecmp(name, "Mod2") == 0)
 130         return Mod2MapIndex;
 131     if (strcasecmp(name, "Mod3") == 0)
 132         return Mod3MapIndex;
 133     if (strcasecmp(name, "Mod4") == 0)
 134         return Mod4MapIndex;
 135     if (strcasecmp(name, "Mod5") == 0)
 136         return Mod5MapIndex;
 137
 138     for (i = 0; i < XkbNumVirtualMods && xkb->names->vmods[i]; i++) {
 139         if (strcasecmp(name, xkb->names->vmods[i]) == 0)
 140             return i + Mod5MapIndex;
 141     }
 142
 143     return XKB_GROUP_INVALID;
 144 }
 145
 146 /**
 147  * Return the total number of active groups in the keymap.
 148  */
 149 xkb_group_index_t
 150 xkb_map_num_groups(struct xkb_keymap *xkb)
 151 {
 152     xkb_group_index_t ret = 0;
 153     xkb_group_index_t i;
 154
 155     for (i = 0; i < XkbNumKbdGroups; i++)
 156         if (xkb->compat->groups[i].mask)
 157             ret++;
 158
 159     return ret;
 160 }
 161
 162 /**
 163  * Returns the name for a given group.
 164  */
 165 const char *
 166 xkb_map_group_get_name(struct xkb_keymap *xkb, xkb_group_index_t idx)
 167 {
 168     if (idx >= xkb_map_num_groups(xkb))
 169         return NULL;
 170
 171     return xkb->names->groups[idx];
 172 }
 173
 174 /**
 175  * Returns the index for a named group.
 176  */
 177 xkb_group_index_t
 178 xkb_map_group_get_index(struct xkb_keymap *xkb, const char *name)
 179 {
 180     xkb_group_index_t num_groups = xkb_map_num_groups(xkb);
 181     xkb_group_index_t i;
 182
 183     for (i = 0; i < num_groups; i++) {
 184         if (strcasecmp(xkb->names->groups[i], name) == 0)
 185             return i;
 186     }
 187
 188     return XKB_GROUP_INVALID;
 189 }
 190
 191 /**
 192  * Returns the number of groups active for a particular key.
 193  */
 194 xkb_group_index_t
 195 xkb_key_num_groups(struct xkb_keymap *xkb, xkb_keycode_t key)
 196 {
 197     return XkbKeyNumGroups(xkb, key);
 198 }
 199
 200 /**
 201  * Return the total number of active LEDs in the keymap.
 202  */
 203 xkb_led_index_t
 204 xkb_map_num_leds(struct xkb_keymap *xkb)
 205 {
 206     xkb_led_index_t ret = 0;
 207     xkb_led_index_t i;
 208
 209     for (i = 0; i < XkbNumIndicators; i++)
 210         if (xkb->indicators->maps[i].which_groups ||
 211             xkb->indicators->maps[i].which_mods ||
 212             xkb->indicators->maps[i].ctrls)
 213             ret++;
 214
 215     return ret;
 216 }
 217
 218 /**
 219  * Returns the name for a given group.
 220  */
 221 const char *
 222 xkb_map_led_get_name(struct xkb_keymap *xkb, xkb_led_index_t idx)
 223 {
 224     if (idx >= xkb_map_num_leds(xkb))
 225         return NULL;
 226
 227     return xkb->names->indicators[idx];
 228 }
 229
 230 /**
 231  * Returns the index for a named group.
 232  */
 233 xkb_group_index_t
 234 xkb_map_led_get_index(struct xkb_keymap *xkb, const char *name)
 235 {
 236     xkb_led_index_t num_leds = xkb_map_num_leds(xkb);
 237     xkb_led_index_t i;
 238
 239     for (i = 0; i < num_leds; i++) {
 240         if (strcasecmp(xkb->names->indicators[i], name) == 0)
 241             return i;
 242     }
 243
 244     return XKB_LED_INVALID;
 245 }
 246
 247 /**
 248  * Returns the level to use for the given key and state, or -1 if invalid.
 249  */
 250 unsigned int
 251 xkb_key_get_level(struct xkb_state *state, xkb_keycode_t key,
 252                   unsigned int group)
 253 {
 254     struct xkb_key_type *type = XkbKeyType(state->xkb, key, group);
 255     unsigned int active_mods = state->mods & type->mods.mask;
 256     int i;
 257
 258     for (i = 0; i < type->map_count; i++) {
 259         if (!type->map[i].active)
 260             continue;
 261         if (type->map[i].mods.mask == active_mods)
 262             return type->map[i].level;
 263     }
 264
 265     return 0;
 266 }
 267
 268 /**
 269  * Returns the group to use for the given key and state, taking
 270  * wrapping/clamping/etc into account.
 271  */
 272 unsigned int
 273 xkb_key_get_group(struct xkb_state *state, xkb_keycode_t key)
 274 {
 275     unsigned int info = XkbKeyGroupInfo(state->xkb, key);
 276     unsigned int num_groups = XkbKeyNumGroups(state->xkb, key);
 277     unsigned int ret = state->group;
 278
 279     if (ret < XkbKeyNumGroups(state->xkb, key))
 280         return ret;
 281
 282     switch (XkbOutOfRangeGroupAction(info)) {
 283     case XkbRedirectIntoRange:
 284         ret = XkbOutOfRangeGroupInfo(info);
 285         if (ret >= num_groups)
 286             ret = 0;
 287         break;
 288     case XkbClampIntoRange:
 289         ret = num_groups - 1;
 290         break;
 291     case XkbWrapIntoRange:
 292     default:
 293         ret %= num_groups;
 294         break;
 295     }
 296
 297     return ret;
 298 }
 299
 300 /**
 301  * As below, but takes an explicit group/level rather than state.
 302  */
 303 unsigned int
 304 xkb_key_get_syms_by_level(struct xkb_keymap *xkb, xkb_keycode_t key, unsigned int group,
 305                           unsigned int level, const xkb_keysym_t **syms_out)
 306 {
 307     int num_syms;
 308
 309     if (group >= XkbKeyNumGroups(xkb, key))
 310         goto err;
 311     if (level >= XkbKeyGroupWidth(xkb, key, group))
 312         goto err;
 313
 314     num_syms = XkbKeyNumSyms(xkb, key, group, level);
 315     if (num_syms == 0)
 316         goto err;
 317
 318     *syms_out = XkbKeySymEntry(xkb, key, group, level);
 319     return num_syms;
 320
 321 err:
 322     *syms_out = NULL;
 323     return 0;
 324 }
 325
 326 /**
 327  * Provides the symbols to use for the given key and state.  Returns the
 328  * number of symbols pointed to in syms_out.
 329  */
 330 unsigned int
 331 xkb_key_get_syms(struct xkb_state *state, xkb_keycode_t key,
 332                  const xkb_keysym_t **syms_out)
 333 {
 334     struct xkb_keymap *xkb = state->xkb;
 335     int group;
 336     int level;
 337
 338     if (!state || key < xkb->min_key_code || key > xkb->max_key_code)
 339         return -1;
 340
 341     group = xkb_key_get_group(state, key);
 342     if (group == -1)
 343         goto err;
 344     level = xkb_key_get_level(state, key, group);
 345     if (level == -1)
 346         goto err;
 347
 348     return xkb_key_get_syms_by_level(xkb, key, group, level, syms_out);
 349
 350 err:
 351     *syms_out = NULL;
 352     return 0;
 353 }