src/keymap.h

   1 /*
   2  * Copyright 1985, 1987, 1990, 1998  The Open Group
   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 shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  18  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  19  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  20  *
  21  * Except as contained in this notice, the names of the authors or their
  22  * institutions shall not be used in advertising or otherwise to promote the
  23  * sale, use or other dealings in this Software without prior written
  24  * authorization from the authors.
  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 /*
  54  * Copyright © 2009 Dan Nicholson
  55  * Copyright © 2012 Intel Corporation
  56  * Copyright © 2012 Ran Benita
  57  *
  58  * Permission is hereby granted, free of charge, to any person obtaining a
  59  * copy of this software and associated documentation files (the "Software"),
  60  * to deal in the Software without restriction, including without limitation
  61  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  62  * and/or sell copies of the Software, and to permit persons to whom the
  63  * Software is furnished to do so, subject to the following conditions:
  64  *
  65  * The above copyright notice and this permission notice (including the next
  66  * paragraph) shall be included in all copies or substantial portions of the
  67  * Software.
  68  *
  69  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  70  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  71  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  72  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  73  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  74  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  75  * DEALINGS IN THE SOFTWARE.
  76  *
  77  * Author: Daniel Stone <daniel@fooishbar.org>
  78  *         Dan Nicholson <dbn.lists@gmail.com>
  79  */
  80
  81 #ifndef MAP_H
  82 #define MAP_H
  83
  84  /* Don't use compat names in internal code. */
  85 #define _XKBCOMMON_COMPAT_H
  86 #include "xkbcommon/xkbcommon.h"
  87
  88 #include "utils.h"
  89 #include "context.h"
  90
  91 /* This limit is artificially enforced, we do not depend on it any where.
  92  * The reason it's still here is that the rules file format does not
  93  * support multiple groups very well, and the rules shipped with
  94  * xkeyboard-config (see rules/evdev) depend on this limit extensively.
  95  * So just lifting this limit would cause problems for people who will use
  96  * more than 4 layouts.
  97  * TODO: Fix the group index syntax in the rules format, preferably in a
  98  *       backwards compatible way.
  99  *       See e.g. https://bugs.freedesktop.org/show_bug.cgi?id=14372
 100  * Note: A limit on the number of groups we *do* depend on is imposed by
 101  * the size of the xkb_layout_mask_t type (32). This is more than enough
 102  * though.
 103  */
 104 #define XKB_NUM_GROUPS 4
 105
 106 /* Don't allow more modifiers than we can hold in xkb_mod_mask_t. */
 107 #define XKB_MAX_MODS ((xkb_mod_index_t) (sizeof(xkb_mod_mask_t) * 8))
 108
 109 /* These should all be dynamic. */
 110 #define XKB_NUM_INDICATORS 32
 111
 112 enum mod_type {
 113     MOD_REAL = (1 << 0),
 114     MOD_VIRT = (1 << 1),
 115     MOD_BOTH = (MOD_REAL | MOD_VIRT),
 116 };
 117
 118 enum xkb_action_type {
 119     ACTION_TYPE_NONE = 0,
 120     ACTION_TYPE_MOD_SET,
 121     ACTION_TYPE_MOD_LATCH,
 122     ACTION_TYPE_MOD_LOCK,
 123     ACTION_TYPE_GROUP_SET,
 124     ACTION_TYPE_GROUP_LATCH,
 125     ACTION_TYPE_GROUP_LOCK,
 126     ACTION_TYPE_PTR_MOVE,
 127     ACTION_TYPE_PTR_BUTTON,
 128     ACTION_TYPE_PTR_LOCK,
 129     ACTION_TYPE_PTR_DEFAULT,
 130     ACTION_TYPE_TERMINATE,
 131     ACTION_TYPE_SWITCH_VT,
 132     ACTION_TYPE_CTRL_SET,
 133     ACTION_TYPE_CTRL_LOCK,
 134     ACTION_TYPE_KEY_REDIRECT,
 135     ACTION_TYPE_PRIVATE,
 136     _ACTION_TYPE_NUM_ENTRIES
 137 };
 138
 139 enum xkb_action_flags {
 140     ACTION_LOCK_CLEAR = (1 << 0),
 141     ACTION_LATCH_TO_LOCK = (1 << 1),
 142     ACTION_LOCK_NO_LOCK = (1 << 2),
 143     ACTION_LOCK_NO_UNLOCK = (1 << 3),
 144     ACTION_MODS_LOOKUP_MODMAP = (1 << 4),
 145     ACTION_ABSOLUTE_SWITCH = (1 << 5),
 146     ACTION_ABSOLUTE_X = (1 << 6),
 147     ACTION_ABSOLUTE_Y = (1 << 7),
 148     ACTION_NO_ACCEL = (1 << 8),
 149     ACTION_SAME_SCREEN = (1 << 9),
 150 };
 151
 152 enum xkb_action_controls {
 153     CONTROL_REPEAT = (1 << 0),
 154     CONTROL_SLOW = (1 << 1),
 155     CONTROL_DEBOUNCE = (1 << 2),
 156     CONTROL_STICKY = (1 << 3),
 157     CONTROL_MOUSEKEYS = (1 << 4),
 158     CONTROL_MOUSEKEYS_ACCEL = (1 << 5),
 159     CONTROL_AX = (1 << 6),
 160     CONTROL_AX_TIMEOUT = (1 << 7),
 161     CONTROL_AX_FEEDBACK = (1 << 8),
 162     CONTROL_BELL = (1 << 9),
 163     CONTROL_IGNORE_GROUP_LOCK = (1 << 10),
 164     CONTROL_ALL = \
 165         (CONTROL_REPEAT | CONTROL_SLOW | CONTROL_DEBOUNCE | CONTROL_STICKY | \
 166          CONTROL_MOUSEKEYS | CONTROL_MOUSEKEYS_ACCEL | CONTROL_AX | \
 167          CONTROL_AX_TIMEOUT | CONTROL_AX_FEEDBACK | CONTROL_BELL | \
 168          CONTROL_IGNORE_GROUP_LOCK)
 169 };
 170
 171 enum xkb_match_operation {
 172     MATCH_NONE = 0,
 173     MATCH_ANY_OR_NONE = 1,
 174     MATCH_ANY = 2,
 175     MATCH_ALL = 3,
 176     MATCH_EXACTLY = 4,
 177     MATCH_OP_MASK = \
 178         (MATCH_NONE | MATCH_ANY_OR_NONE | MATCH_ANY | MATCH_ALL | \
 179          MATCH_EXACTLY),
 180     MATCH_LEVEL_ONE_ONLY = (1 << 7),
 181 };
 182
 183 struct xkb_mods {
 184     xkb_mod_mask_t mods;       /* original real+virtual mods in definition */
 185     xkb_mod_mask_t mask;       /* computed effective mask */
 186 };
 187
 188 struct xkb_mod_action {
 189     enum xkb_action_type type;
 190     enum xkb_action_flags flags;
 191     struct xkb_mods mods;
 192 };
 193
 194 struct xkb_group_action {
 195     enum xkb_action_type type;
 196     enum xkb_action_flags flags;
 197     int32_t group;
 198 };
 199
 200 struct xkb_controls_action {
 201     enum xkb_action_type type;
 202     enum xkb_action_flags flags;
 203     enum xkb_action_controls ctrls;
 204 };
 205
 206 struct xkb_pointer_default_action {
 207     enum xkb_action_type type;
 208     enum xkb_action_flags flags;
 209     int8_t value;
 210 };
 211
 212 struct xkb_switch_screen_action {
 213     enum xkb_action_type type;
 214     enum xkb_action_flags flags;
 215     int8_t screen;
 216 };
 217
 218 struct xkb_redirect_key_action {
 219     enum xkb_action_type type;
 220     enum xkb_action_flags flags;
 221     xkb_keycode_t new_kc;
 222     uint8_t mods_mask;
 223     uint8_t mods;
 224     uint16_t vmods_mask;
 225     uint16_t vmods;
 226 };
 227
 228 struct xkb_pointer_action {
 229     enum xkb_action_type type;
 230     enum xkb_action_flags flags;
 231     int16_t x;
 232     int16_t y;
 233 };
 234
 235 struct xkb_pointer_button_action {
 236     enum xkb_action_type type;
 237     enum xkb_action_flags flags;
 238     uint8_t count;
 239     int8_t button;
 240 };
 241
 242 struct xkb_private_action {
 243     enum xkb_action_type type;
 244     enum xkb_action_flags flags;
 245     uint8_t data[7];
 246 };
 247
 248 union xkb_action {
 249     enum xkb_action_type type;
 250     struct xkb_mod_action mods;
 251     struct xkb_group_action group;
 252     struct xkb_controls_action ctrls;
 253     struct xkb_pointer_default_action dflt;
 254     struct xkb_switch_screen_action screen;
 255     struct xkb_redirect_key_action redirect;    /* XXX wholly unnecessary? */
 256     struct xkb_pointer_action ptr;
 257     struct xkb_pointer_button_action btn;
 258     struct xkb_private_action priv;
 259 };
 260
 261 struct xkb_kt_map_entry {
 262     xkb_level_index_t level;
 263     struct xkb_mods mods;
 264     struct xkb_mods preserve;
 265 };
 266
 267 struct xkb_key_type {
 268     struct xkb_mods mods;
 269     xkb_level_index_t num_levels;
 270     struct xkb_kt_map_entry *map;
 271     unsigned int num_entries;
 272     xkb_atom_t name;
 273     xkb_atom_t *level_names;
 274 };
 275
 276 struct xkb_sym_interpret {
 277     xkb_keysym_t sym;
 278     bool repeat;
 279     enum xkb_match_operation match;
 280     uint8_t mods;
 281     xkb_mod_index_t virtual_mod;
 282     union xkb_action act;
 283 };
 284
 285 struct xkb_indicator_map {
 286     xkb_atom_t name;
 287     enum xkb_state_component which_groups;
 288     xkb_layout_mask_t groups;
 289     enum xkb_state_component which_mods;
 290     struct xkb_mods mods;
 291     enum xkb_action_controls ctrls;
 292 };
 293
 294 struct xkb_key_alias {
 295     xkb_atom_t real;
 296     xkb_atom_t alias;
 297 };
 298
 299 struct xkb_controls {
 300     unsigned char groups_wrap;
 301     struct xkb_mods internal;
 302     struct xkb_mods ignore_lock;
 303     unsigned short repeat_delay;
 304     unsigned short repeat_interval;
 305     unsigned short slow_keys_delay;
 306     unsigned short debounce_delay;
 307     unsigned short ax_options;
 308     unsigned short ax_timeout;
 309     unsigned short axt_opts_mask;
 310     unsigned short axt_opts_values;
 311     unsigned int axt_ctrls_mask;
 312     unsigned int axt_ctrls_values;
 313 };
 314
 315 /* Such an awkward name.  Oh well. */
 316 enum xkb_range_exceed_type {
 317     RANGE_SATURATE,
 318     RANGE_WRAP,
 319     RANGE_REDIRECT,
 320 };
 321
 322 enum xkb_explicit_components {
 323     EXPLICIT_INTERP = (1 << 0),
 324     EXPLICIT_VMODMAP = (1 << 1),
 325     EXPLICIT_REPEAT = (1 << 2),
 326 };
 327
 328 struct xkb_level {
 329     union xkb_action action;
 330     unsigned int num_syms;
 331     union {
 332         xkb_keysym_t sym;       /* num_syms == 1 */
 333         xkb_keysym_t *syms;     /* num_syms > 1  */
 334     } u;
 335 };
 336
 337 struct xkb_group {
 338     bool explicit_type;
 339     /* Points to a type in keymap->types. */
 340     const struct xkb_key_type *type;
 341     /* Use XkbKeyGroupWidth for the number of levels. */
 342     struct xkb_level *levels;
 343 };
 344
 345 struct xkb_key {
 346     xkb_keycode_t keycode;
 347     xkb_atom_t name;
 348
 349     enum xkb_explicit_components explicit;
 350
 351     unsigned char modmap;
 352     xkb_mod_mask_t vmodmap;
 353
 354     bool repeats;
 355
 356     enum xkb_range_exceed_type out_of_range_group_action;
 357     xkb_layout_index_t out_of_range_group_number;
 358
 359     xkb_layout_index_t num_groups;
 360     struct xkb_group *groups;
 361 };
 362
 363 typedef darray(xkb_atom_t) darray_xkb_atom_t;
 364
 365 struct xkb_mod {
 366     xkb_atom_t name;
 367     enum mod_type type;
 368     xkb_mod_mask_t mapping; /* vmod -> real mod mapping */
 369 };
 370
 371 /* Common keyboard description structure */
 372 struct xkb_keymap {
 373     struct xkb_context *ctx;
 374
 375     int refcnt;
 376     enum xkb_keymap_compile_flags flags;
 377     enum xkb_keymap_format format;
 378
 379     enum xkb_action_controls enabled_ctrls;
 380
 381     xkb_keycode_t min_key_code;
 382     xkb_keycode_t max_key_code;
 383
 384     darray(struct xkb_key) keys;
 385
 386     /* aliases in no particular order */
 387     darray(struct xkb_key_alias) key_aliases;
 388
 389     struct xkb_key_type *types;
 390     unsigned int num_types;
 391
 392     darray(struct xkb_sym_interpret) sym_interpret;
 393
 394     darray(struct xkb_mod) mods;
 395
 396     /* Number of groups in the key with the most groups. */
 397     xkb_layout_index_t num_groups;
 398     darray_xkb_atom_t group_names;
 399
 400     struct xkb_indicator_map indicators[XKB_NUM_INDICATORS];
 401
 402     char *keycodes_section_name;
 403     char *symbols_section_name;
 404     char *types_section_name;
 405     char *compat_section_name;
 406 };
 407
 408 static inline const struct xkb_key *
 409 XkbKey(struct xkb_keymap *keymap, xkb_keycode_t kc)
 410 {
 411     if (kc < keymap->min_key_code || kc > keymap->max_key_code)
 412         return NULL;
 413     return &darray_item(keymap->keys, kc);
 414 }
 415
 416 #define xkb_foreach_key(iter, keymap) \
 417     darray_foreach(iter, keymap->keys)
 418
 419 static inline xkb_level_index_t
 420 XkbKeyGroupWidth(const struct xkb_key *key, xkb_layout_index_t layout)
 421 {
 422     return key->groups[layout].type->num_levels;
 423 }
 424
 425 struct xkb_keymap *
 426 xkb_keymap_new(struct xkb_context *ctx,
 427                enum xkb_keymap_format format,
 428                enum xkb_keymap_compile_flags);
 429
 430 #endif