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 vmods than we can hold in xkb_mod_mask_t. */
 107 #define XKB_MAX_VIRTUAL_MODS \
 108     ((xkb_mod_index_t) (sizeof(xkb_mod_mask_t) * 8 - XKB_NUM_CORE_MODS))
 109
 110 /* These should all be dynamic. */
 111 #define XKB_NUM_INDICATORS 32
 112 #define XKB_NUM_CORE_MODS 8
 113
 114 enum xkb_action_type {
 115     ACTION_TYPE_NONE = 0,
 116     ACTION_TYPE_MOD_SET,
 117     ACTION_TYPE_MOD_LATCH,
 118     ACTION_TYPE_MOD_LOCK,
 119     ACTION_TYPE_GROUP_SET,
 120     ACTION_TYPE_GROUP_LATCH,
 121     ACTION_TYPE_GROUP_LOCK,
 122     ACTION_TYPE_PTR_MOVE,
 123     ACTION_TYPE_PTR_BUTTON,
 124     ACTION_TYPE_PTR_LOCK,
 125     ACTION_TYPE_PTR_DEFAULT,
 126     ACTION_TYPE_TERMINATE,
 127     ACTION_TYPE_SWITCH_VT,
 128     ACTION_TYPE_CTRL_SET,
 129     ACTION_TYPE_CTRL_LOCK,
 130     ACTION_TYPE_KEY_REDIRECT,
 131     ACTION_TYPE_PRIVATE,
 132     _ACTION_TYPE_NUM_ENTRIES
 133 };
 134
 135 enum xkb_action_flags {
 136     ACTION_LOCK_CLEAR = (1 << 0),
 137     ACTION_LATCH_TO_LOCK = (1 << 1),
 138     ACTION_LOCK_NO_LOCK = (1 << 2),
 139     ACTION_LOCK_NO_UNLOCK = (1 << 3),
 140     ACTION_MODS_LOOKUP_MODMAP = (1 << 4),
 141     ACTION_ABSOLUTE_SWITCH = (1 << 5),
 142     ACTION_ABSOLUTE_X = (1 << 6),
 143     ACTION_ABSOLUTE_Y = (1 << 7),
 144     ACTION_NO_ACCEL = (1 << 8),
 145     ACTION_SAME_SCREEN = (1 << 9),
 146 };
 147
 148 enum xkb_action_controls {
 149     CONTROL_REPEAT = (1 << 0),
 150     CONTROL_SLOW = (1 << 1),
 151     CONTROL_DEBOUNCE = (1 << 2),
 152     CONTROL_STICKY = (1 << 3),
 153     CONTROL_MOUSEKEYS = (1 << 4),
 154     CONTROL_MOUSEKEYS_ACCEL = (1 << 5),
 155     CONTROL_AX = (1 << 6),
 156     CONTROL_AX_TIMEOUT = (1 << 7),
 157     CONTROL_AX_FEEDBACK = (1 << 8),
 158     CONTROL_BELL = (1 << 9),
 159     CONTROL_IGNORE_GROUP_LOCK = (1 << 10),
 160     CONTROL_ALL = \
 161         (CONTROL_REPEAT | CONTROL_SLOW | CONTROL_DEBOUNCE | CONTROL_STICKY | \
 162          CONTROL_MOUSEKEYS | CONTROL_MOUSEKEYS_ACCEL | CONTROL_AX | \
 163          CONTROL_AX_TIMEOUT | CONTROL_AX_FEEDBACK | CONTROL_BELL | \
 164          CONTROL_IGNORE_GROUP_LOCK)
 165 };
 166
 167 enum xkb_match_operation {
 168     MATCH_NONE = 0,
 169     MATCH_ANY_OR_NONE = 1,
 170     MATCH_ANY = 2,
 171     MATCH_ALL = 3,
 172     MATCH_EXACTLY = 4,
 173     MATCH_OP_MASK = \
 174         (MATCH_NONE | MATCH_ANY_OR_NONE | MATCH_ANY | MATCH_ALL | \
 175          MATCH_EXACTLY),
 176     MATCH_LEVEL_ONE_ONLY = (1 << 7),
 177 };
 178
 179 struct xkb_mods {
 180     xkb_mod_mask_t mods;       /* original real+virtual mods in definition */
 181     xkb_mod_mask_t mask;       /* computed effective mask */
 182 };
 183
 184 struct xkb_mod_action {
 185     enum xkb_action_type type;
 186     enum xkb_action_flags flags;
 187     struct xkb_mods mods;
 188 };
 189
 190 struct xkb_group_action {
 191     enum xkb_action_type type;
 192     enum xkb_action_flags flags;
 193     int32_t group;
 194 };
 195
 196 struct xkb_controls_action {
 197     enum xkb_action_type type;
 198     enum xkb_action_flags flags;
 199     enum xkb_action_controls ctrls;
 200 };
 201
 202 struct xkb_pointer_default_action {
 203     enum xkb_action_type type;
 204     enum xkb_action_flags flags;
 205     int8_t value;
 206 };
 207
 208 struct xkb_switch_screen_action {
 209     enum xkb_action_type type;
 210     enum xkb_action_flags flags;
 211     int8_t screen;
 212 };
 213
 214 struct xkb_redirect_key_action {
 215     enum xkb_action_type type;
 216     enum xkb_action_flags flags;
 217     xkb_keycode_t new_kc;
 218     uint8_t mods_mask;
 219     uint8_t mods;
 220     uint16_t vmods_mask;
 221     uint16_t vmods;
 222 };
 223
 224 struct xkb_pointer_action {
 225     enum xkb_action_type type;
 226     enum xkb_action_flags flags;
 227     int16_t x;
 228     int16_t y;
 229 };
 230
 231 struct xkb_pointer_button_action {
 232     enum xkb_action_type type;
 233     enum xkb_action_flags flags;
 234     uint8_t count;
 235     int8_t button;
 236 };
 237
 238 struct xkb_private_action {
 239     enum xkb_action_type type;
 240     enum xkb_action_flags flags;
 241     uint8_t data[7];
 242 };
 243
 244 union xkb_action {
 245     enum xkb_action_type type;
 246     struct xkb_mod_action mods;
 247     struct xkb_group_action group;
 248     struct xkb_controls_action ctrls;
 249     struct xkb_pointer_default_action dflt;
 250     struct xkb_switch_screen_action screen;
 251     struct xkb_redirect_key_action redirect;    /* XXX wholly unnecessary? */
 252     struct xkb_pointer_action ptr;
 253     struct xkb_pointer_button_action btn;
 254     struct xkb_private_action priv;
 255 };
 256
 257 struct xkb_kt_map_entry {
 258     xkb_level_index_t level;
 259     struct xkb_mods mods;
 260     struct xkb_mods preserve;
 261 };
 262
 263 struct xkb_key_type {
 264     struct xkb_mods mods;
 265     xkb_level_index_t num_levels;
 266     struct xkb_kt_map_entry *map;
 267     unsigned int num_entries;
 268     xkb_atom_t name;
 269     xkb_atom_t *level_names;
 270 };
 271
 272 struct xkb_sym_interpret {
 273     xkb_keysym_t sym;
 274     bool repeat;
 275     enum xkb_match_operation match;
 276     uint8_t mods;
 277     xkb_mod_index_t virtual_mod;
 278     union xkb_action act;
 279 };
 280
 281 struct xkb_indicator_map {
 282     xkb_atom_t name;
 283     enum xkb_state_component which_groups;
 284     xkb_layout_mask_t groups;
 285     enum xkb_state_component which_mods;
 286     struct xkb_mods mods;
 287     enum xkb_action_controls ctrls;
 288 };
 289
 290 struct xkb_key_alias {
 291     xkb_atom_t real;
 292     xkb_atom_t alias;
 293 };
 294
 295 struct xkb_controls {
 296     unsigned char groups_wrap;
 297     struct xkb_mods internal;
 298     struct xkb_mods ignore_lock;
 299     unsigned short repeat_delay;
 300     unsigned short repeat_interval;
 301     unsigned short slow_keys_delay;
 302     unsigned short debounce_delay;
 303     unsigned short ax_options;
 304     unsigned short ax_timeout;
 305     unsigned short axt_opts_mask;
 306     unsigned short axt_opts_values;
 307     unsigned int axt_ctrls_mask;
 308     unsigned int axt_ctrls_values;
 309 };
 310
 311 /* Such an awkward name.  Oh well. */
 312 enum xkb_range_exceed_type {
 313     RANGE_SATURATE,
 314     RANGE_WRAP,
 315     RANGE_REDIRECT,
 316 };
 317
 318 enum xkb_explicit_components {
 319     EXPLICIT_INTERP = (1 << 0),
 320     EXPLICIT_VMODMAP = (1 << 1),
 321     EXPLICIT_REPEAT = (1 << 2),
 322 };
 323
 324 struct xkb_level {
 325     union xkb_action action;
 326     unsigned int num_syms;
 327     union {
 328         xkb_keysym_t sym;       /* num_syms == 1 */
 329         xkb_keysym_t *syms;     /* num_syms > 1  */
 330     } u;
 331 };
 332
 333 struct xkb_group {
 334     bool explicit_type;
 335     /* Points to a type in keymap->types. */
 336     const struct xkb_key_type *type;
 337     /* Use XkbKeyGroupWidth for the number of levels. */
 338     struct xkb_level *levels;
 339 };
 340
 341 struct xkb_key {
 342     xkb_keycode_t keycode;
 343     xkb_atom_t name;
 344
 345     enum xkb_explicit_components explicit;
 346
 347     unsigned char modmap;
 348     xkb_mod_mask_t vmodmap;
 349
 350     bool repeats;
 351
 352     enum xkb_range_exceed_type out_of_range_group_action;
 353     xkb_layout_index_t out_of_range_group_number;
 354
 355     xkb_layout_index_t num_groups;
 356     struct xkb_group *groups;
 357 };
 358
 359 typedef darray(xkb_atom_t) darray_xkb_atom_t;
 360
 361 struct xkb_vmod {
 362     xkb_atom_t name;
 363     xkb_mod_mask_t mapping; /* vmod -> real mod mapping */
 364 };
 365
 366 /* Common keyboard description structure */
 367 struct xkb_keymap {
 368     struct xkb_context *ctx;
 369
 370     int refcnt;
 371     enum xkb_keymap_compile_flags flags;
 372     enum xkb_keymap_format format;
 373
 374     enum xkb_action_controls enabled_ctrls;
 375
 376     xkb_keycode_t min_key_code;
 377     xkb_keycode_t max_key_code;
 378
 379     darray(struct xkb_key) keys;
 380
 381     /* aliases in no particular order */
 382     darray(struct xkb_key_alias) key_aliases;
 383
 384     struct xkb_key_type *types;
 385     unsigned int num_types;
 386
 387     darray(struct xkb_sym_interpret) sym_interpret;
 388
 389     darray(struct xkb_vmod) vmods;
 390
 391     /* Number of groups in the key with the most groups. */
 392     xkb_layout_index_t num_groups;
 393     darray_xkb_atom_t group_names;
 394
 395     struct xkb_indicator_map indicators[XKB_NUM_INDICATORS];
 396
 397     char *keycodes_section_name;
 398     char *symbols_section_name;
 399     char *types_section_name;
 400     char *compat_section_name;
 401 };
 402
 403 static inline const struct xkb_key *
 404 XkbKey(struct xkb_keymap *keymap, xkb_keycode_t kc)
 405 {
 406     if (kc < keymap->min_key_code || kc > keymap->max_key_code)
 407         return NULL;
 408     return &darray_item(keymap->keys, kc);
 409 }
 410
 411 #define xkb_foreach_key(iter, keymap) \
 412     darray_foreach(iter, keymap->keys)
 413
 414 static inline xkb_level_index_t
 415 XkbKeyGroupWidth(const struct xkb_key *key, xkb_layout_index_t layout)
 416 {
 417     return key->groups[layout].type->num_levels;
 418 }
 419
 420 struct xkb_keymap *
 421 xkb_keymap_new(struct xkb_context *ctx,
 422                enum xkb_keymap_format format,
 423                enum xkb_keymap_compile_flags);
 424
 425 #endif