src/keymap-dump.c

   1 /************************************************************
   2  * Copyright (c) 1994 by Silicon Graphics Computer Systems, Inc.
   3  *
   4  * Permission to use, copy, modify, and distribute this
   5  * software and its documentation for any purpose and without
   6  * fee is hereby granted, provided that the above copyright
   7  * notice appear in all copies and that both that copyright
   8  * notice and this permission notice appear in supporting
   9  * documentation, and that the name of Silicon Graphics not be
  10  * used in advertising or publicity pertaining to distribution
  11  * of the software without specific prior written permission.
  12  * Silicon Graphics makes no representation about the suitability
  13  * of this software for any purpose. It is provided "as is"
  14  * without any express or implied warranty.
  15  *
  16  * SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
  17  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  18  * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
  19  * GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
  20  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  21  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  22  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION  WITH
  23  * THE USE OR PERFORMANCE OF THIS SOFTWARE.
  24  *
  25  ********************************************************/
  26
  27 /*
  28  * Copyright © 2012 Intel Corporation
  29  *
  30  * Permission is hereby granted, free of charge, to any person obtaining a
  31  * copy of this software and associated documentation files (the "Software"),
  32  * to deal in the Software without restriction, including without limitation
  33  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  34  * and/or sell copies of the Software, and to permit persons to whom the
  35  * Software is furnished to do so, subject to the following conditions:
  36  *
  37  * The above copyright notice and this permission notice (including the next
  38  * paragraph) shall be included in all copies or substantial portions of the
  39  * Software.
  40  *
  41  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  42  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  43  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  44  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  45  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  46  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  47  * DEALINGS IN THE SOFTWARE.
  48  *
  49  * Author: Daniel Stone <daniel@fooishbar.org>
  50  */
  51
  52 #include <stdarg.h>
  53 #include <stdio.h>
  54 #include <ctype.h>
  55 #include <stdlib.h>
  56
  57 #include "xkb-priv.h"
  58 #include "text.h"
  59
  60 #define VMOD_HIDE_VALUE    0
  61 #define VMOD_SHOW_VALUE    1
  62 #define VMOD_COMMENT_VALUE 2
  63
  64 #define BUF_CHUNK_SIZE     4096
  65
  66 struct buf {
  67     char *buf;
  68     size_t size;
  69     size_t alloc;
  70 };
  71
  72 static bool
  73 do_realloc(struct buf *buf, size_t at_least)
  74 {
  75     char *new;
  76
  77     buf->alloc += BUF_CHUNK_SIZE;
  78     if (at_least >= BUF_CHUNK_SIZE)
  79         buf->alloc += at_least;
  80
  81     new = realloc(buf->buf, buf->alloc);
  82     if (!new)
  83         return false;
  84
  85     buf->buf = new;
  86     return true;
  87 }
  88
  89 ATTR_PRINTF(2, 3) static bool
  90 check_write_buf(struct buf *buf, const char *fmt, ...)
  91 {
  92     va_list args;
  93     int printed;
  94     size_t available;
  95
  96     available = buf->alloc - buf->size;
  97     va_start(args, fmt);
  98     printed = vsnprintf(buf->buf + buf->size, available, fmt, args);
  99     va_end(args);
 100
 101     if (printed < 0)
 102         goto err;
 103
 104     if (printed >= available)
 105         if (!do_realloc(buf, printed))
 106             goto err;
 107
 108     /* The buffer has enough space now. */
 109
 110     available = buf->alloc - buf->size;
 111     va_start(args, fmt);
 112     printed = vsnprintf(buf->buf + buf->size, available, fmt, args);
 113     va_end(args);
 114
 115     if (printed >= available || printed < 0)
 116         goto err;
 117
 118     buf->size += printed;
 119     return true;
 120
 121 err:
 122     free(buf->buf);
 123     buf->buf = NULL;
 124     return false;
 125 }
 126
 127 #define write_buf(buf, ...) do { \
 128     if (!check_write_buf(buf, __VA_ARGS__)) \
 129         return false; \
 130 } while (0)
 131
 132 static bool
 133 write_vmods(struct xkb_keymap *keymap, struct buf *buf)
 134 {
 135     int num_vmods = 0;
 136     int i;
 137
 138     for (i = 0; i < XkbNumVirtualMods; i++) {
 139         if (!keymap->vmod_names[i])
 140             continue;
 141         if (num_vmods == 0)
 142             write_buf(buf, "\t\tvirtual_modifiers ");
 143         else
 144             write_buf(buf, ",");
 145         write_buf(buf, "%s", keymap->vmod_names[i]);
 146         num_vmods++;
 147     }
 148
 149     if (num_vmods > 0)
 150         write_buf(buf, ";\n\n");
 151
 152     return true;
 153 }
 154
 155 #define GET_TEXT_BUF_SIZE 512
 156
 157 #define append_get_text(...) do { \
 158         int _size = snprintf(ret, GET_TEXT_BUF_SIZE, __VA_ARGS__); \
 159         if (_size >= GET_TEXT_BUF_SIZE) \
 160             return NULL; \
 161 } while (0)
 162
 163 static char *
 164 get_mod_mask_text(struct xkb_keymap *keymap, uint8_t real_mods,
 165                   uint32_t vmods)
 166 {
 167     static char ret[GET_TEXT_BUF_SIZE], ret2[GET_TEXT_BUF_SIZE];
 168     int i;
 169
 170     memset(ret, 0, GET_TEXT_BUF_SIZE);
 171
 172     if (real_mods == 0 && vmods == 0) {
 173         strcpy(ret, "none");
 174         return ret;
 175     }
 176
 177     /* This is so broken.  If we have a real modmask of 0xff and a
 178      * vmodmask, we'll get, e.g., all+RightControl.  But, it's what xkbfile
 179      * does, so ... */
 180     if (real_mods == 0xff) {
 181         strcpy(ret, "all");
 182     }
 183     else if (real_mods) {
 184         for (i = 0; i < XkbNumModifiers; i++) {
 185             if (!(real_mods & (1 << i)))
 186                 continue;
 187             if (ret[0] != '\0') {
 188                 strcpy(ret2, ret);
 189                 append_get_text("%s+%s", ret2, ModIndexToName(i));
 190             }
 191             else {
 192                 append_get_text("%s", ModIndexToName(i));
 193             }
 194         }
 195     }
 196
 197     if (vmods == 0)
 198         return ret;
 199
 200     for (i = 0; i < XkbNumVirtualMods; i++) {
 201         if (!(vmods & (1 << i)))
 202             continue;
 203         if (ret[0] != '\0') {
 204             strcpy(ret2, ret);
 205             append_get_text("%s+%s", ret2, keymap->vmod_names[i]);
 206         }
 207         else {
 208             append_get_text("%s", keymap->vmod_names[i]);
 209         }
 210     }
 211
 212     return ret;
 213 }
 214
 215 static char *
 216 get_indicator_state_text(uint8_t which)
 217 {
 218     int i;
 219     static char ret[GET_TEXT_BUF_SIZE];
 220     /* FIXME: Merge with ... something ... in xkbcomp? */
 221     static const char *state_names[] = {
 222         "base",
 223         "latched",
 224         "locked",
 225         "effective",
 226         "compat"
 227     };
 228
 229     memset(ret, 0, GET_TEXT_BUF_SIZE);
 230
 231     which &= XkbIM_UseAnyMods;
 232
 233     if (which == 0) {
 234         strcpy(ret, "0");
 235         return NULL;
 236     }
 237
 238     for (i = 0; which != 0; i++) {
 239         if (!(which & (1 << i)))
 240             continue;
 241         which &= ~(1 << i);
 242
 243         if (ret[0] != '\0')
 244             append_get_text("%s+%s", ret, state_names[i]);
 245         else
 246             append_get_text("%s", state_names[i]);
 247     }
 248
 249     return ret;
 250 }
 251
 252 static char *
 253 get_control_mask_text(uint32_t control_mask)
 254 {
 255     int i;
 256     static char ret[GET_TEXT_BUF_SIZE];
 257     /* FIXME: Merge with ... something ... in xkbcomp. */
 258     static const char *ctrl_names[] = {
 259         "RepeatKeys",
 260         "SlowKeys",
 261         "BounceKeys",
 262         "StickyKeys",
 263         "MouseKeys",
 264         "MouseKeysAccel",
 265         "AccessXKeys",
 266         "AccessXTimeout",
 267         "AccessXFeedback",
 268         "AudibleBell",
 269         "Overlay1",
 270         "Overlay2",
 271         "IgnoreGroupLock"
 272     };
 273
 274     memset(ret, 0, GET_TEXT_BUF_SIZE);
 275
 276     control_mask &= XkbAllBooleanCtrlsMask;
 277
 278     if (control_mask == 0) {
 279         strcpy(ret, "none");
 280         return ret;
 281     }
 282     else if (control_mask == XkbAllBooleanCtrlsMask) {
 283         strcpy(ret, "all");
 284         return ret;
 285     }
 286
 287     for (i = 0; control_mask; i++) {
 288         if (!(control_mask & (1 << i)))
 289             continue;
 290         control_mask &= ~(1 << i);
 291
 292         if (ret[0] != '\0')
 293             append_get_text("%s+%s", ret, ctrl_names[i]);
 294         else
 295             append_get_text("%s", ctrl_names[i]);
 296     }
 297
 298     return ret;
 299 }
 300
 301 static bool
 302 write_keycodes(struct xkb_keymap *keymap, struct buf *buf)
 303 {
 304     struct xkb_key *key;
 305     struct xkb_key_alias *alias;
 306     int i;
 307
 308     if (keymap->keycodes_section_name)
 309         write_buf(buf, "\txkb_keycodes \"%s\" {\n",
 310                   keymap->keycodes_section_name);
 311     else
 312         write_buf(buf, "\txkb_keycodes {\n");
 313
 314     write_buf(buf, "\t\tminimum = %d;\n",
 315               keymap->min_key_code);
 316     write_buf(buf, "\t\tmaximum = %d;\n",
 317               keymap->max_key_code);
 318
 319     xkb_foreach_key(key, keymap) {
 320         if (key->name[0] == '\0')
 321             continue;
 322
 323         write_buf(buf, "\t\t%6s = %d;\n",
 324                   KeyNameText(key->name), XkbKeyGetKeycode(keymap, key));
 325     }
 326
 327     for (i = 0; i < XkbNumIndicators; i++) {
 328         if (!keymap->indicator_names[i])
 329             continue;
 330         write_buf(buf, "\t\tindicator %d = \"%s\";\n",
 331                   i + 1, keymap->indicator_names[i]);
 332     }
 333
 334
 335     darray_foreach(alias, keymap->key_aliases)
 336         write_buf(buf, "\t\talias %6s = %6s;\n",
 337                   KeyNameText(alias->alias),
 338                   KeyNameText(alias->real));
 339
 340     write_buf(buf, "\t};\n\n");
 341     return true;
 342 }
 343
 344 static bool
 345 write_types(struct xkb_keymap *keymap, struct buf *buf)
 346 {
 347     int n;
 348     struct xkb_key_type *type;
 349     struct xkb_kt_map_entry *entry;
 350
 351     if (keymap->types_section_name)
 352         write_buf(buf, "\txkb_types \"%s\" {\n\n",
 353                   keymap->types_section_name);
 354     else
 355         write_buf(buf, "\txkb_types {\n\n");
 356
 357     write_vmods(keymap, buf);
 358
 359     darray_foreach(type, keymap->types) {
 360         write_buf(buf, "\t\ttype \"%s\" {\n",
 361                   type->name);
 362         write_buf(buf, "\t\t\tmodifiers= %s;\n",
 363                   get_mod_mask_text(keymap, type->mods.real_mods,
 364                                     type->mods.vmods));
 365
 366         darray_foreach(entry, type->map) {
 367             char *str;
 368
 369             str = get_mod_mask_text(keymap, entry->mods.real_mods,
 370                                     entry->mods.vmods);
 371             write_buf(buf, "\t\t\tmap[%s]= Level%d;\n",
 372                       str, entry->level + 1);
 373
 374             if (!entry->preserve.real_mods && !entry->preserve.vmods)
 375                 continue;
 376
 377             write_buf(buf, "\t\t\tpreserve[%s]= ", str);
 378             write_buf(buf, "%s;\n",
 379                       get_mod_mask_text(keymap, entry->preserve.real_mods,
 380                                         entry->preserve.vmods));
 381         }
 382
 383         if (type->level_names) {
 384             for (n = 0; n < type->num_levels; n++) {
 385                 if (!type->level_names[n])
 386                     continue;
 387                 write_buf(buf, "\t\t\tlevel_name[Level%d]= \"%s\";\n", n + 1,
 388                           type->level_names[n]);
 389             }
 390         }
 391         write_buf(buf, "\t\t};\n");
 392     }
 393
 394     write_buf(buf, "\t};\n\n");
 395     return true;
 396 }
 397
 398 static bool
 399 write_indicator_map(struct xkb_keymap *keymap, struct buf *buf, int num)
 400 {
 401     struct xkb_indicator_map *led = &keymap->indicators[num];
 402
 403     write_buf(buf, "\t\tindicator \"%s\" {\n",
 404               keymap->indicator_names[num]);
 405
 406     if (led->which_groups) {
 407         if (led->which_groups != XkbIM_UseEffective) {
 408             write_buf(buf, "\t\t\twhichGroupState= %s;\n",
 409                       get_indicator_state_text(led->which_groups));
 410         }
 411         write_buf(buf, "\t\t\tgroups= 0x%02x;\n",
 412                   led->groups);
 413     }
 414
 415     if (led->which_mods) {
 416         if (led->which_mods != XkbIM_UseEffective) {
 417             write_buf(buf, "\t\t\twhichModState= %s;\n",
 418                       get_indicator_state_text(led->which_mods));
 419         }
 420         write_buf(buf, "\t\t\tmodifiers= %s;\n",
 421                   get_mod_mask_text(keymap, led->mods.real_mods,
 422                                     led->mods.vmods));
 423     }
 424
 425     if (led->ctrls) {
 426         write_buf(buf, "\t\t\tcontrols= %s;\n",
 427                   get_control_mask_text(led->ctrls));
 428     }
 429
 430     write_buf(buf, "\t\t};\n");
 431     return true;
 432 }
 433
 434 static bool
 435 write_action(struct xkb_keymap *keymap, struct buf *buf,
 436              union xkb_action *action, const char *prefix, const char *suffix)
 437 {
 438     const char *type;
 439     const char *args = NULL;
 440
 441     if (!prefix)
 442         prefix = "";
 443     if (!suffix)
 444         suffix = "";
 445
 446     type = ActionTypeText(action->any.type);
 447
 448     switch (action->any.type) {
 449     case XkbSA_SetMods:
 450     case XkbSA_LatchMods:
 451     case XkbSA_LockMods:
 452         if (action->mods.flags & XkbSA_UseModMapMods)
 453             args = "modMapMods";
 454         else
 455             args = get_mod_mask_text(keymap, action->mods.real_mods,
 456                                      action->mods.vmods);
 457         write_buf(buf, "%s%s(modifiers=%s%s%s)%s", prefix, type, args,
 458                   (action->any.type != XkbSA_LockGroup &&
 459                    (action->mods.flags & XkbSA_ClearLocks)) ?
 460                    ",clearLocks" : "",
 461                   (action->any.type != XkbSA_LockGroup &&
 462                    (action->mods.flags & XkbSA_LatchToLock)) ?
 463                    ",latchToLock" : "",
 464                   suffix);
 465         break;
 466
 467     case XkbSA_SetGroup:
 468     case XkbSA_LatchGroup:
 469     case XkbSA_LockGroup:
 470         write_buf(buf, "%s%s(group=%s%d%s%s)%s", prefix, type,
 471                   (!(action->group.flags & XkbSA_GroupAbsolute) &&
 472                    action->group.group > 0) ? "+" : "",
 473                   (action->group.flags & XkbSA_GroupAbsolute) ?
 474                   action->group.group + 1 : action->group.group,
 475                   (action->any.type != XkbSA_LockGroup &&
 476                    (action->group.flags & XkbSA_ClearLocks)) ?
 477                   ",clearLocks" : "",
 478                   (action->any.type != XkbSA_LockGroup &&
 479                    (action->group.flags & XkbSA_LatchToLock)) ?
 480                   ",latchToLock" : "",
 481                   suffix);
 482         break;
 483
 484     case XkbSA_Terminate:
 485         write_buf(buf, "%s%s()%s", prefix, type, suffix);
 486         break;
 487
 488     case XkbSA_MovePtr:
 489         write_buf(buf, "%s%s(x=%s%d,y=%s%d%s)%s", prefix, type,
 490                   (!(action->ptr.flags & XkbSA_MoveAbsoluteX) &&
 491                    action->ptr.x >= 0) ? "+" : "",
 492                   action->ptr.x,
 493                   (!(action->ptr.flags & XkbSA_MoveAbsoluteY) &&
 494                    action->ptr.y >= 0) ? "+" : "",
 495                   action->ptr.y,
 496                   (action->ptr.flags & XkbSA_NoAcceleration) ? ",!accel" : "",
 497                   suffix);
 498         break;
 499
 500     case XkbSA_LockPtrBtn:
 501         switch (action->btn.flags & (XkbSA_LockNoUnlock | XkbSA_LockNoLock)) {
 502         case XkbSA_LockNoUnlock:
 503             args = ",affect=lock";
 504             break;
 505
 506         case XkbSA_LockNoLock:
 507             args = ",affect=unlock";
 508             break;
 509
 510         case XkbSA_LockNoLock | XkbSA_LockNoUnlock:
 511             args = ",affect=neither";
 512             break;
 513
 514         default:
 515             args = ",affect=both";
 516             break;
 517         }
 518     case XkbSA_PtrBtn:
 519         write_buf(buf, "%s%s(button=", prefix, type);
 520         if (action->btn.button > 0 && action->btn.button <= 5)
 521             write_buf(buf, "%d", action->btn.button);
 522         else
 523             write_buf(buf, "default");
 524         if (action->btn.count)
 525             write_buf(buf, ",count=%d", action->btn.count);
 526         if (args)
 527             write_buf(buf, "%s", args);
 528         write_buf(buf, ")%s", suffix);
 529         break;
 530
 531     case XkbSA_SetPtrDflt:
 532         write_buf(buf, "%s%s(", prefix, type);
 533         if (action->dflt.affect == XkbSA_AffectDfltBtn)
 534             write_buf(buf, "affect=button,button=%s%d",
 535                       (!(action->dflt.flags & XkbSA_DfltBtnAbsolute) &&
 536                        action->dflt.value >= 0) ? "+" : "",
 537                       action->dflt.value);
 538         write_buf(buf, ")%s", suffix);
 539         break;
 540
 541     case XkbSA_SwitchScreen:
 542         write_buf(buf, "%s%s(screen=%s%d,%ssame)%s", prefix, type,
 543                   (!(action->screen.flags & XkbSA_SwitchAbsolute) &&
 544                    action->screen.screen >= 0) ? "+" : "",
 545                   action->screen.screen,
 546                   (action->screen.flags & XkbSA_SwitchApplication) ? "!" : "",
 547                   suffix);
 548         break;
 549
 550     /* Deprecated actions below here */
 551     case XkbSA_SetControls:
 552     case XkbSA_LockControls:
 553         write_buf(buf, "%s%s(controls=%s)%s", prefix, type,
 554                   get_control_mask_text(action->ctrls.ctrls), suffix);
 555         break;
 556
 557     case XkbSA_ISOLock:
 558     case XkbSA_ActionMessage:
 559     case XkbSA_RedirectKey:
 560     case XkbSA_DeviceBtn:
 561     case XkbSA_LockDeviceBtn:
 562     case XkbSA_NoAction:
 563         /* XXX TODO */
 564         write_buf(buf, "%sNoAction()%s", prefix, suffix);
 565         break;
 566
 567     case XkbSA_XFree86Private:
 568     default:
 569         write_buf(buf,
 570                   "%s%s(type=0x%02x,data[0]=0x%02x,data[1]=0x%02x,data[2]=0x%02x,data[3]=0x%02x,data[4]=0x%02x,data[5]=0x%02x,data[6]=0x%02x)%s",
 571                   prefix, type, action->any.type, action->any.data[0],
 572                   action->any.data[1], action->any.data[2],
 573                   action->any.data[3], action->any.data[4],
 574                   action->any.data[5], action->any.data[6],
 575                   suffix);
 576         break;
 577     }
 578
 579     return true;
 580 }
 581
 582 static bool
 583 write_compat(struct xkb_keymap *keymap, struct buf *buf)
 584 {
 585     int i;
 586     struct xkb_sym_interpret *interp;
 587
 588     if (keymap->compat_section_name)
 589         write_buf(buf, "\txkb_compatibility \"%s\" {\n\n",
 590                   keymap->compat_section_name);
 591     else
 592         write_buf(buf, "\txkb_compatibility {\n\n");
 593
 594     write_vmods(keymap, buf);
 595
 596     write_buf(buf, "\t\tinterpret.useModMapMods= AnyLevel;\n");
 597     write_buf(buf, "\t\tinterpret.repeat= False;\n");
 598     write_buf(buf, "\t\tinterpret.locking= False;\n");
 599
 600     darray_foreach(interp, keymap->sym_interpret) {
 601         char keysym_name[64];
 602
 603         if (interp->sym == XKB_KEY_NoSymbol)
 604             sprintf(keysym_name, "Any");
 605         else
 606             xkb_keysym_get_name(interp->sym, keysym_name, sizeof(keysym_name));
 607
 608         write_buf(buf, "\t\tinterpret %s+%s(%s) {\n",
 609                   keysym_name,
 610                   SIMatchText(interp->match),
 611                   get_mod_mask_text(keymap, interp->mods, 0));
 612
 613         if (interp->virtual_mod != XkbNoModifier) {
 614             write_buf(buf, "\t\t\tvirtualModifier= %s;\n",
 615                       keymap->vmod_names[interp->virtual_mod]);
 616         }
 617
 618         if (interp->match & XkbSI_LevelOneOnly)
 619             write_buf(buf,
 620                       "\t\t\tuseModMapMods=level1;\n");
 621         if (interp->flags & XkbSI_LockingKey)
 622             write_buf(buf, "\t\t\tlocking= True;\n");
 623         if (interp->flags & XkbSI_AutoRepeat)
 624             write_buf(buf, "\t\t\trepeat= True;\n");
 625
 626         write_action(keymap, buf, &interp->act, "\t\t\taction= ", ";\n");
 627         write_buf(buf, "\t\t};\n");
 628     }
 629
 630     for (i = 0; i < XkbNumKbdGroups; i++) {
 631         struct xkb_mods *gc;
 632
 633         gc = &keymap->groups[i];
 634         if (gc->real_mods == 0 && gc->vmods == 0)
 635             continue;
 636         write_buf(buf, "\t\tgroup %d = %s;\n", i + 1,
 637                   get_mod_mask_text(keymap, gc->real_mods, gc->vmods));
 638     }
 639
 640     for (i = 0; i < XkbNumIndicators; i++) {
 641         struct xkb_indicator_map *map = &keymap->indicators[i];
 642         if (map->flags == 0 && map->which_groups == 0 &&
 643             map->groups == 0 && map->which_mods == 0 &&
 644             map->mods.real_mods == 0 && map->mods.vmods == 0 &&
 645             map->ctrls == 0)
 646             continue;
 647         write_indicator_map(keymap, buf, i);
 648     }
 649
 650     write_buf(buf, "\t};\n\n");
 651
 652     return true;
 653 }
 654
 655 static bool
 656 write_keysyms(struct xkb_keymap *keymap, struct buf *buf,
 657               struct xkb_key *key, xkb_group_index_t group)
 658 {
 659     const xkb_keysym_t *syms;
 660     int num_syms;
 661     xkb_level_index_t level;
 662 #define OUT_BUF_LEN 128
 663     char out_buf[OUT_BUF_LEN];
 664
 665     for (level = 0; level < XkbKeyGroupWidth(keymap, key, group); level++) {
 666         if (level != 0)
 667             write_buf(buf, ", ");
 668         num_syms = xkb_key_get_syms_by_level(keymap, key, group, level,
 669                                              &syms);
 670         if (num_syms == 0) {
 671             write_buf(buf, "%15s", "NoSymbol");
 672         }
 673         else if (num_syms == 1) {
 674             xkb_keysym_get_name(syms[0], out_buf, OUT_BUF_LEN);
 675             write_buf(buf, "%15s", out_buf);
 676         }
 677         else {
 678             int s;
 679             write_buf(buf, "{ ");
 680             for (s = 0; s < num_syms; s++) {
 681                 if (s != 0)
 682                     write_buf(buf, ", ");
 683                 xkb_keysym_get_name(syms[s], out_buf, OUT_BUF_LEN);
 684                 write_buf(buf, "%15s", out_buf);
 685             }
 686             write_buf(buf, " }");
 687         }
 688     }
 689 #undef OUT_BUF_LEN
 690
 691     return true;
 692 }
 693
 694 static bool
 695 write_symbols(struct xkb_keymap *keymap, struct buf *buf)
 696 {
 697     struct xkb_key *key;
 698     xkb_group_index_t group, tmp;
 699     bool showActions;
 700
 701     if (keymap->symbols_section_name)
 702         write_buf(buf, "\txkb_symbols \"%s\" {\n\n",
 703                   keymap->symbols_section_name);
 704     else
 705         write_buf(buf, "\txkb_symbols {\n\n");
 706
 707     for (tmp = group = 0; group < XkbNumKbdGroups; group++) {
 708         if (!keymap->group_names[group])
 709             continue;
 710         write_buf(buf,
 711                   "\t\tname[group%d]=\"%s\";\n", group + 1,
 712                   keymap->group_names[group]);
 713         tmp++;
 714     }
 715     if (tmp > 0)
 716         write_buf(buf, "\n");
 717
 718     xkb_foreach_key(key, keymap) {
 719         bool simple = true;
 720
 721         if (key->num_groups == 0)
 722             continue;
 723
 724         write_buf(buf, "\t\tkey %6s {", KeyNameText(key->name));
 725
 726         if (key->explicit & XkbExplicitKeyTypesMask) {
 727             bool multi_type = false;
 728             int type = XkbKeyTypeIndex(key, 0);
 729
 730             simple = false;
 731
 732             for (group = 0; group < key->num_groups; group++) {
 733                 if (XkbKeyTypeIndex(key, group) != type) {
 734                     multi_type = true;
 735                     break;
 736                 }
 737             }
 738
 739             if (multi_type) {
 740                 for (group = 0; group < key->num_groups; group++) {
 741                     if (!(key->explicit & (1 << group)))
 742                         continue;
 743                     type = XkbKeyTypeIndex(key, group);
 744                     write_buf(buf, "\n\t\t\ttype[group%u]= \"%s\",",
 745                               group + 1,
 746                               darray_item(keymap->types, type).name);
 747                 }
 748             }
 749             else {
 750                 write_buf(buf, "\n\t\t\ttype= \"%s\",",
 751                           darray_item(keymap->types, type).name);
 752             }
 753         }
 754
 755         if (key->explicit & XkbExplicitAutoRepeatMask) {
 756             if (key->repeats)
 757                 write_buf(buf, "\n\t\t\trepeat= Yes,");
 758             else
 759                 write_buf(buf, "\n\t\t\trepeat= No,");
 760             simple = false;
 761         }
 762
 763         if (key->vmodmap && (key->explicit & XkbExplicitVModMapMask)) {
 764             write_buf(buf, "\n\t\t\tvirtualMods= %s,",
 765                       get_mod_mask_text(keymap, 0, key->vmodmap));
 766         }
 767
 768         switch (key->out_of_range_group_action) {
 769         case XkbClampIntoRange:
 770             write_buf(buf, "\n\t\t\tgroupsClamp,");
 771             break;
 772
 773         case XkbRedirectIntoRange:
 774             write_buf(buf, "\n\t\t\tgroupsRedirect= Group%u,",
 775                       key->out_of_range_group_number + 1);
 776             break;
 777         }
 778
 779         if (key->explicit & XkbExplicitInterpretMask)
 780             showActions = XkbKeyHasActions(key);
 781         else
 782             showActions = false;
 783
 784         if (key->num_groups > 1 || showActions)
 785             simple = false;
 786
 787         if (simple) {
 788             write_buf(buf, "\t[ ");
 789             if (!write_keysyms(keymap, buf, key, 0))
 790                 return false;
 791             write_buf(buf, " ] };\n");
 792         }
 793         else {
 794             union xkb_action *acts;
 795             int level;
 796
 797             acts = XkbKeyActionsPtr(keymap, key);
 798             for (group = 0; group < key->num_groups; group++) {
 799                 if (group != 0)
 800                     write_buf(buf, ",");
 801                 write_buf(buf, "\n\t\t\tsymbols[Group%u]= [ ", group + 1);
 802                 if (!write_keysyms(keymap, buf, key, group))
 803                     return false;
 804                 write_buf(buf, " ]");
 805                 if (showActions) {
 806                     write_buf(buf, ",\n\t\t\tactions[Group%u]= [ ",
 807                               group + 1);
 808                     for (level = 0;
 809                          level < XkbKeyGroupWidth(keymap, key, group);
 810                          level++) {
 811                         if (level != 0)
 812                             write_buf(buf, ", ");
 813                         write_action(keymap, buf, &acts[level], NULL, NULL);
 814                     }
 815                     write_buf(buf, " ]");
 816                     acts += key->width;
 817                 }
 818             }
 819             write_buf(buf, "\n\t\t};\n");
 820         }
 821     }
 822
 823     xkb_foreach_key(key, keymap) {
 824         int mod;
 825
 826         if (key->modmap == 0)
 827             continue;
 828
 829         for (mod = 0; mod < XkbNumModifiers; mod++) {
 830             if (!(key->modmap & (1 << mod)))
 831                 continue;
 832
 833             write_buf(buf, "\t\tmodifier_map %s { %s };\n",
 834                       ModIndexToName(mod), KeyNameText(key->name));
 835         }
 836     }
 837
 838     write_buf(buf, "\t};\n\n");
 839     return true;
 840 }
 841
 842 XKB_EXPORT char *
 843 xkb_map_get_as_string(struct xkb_keymap *keymap)
 844 {
 845     bool ok;
 846     struct buf buf = { NULL, 0, 0 };
 847
 848     ok = (check_write_buf(&buf, "xkb_keymap {\n") &&
 849           write_keycodes(keymap, &buf) &&
 850           write_types(keymap, &buf) &&
 851           write_compat(keymap, &buf) &&
 852           write_symbols(keymap, &buf) &&
 853           check_write_buf(&buf, "};\n"));
 854
 855     return (ok ? buf.buf : NULL);
 856 }