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 ((size_t) 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 < 0 || (size_t) printed >= available)
 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.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 = %u;\n", min(keymap->min_key_code, 8));
 165     write_buf(buf, "\tmaximum = %u;\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 = %u;\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 %u = \"%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%u;\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%u]= \"%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 const char *
 277 affect_lock_text(enum xkb_action_flags flags)
 278 {
 279     switch (flags & (ACTION_LOCK_NO_LOCK | ACTION_LOCK_NO_UNLOCK)) {
 280     case ACTION_LOCK_NO_UNLOCK:
 281         return ",affect=lock";
 282     case ACTION_LOCK_NO_LOCK:
 283         return ",affect=unlock";
 284     case ACTION_LOCK_NO_LOCK | ACTION_LOCK_NO_UNLOCK:
 285         return ",affect=neither";
 286     }
 287     return "";
 288 }
 289
 290 static bool
 291 write_action(struct xkb_keymap *keymap, struct buf *buf,
 292              const union xkb_action *action,
 293              const char *prefix, const char *suffix)
 294 {
 295     const char *type;
 296     const char *args = NULL;
 297
 298     if (!prefix)
 299         prefix = "";
 300     if (!suffix)
 301         suffix = "";
 302
 303     type = ActionTypeText(action->type);
 304
 305     switch (action->type) {
 306     case ACTION_TYPE_MOD_LOCK:
 307     case ACTION_TYPE_MOD_SET:
 308     case ACTION_TYPE_MOD_LATCH:
 309         if (action->mods.flags & ACTION_MODS_LOOKUP_MODMAP)
 310             args = "modMapMods";
 311         else
 312             args = ModMaskText(keymap, action->mods.mods.mods);
 313         write_buf(buf, "%s%s(modifiers=%s%s%s%s)%s", prefix, type, args,
 314                   (action->type != ACTION_TYPE_MOD_LOCK && (action->mods.flags & ACTION_LOCK_CLEAR)) ? ",clearLocks" : "",
 315                   (action->type != ACTION_TYPE_MOD_LOCK && (action->mods.flags & ACTION_LATCH_TO_LOCK)) ? ",latchToLock" : "",
 316                   (action->type == ACTION_TYPE_MOD_LOCK) ? affect_lock_text(action->mods.flags) : "",
 317                   suffix);
 318         break;
 319
 320     case ACTION_TYPE_GROUP_SET:
 321     case ACTION_TYPE_GROUP_LATCH:
 322     case ACTION_TYPE_GROUP_LOCK:
 323         write_buf(buf, "%s%s(group=%s%d%s%s)%s", prefix, type,
 324                   (!(action->group.flags & ACTION_ABSOLUTE_SWITCH) && action->group.group > 0) ? "+" : "",
 325                   (action->group.flags & ACTION_ABSOLUTE_SWITCH) ? action->group.group + 1 : action->group.group,
 326                   (action->type != ACTION_TYPE_GROUP_LOCK && (action->group.flags & ACTION_LOCK_CLEAR)) ? ",clearLocks" : "",
 327                   (action->type != ACTION_TYPE_GROUP_LOCK && (action->group.flags & ACTION_LATCH_TO_LOCK)) ? ",latchToLock" : "",
 328                   suffix);
 329         break;
 330
 331     case ACTION_TYPE_TERMINATE:
 332         write_buf(buf, "%s%s()%s", prefix, type, suffix);
 333         break;
 334
 335     case ACTION_TYPE_PTR_MOVE:
 336         write_buf(buf, "%s%s(x=%s%d,y=%s%d%s)%s", prefix, type,
 337                   (!(action->ptr.flags & ACTION_ABSOLUTE_X) && action->ptr.x >= 0) ? "+" : "",
 338                   action->ptr.x,
 339                   (!(action->ptr.flags & ACTION_ABSOLUTE_Y) && action->ptr.y >= 0) ? "+" : "",
 340                   action->ptr.y,
 341                   (action->ptr.flags & ACTION_ACCEL) ? "" : ",!accel",
 342                   suffix);
 343         break;
 344
 345     case ACTION_TYPE_PTR_LOCK:
 346         args = affect_lock_text(action->btn.flags);
 347         /* fallthrough */
 348     case ACTION_TYPE_PTR_BUTTON:
 349         write_buf(buf, "%s%s(button=", prefix, type);
 350         if (action->btn.button > 0 && action->btn.button <= 5)
 351             write_buf(buf, "%d", action->btn.button);
 352         else
 353             write_buf(buf, "default");
 354         if (action->btn.count)
 355             write_buf(buf, ",count=%d", action->btn.count);
 356         if (args)
 357             write_buf(buf, "%s", args);
 358         write_buf(buf, ")%s", suffix);
 359         break;
 360
 361     case ACTION_TYPE_PTR_DEFAULT:
 362         write_buf(buf, "%s%s(", prefix, type);
 363         write_buf(buf, "affect=button,button=%s%d",
 364                   (!(action->dflt.flags & ACTION_ABSOLUTE_SWITCH) && action->dflt.value >= 0) ? "+" : "",
 365                   action->dflt.value);
 366         write_buf(buf, ")%s", suffix);
 367         break;
 368
 369     case ACTION_TYPE_SWITCH_VT:
 370         write_buf(buf, "%s%s(screen=%s%d,%ssame)%s", prefix, type,
 371                   (!(action->screen.flags & ACTION_ABSOLUTE_SWITCH) && action->screen.screen >= 0) ? "+" : "",
 372                   action->screen.screen,
 373                   (action->screen.flags & ACTION_SAME_SCREEN) ? "" : "!",
 374                   suffix);
 375         break;
 376
 377     case ACTION_TYPE_CTRL_SET:
 378     case ACTION_TYPE_CTRL_LOCK:
 379         write_buf(buf, "%s%s(controls=%s%s)%s", prefix, type,
 380                   ControlMaskText(keymap->ctx, action->ctrls.ctrls),
 381                   (action->type == ACTION_TYPE_CTRL_LOCK) ? affect_lock_text(action->ctrls.flags) : "",
 382                   suffix);
 383         break;
 384
 385     case ACTION_TYPE_NONE:
 386         write_buf(buf, "%sNoAction()%s", prefix, suffix);
 387         break;
 388
 389     default:
 390         write_buf(buf,
 391                   "%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",
 392                   prefix, type, action->type, action->priv.data[0],
 393                   action->priv.data[1], action->priv.data[2],
 394                   action->priv.data[3], action->priv.data[4],
 395                   action->priv.data[5], action->priv.data[6],
 396                   suffix);
 397         break;
 398     }
 399
 400     return true;
 401 }
 402
 403 static bool
 404 write_compat(struct xkb_keymap *keymap, struct buf *buf)
 405 {
 406     const struct xkb_led *led;
 407
 408     if (keymap->compat_section_name)
 409         write_buf(buf, "xkb_compatibility \"%s\" {\n",
 410                   keymap->compat_section_name);
 411     else
 412         write_buf(buf, "xkb_compatibility {\n");
 413
 414     write_vmods(keymap, buf);
 415
 416     write_buf(buf, "\tinterpret.useModMapMods= AnyLevel;\n");
 417     write_buf(buf, "\tinterpret.repeat= False;\n");
 418
 419     for (unsigned i = 0; i < keymap->num_sym_interprets; i++) {
 420         const struct xkb_sym_interpret *si = &keymap->sym_interprets[i];
 421
 422         write_buf(buf, "\tinterpret %s+%s(%s) {\n",
 423                   si->sym ? KeysymText(keymap->ctx, si->sym) : "Any",
 424                   SIMatchText(si->match),
 425                   ModMaskText(keymap, si->mods));
 426
 427         if (si->virtual_mod != XKB_MOD_INVALID)
 428             write_buf(buf, "\t\tvirtualModifier= %s;\n",
 429                       ModIndexText(keymap, si->virtual_mod));
 430
 431         if (si->level_one_only)
 432             write_buf(buf, "\t\tuseModMapMods=level1;\n");
 433
 434         if (si->repeat)
 435             write_buf(buf, "\t\trepeat= True;\n");
 436
 437         write_action(keymap, buf, &si->action, "\t\taction= ", ";\n");
 438         write_buf(buf, "\t};\n");
 439     }
 440
 441     darray_foreach(led, keymap->leds)
 442         if (led->which_groups || led->groups || led->which_mods ||
 443             led->mods.mods || led->ctrls)
 444             write_led_map(keymap, buf, led);
 445
 446     write_buf(buf, "};\n\n");
 447
 448     return true;
 449 }
 450
 451 static bool
 452 write_keysyms(struct xkb_keymap *keymap, struct buf *buf,
 453               const struct xkb_key *key, xkb_layout_index_t group)
 454 {
 455     for (xkb_level_index_t level = 0; level < XkbKeyGroupWidth(key, group);
 456          level++) {
 457         const xkb_keysym_t *syms;
 458         int num_syms;
 459
 460         if (level != 0)
 461             write_buf(buf, ", ");
 462
 463         num_syms = xkb_keymap_key_get_syms_by_level(keymap, key->keycode,
 464                                                     group, level, &syms);
 465         if (num_syms == 0) {
 466             write_buf(buf, "%15s", "NoSymbol");
 467         }
 468         else if (num_syms == 1) {
 469             write_buf(buf, "%15s", KeysymText(keymap->ctx, syms[0]));
 470         }
 471         else {
 472             write_buf(buf, "{ ");
 473             for (int s = 0; s < num_syms; s++) {
 474                 if (s != 0)
 475                     write_buf(buf, ", ");
 476                 write_buf(buf, "%s", KeysymText(keymap->ctx, syms[s]));
 477             }
 478             write_buf(buf, " }");
 479         }
 480     }
 481
 482     return true;
 483 }
 484
 485 static bool
 486 write_key(struct xkb_keymap *keymap, struct buf *buf,
 487           const struct xkb_key *key)
 488 {
 489     xkb_layout_index_t group;
 490     bool simple = true;
 491     bool explicit_types = false;
 492     bool multi_type = false;
 493     bool show_actions;
 494
 495     write_buf(buf, "\tkey %-20s {", KeyNameText(keymap->ctx, key->name));
 496
 497     for (group = 0; group < key->num_groups; group++) {
 498         if (key->groups[group].explicit_type)
 499             explicit_types = true;
 500
 501         if (group != 0 && key->groups[group].type != key->groups[0].type)
 502             multi_type = true;
 503     }
 504
 505     if (explicit_types) {
 506         const struct xkb_key_type *type;
 507         simple = false;
 508
 509         if (multi_type) {
 510             for (group = 0; group < key->num_groups; group++) {
 511                 if (!key->groups[group].explicit_type)
 512                     continue;
 513
 514                 type = key->groups[group].type;
 515                 write_buf(buf, "\n\t\ttype[group%u]= \"%s\",",
 516                             group + 1,
 517                             xkb_atom_text(keymap->ctx, type->name));
 518             }
 519         }
 520         else {
 521             type = key->groups[0].type;
 522             write_buf(buf, "\n\t\ttype= \"%s\",",
 523                         xkb_atom_text(keymap->ctx, type->name));
 524         }
 525     }
 526
 527     if (key->explicit & EXPLICIT_REPEAT) {
 528         if (key->repeats)
 529             write_buf(buf, "\n\t\trepeat= Yes,");
 530         else
 531             write_buf(buf, "\n\t\trepeat= No,");
 532         simple = false;
 533     }
 534
 535     if (key->vmodmap && (key->explicit & EXPLICIT_VMODMAP))
 536         write_buf(buf, "\n\t\tvirtualMods= %s,",
 537                     ModMaskText(keymap, key->vmodmap));
 538
 539     switch (key->out_of_range_group_action) {
 540     case RANGE_SATURATE:
 541         write_buf(buf, "\n\t\tgroupsClamp,");
 542         break;
 543
 544     case RANGE_REDIRECT:
 545         write_buf(buf, "\n\t\tgroupsRedirect= Group%u,",
 546                     key->out_of_range_group_number + 1);
 547         break;
 548
 549     default:
 550         break;
 551     }
 552
 553     show_actions = !!(key->explicit & EXPLICIT_INTERP);
 554
 555     if (key->num_groups > 1 || show_actions)
 556         simple = false;
 557
 558     if (simple) {
 559         write_buf(buf, "\t[ ");
 560         if (!write_keysyms(keymap, buf, key, 0))
 561             return false;
 562         write_buf(buf, " ] };\n");
 563     }
 564     else {
 565         xkb_level_index_t level;
 566
 567         for (group = 0; group < key->num_groups; group++) {
 568             if (group != 0)
 569                 write_buf(buf, ",");
 570             write_buf(buf, "\n\t\tsymbols[Group%u]= [ ", group + 1);
 571             if (!write_keysyms(keymap, buf, key, group))
 572                 return false;
 573             write_buf(buf, " ]");
 574             if (show_actions) {
 575                 write_buf(buf, ",\n\t\tactions[Group%u]= [ ", group + 1);
 576                 for (level = 0;
 577                         level < XkbKeyGroupWidth(key, group); level++) {
 578                     if (level != 0)
 579                         write_buf(buf, ", ");
 580                     write_action(keymap, buf,
 581                                     &key->groups[group].levels[level].action,
 582                                     NULL, NULL);
 583                 }
 584                 write_buf(buf, " ]");
 585             }
 586         }
 587         write_buf(buf, "\n\t};\n");
 588     }
 589
 590     return true;
 591 }
 592
 593 static bool
 594 write_symbols(struct xkb_keymap *keymap, struct buf *buf)
 595 {
 596     const struct xkb_key *key;
 597     xkb_layout_index_t group;
 598
 599     if (keymap->symbols_section_name)
 600         write_buf(buf, "xkb_symbols \"%s\" {\n",
 601                   keymap->symbols_section_name);
 602     else
 603         write_buf(buf, "xkb_symbols {\n");
 604
 605     for (group = 0; group < keymap->num_group_names; group++)
 606         if (keymap->group_names[group])
 607             write_buf(buf,
 608                       "\tname[group%u]=\"%s\";\n", group + 1,
 609                       xkb_atom_text(keymap->ctx, keymap->group_names[group]));
 610     if (group > 0)
 611         write_buf(buf, "\n");
 612
 613     xkb_foreach_key(key, keymap)
 614         if (key->num_groups > 0)
 615             write_key(keymap, buf, key);
 616
 617     xkb_foreach_key(key, keymap) {
 618         xkb_mod_index_t i;
 619         const struct xkb_mod *mod;
 620
 621         if (key->modmap == 0)
 622             continue;
 623
 624         darray_enumerate(i, mod, keymap->mods.mods)
 625             if (key->modmap & (1u << i))
 626                 write_buf(buf, "\tmodifier_map %s { %s };\n",
 627                           xkb_atom_text(keymap->ctx, mod->name),
 628                           KeyNameText(keymap->ctx, key->name));
 629     }
 630
 631     write_buf(buf, "};\n\n");
 632     return true;
 633 }
 634
 635 static bool
 636 write_keymap(struct xkb_keymap *keymap, struct buf *buf)
 637 {
 638     return (check_write_buf(buf, "xkb_keymap {\n") &&
 639             write_keycodes(keymap, buf) &&
 640             write_types(keymap, buf) &&
 641             write_compat(keymap, buf) &&
 642             write_symbols(keymap, buf) &&
 643             check_write_buf(buf, "};\n"));
 644 }
 645
 646 char *
 647 text_v1_keymap_get_as_string(struct xkb_keymap *keymap)
 648 {
 649     struct buf buf = { NULL, 0, 0 };
 650
 651     if (!write_keymap(keymap, &buf)) {
 652         free(buf.buf);
 653         return NULL;
 654     }
 655
 656     return buf.buf;
 657 }