src/keymap.c

   1 /**
   2  * Copyright © 2012 Intel Corporation
   3  * Copyright © 2012 Ran Benita <ran234@gmail.com>
   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 (including the next
  13  * paragraph) shall be included in all copies or substantial portions of the
  14  * Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  *
  24  * Author: Daniel Stone <daniel@fooishbar.org>
  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 #include "keymap.h"
  54 #include "text.h"
  55
  56 XKB_EXPORT struct xkb_keymap *
  57 xkb_keymap_ref(struct xkb_keymap *keymap)
  58 {
  59     keymap->refcnt++;
  60     return keymap;
  61 }
  62
  63 XKB_EXPORT void
  64 xkb_keymap_unref(struct xkb_keymap *keymap)
  65 {
  66     if (!keymap || --keymap->refcnt > 0)
  67         return;
  68
  69     if (keymap->keys) {
  70         struct xkb_key *key;
  71         xkb_foreach_key(key, keymap) {
  72             if (key->groups) {
  73                 for (unsigned i = 0; i < key->num_groups; i++) {
  74                     if (key->groups[i].levels) {
  75                         for (unsigned j = 0; j < XkbKeyGroupWidth(key, i); j++)
  76                             if (key->groups[i].levels[j].num_syms > 1)
  77                                 free(key->groups[i].levels[j].u.syms);
  78                         free(key->groups[i].levels);
  79                     }
  80                 }
  81                 free(key->groups);
  82             }
  83         }
  84         free(keymap->keys);
  85     }
  86     if (keymap->types) {
  87         for (unsigned i = 0; i < keymap->num_types; i++) {
  88             free(keymap->types[i].entries);
  89             free(keymap->types[i].level_names);
  90         }
  91         free(keymap->types);
  92     }
  93     free(keymap->sym_interprets);
  94     free(keymap->key_aliases);
  95     free(keymap->group_names);
  96     darray_free(keymap->mods.mods);
  97     darray_free(keymap->leds);
  98     free(keymap->keycodes_section_name);
  99     free(keymap->symbols_section_name);
 100     free(keymap->types_section_name);
 101     free(keymap->compat_section_name);
 102     xkb_context_unref(keymap->ctx);
 103     free(keymap);
 104 }
 105
 106 static const struct xkb_keymap_format_ops *
 107 get_keymap_format_ops(enum xkb_keymap_format format)
 108 {
 109     static const struct xkb_keymap_format_ops *keymap_format_ops[] = {
 110         [XKB_KEYMAP_FORMAT_TEXT_V1] = &text_v1_keymap_format_ops,
 111     };
 112
 113     if ((int) format < 0 || (int) format >= (int) ARRAY_SIZE(keymap_format_ops))
 114         return NULL;
 115
 116     return keymap_format_ops[(int) format];
 117 }
 118
 119 XKB_EXPORT struct xkb_keymap *
 120 xkb_keymap_new_from_names(struct xkb_context *ctx,
 121                           const struct xkb_rule_names *rmlvo_in,
 122                           enum xkb_keymap_compile_flags flags)
 123 {
 124     struct xkb_keymap *keymap;
 125     struct xkb_rule_names rmlvo;
 126     const enum xkb_keymap_format format = XKB_KEYMAP_FORMAT_TEXT_V1;
 127     const struct xkb_keymap_format_ops *ops;
 128
 129     ops = get_keymap_format_ops(format);
 130     if (!ops || !ops->keymap_new_from_names) {
 131         log_err_func(ctx, "unsupported keymap format: %d\n", format);
 132         return NULL;
 133     }
 134
 135     if (flags & ~(XKB_KEYMAP_COMPILE_NO_FLAGS)) {
 136         log_err_func(ctx, "unrecognized flags: %#x\n", flags);
 137         return NULL;
 138     }
 139
 140     keymap = xkb_keymap_new(ctx, format, flags);
 141     if (!keymap)
 142         return NULL;
 143
 144     if (rmlvo_in)
 145         rmlvo = *rmlvo_in;
 146     else
 147         memset(&rmlvo, 0, sizeof(rmlvo));
 148     xkb_context_sanitize_rule_names(ctx, &rmlvo);
 149
 150     if (!ops->keymap_new_from_names(keymap, &rmlvo)) {
 151         xkb_keymap_unref(keymap);
 152         return NULL;
 153     }
 154
 155     return keymap;
 156 }
 157
 158 XKB_EXPORT struct xkb_keymap *
 159 xkb_keymap_new_from_string(struct xkb_context *ctx,
 160                            const char *string,
 161                            enum xkb_keymap_format format,
 162                            enum xkb_keymap_compile_flags flags)
 163 {
 164     return xkb_keymap_new_from_buffer(ctx, string, strlen(string),
 165                                       format, flags);
 166 }
 167
 168 XKB_EXPORT struct xkb_keymap *
 169 xkb_keymap_new_from_buffer(struct xkb_context *ctx,
 170                            const char *buffer, size_t length,
 171                            enum xkb_keymap_format format,
 172                            enum xkb_keymap_compile_flags flags)
 173 {
 174     struct xkb_keymap *keymap;
 175     const struct xkb_keymap_format_ops *ops;
 176
 177     ops = get_keymap_format_ops(format);
 178     if (!ops || !ops->keymap_new_from_string) {
 179         log_err_func(ctx, "unsupported keymap format: %d\n", format);
 180         return NULL;
 181     }
 182
 183     if (flags & ~(XKB_KEYMAP_COMPILE_NO_FLAGS)) {
 184         log_err_func(ctx, "unrecognized flags: %#x\n", flags);
 185         return NULL;
 186     }
 187
 188     if (!buffer) {
 189         log_err_func1(ctx, "no buffer specified\n");
 190         return NULL;
 191     }
 192
 193     keymap = xkb_keymap_new(ctx, format, flags);
 194     if (!keymap)
 195         return NULL;
 196
 197     if (!ops->keymap_new_from_string(keymap, buffer, length)) {
 198         xkb_keymap_unref(keymap);
 199         return NULL;
 200     }
 201
 202     return keymap;
 203 }
 204
 205 XKB_EXPORT struct xkb_keymap *
 206 xkb_keymap_new_from_file(struct xkb_context *ctx,
 207                          FILE *file,
 208                          enum xkb_keymap_format format,
 209                          enum xkb_keymap_compile_flags flags)
 210 {
 211     struct xkb_keymap *keymap;
 212     const struct xkb_keymap_format_ops *ops;
 213
 214     ops = get_keymap_format_ops(format);
 215     if (!ops || !ops->keymap_new_from_file) {
 216         log_err_func(ctx, "unsupported keymap format: %d\n", format);
 217         return NULL;
 218     }
 219
 220     if (flags & ~(XKB_KEYMAP_COMPILE_NO_FLAGS)) {
 221         log_err_func(ctx, "unrecognized flags: %#x\n", flags);
 222         return NULL;
 223     }
 224
 225     if (!file) {
 226         log_err_func1(ctx, "no file specified\n");
 227         return NULL;
 228     }
 229
 230     keymap = xkb_keymap_new(ctx, format, flags);
 231     if (!keymap)
 232         return NULL;
 233
 234     if (!ops->keymap_new_from_file(keymap, file)) {
 235         xkb_keymap_unref(keymap);
 236         return NULL;
 237     }
 238
 239     return keymap;
 240 }
 241
 242 XKB_EXPORT char *
 243 xkb_keymap_get_as_string(struct xkb_keymap *keymap,
 244                          enum xkb_keymap_format format)
 245 {
 246     const struct xkb_keymap_format_ops *ops;
 247
 248     if (format == XKB_KEYMAP_USE_ORIGINAL_FORMAT)
 249         format = keymap->format;
 250
 251     ops = get_keymap_format_ops(format);
 252     if (!ops || !ops->keymap_get_as_string) {
 253         log_err_func(keymap->ctx, "unsupported keymap format: %d\n", format);
 254         return NULL;
 255     }
 256
 257     return ops->keymap_get_as_string(keymap);
 258 }
 259
 260 /**
 261  * Returns the total number of modifiers active in the keymap.
 262  */
 263 XKB_EXPORT xkb_mod_index_t
 264 xkb_keymap_num_mods(struct xkb_keymap *keymap)
 265 {
 266     return darray_size(keymap->mods.mods);
 267 }
 268
 269 /**
 270  * Return the name for a given modifier.
 271  */
 272 XKB_EXPORT const char *
 273 xkb_keymap_mod_get_name(struct xkb_keymap *keymap, xkb_mod_index_t idx)
 274 {
 275     if (idx >= darray_size(keymap->mods.mods))
 276         return NULL;
 277
 278     return xkb_atom_text(keymap->ctx,
 279                          darray_item(keymap->mods.mods, idx).name);
 280 }
 281
 282 /**
 283  * Returns the index for a named modifier.
 284  */
 285 XKB_EXPORT xkb_mod_index_t
 286 xkb_keymap_mod_get_index(struct xkb_keymap *keymap, const char *name)
 287 {
 288     xkb_atom_t atom;
 289
 290     atom = xkb_atom_lookup(keymap->ctx, name);
 291     if (atom == XKB_ATOM_NONE)
 292         return XKB_MOD_INVALID;
 293
 294     return XkbModNameToIndex(keymap, atom, MOD_BOTH);
 295 }
 296
 297 /**
 298  * Return the total number of active groups in the keymap.
 299  */
 300 XKB_EXPORT xkb_layout_index_t
 301 xkb_keymap_num_layouts(struct xkb_keymap *keymap)
 302 {
 303     return keymap->num_groups;
 304 }
 305
 306 /**
 307  * Returns the name for a given group.
 308  */
 309 XKB_EXPORT const char *
 310 xkb_keymap_layout_get_name(struct xkb_keymap *keymap, xkb_layout_index_t idx)
 311 {
 312     if (idx >= keymap->num_group_names)
 313         return NULL;
 314
 315     return xkb_atom_text(keymap->ctx, keymap->group_names[idx]);
 316 }
 317
 318 /**
 319  * Returns the index for a named layout.
 320  */
 321 XKB_EXPORT xkb_layout_index_t
 322 xkb_keymap_layout_get_index(struct xkb_keymap *keymap, const char *name)
 323 {
 324     xkb_atom_t atom = xkb_atom_lookup(keymap->ctx, name);
 325     xkb_layout_index_t i;
 326
 327     if (atom == XKB_ATOM_NONE)
 328         return XKB_LAYOUT_INVALID;
 329
 330     for (i = 0; i < keymap->num_group_names; i++)
 331         if (keymap->group_names[i] == atom)
 332             return i;
 333
 334     return XKB_LAYOUT_INVALID;
 335 }
 336
 337 /**
 338  * Returns the number of layouts active for a particular key.
 339  */
 340 XKB_EXPORT xkb_layout_index_t
 341 xkb_keymap_num_layouts_for_key(struct xkb_keymap *keymap, xkb_keycode_t kc)
 342 {
 343     const struct xkb_key *key = XkbKey(keymap, kc);
 344
 345     if (!key)
 346         return 0;
 347
 348     return key->num_groups;
 349 }
 350
 351 /**
 352  * Returns the number of levels active for a particular key and layout.
 353  */
 354 XKB_EXPORT xkb_level_index_t
 355 xkb_keymap_num_levels_for_key(struct xkb_keymap *keymap, xkb_keycode_t kc,
 356                               xkb_layout_index_t layout)
 357 {
 358     const struct xkb_key *key = XkbKey(keymap, kc);
 359
 360     if (!key)
 361         return 0;
 362
 363     layout = XkbWrapGroupIntoRange(layout, key->num_groups,
 364                                    key->out_of_range_group_action,
 365                                    key->out_of_range_group_number);
 366     if (layout == XKB_LAYOUT_INVALID)
 367         return 0;
 368
 369     return XkbKeyGroupWidth(key, layout);
 370 }
 371
 372 /**
 373  * Return the total number of LEDs in the keymap.
 374  */
 375 XKB_EXPORT xkb_led_index_t
 376 xkb_keymap_num_leds(struct xkb_keymap *keymap)
 377 {
 378     return darray_size(keymap->leds);
 379 }
 380
 381 /**
 382  * Returns the name for a given LED.
 383  */
 384 XKB_EXPORT const char *
 385 xkb_keymap_led_get_name(struct xkb_keymap *keymap, xkb_led_index_t idx)
 386 {
 387     if (idx >= darray_size(keymap->leds))
 388         return NULL;
 389
 390     return xkb_atom_text(keymap->ctx, darray_item(keymap->leds, idx).name);
 391 }
 392
 393 /**
 394  * Returns the index for a named LED.
 395  */
 396 XKB_EXPORT xkb_led_index_t
 397 xkb_keymap_led_get_index(struct xkb_keymap *keymap, const char *name)
 398 {
 399     xkb_atom_t atom = xkb_atom_lookup(keymap->ctx, name);
 400     xkb_led_index_t i;
 401     const struct xkb_led *led;
 402
 403     if (atom == XKB_ATOM_NONE)
 404         return XKB_LED_INVALID;
 405
 406     darray_enumerate(i, led, keymap->leds)
 407         if (led->name == atom)
 408             return i;
 409
 410     return XKB_LED_INVALID;
 411 }
 412
 413 /**
 414  * As below, but takes an explicit layout/level rather than state.
 415  */
 416 XKB_EXPORT int
 417 xkb_keymap_key_get_syms_by_level(struct xkb_keymap *keymap,
 418                                  xkb_keycode_t kc,
 419                                  xkb_layout_index_t layout,
 420                                  xkb_level_index_t level,
 421                                  const xkb_keysym_t **syms_out)
 422 {
 423     const struct xkb_key *key = XkbKey(keymap, kc);
 424     int num_syms;
 425
 426     if (!key)
 427         goto err;
 428
 429     layout = XkbWrapGroupIntoRange(layout, key->num_groups,
 430                                    key->out_of_range_group_action,
 431                                    key->out_of_range_group_number);
 432     if (layout == XKB_LAYOUT_INVALID)
 433         goto err;
 434
 435     if (level >= XkbKeyGroupWidth(key, layout))
 436         goto err;
 437
 438     num_syms = key->groups[layout].levels[level].num_syms;
 439     if (num_syms == 0)
 440         goto err;
 441
 442     if (num_syms == 1)
 443         *syms_out = &key->groups[layout].levels[level].u.sym;
 444     else
 445         *syms_out = key->groups[layout].levels[level].u.syms;
 446
 447     return num_syms;
 448
 449 err:
 450     *syms_out = NULL;
 451     return 0;
 452 }
 453
 454 XKB_EXPORT xkb_keycode_t
 455 xkb_keymap_min_keycode(struct xkb_keymap *keymap)
 456 {
 457     return keymap->min_key_code;
 458 }
 459
 460 XKB_EXPORT xkb_keycode_t
 461 xkb_keymap_max_keycode(struct xkb_keymap *keymap)
 462 {
 463     return keymap->max_key_code;
 464 }
 465
 466 XKB_EXPORT void
 467 xkb_keymap_key_for_each(struct xkb_keymap *keymap, xkb_keymap_key_iter_t iter,
 468                         void *data)
 469 {
 470     struct xkb_key *key;
 471
 472     xkb_foreach_key(key, keymap)
 473         iter(keymap, key->keycode, data);
 474 }
 475
 476 /**
 477  * Simple boolean specifying whether or not the key should repeat.
 478  */
 479 XKB_EXPORT int
 480 xkb_keymap_key_repeats(struct xkb_keymap *keymap, xkb_keycode_t kc)
 481 {
 482     const struct xkb_key *key = XkbKey(keymap, kc);
 483
 484     if (!key)
 485         return 0;
 486
 487     return key->repeats;
 488 }