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 #include "xkb-priv.h"
  53
  54 /**
  55  * Returns the total number of modifiers active in the keymap.
  56  */
  57 XKB_EXPORT xkb_mod_index_t
  58 xkb_map_num_mods(struct xkb_keymap *keymap)
  59 {
  60     xkb_mod_index_t i;
  61
  62     for (i = 0; i < XkbNumVirtualMods; i++)
  63         if (!keymap->vmod_names[i])
  64             break;
  65
  66     /* We always have all the core modifiers (for now), plus any virtual
  67      * modifiers we may have defined, and then shift to one-based indexing. */
  68     return i + Mod5MapIndex + 1;
  69 }
  70
  71 /**
  72  * Return the name for a given modifier.
  73  */
  74 XKB_EXPORT const char *
  75 xkb_map_mod_get_name(struct xkb_keymap *keymap, xkb_mod_index_t idx)
  76 {
  77     if (idx >= xkb_map_num_mods(keymap))
  78         return NULL;
  79
  80     /* First try to find a legacy modifier name. */
  81     switch (idx) {
  82     case ShiftMapIndex:
  83         return "Shift";
  84     case ControlMapIndex:
  85         return "Control";
  86     case LockMapIndex:
  87         return "Caps Lock";
  88     case Mod1MapIndex:
  89         return "Mod1";
  90     case Mod2MapIndex:
  91         return "Mod2";
  92     case Mod3MapIndex:
  93         return "Mod3";
  94     case Mod4MapIndex:
  95         return "Mod4";
  96     case Mod5MapIndex:
  97         return "Mod5";
  98     default:
  99         break;
 100     }
 101
 102     /* If that fails, try to find a virtual mod name. */
 103     return keymap->vmod_names[idx - Mod5MapIndex];
 104 }
 105
 106 /**
 107  * Returns the index for a named modifier.
 108  */
 109 XKB_EXPORT xkb_mod_index_t
 110 xkb_map_mod_get_index(struct xkb_keymap *keymap, const char *name)
 111 {
 112     xkb_mod_index_t i;
 113
 114     if (istreq(name, "Shift"))
 115         return ShiftMapIndex;
 116     if (istreq(name, "Control"))
 117         return ControlMapIndex;
 118     if (istreq(name, "Caps Lock"))
 119         return LockMapIndex;
 120     if (istreq(name, "Mod1"))
 121         return Mod1MapIndex;
 122     if (istreq(name, "Mod2"))
 123         return Mod2MapIndex;
 124     if (istreq(name, "Mod3"))
 125         return Mod3MapIndex;
 126     if (istreq(name, "Mod4"))
 127         return Mod4MapIndex;
 128     if (istreq(name, "Mod5"))
 129         return Mod5MapIndex;
 130
 131     for (i = 0; i < XkbNumVirtualMods && keymap->vmod_names[i]; i++) {
 132         if (istreq(name, keymap->vmod_names[i]))
 133             return i + Mod5MapIndex;
 134     }
 135
 136     return XKB_GROUP_INVALID;
 137 }
 138
 139 /**
 140  * Return the total number of active groups in the keymap.
 141  */
 142 XKB_EXPORT xkb_group_index_t
 143 xkb_map_num_groups(struct xkb_keymap *keymap)
 144 {
 145     xkb_group_index_t ret = 0;
 146     xkb_group_index_t i;
 147
 148     for (i = 0; i < XkbNumKbdGroups; i++)
 149         if (keymap->groups[i].mask)
 150             ret++;
 151
 152     return ret;
 153 }
 154
 155 /**
 156  * Returns the name for a given group.
 157  */
 158 XKB_EXPORT const char *
 159 xkb_map_group_get_name(struct xkb_keymap *keymap, xkb_group_index_t idx)
 160 {
 161     if (idx >= xkb_map_num_groups(keymap))
 162         return NULL;
 163
 164     return keymap->group_names[idx];
 165 }
 166
 167 /**
 168  * Returns the index for a named group.
 169  */
 170 XKB_EXPORT xkb_group_index_t
 171 xkb_map_group_get_index(struct xkb_keymap *keymap, const char *name)
 172 {
 173     xkb_group_index_t num_groups = xkb_map_num_groups(keymap);
 174     xkb_group_index_t i;
 175
 176     for (i = 0; i < num_groups; i++)
 177         if (istreq(keymap->group_names[i], name))
 178             return i;
 179
 180     return XKB_GROUP_INVALID;
 181 }
 182
 183 /**
 184  * Returns the number of groups active for a particular key.
 185  */
 186 XKB_EXPORT xkb_group_index_t
 187 xkb_key_num_groups(struct xkb_keymap *keymap, xkb_keycode_t kc)
 188 {
 189     if (XkbKeycodeInRange(keymap, kc))
 190         return XkbKey(keymap, kc)->num_groups;
 191     return 0;
 192 }
 193
 194 /**
 195  * Return the total number of active LEDs in the keymap.
 196  */
 197 XKB_EXPORT xkb_led_index_t
 198 xkb_map_num_leds(struct xkb_keymap *keymap)
 199 {
 200     xkb_led_index_t ret = 0;
 201     xkb_led_index_t i;
 202
 203     for (i = 0; i < XkbNumIndicators; i++)
 204         if (keymap->indicators[i].which_groups ||
 205             keymap->indicators[i].which_mods ||
 206             keymap->indicators[i].ctrls)
 207             ret++;
 208
 209     return ret;
 210 }
 211
 212 /**
 213  * Returns the name for a given group.
 214  */
 215 XKB_EXPORT const char *
 216 xkb_map_led_get_name(struct xkb_keymap *keymap, xkb_led_index_t idx)
 217 {
 218     if (idx >= xkb_map_num_leds(keymap))
 219         return NULL;
 220
 221     return keymap->indicator_names[idx];
 222 }
 223
 224 /**
 225  * Returns the index for a named group.
 226  */
 227 XKB_EXPORT xkb_group_index_t
 228 xkb_map_led_get_index(struct xkb_keymap *keymap, const char *name)
 229 {
 230     xkb_led_index_t num_leds = xkb_map_num_leds(keymap);
 231     xkb_led_index_t i;
 232
 233     for (i = 0; i < num_leds; i++)
 234         if (istreq(keymap->indicator_names[i], name))
 235             return i;
 236
 237     return XKB_LED_INVALID;
 238 }
 239
 240 /**
 241  * Returns the level to use for the given key and state, or -1 if invalid.
 242  */
 243 unsigned int
 244 xkb_key_get_level(struct xkb_state *state, xkb_keycode_t kc,
 245                   xkb_group_index_t group)
 246 {
 247     struct xkb_keymap *keymap = xkb_state_get_map(state);
 248     struct xkb_key_type *type;
 249     struct xkb_kt_map_entry *entry;
 250     unsigned int active_mods;
 251
 252     if (!XkbKeycodeInRange(keymap, kc))
 253         return 0;
 254
 255     type = XkbKeyType(keymap, XkbKey(keymap, kc), group);
 256     active_mods = xkb_state_serialize_mods(state, XKB_STATE_EFFECTIVE);
 257     active_mods &= type->mods.mask;
 258
 259     darray_foreach(entry, type->map) {
 260         if (entry->mods.mask == active_mods)
 261             return entry->level;
 262     }
 263
 264     return 0;
 265 }
 266
 267 /**
 268  * Returns the group to use for the given key and state, taking
 269  * wrapping/clamping/etc into account.
 270  */
 271 xkb_group_index_t
 272 xkb_key_get_group(struct xkb_state *state, xkb_keycode_t kc)
 273 {
 274     struct xkb_keymap *keymap = xkb_state_get_map(state);
 275     xkb_group_index_t ret = xkb_state_serialize_group(state,
 276                                                       XKB_STATE_EFFECTIVE);
 277     struct xkb_key *key;
 278
 279     if (!XkbKeycodeInRange(keymap, kc))
 280         return 0;
 281     key = XkbKey(keymap, kc);
 282
 283     if (ret < key->num_groups)
 284         return ret;
 285
 286     switch (key->out_of_range_group_action) {
 287     case XkbRedirectIntoRange:
 288         ret = key->out_of_range_group_number;
 289         if (ret >= key->num_groups)
 290             ret = 0;
 291         break;
 292
 293     case XkbClampIntoRange:
 294         ret = key->num_groups - 1;
 295         break;
 296
 297     case XkbWrapIntoRange:
 298     default:
 299         ret %= key->num_groups;
 300         break;
 301     }
 302
 303     return ret;
 304 }
 305
 306 /**
 307  * As below, but takes an explicit group/level rather than state.
 308  */
 309 int
 310 xkb_key_get_syms_by_level(struct xkb_keymap *keymap, struct xkb_key *key,
 311                           xkb_group_index_t group, unsigned int level,
 312                           const xkb_keysym_t **syms_out)
 313 {
 314     int num_syms;
 315
 316     if (group >= key->num_groups)
 317         goto err;
 318     if (level >= XkbKeyGroupWidth(keymap, key, group))
 319         goto err;
 320
 321     num_syms = XkbKeyNumSyms(key, group, level);
 322     if (num_syms == 0)
 323         goto err;
 324
 325     *syms_out = XkbKeySymEntry(key, group, level);
 326     return num_syms;
 327
 328 err:
 329     *syms_out = NULL;
 330     return 0;
 331 }
 332
 333 /**
 334  * Provides the symbols to use for the given key and state.  Returns the
 335  * number of symbols pointed to in syms_out.
 336  */
 337 XKB_EXPORT int
 338 xkb_key_get_syms(struct xkb_state *state, xkb_keycode_t kc,
 339                  const xkb_keysym_t **syms_out)
 340 {
 341     struct xkb_keymap *keymap = xkb_state_get_map(state);
 342     struct xkb_key *key;
 343     xkb_group_index_t group;
 344     unsigned int level;
 345
 346     if (!state || !XkbKeycodeInRange(keymap, kc))
 347         return -1;
 348
 349     key = XkbKey(keymap, kc);
 350
 351     group = xkb_key_get_group(state, kc);
 352     if (group == -1)
 353         goto err;
 354
 355     level = xkb_key_get_level(state, kc, group);
 356     if (level == -1)
 357         goto err;
 358
 359     return xkb_key_get_syms_by_level(keymap, key, group, level, syms_out);
 360
 361 err:
 362     *syms_out = NULL;
 363     return 0;
 364 }
 365
 366 /**
 367  * Simple boolean specifying whether or not the key should repeat.
 368  */
 369 XKB_EXPORT int
 370 xkb_key_repeats(struct xkb_keymap *keymap, xkb_keycode_t kc)
 371 {
 372     if (!XkbKeycodeInRange(keymap, kc))
 373         return 0;
 374     return XkbKey(keymap, kc)->repeats;
 375 }