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 struct xkb_context {
  99     int refcnt;
 100
 101     ATTR_PRINTF(3, 0) void (*log_fn)(struct xkb_context *ctx,
 102                                      enum xkb_log_level level,
 103                                      const char *fmt, va_list args);
 104     enum xkb_log_level log_level;
 105     int log_verbosity;
 106     void *user_data;
 107
 108     darray(char *) includes;
 109     darray(char *) failed_includes;
 110
 111     /* xkbcomp needs to assign sequential IDs to XkbFile's it creates. */
 112     unsigned file_id;
 113
 114     struct atom_table *atom_table;
 115 };
 116
 117 /**
 118  * Legacy names for the components of an XKB keymap, also known as KcCGST.
 119  */
 120 struct xkb_component_names {
 121     char *keycodes;
 122     char *types;
 123     char *compat;
 124     char *symbols;
 125 };
 126
 127 struct xkb_mods {
 128     xkb_mod_mask_t mods;       /* original real+virtual mods in definition */
 129     xkb_mod_mask_t mask;       /* computed effective mask */
 130 };
 131
 132 struct xkb_mod_action {
 133     uint8_t type;
 134     uint8_t flags;
 135     struct xkb_mods mods;
 136 };
 137
 138 struct xkb_group_action {
 139     uint8_t type;
 140     uint8_t flags;
 141     int32_t group;
 142 };
 143
 144 struct xkb_iso_action {
 145     uint8_t type;
 146     uint8_t flags;
 147     struct xkb_mods mods;
 148     int32_t group;
 149     uint8_t affect;
 150 };
 151
 152 struct xkb_controls_action {
 153     uint8_t type;
 154     uint8_t flags;
 155     uint32_t ctrls;
 156 };
 157
 158 struct xkb_device_button_action {
 159     uint8_t type;
 160     uint8_t flags;
 161     uint8_t count;
 162     uint8_t button;
 163     uint8_t device;
 164 };
 165
 166 struct xkb_device_valuator_action {
 167     uint8_t type;
 168     uint8_t device;
 169     uint8_t v1_what;
 170     uint8_t v1_index;
 171     int8_t v1_value;
 172     uint8_t v2_what;
 173     uint8_t v2_index;
 174     int8_t v2_value;
 175 };
 176
 177 struct xkb_pointer_default_action {
 178     uint8_t type;
 179     uint8_t flags;
 180     uint8_t affect;
 181     int8_t value;
 182 };
 183
 184 struct xkb_switch_screen_action {
 185     uint8_t type;
 186     uint8_t flags;
 187     int8_t screen;
 188 };
 189
 190 struct xkb_redirect_key_action {
 191     uint8_t type;
 192     xkb_keycode_t new_kc;
 193     uint8_t mods_mask;
 194     uint8_t mods;
 195     uint16_t vmods_mask;
 196     uint16_t vmods;
 197 };
 198
 199 struct xkb_pointer_action {
 200     uint8_t type;
 201     uint8_t flags;
 202     int16_t x;
 203     int16_t y;
 204 };
 205
 206 struct xkb_message_action {
 207     uint8_t type;
 208     uint8_t flags;
 209     uint8_t message[6];
 210 };
 211
 212 struct xkb_pointer_button_action {
 213     uint8_t type;
 214     uint8_t flags;
 215     uint8_t count;
 216     int8_t button;
 217 };
 218
 219 struct xkb_private_action {
 220     uint8_t type;
 221     uint8_t data[7];
 222 };
 223
 224 union xkb_action {
 225     struct xkb_mod_action mods;
 226     struct xkb_group_action group;
 227     struct xkb_iso_action iso;
 228     struct xkb_controls_action ctrls;
 229     struct xkb_device_button_action devbtn;
 230     struct xkb_device_valuator_action devval;
 231     struct xkb_pointer_default_action dflt;
 232     struct xkb_switch_screen_action screen;
 233     struct xkb_redirect_key_action redirect;    /* XXX wholly unnecessary? */
 234     struct xkb_pointer_action ptr;         /* XXX delete for DeviceValuator */
 235     struct xkb_pointer_button_action btn;  /* XXX delete for DeviceBtn */
 236     struct xkb_message_action msg;         /* XXX just delete */
 237     struct xkb_private_action priv;
 238     unsigned char type;
 239 };
 240
 241 struct xkb_kt_map_entry {
 242     xkb_level_index_t level;
 243     struct xkb_mods mods;
 244     struct xkb_mods preserve;
 245 };
 246
 247 struct xkb_key_type {
 248     struct xkb_mods mods;
 249     xkb_level_index_t num_levels;
 250     struct xkb_kt_map_entry *map;
 251     unsigned int num_entries;
 252     xkb_atom_t name;
 253     xkb_atom_t *level_names;
 254 };
 255
 256 struct xkb_sym_interpret {
 257     xkb_keysym_t sym;
 258     unsigned char flags;
 259     unsigned char match;
 260     uint8_t mods;
 261     xkb_mod_index_t virtual_mod;
 262     union xkb_action act;
 263 };
 264
 265 struct xkb_indicator_map {
 266     unsigned char which_groups;
 267     uint32_t groups;
 268     unsigned char which_mods;
 269     struct xkb_mods mods;
 270     unsigned int ctrls;
 271 };
 272
 273 struct xkb_key_alias {
 274     char real[XkbKeyNameLength];
 275     char alias[XkbKeyNameLength];
 276 };
 277
 278 struct xkb_controls {
 279     unsigned char groups_wrap;
 280     struct xkb_mods internal;
 281     struct xkb_mods ignore_lock;
 282     unsigned short repeat_delay;
 283     unsigned short repeat_interval;
 284     unsigned short slow_keys_delay;
 285     unsigned short debounce_delay;
 286     unsigned short ax_options;
 287     unsigned short ax_timeout;
 288     unsigned short axt_opts_mask;
 289     unsigned short axt_opts_values;
 290     unsigned int axt_ctrls_mask;
 291     unsigned int axt_ctrls_values;
 292 };
 293
 294 struct xkb_key {
 295     char name[XkbKeyNameLength];
 296
 297     unsigned char explicit;
 298
 299     unsigned char modmap;
 300     xkb_mod_mask_t vmodmap;
 301
 302     bool repeats;
 303
 304     union xkb_action *actions;
 305
 306     unsigned kt_index[XkbNumKbdGroups];
 307
 308     xkb_group_index_t num_groups;
 309     /* How many levels the largest group has. */
 310     xkb_level_index_t width;
 311
 312     uint8_t out_of_range_group_action;
 313     xkb_group_index_t out_of_range_group_number;
 314
 315     /* per level/group index into 'syms' */
 316     int *sym_index;
 317     /* per level/group */
 318     unsigned int *num_syms;
 319     darray(xkb_keysym_t) syms;
 320 };
 321
 322 /* Common keyboard description structure */
 323 struct xkb_keymap {
 324     struct xkb_context *ctx;
 325
 326     int refcnt;
 327     enum xkb_map_compile_flags flags;
 328
 329     unsigned int enabled_ctrls;
 330
 331     xkb_keycode_t min_key_code;
 332     xkb_keycode_t max_key_code;
 333
 334     darray(struct xkb_key) keys;
 335
 336     /* aliases in no particular order */
 337     darray(struct xkb_key_alias) key_aliases;
 338
 339     struct xkb_key_type *types;
 340     unsigned int num_types;
 341
 342     darray(struct xkb_sym_interpret) sym_interpret;
 343
 344     /* vmod -> mod mapping */
 345     xkb_mod_mask_t vmods[XkbNumVirtualMods];
 346     const char *vmod_names[XkbNumVirtualMods];
 347
 348     /* Number of groups in the key with the most groups. */
 349     xkb_group_index_t num_groups;
 350     const char *group_names[XkbNumKbdGroups];
 351
 352     struct xkb_indicator_map indicators[XkbNumIndicators];
 353     const char *indicator_names[XkbNumIndicators];
 354
 355     char *keycodes_section_name;
 356     char *symbols_section_name;
 357     char *types_section_name;
 358     char *compat_section_name;
 359 };
 360
 361 static inline struct xkb_key *
 362 XkbKey(struct xkb_keymap *keymap, xkb_keycode_t kc)
 363 {
 364     return &darray_item(keymap->keys, kc);
 365 }
 366
 367 static inline xkb_keycode_t
 368 XkbKeyGetKeycode(struct xkb_keymap *keymap, struct xkb_key *key)
 369 {
 370     /* Hack to avoid having to keep the keycode inside the xkb_key. */
 371     return (xkb_keycode_t)(key - keymap->keys.item);
 372 }
 373
 374 #define xkb_foreach_key_from(iter, keymap, from) \
 375     darray_foreach_from(iter, keymap->keys, from)
 376
 377 #define xkb_foreach_key(iter, keymap) \
 378     xkb_foreach_key_from(iter, keymap, keymap->min_key_code)
 379
 380 static inline struct xkb_key_type *
 381 XkbKeyType(struct xkb_keymap *keymap, struct xkb_key *key,
 382            xkb_group_index_t group)
 383 {
 384     return &keymap->types[key->kt_index[group]];
 385 }
 386
 387 static inline xkb_level_index_t
 388 XkbKeyGroupWidth(struct xkb_keymap *keymap, struct xkb_key *key,
 389                  xkb_group_index_t group)
 390 {
 391     return XkbKeyType(keymap, key, group)->num_levels;
 392 }
 393
 394 static inline unsigned int
 395 XkbKeyNumSyms(struct xkb_key *key, xkb_group_index_t group,
 396               xkb_level_index_t level)
 397 {
 398     return key->num_syms[group * key->width + level];
 399 }
 400
 401 static inline xkb_keysym_t *
 402 XkbKeySymEntry(struct xkb_key *key, xkb_group_index_t group,
 403                xkb_level_index_t level)
 404 {
 405     return &darray_item(key->syms,
 406                         key->sym_index[group * key->width + level]);
 407 }
 408
 409 static inline union xkb_action *
 410 XkbKeyActionEntry(struct xkb_key *key, xkb_group_index_t group,
 411                   xkb_level_index_t level)
 412 {
 413     return &key->actions[key->width * group + level];
 414 }
 415
 416 static inline bool
 417 XkbKeycodeInRange(struct xkb_keymap *keymap, xkb_keycode_t kc)
 418 {
 419     return kc >= keymap->min_key_code && kc <= keymap->max_key_code;
 420 }
 421
 422 struct xkb_keymap *
 423 xkb_map_new(struct xkb_context *ctx);
 424
 425 xkb_atom_t
 426 xkb_atom_intern(struct xkb_context *ctx, const char *string);
 427
 428 /**
 429  * If @string is dynamically allocated, free'd immediately after
 430  * being interned, and not used afterwards, use this function
 431  * instead of xkb_atom_intern to avoid some unnecessary allocations.
 432  * The caller should not use or free the passed in string afterwards.
 433  */
 434 xkb_atom_t
 435 xkb_atom_steal(struct xkb_context *ctx, char *string);
 436
 437 char *
 438 xkb_atom_strdup(struct xkb_context *ctx, xkb_atom_t atom);
 439
 440 const char *
 441 xkb_atom_text(struct xkb_context *ctx, xkb_atom_t atom);
 442
 443 xkb_group_index_t
 444 xkb_key_get_group(struct xkb_state *state, xkb_keycode_t kc);
 445
 446 xkb_level_index_t
 447 xkb_key_get_level(struct xkb_state *state, xkb_keycode_t kc,
 448                   xkb_group_index_t group);
 449
 450 extern int
 451 xkb_key_get_syms_by_level(struct xkb_keymap *keymap, struct xkb_key *key,
 452                           xkb_group_index_t group, xkb_level_index_t level,
 453                           const xkb_keysym_t **syms_out);
 454
 455 extern unsigned
 456 xkb_context_take_file_id(struct xkb_context *ctx);
 457
 458 bool
 459 xkb_keysym_is_lower(xkb_keysym_t keysym);
 460
 461 bool
 462 xkb_keysym_is_upper(xkb_keysym_t keysym);
 463
 464 bool
 465 xkb_keysym_is_keypad(xkb_keysym_t keysym);
 466
 467 ATTR_PRINTF(3, 4) void
 468 xkb_log(struct xkb_context *ctx, enum xkb_log_level level,
 469         const char *fmt, ...);
 470
 471 #define xkb_log_cond_level(ctx, level, ...) do { \
 472     if (xkb_get_log_level(ctx) >= (level)) \
 473     xkb_log((ctx), (level), __VA_ARGS__); \
 474 } while (0)
 475
 476 #define xkb_log_cond_verbosity(ctx, level, vrb, ...) do { \
 477     if (xkb_get_log_verbosity(ctx) >= (vrb)) \
 478     xkb_log_cond_level((ctx), (level), __VA_ARGS__); \
 479 } while (0)
 480
 481 /*
 482  * The format is not part of the argument list in order to avoid the
 483  * "ISO C99 requires rest arguments to be used" warning when only the
 484  * format is supplied without arguments. Not supplying it would still
 485  * result in an error, though.
 486  */
 487 #define log_dbg(ctx, ...) \
 488     xkb_log_cond_level((ctx), XKB_LOG_LEVEL_DEBUG, __VA_ARGS__)
 489 #define log_info(ctx, ...) \
 490     xkb_log_cond_level((ctx), XKB_LOG_LEVEL_INFO, __VA_ARGS__)
 491 #define log_warn(ctx, ...) \
 492     xkb_log_cond_level((ctx), XKB_LOG_LEVEL_WARNING, __VA_ARGS__)
 493 #define log_err(ctx, ...) \
 494     xkb_log_cond_level((ctx), XKB_LOG_LEVEL_ERROR, __VA_ARGS__)
 495 #define log_wsgo(ctx, ...) \
 496     xkb_log_cond_level((ctx), XKB_LOG_LEVEL_CRITICAL, __VA_ARGS__)
 497 #define log_vrb(ctx, vrb, ...) \
 498     xkb_log_cond_verbosity((ctx), XKB_LOG_LEVEL_WARNING, (vrb), __VA_ARGS__)
 499
 500 #endif /* XKB_PRIV_H */