src/xkb-priv.h

   1 /*
   2  * Copyright 1985, 1987, 1990, 1998  The Open Group
   3  * Copyright 2008  Dan Nicholson
   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 shall be included in
  13  * all copies or substantial portions of the 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 THE
  18  * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  19  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * Except as contained in this notice, the names of the authors or their
  23  * institutions shall not be used in advertising or otherwise to promote the
  24  * sale, use or other dealings in this Software without prior written
  25  * authorization from the authors.
  26  */
  27
  28 /************************************************************
  29  * Copyright (c) 1993 by Silicon Graphics Computer Systems, Inc.
  30  *
  31  * Permission to use, copy, modify, and distribute this
  32  * software and its documentation for any purpose and without
  33  * fee is hereby granted, provided that the above copyright
  34  * notice appear in all copies and that both that copyright
  35  * notice and this permission notice appear in supporting
  36  * documentation, and that the name of Silicon Graphics not be
  37  * used in advertising or publicity pertaining to distribution
  38  * of the software without specific prior written permission.
  39  * Silicon Graphics makes no representation about the suitability
  40  * of this software for any purpose. It is provided "as is"
  41  * without any express or implied warranty.
  42  *
  43  * SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
  44  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  45  * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
  46  * GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
  47  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  48  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  49  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION  WITH
  50  * THE USE OR PERFORMANCE OF THIS SOFTWARE.
  51  *
  52  ********************************************************/
  53
  54 /*
  55  * Copyright © 2012 Intel Corporation
  56  *
  57  * Permission is hereby granted, free of charge, to any person obtaining a
  58  * copy of this software and associated documentation files (the "Software"),
  59  * to deal in the Software without restriction, including without limitation
  60  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  61  * and/or sell copies of the Software, and to permit persons to whom the
  62  * Software is furnished to do so, subject to the following conditions:
  63  *
  64  * The above copyright notice and this permission notice (including the next
  65  * paragraph) shall be included in all copies or substantial portions of the
  66  * Software.
  67  *
  68  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  69  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  70  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  71  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  72  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  73  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  74  * DEALINGS IN THE SOFTWARE.
  75  *
  76  * Author: Daniel Stone <daniel@fooishbar.org>
  77  */
  78
  79 #ifndef XKB_PRIV_H
  80 #define XKB_PRIV_H
  81
  82 #include <stdbool.h>
  83 #include <string.h>
  84 #include <strings.h>
  85 #include <X11/extensions/XKB.h>
  86
  87 #include "xkbcommon/xkbcommon.h"
  88 #include "utils.h"
  89 #include "darray.h"
  90 #include "list.h"
  91
  92 typedef uint32_t xkb_level_index_t;
  93 typedef uint32_t xkb_atom_t;
  94
  95 #define XKB_ATOM_NONE 0
  96 #define XKB_LEVEL_INVALID 0xffffffff
  97
  98 #define XKB_KEY_NAME_LENGTH 4
  99
 100 /* These should all be dynamic. */
 101 #define XKB_NUM_GROUPS 4
 102 #define XKB_NUM_INDICATORS 32
 103 #define XKB_NUM_VIRTUAL_MODS 16
 104 #define XKB_NUM_CORE_MODS 8
 105
 106 struct xkb_context {
 107     int refcnt;
 108
 109     ATTR_PRINTF(3, 0) void (*log_fn)(struct xkb_context *ctx,
 110                                      enum xkb_log_level level,
 111                                      const char *fmt, va_list args);
 112     enum xkb_log_level log_level;
 113     int log_verbosity;
 114     void *user_data;
 115
 116     darray(char *) includes;
 117     darray(char *) failed_includes;
 118
 119     /* xkbcomp needs to assign sequential IDs to XkbFile's it creates. */
 120     unsigned file_id;
 121
 122     struct atom_table *atom_table;
 123 };
 124
 125 /**
 126  * Legacy names for the components of an XKB keymap, also known as KcCGST.
 127  */
 128 struct xkb_component_names {
 129     char *keycodes;
 130     char *types;
 131     char *compat;
 132     char *symbols;
 133 };
 134
 135 struct xkb_mods {
 136     xkb_mod_mask_t mods;       /* original real+virtual mods in definition */
 137     xkb_mod_mask_t mask;       /* computed effective mask */
 138 };
 139
 140 struct xkb_mod_action {
 141     uint8_t type;
 142     uint8_t flags;
 143     struct xkb_mods mods;
 144 };
 145
 146 struct xkb_group_action {
 147     uint8_t type;
 148     uint8_t flags;
 149     int32_t group;
 150 };
 151
 152 struct xkb_controls_action {
 153     uint8_t type;
 154     uint8_t flags;
 155     uint32_t ctrls;
 156 };
 157
 158 struct xkb_pointer_default_action {
 159     uint8_t type;
 160     uint8_t flags;
 161     uint8_t affect;
 162     int8_t value;
 163 };
 164
 165 struct xkb_switch_screen_action {
 166     uint8_t type;
 167     uint8_t flags;
 168     int8_t screen;
 169 };
 170
 171 struct xkb_redirect_key_action {
 172     uint8_t type;
 173     xkb_keycode_t new_kc;
 174     uint8_t mods_mask;
 175     uint8_t mods;
 176     uint16_t vmods_mask;
 177     uint16_t vmods;
 178 };
 179
 180 struct xkb_pointer_action {
 181     uint8_t type;
 182     uint8_t flags;
 183     int16_t x;
 184     int16_t y;
 185 };
 186
 187 struct xkb_pointer_button_action {
 188     uint8_t type;
 189     uint8_t flags;
 190     uint8_t count;
 191     int8_t button;
 192 };
 193
 194 /* Instead of non-sequential XkbSA_XFree86Private. */
 195 #define PrivateAction (XkbSA_LastAction + 1)
 196
 197 struct xkb_private_action {
 198     uint8_t type;
 199     uint8_t data[7];
 200 };
 201
 202 union xkb_action {
 203     struct xkb_mod_action mods;
 204     struct xkb_group_action group;
 205     struct xkb_controls_action ctrls;
 206     struct xkb_pointer_default_action dflt;
 207     struct xkb_switch_screen_action screen;
 208     struct xkb_redirect_key_action redirect;    /* XXX wholly unnecessary? */
 209     struct xkb_pointer_action ptr;
 210     struct xkb_pointer_button_action btn;
 211     struct xkb_private_action priv;
 212     unsigned char type;
 213 };
 214
 215 struct xkb_kt_map_entry {
 216     xkb_level_index_t level;
 217     struct xkb_mods mods;
 218     struct xkb_mods preserve;
 219 };
 220
 221 struct xkb_key_type {
 222     struct xkb_mods mods;
 223     xkb_level_index_t num_levels;
 224     struct xkb_kt_map_entry *map;
 225     unsigned int num_entries;
 226     xkb_atom_t name;
 227     xkb_atom_t *level_names;
 228 };
 229
 230 struct xkb_sym_interpret {
 231     xkb_keysym_t sym;
 232     unsigned char flags;
 233     unsigned char match;
 234     uint8_t mods;
 235     xkb_mod_index_t virtual_mod;
 236     union xkb_action act;
 237 };
 238
 239 struct xkb_indicator_map {
 240     xkb_atom_t name;
 241     unsigned char which_groups;
 242     uint32_t groups;
 243     unsigned char which_mods;
 244     struct xkb_mods mods;
 245     unsigned int ctrls;
 246 };
 247
 248 struct xkb_key_alias {
 249     char real[XKB_KEY_NAME_LENGTH];
 250     char alias[XKB_KEY_NAME_LENGTH];
 251 };
 252
 253 struct xkb_controls {
 254     unsigned char groups_wrap;
 255     struct xkb_mods internal;
 256     struct xkb_mods ignore_lock;
 257     unsigned short repeat_delay;
 258     unsigned short repeat_interval;
 259     unsigned short slow_keys_delay;
 260     unsigned short debounce_delay;
 261     unsigned short ax_options;
 262     unsigned short ax_timeout;
 263     unsigned short axt_opts_mask;
 264     unsigned short axt_opts_values;
 265     unsigned int axt_ctrls_mask;
 266     unsigned int axt_ctrls_values;
 267 };
 268
 269 struct xkb_key {
 270     char name[XKB_KEY_NAME_LENGTH];
 271
 272     unsigned char explicit;
 273
 274     unsigned char modmap;
 275     xkb_mod_mask_t vmodmap;
 276
 277     bool repeats;
 278
 279     union xkb_action *actions;
 280
 281     unsigned kt_index[XKB_NUM_GROUPS];
 282
 283     xkb_group_index_t num_groups;
 284     /* How many levels the largest group has. */
 285     xkb_level_index_t width;
 286
 287     uint8_t out_of_range_group_action;
 288     xkb_group_index_t out_of_range_group_number;
 289
 290     /* per level/group index into 'syms' */
 291     int *sym_index;
 292     /* per level/group */
 293     unsigned int *num_syms;
 294     darray(xkb_keysym_t) syms;
 295 };
 296
 297 /* Common keyboard description structure */
 298 struct xkb_keymap {
 299     struct xkb_context *ctx;
 300
 301     int refcnt;
 302     enum xkb_map_compile_flags flags;
 303
 304     unsigned int enabled_ctrls;
 305
 306     xkb_keycode_t min_key_code;
 307     xkb_keycode_t max_key_code;
 308
 309     darray(struct xkb_key) keys;
 310
 311     /* aliases in no particular order */
 312     darray(struct xkb_key_alias) key_aliases;
 313
 314     struct xkb_key_type *types;
 315     unsigned int num_types;
 316
 317     darray(struct xkb_sym_interpret) sym_interpret;
 318
 319     /* vmod -> mod mapping */
 320     xkb_mod_mask_t vmods[XKB_NUM_VIRTUAL_MODS];
 321     xkb_atom_t vmod_names[XKB_NUM_VIRTUAL_MODS];
 322
 323     /* Number of groups in the key with the most groups. */
 324     xkb_group_index_t num_groups;
 325     xkb_atom_t group_names[XKB_NUM_GROUPS];
 326
 327     struct xkb_indicator_map indicators[XKB_NUM_INDICATORS];
 328
 329     char *keycodes_section_name;
 330     char *symbols_section_name;
 331     char *types_section_name;
 332     char *compat_section_name;
 333 };
 334
 335 static inline struct xkb_key *
 336 XkbKey(struct xkb_keymap *keymap, xkb_keycode_t kc)
 337 {
 338     return &darray_item(keymap->keys, kc);
 339 }
 340
 341 static inline xkb_keycode_t
 342 XkbKeyGetKeycode(struct xkb_keymap *keymap, struct xkb_key *key)
 343 {
 344     /* Hack to avoid having to keep the keycode inside the xkb_key. */
 345     return (xkb_keycode_t)(key - keymap->keys.item);
 346 }
 347
 348 #define xkb_foreach_key_from(iter, keymap, from) \
 349     darray_foreach_from(iter, keymap->keys, from)
 350
 351 #define xkb_foreach_key(iter, keymap) \
 352     xkb_foreach_key_from(iter, keymap, keymap->min_key_code)
 353
 354 static inline struct xkb_key_type *
 355 XkbKeyType(struct xkb_keymap *keymap, struct xkb_key *key,
 356            xkb_group_index_t group)
 357 {
 358     return &keymap->types[key->kt_index[group]];
 359 }
 360
 361 static inline xkb_level_index_t
 362 XkbKeyGroupWidth(struct xkb_keymap *keymap, struct xkb_key *key,
 363                  xkb_group_index_t group)
 364 {
 365     return XkbKeyType(keymap, key, group)->num_levels;
 366 }
 367
 368 static inline unsigned int
 369 XkbKeyNumSyms(struct xkb_key *key, xkb_group_index_t group,
 370               xkb_level_index_t level)
 371 {
 372     return key->num_syms[group * key->width + level];
 373 }
 374
 375 static inline xkb_keysym_t *
 376 XkbKeySymEntry(struct xkb_key *key, xkb_group_index_t group,
 377                xkb_level_index_t level)
 378 {
 379     return &darray_item(key->syms,
 380                         key->sym_index[group * key->width + level]);
 381 }
 382
 383 static inline union xkb_action *
 384 XkbKeyActionEntry(struct xkb_key *key, xkb_group_index_t group,
 385                   xkb_level_index_t level)
 386 {
 387     return &key->actions[key->width * group + level];
 388 }
 389
 390 static inline bool
 391 XkbKeycodeInRange(struct xkb_keymap *keymap, xkb_keycode_t kc)
 392 {
 393     return kc >= keymap->min_key_code && kc <= keymap->max_key_code;
 394 }
 395
 396 struct xkb_keymap *
 397 xkb_map_new(struct xkb_context *ctx);
 398
 399 /*
 400  * Returns XKB_ATOM_NONE if @string was not previously interned,
 401  * otherwise returns the atom.
 402  */
 403 xkb_atom_t
 404 xkb_atom_lookup(struct xkb_context *ctx, const char *string);
 405
 406 xkb_atom_t
 407 xkb_atom_intern(struct xkb_context *ctx, const char *string);
 408
 409 /**
 410  * If @string is dynamically allocated, free'd immediately after
 411  * being interned, and not used afterwards, use this function
 412  * instead of xkb_atom_intern to avoid some unnecessary allocations.
 413  * The caller should not use or free the passed in string afterwards.
 414  */
 415 xkb_atom_t
 416 xkb_atom_steal(struct xkb_context *ctx, char *string);
 417
 418 char *
 419 xkb_atom_strdup(struct xkb_context *ctx, xkb_atom_t atom);
 420
 421 const char *
 422 xkb_atom_text(struct xkb_context *ctx, xkb_atom_t atom);
 423
 424 xkb_group_index_t
 425 xkb_key_get_group(struct xkb_state *state, xkb_keycode_t kc);
 426
 427 xkb_level_index_t
 428 xkb_key_get_level(struct xkb_state *state, xkb_keycode_t kc,
 429                   xkb_group_index_t group);
 430
 431 extern int
 432 xkb_key_get_syms_by_level(struct xkb_keymap *keymap, struct xkb_key *key,
 433                           xkb_group_index_t group, xkb_level_index_t level,
 434                           const xkb_keysym_t **syms_out);
 435
 436 extern unsigned
 437 xkb_context_take_file_id(struct xkb_context *ctx);
 438
 439 bool
 440 xkb_keysym_is_lower(xkb_keysym_t keysym);
 441
 442 bool
 443 xkb_keysym_is_upper(xkb_keysym_t keysym);
 444
 445 bool
 446 xkb_keysym_is_keypad(xkb_keysym_t keysym);
 447
 448 ATTR_PRINTF(3, 4) void
 449 xkb_log(struct xkb_context *ctx, enum xkb_log_level level,
 450         const char *fmt, ...);
 451
 452 #define xkb_log_cond_level(ctx, level, ...) do { \
 453     if (xkb_get_log_level(ctx) >= (level)) \
 454     xkb_log((ctx), (level), __VA_ARGS__); \
 455 } while (0)
 456
 457 #define xkb_log_cond_verbosity(ctx, level, vrb, ...) do { \
 458     if (xkb_get_log_verbosity(ctx) >= (vrb)) \
 459     xkb_log_cond_level((ctx), (level), __VA_ARGS__); \
 460 } while (0)
 461
 462 /*
 463  * The format is not part of the argument list in order to avoid the
 464  * "ISO C99 requires rest arguments to be used" warning when only the
 465  * format is supplied without arguments. Not supplying it would still
 466  * result in an error, though.
 467  */
 468 #define log_dbg(ctx, ...) \
 469     xkb_log_cond_level((ctx), XKB_LOG_LEVEL_DEBUG, __VA_ARGS__)
 470 #define log_info(ctx, ...) \
 471     xkb_log_cond_level((ctx), XKB_LOG_LEVEL_INFO, __VA_ARGS__)
 472 #define log_warn(ctx, ...) \
 473     xkb_log_cond_level((ctx), XKB_LOG_LEVEL_WARNING, __VA_ARGS__)
 474 #define log_err(ctx, ...) \
 475     xkb_log_cond_level((ctx), XKB_LOG_LEVEL_ERROR, __VA_ARGS__)
 476 #define log_wsgo(ctx, ...) \
 477     xkb_log_cond_level((ctx), XKB_LOG_LEVEL_CRITICAL, __VA_ARGS__)
 478 #define log_vrb(ctx, vrb, ...) \
 479     xkb_log_cond_verbosity((ctx), XKB_LOG_LEVEL_WARNING, (vrb), __VA_ARGS__)
 480
 481 #endif /* XKB_PRIV_H */