src/xkbcomp/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 "xkbcomp-priv.h"
  53 #include "text.h"
  54
  55 #define BUF_CHUNK_SIZE 4096
  56
  57 struct buf {
  58     char *buf;
  59     size_t size;
  60     size_t alloc;
  61 };
  62
  63 static bool
  64 do_realloc(struct buf *buf, size_t at_least)
  65 {
  66     char *new;
  67
  68     buf->alloc += BUF_CHUNK_SIZE;
  69     if (at_least >= BUF_CHUNK_SIZE)
  70         buf->alloc += at_least;
  71
  72     new = realloc(buf->buf, buf->alloc);
  73     if (!new)
  74         return false;
  75
  76     buf->buf = new;
  77     return true;
  78 }
  79
  80 ATTR_PRINTF(2, 3) static bool
  81 check_write_buf(struct buf *buf, const char *fmt, ...)
  82 {
  83     va_list args;
  84     int printed;
  85     size_t available;
  86
  87     available = buf->alloc - buf->size;
  88     va_start(args, fmt);
  89     printed = vsnprintf(buf->buf + buf->size, available, fmt, args);
  90     va_end(args);
  91
  92     if (printed < 0)
  93         goto err;
  94
  95     if (printed >= available)
  96         if (!do_realloc(buf, printed))
  97             goto err;
  98
  99     /* The buffer has enough space now. */
 100
 101     available = buf->alloc - buf->size;
 102     va_start(args, fmt);
 103     printed = vsnprintf(buf->buf + buf->size, available, fmt, args);
 104     va_end(args);
 105
 106     if (printed >= available || printed < 0)
 107         goto err;
 108
 109     buf->size += printed;
 110     return true;
 111
 112 err:
 113     free(buf->buf);
 114     buf->buf = NULL;
 115     return false;
 116 }
 117
 118 #define write_buf(buf, ...) do { \
 119     if (!check_write_buf(buf, __VA_ARGS__)) \
 120         return false; \
 121 } while (0)
 122
 123 static bool
 124 write_vmods(struct xkb_keymap *keymap, struct buf *buf)
 125 {
 126     const struct xkb_mod *mod;
 127     xkb_mod_index_t num_vmods = 0;
 128
 129     darray_foreach(mod, keymap->mods) {
 130         if (mod->type != MOD_VIRT)
 131             continue;
 132
 133         if (num_vmods == 0)
 134             write_buf(buf, "\tvirtual_modifiers ");
 135         else
 136             write_buf(buf, ",");
 137         write_buf(buf, "%s", xkb_atom_text(keymap->ctx, mod->name));
 138         num_vmods++;
 139     }
 140
 141     if (num_vmods > 0)
 142         write_buf(buf, ";\n\n");
 143
 144     return true;
 145 }
 146
 147 static bool
 148 write_keycodes(struct xkb_keymap *keymap, struct buf *buf)
 149 {
 150     const struct xkb_key *key;
 151     xkb_led_index_t idx;
 152     const struct xkb_led *led;
 153
 154     if (keymap->keycodes_section_name)
 155         write_buf(buf, "xkb_keycodes \"%s\" {\n",
 156                   keymap->keycodes_section_name);
 157     else
 158         write_buf(buf, "xkb_keycodes {\n");
 159
 160     /* xkbcomp and X11 really want to see keymaps with a minimum of 8, and
 161      * a maximum of at least 255, else XWayland really starts hating life.
 162      * If this is a problem and people really need strictly bounded keymaps,
 163      * we should probably control this with a flag. */
 164     write_buf(buf, "\tminimum = %d;\n", min(keymap->min_key_code, 8));
 165     write_buf(buf, "\tmaximum = %d;\n", max(keymap->max_key_code, 255));
 166
 167     xkb_foreach_key(key, keymap) {
 168         if (key->name == XKB_ATOM_NONE)
 169             continue;
 170
 171         write_buf(buf, "\t%-20s = %d;\n",
 172                   KeyNameText(keymap->ctx, key->name), key->keycode);
 173     }
 174
 175     darray_enumerate(idx, led, keymap->leds)
 176         if (led->name != XKB_ATOM_NONE)
 177             write_buf(buf, "\tindicator %d = \"%s\";\n",
 178                       idx + 1, xkb_atom_text(keymap->ctx, led->name));
 179
 180
 181     for (unsigned i = 0; i < keymap->num_key_aliases; i++)
 182         write_buf(buf, "\talias %-14s = %s;\n",
 183                   KeyNameText(keymap->ctx, keymap->key_aliases[i].alias),
 184                   KeyNameText(keymap->ctx, keymap->key_aliases[i].real));
 185
 186     write_buf(buf, "};\n\n");
 187     return true;
 188 }
 189
 190 static bool
 191 write_types(struct xkb_keymap *keymap, struct buf *buf)
 192 {
 193     if (keymap->types_section_name)
 194         write_buf(buf, "xkb_types \"%s\" {\n",
 195                   keymap->types_section_name);
 196     else
 197         write_buf(buf, "xkb_types {\n");
 198
 199     write_vmods(keymap, buf);
 200
 201     for (unsigned i = 0; i < keymap->num_types; i++) {
 202         const struct xkb_key_type *type = &keymap->types[i];
 203
 204         write_buf(buf, "\ttype \"%s\" {\n",
 205                   xkb_atom_text(keymap->ctx, type->name));
 206
 207         write_buf(buf, "\t\tmodifiers= %s;\n",
 208                   ModMaskText(keymap, type->mods.mods));
 209
 210         for (unsigned j = 0; j < type->num_entries; j++) {
 211             const char *str;
 212             const struct xkb_key_type_entry *entry = &type->entries[j];
 213
 214             /*
 215              * Printing level 1 entries is redundant, it's the default,
 216              * unless there's preserve info.
 217              */
 218             if (entry->level == 0 && entry->preserve.mods == 0)
 219                 continue;
 220
 221             str = ModMaskText(keymap, entry->mods.mods);
 222             write_buf(buf, "\t\tmap[%s]= Level%d;\n",
 223                       str, entry->level + 1);
 224
 225             if (entry->preserve.mods)
 226                 write_buf(buf, "\t\tpreserve[%s]= %s;\n",
 227                           str, ModMaskText(keymap, entry->preserve.mods));
 228         }
 229
 230         for (xkb_level_index_t n = 0; n < type->num_levels; n++)
 231             if (type->level_names[n])
 232                 write_buf(buf, "\t\tlevel_name[Level%d]= \"%s\";\n", n + 1,
 233                           xkb_atom_text(keymap->ctx, type->level_names[n]));
 234
 235         write_buf(buf, "\t};\n");
 236     }
 237
 238     write_buf(buf, "};\n\n");
 239     return true;
 240 }
 241
 242 static bool
 243 write_led_map(struct xkb_keymap *keymap, struct buf *buf,
 244               const struct xkb_led *led)
 245 {
 246     write_buf(buf, "\tindicator \"%s\" {\n",
 247               xkb_atom_text(keymap->ctx, led->name));
 248
 249     if (led->which_groups) {
 250         if (led->which_groups != XKB_STATE_LAYOUT_EFFECTIVE) {
 251             write_buf(buf, "\t\twhichGroupState= %s;\n",
 252                       LedStateMaskText(keymap->ctx, led->which_groups));
 253         }
 254         write_buf(buf, "\t\tgroups= 0x%02x;\n",
 255                   led->groups);
 256     }
 257
 258     if (led->which_mods) {
 259         if (led->which_mods != XKB_STATE_MODS_EFFECTIVE) {
 260             write_buf(buf, "\t\twhichModState= %s;\n",
 261                       LedStateMaskText(keymap->ctx, led->which_mods));
 262         }
 263         write_buf(buf, "\t\tmodifiers= %s;\n",
 264                   ModMaskText(keymap, led->mods.mods));
 265     }
 266
 267     if (led->ctrls) {
 268         write_buf(buf, "\t\tcontrols= %s;\n",
 269                   ControlMaskText(keymap->ctx, led->ctrls));
 270     }
 271
 272     write_buf(buf, "\t};\n");
 273     return true;
 274 }
 275
 276 static bool
 277 write_action(struct xkb_keymap *keymap, struct buf *buf,
 278              const union xkb_action *action,
 279              const char *prefix, const char *suffix)
 280 {
 281     const char *type;
 282     const char *args = NULL;
 283
 284     if (!prefix)
 285         prefix = "";
 286     if (!suffix)
 287         suffix = "";
 288
 289     type = ActionTypeText(action->type);
 290
 291     switch (action->type) {
 292     case ACTION_TYPE_MOD_SET:
 293     case ACTION_TYPE_MOD_LATCH:
 294     case ACTION_TYPE_MOD_LOCK:
 295         if (action->mods.flags & ACTION_MODS_LOOKUP_MODMAP)
 296             args = "modMapMods";
 297         else
 298             args = ModMaskText(keymap, action->mods.mods.mods);
 299         write_buf(buf, "%s%s(modifiers=%s%s%s)%s", prefix, type, args,
 300                   (action->type != ACTION_TYPE_MOD_LOCK &&
 301                    (action->mods.flags & ACTION_LOCK_CLEAR)) ?
 302                    ",clearLocks" : "",
 303                   (action->type != ACTION_TYPE_MOD_LOCK &&
 304                    (action->mods.flags & ACTION_LATCH_TO_LOCK)) ?
 305                    ",latchToLock" : "",
 306                   suffix);
 307         break;
 308
 309     case ACTION_TYPE_GROUP_SET:
 310     case ACTION_TYPE_GROUP_LATCH:
 311     case ACTION_TYPE_GROUP_LOCK:
 312         write_buf(buf, "%s%s(group=%s%d%s%s)%s", prefix, type,
 313                   (!(action->group.flags & ACTION_ABSOLUTE_SWITCH) &&
 314                    action->group.group > 0) ? "+" : "",
 315                   (action->group.flags & ACTION_ABSOLUTE_SWITCH) ?
 316                   action->group.group + 1 : action->group.group,
 317                   (action->type != ACTION_TYPE_GROUP_LOCK &&
 318                    (action->group.flags & ACTION_LOCK_CLEAR)) ?
 319                   ",clearLocks" : "",
 320                   (action->type != ACTION_TYPE_GROUP_LOCK &&
 321                    (action->group.flags & ACTION_LATCH_TO_LOCK)) ?
 322                   ",latchToLock" : "",
 323                   suffix);
 324         break;
 325
 326     case ACTION_TYPE_TERMINATE:
 327         write_buf(buf, "%s%s()%s", prefix, type, suffix);
 328         break;
 329
 330     case ACTION_TYPE_PTR_MOVE:
 331         write_buf(buf, "%s%s(x=%s%d,y=%s%d%s)%s", prefix, type,
 332                   (!(action->ptr.flags & ACTION_ABSOLUTE_X) &&
 333                    action->ptr.x >= 0) ? "+" : "",
 334                   action->ptr.x,
 335                   (!(action->ptr.flags & ACTION_ABSOLUTE_Y) &&
 336                    action->ptr.y >= 0) ? "+" : "",
 337                   action->ptr.y,
 338                   (action->ptr.flags & ACTION_NO_ACCEL) ? ",!accel" : "",
 339                   suffix);
 340         break;
 341
 342     case ACTION_TYPE_PTR_LOCK:
 343         switch (action->btn.flags &
 344                  (ACTION_LOCK_NO_LOCK | ACTION_LOCK_NO_UNLOCK)) {
 345         case ACTION_LOCK_NO_UNLOCK:
 346             args = ",affect=lock";
 347             break;
 348
 349         case ACTION_LOCK_NO_LOCK:
 350             args = ",affect=unlock";
 351             break;
 352
 353         case ACTION_LOCK_NO_LOCK | ACTION_LOCK_NO_UNLOCK:
 354             args = ",affect=neither";
 355             break;
 356
 357         default:
 358             args = ",affect=both";
 359             break;
 360         }
 361     case ACTION_TYPE_PTR_BUTTON:
 362         write_buf(buf, "%s%s(button=", prefix, type);
 363         if (action->btn.button > 0 && action->btn.button <= 5)
 364             write_buf(buf, "%d", action->btn.button);
 365         else
 366             write_buf(buf, "default");
 367         if (action->btn.count)
 368             write_buf(buf, ",count=%d", action->btn.count);
 369         if (args)
 370             write_buf(buf, "%s", args);
 371         write_buf(buf, ")%s", suffix);
 372         break;
 373
 374     case ACTION_TYPE_PTR_DEFAULT:
 375         write_buf(buf, "%s%s(", prefix, type);
 376         write_buf(buf, "affect=button,button=%s%d",
 377                   (!(action->dflt.flags & ACTION_ABSOLUTE_SWITCH) &&
 378                    action->dflt.value >= 0) ? "+" : "",
 379                   action->dflt.value);
 380         write_buf(buf, ")%s", suffix);
 381         break;
 382
 383     case ACTION_TYPE_SWITCH_VT:
 384         write_buf(buf, "%s%s(screen=%s%d,%ssame)%s", prefix, type,
 385                   (!(action->screen.flags & ACTION_ABSOLUTE_SWITCH) &&
 386                    action->screen.screen >= 0) ? "+" : "",
 387                   action->screen.screen,
 388                   (action->screen.flags & ACTION_SAME_SCREEN) ? "!" : "",
 389                   suffix);
 390         break;
 391
 392     case ACTION_TYPE_CTRL_SET:
 393     case ACTION_TYPE_CTRL_LOCK:
 394         write_buf(buf, "%s%s(controls=%s)%s", prefix, type,
 395                   ControlMaskText(keymap->ctx, action->ctrls.ctrls), suffix);
 396         break;
 397
 398     case ACTION_TYPE_NONE:
 399         write_buf(buf, "%sNoAction()%s", prefix, suffix);
 400         break;
 401
 402     default:
 403         write_buf(buf,
 404                   "%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",
 405                   prefix, type, action->type, action->priv.data[0],
 406                   action->priv.data[1], action->priv.data[2],
 407                   action->priv.data[3], action->priv.data[4],
 408                   action->priv.data[5], action->priv.data[6],
 409                   suffix);
 410         break;
 411     }
 412
 413     return true;
 414 }
 415
 416 static bool
 417 write_compat(struct xkb_keymap *keymap, struct buf *buf)
 418 {
 419     const struct xkb_sym_interpret *si;
 420     const struct xkb_led *led;
 421
 422     if (keymap->compat_section_name)
 423         write_buf(buf, "xkb_compatibility \"%s\" {\n",
 424                   keymap->compat_section_name);
 425     else
 426         write_buf(buf, "xkb_compatibility {\n");
 427
 428     write_vmods(keymap, buf);
 429
 430     write_buf(buf, "\tinterpret.useModMapMods= AnyLevel;\n");
 431     write_buf(buf, "\tinterpret.repeat= False;\n");
 432
 433     darray_foreach(si, keymap->sym_interprets) {
 434         write_buf(buf, "\tinterpret %s+%s(%s) {\n",
 435                   si->sym ? KeysymText(keymap->ctx, si->sym) : "Any",
 436                   SIMatchText(si->match),
 437                   ModMaskText(keymap, si->mods));
 438
 439         if (si->virtual_mod != XKB_MOD_INVALID)
 440             write_buf(buf, "\t\tvirtualModifier= %s;\n",
 441                       ModIndexText(keymap, si->virtual_mod));
 442
 443         if (si->level_one_only)
 444             write_buf(buf, "\t\tuseModMapMods=level1;\n");
 445
 446         if (si->repeat)
 447             write_buf(buf, "\t\trepeat= True;\n");
 448
 449         write_action(keymap, buf, &si->action, "\t\taction= ", ";\n");
 450         write_buf(buf, "\t};\n");
 451     }
 452
 453     darray_foreach(led, keymap->leds)
 454         if (led->which_groups || led->groups || led->which_mods ||
 455             led->mods.mods || led->ctrls)
 456             write_led_map(keymap, buf, led);
 457
 458     write_buf(buf, "};\n\n");
 459
 460     return true;
 461 }
 462
 463 static bool
 464 write_keysyms(struct xkb_keymap *keymap, struct buf *buf,
 465               const struct xkb_key *key, xkb_layout_index_t group)
 466 {
 467     for (xkb_level_index_t level = 0; level < XkbKeyGroupWidth(key, group);
 468          level++) {
 469         const xkb_keysym_t *syms;
 470         int num_syms;
 471
 472         if (level != 0)
 473             write_buf(buf, ", ");
 474
 475         num_syms = xkb_keymap_key_get_syms_by_level(keymap, key->keycode,
 476                                                     group, level, &syms);
 477         if (num_syms == 0) {
 478             write_buf(buf, "%15s", "NoSymbol");
 479         }
 480         else if (num_syms == 1) {
 481             write_buf(buf, "%15s", KeysymText(keymap->ctx, syms[0]));
 482         }
 483         else {
 484             write_buf(buf, "{ ");
 485             for (int s = 0; s < num_syms; s++) {
 486                 if (s != 0)
 487                     write_buf(buf, ", ");
 488                 write_buf(buf, "%s", KeysymText(keymap->ctx, syms[s]));
 489             }
 490             write_buf(buf, " }");
 491         }
 492     }
 493
 494     return true;
 495 }
 496
 497 static bool
 498 write_key(struct xkb_keymap *keymap, struct buf *buf,
 499           const struct xkb_key *key)
 500 {
 501     xkb_layout_index_t group;
 502     bool simple = true;
 503     bool explicit_types = false;
 504     bool multi_type = false;
 505     bool show_actions;
 506
 507     write_buf(buf, "\tkey %-20s {", KeyNameText(keymap->ctx, key->name));
 508
 509     for (group = 0; group < key->num_groups; group++) {
 510         if (key->groups[group].explicit_type)
 511             explicit_types = true;
 512
 513         if (group != 0 && key->groups[group].type != key->groups[0].type)
 514             multi_type = true;
 515     }
 516
 517     if (explicit_types) {
 518         const struct xkb_key_type *type;
 519         simple = false;
 520
 521         if (multi_type) {
 522             for (group = 0; group < key->num_groups; group++) {
 523                 if (!key->groups[group].explicit_type)
 524                     continue;
 525
 526                 type = key->groups[group].type;
 527                 write_buf(buf, "\n\t\ttype[group%u]= \"%s\",",
 528                             group + 1,
 529                             xkb_atom_text(keymap->ctx, type->name));
 530             }
 531         }
 532         else {
 533             type = key->groups[0].type;
 534             write_buf(buf, "\n\t\ttype= \"%s\",",
 535                         xkb_atom_text(keymap->ctx, type->name));
 536         }
 537     }
 538
 539     if (key->explicit & EXPLICIT_REPEAT) {
 540         if (key->repeats)
 541             write_buf(buf, "\n\t\trepeat= Yes,");
 542         else
 543             write_buf(buf, "\n\t\trepeat= No,");
 544         simple = false;
 545     }
 546
 547     if (key->vmodmap && (key->explicit & EXPLICIT_VMODMAP))
 548         write_buf(buf, "\n\t\tvirtualMods= %s,",
 549                     ModMaskText(keymap, key->vmodmap));
 550
 551     switch (key->out_of_range_group_action) {
 552     case RANGE_SATURATE:
 553         write_buf(buf, "\n\t\tgroupsClamp,");
 554         break;
 555
 556     case RANGE_REDIRECT:
 557         write_buf(buf, "\n\t\tgroupsRedirect= Group%u,",
 558                     key->out_of_range_group_number + 1);
 559         break;
 560
 561     default:
 562         break;
 563     }
 564
 565     show_actions = !!(key->explicit & EXPLICIT_INTERP);
 566
 567     if (key->num_groups > 1 || show_actions)
 568         simple = false;
 569
 570     if (simple) {
 571         write_buf(buf, "\t[ ");
 572         if (!write_keysyms(keymap, buf, key, 0))
 573             return false;
 574         write_buf(buf, " ] };\n");
 575     }
 576     else {
 577         xkb_level_index_t level;
 578
 579         for (group = 0; group < key->num_groups; group++) {
 580             if (group != 0)
 581                 write_buf(buf, ",");
 582             write_buf(buf, "\n\t\tsymbols[Group%u]= [ ", group + 1);
 583             if (!write_keysyms(keymap, buf, key, group))
 584                 return false;
 585             write_buf(buf, " ]");
 586             if (show_actions) {
 587                 write_buf(buf, ",\n\t\tactions[Group%u]= [ ", group + 1);
 588                 for (level = 0;
 589                         level < XkbKeyGroupWidth(key, group); level++) {
 590                     if (level != 0)
 591                         write_buf(buf, ", ");
 592                     write_action(keymap, buf,
 593                                     &key->groups[group].levels[level].action,
 594                                     NULL, NULL);
 595                 }
 596                 write_buf(buf, " ]");
 597             }
 598         }
 599         write_buf(buf, "\n\t};\n");
 600     }
 601
 602     return true;
 603 }
 604
 605 static bool
 606 write_symbols(struct xkb_keymap *keymap, struct buf *buf)
 607 {
 608     const struct xkb_key *key;
 609     xkb_layout_index_t group;
 610
 611     if (keymap->symbols_section_name)
 612         write_buf(buf, "xkb_symbols \"%s\" {\n",
 613                   keymap->symbols_section_name);
 614     else
 615         write_buf(buf, "xkb_symbols {\n");
 616
 617     for (group = 0; group < keymap->num_group_names; group++)
 618         if (keymap->group_names[group])
 619             write_buf(buf,
 620                       "\tname[group%d]=\"%s\";\n", group + 1,
 621                       xkb_atom_text(keymap->ctx, keymap->group_names[group]));
 622     if (group > 0)
 623         write_buf(buf, "\n");
 624
 625     xkb_foreach_key(key, keymap)
 626         if (key->num_groups > 0)
 627             write_key(keymap, buf, key);
 628
 629     xkb_foreach_key(key, keymap) {
 630         xkb_mod_index_t i;
 631         const struct xkb_mod *mod;
 632
 633         if (key->modmap == 0)
 634             continue;
 635
 636         darray_enumerate(i, mod, keymap->mods)
 637             if (key->modmap & (1 << i))
 638                 write_buf(buf, "\tmodifier_map %s { %s };\n",
 639                           xkb_atom_text(keymap->ctx, mod->name),
 640                           KeyNameText(keymap->ctx, key->name));
 641     }
 642
 643     write_buf(buf, "};\n\n");
 644     return true;
 645 }
 646
 647 static bool
 648 write_keymap(struct xkb_keymap *keymap, struct buf *buf)
 649 {
 650     return (check_write_buf(buf, "xkb_keymap {\n") &&
 651             write_keycodes(keymap, buf) &&
 652             write_types(keymap, buf) &&
 653             write_compat(keymap, buf) &&
 654             write_symbols(keymap, buf) &&
 655             check_write_buf(buf, "};\n"));
 656 }
 657
 658 char *
 659 text_v1_keymap_get_as_string(struct xkb_keymap *keymap)
 660 {
 661     struct buf buf = { NULL, 0, 0 };
 662
 663     if (!write_keymap(keymap, &buf)) {
 664         free(buf.buf);
 665         return NULL;
 666     }
 667
 668     return buf.buf;
 669 }