Commit ebd397e184a9f0b6127d37fed96e75ed32be8ae1
2012-05-25T17:05:39
Add xkb_map_get_as_string Returns a newly-allocated string representing the specified keymap. Signed-off-by: Daniel Stone <daniel@fooishbar.org>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
diff --git a/Makefile.am b/Makefile.am
index b265099..5ce1a2e 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -74,6 +74,7 @@ libxkbcommon_la_SOURCES = \
src/atom.h \
src/context.c \
src/darray.h \
+ src/keymap-dump.c \
src/keysym.c \
src/map.c \
src/misc.c \
@@ -116,7 +117,8 @@ TESTS = \
test/canonicalise \
test/state \
test/context \
- test/rules-file
+ test/rules-file \
+ test/dump
TESTS_LDADD = libxkbcommon-priv.la
test_xkey_LDADD = $(TESTS_LDADD)
@@ -128,6 +130,7 @@ test_state_LDADD = $(TESTS_LDADD)
test_context_LDADD = $(TESTS_LDADD)
test_rules_file_CFLAGS = $(AM_CFLAGS) -Wno-declaration-after-statement
test_rules_file_LDADD = $(TESTS_LDADD)
+test_dump_LDADD = $(TESTS_LDADD)
check_PROGRAMS = $(TESTS)
diff --git a/include/xkbcommon/xkbcommon.h b/include/xkbcommon/xkbcommon.h
index e2786fe..fb23425 100644
--- a/include/xkbcommon/xkbcommon.h
+++ b/include/xkbcommon/xkbcommon.h
@@ -279,6 +279,13 @@ xkb_map_new_from_string(struct xkb_context *context,
enum xkb_map_compile_flags flags);
/**
+ * Returns the compiled XKB map as a string which can later be fed back into
+ * xkb_map_new_from_string to return the exact same keymap.
+ */
+char *
+xkb_map_get_as_string(struct xkb_keymap *keymap);
+
+/**
* Takes a new reference on a keymap.
*/
struct xkb_keymap *
diff --git a/src/keymap-dump.c b/src/keymap-dump.c
new file mode 100644
index 0000000..5dc8166
--- /dev/null
+++ b/src/keymap-dump.c
@@ -0,0 +1,932 @@
+/************************************************************
+ Copyright (c) 1994 by Silicon Graphics Computer Systems, Inc.
+
+ Permission to use, copy, modify, and distribute this
+ software and its documentation for any purpose and without
+ fee is hereby granted, provided that the above copyright
+ notice appear in all copies and that both that copyright
+ notice and this permission notice appear in supporting
+ documentation, and that the name of Silicon Graphics not be
+ used in advertising or publicity pertaining to distribution
+ of the software without specific prior written permission.
+ Silicon Graphics makes no representation about the suitability
+ of this software for any purpose. It is provided "as is"
+ without any express or implied warranty.
+
+ SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+ SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+ AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
+ GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
+ DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
+ DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+ OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH
+ THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+ ********************************************************/
+
+/*
+ * Copyright © 2012 Intel Corporation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ *
+ * Author: Daniel Stone <daniel@fooishbar.org>
+ */
+
+#include <config.h>
+
+#include <stdio.h>
+#include <ctype.h>
+#include <stdlib.h>
+
+#include "xkb-priv.h"
+#include "text.h"
+
+#define VMOD_HIDE_VALUE 0
+#define VMOD_SHOW_VALUE 1
+#define VMOD_COMMENT_VALUE 2
+
+#define BUF_CHUNK_SIZE 4096
+
+static bool
+do_realloc(char **buf, size_t *size, size_t offset, size_t at_least)
+{
+ char *new;
+
+ *size += BUF_CHUNK_SIZE;
+ if (at_least >= BUF_CHUNK_SIZE)
+ *size += at_least;
+
+ new = realloc(*buf, *size);
+ if (!new)
+ return false;
+ *buf = new;
+
+ memset(*buf + offset, 0, *size - offset);
+
+ return true;
+}
+
+/* This whole thing should be a function, but you can't call vsnprintf
+ * multiple times. */
+#define check_write_buf(keymap, buf, size, offset, ...) \
+do { \
+ size_t _printed; \
+ bool _ret = true; \
+ \
+ /* Concatenate the strings, and check whether or not the output was \
+ * truncated. */ \
+ while ((_printed = snprintf(*buf + *offset, *size - *offset, \
+ __VA_ARGS__)) >= \
+ (*size - *offset)) {\
+ /* If it was truncated, embiggen the string and roll from the top. */ \
+ if (!do_realloc(buf, size, *offset, _printed)) { \
+ fprintf(stderr, \
+ "xkbcommon: failed to allocate %lu bytes for keymap\n", \
+ (unsigned long) *size); \
+ free(*buf); \
+ *buf = NULL; \
+ _ret = false; \
+ break; \
+ } \
+ } \
+ if (_ret == true) \
+ *offset += _printed; \
+} while (0)
+
+#define write_buf(keymap, buf, size, offset, ...) \
+do { \
+ check_write_buf(keymap, buf, size, offset, __VA_ARGS__); \
+ if (*buf == NULL) \
+ return false; \
+} while (0)
+
+static bool
+write_vmods(struct xkb_keymap *keymap, char **buf, size_t *size, size_t *offset)
+{
+ int num_vmods = 0;
+ int i;
+
+ for (i = 0; i < XkbNumVirtualMods; i++) {
+ if (!keymap->names->vmods[i])
+ continue;
+ if (num_vmods == 0)
+ write_buf(keymap, buf, size, offset, "\t\tvirtual_modifiers ");
+ else
+ write_buf(keymap, buf, size, offset, ",");
+ write_buf(keymap, buf, size, offset, "%s", keymap->names->vmods[i]);
+ num_vmods++;
+ }
+
+ if (num_vmods > 0)
+ write_buf(keymap, buf, size, offset, ";\n\n");
+
+ return true;
+}
+
+#define GET_TEXT_BUF_SIZE 512
+
+#define append_get_text(...) do { \
+ int _size = snprintf(ret, GET_TEXT_BUF_SIZE, __VA_ARGS__); \
+ if (_size >= GET_TEXT_BUF_SIZE) \
+ return NULL; \
+} while(0)
+
+/* FIXME: Merge with src/xkbcomp/expr.c::modIndexNames. */
+static const char *core_mod_names[] = {
+ "Shift",
+ "Lock",
+ "Control",
+ "Mod1",
+ "Mod2",
+ "Mod3",
+ "Mod4",
+ "Mod5",
+};
+
+static const char *
+get_mod_index_text(uint8_t real_mod)
+{
+ return core_mod_names[real_mod];
+}
+
+static char *
+get_mod_mask_text(struct xkb_keymap *keymap, uint8_t real_mods, uint32_t vmods)
+{
+ static char ret[GET_TEXT_BUF_SIZE], ret2[GET_TEXT_BUF_SIZE];
+ int i;
+
+ memset(ret, 0, GET_TEXT_BUF_SIZE);
+
+ if (real_mods == 0 && vmods == 0) {
+ strcpy(ret, "none");
+ return ret;
+ }
+
+ /* This is so broken. If we have a real modmask of 0xff and a
+ * vmodmask, we'll get, e.g., all+RightControl. But, it's what xkbfile
+ * does, so ... */
+ if (real_mods == 0xff) {
+ strcpy(ret, "all");
+ }
+ else if (real_mods) {
+ for (i = 0; i < XkbNumModifiers; i++) {
+ if (!(real_mods & (1 << i)))
+ continue;
+ if (ret[0] != '\0') {
+ strcpy(ret2, ret);
+ append_get_text("%s+%s", ret2, core_mod_names[i]);
+ }
+ else {
+ append_get_text("%s", core_mod_names[i]);
+ }
+ }
+ }
+
+ if (vmods == 0)
+ return ret;
+
+ for (i = 0; i < XkbNumVirtualMods; i++) {
+ if (!(vmods & (1 << i)))
+ continue;
+ if (ret[0] != '\0') {
+ strcpy(ret2, ret);
+ append_get_text("%s+%s", ret2, keymap->names->vmods[i]);
+ }
+ else {
+ append_get_text("%s", keymap->names->vmods[i]);
+ }
+ }
+
+ return ret;
+}
+
+static char *
+get_indicator_state_text(uint8_t which)
+{
+ int i;
+ static char ret[GET_TEXT_BUF_SIZE];
+ /* FIXME: Merge with ... something ... in xkbcomp? */
+ static const char *state_names[] = {
+ "base",
+ "latched",
+ "locked",
+ "effective",
+ "compat"
+ };
+
+ memset(ret, 0, GET_TEXT_BUF_SIZE);
+
+ which &= XkbIM_UseAnyMods;
+
+ if (which == 0) {
+ strcpy(ret, "0");
+ return NULL;
+ }
+
+ for (i = 0; which != 0; i++) {
+ if (!(which & (1 << i)))
+ continue;
+ which &= ~(1 << i);
+
+ if (ret[0] != '\0')
+ append_get_text("%s+%s", ret, state_names[i]);
+ else
+ append_get_text("%s", state_names[i]);
+ }
+
+ return ret;
+}
+
+static char *
+get_control_mask_text(uint32_t control_mask)
+{
+ int i;
+ static char ret[GET_TEXT_BUF_SIZE];
+ /* FIXME: Merge with ... something ... in xkbcomp. */
+ static const char *ctrl_names[] = {
+ "repeatKeys",
+ "slowKeys",
+ "bounceKeys",
+ "stickyKeys",
+ "mouseKeys",
+ "mouseKeysAccel",
+ "accessXKeys",
+ "accessXTimeout",
+ "accessXFeedback",
+ "audibleBell",
+ "overlay1",
+ "overlay2",
+ "ignoreGroupLock"
+ };
+
+ memset(ret, 0, GET_TEXT_BUF_SIZE);
+
+ control_mask &= XkbAllBooleanCtrlsMask;
+
+ if (control_mask == 0) {
+ strcpy(ret, "none");
+ return ret;
+ }
+ else if (control_mask == XkbAllBooleanCtrlsMask) {
+ strcpy(ret, "all");
+ return ret;
+ }
+
+ for (i = 0; control_mask; i++) {
+ if (!(control_mask & (1 << i)))
+ continue;
+ control_mask &= ~(1 << i);
+
+ if (ret[0] != '\0')
+ append_get_text("%s+%s", ret, ctrl_names[i]);
+ else
+ append_get_text("%s", ctrl_names[i]);
+ }
+
+ return ret;
+}
+
+static bool
+write_keycodes(struct xkb_keymap *keymap, char **buf, size_t *size,
+ size_t *offset)
+{
+ xkb_keycode_t key;
+ struct xkb_key_alias *alias;
+ int i;
+
+ write_buf(keymap, buf, size, offset, "\txkb_keycodes {\n");
+ write_buf(keymap, buf, size, offset, "\t\tminimum = %d;\n",
+ keymap->min_key_code);
+ write_buf(keymap, buf, size, offset, "\t\tmaximum = %d;\n",
+ keymap->max_key_code);
+
+ for (key = keymap->min_key_code; key <= keymap->max_key_code; key++) {
+ const char *alternate = "";
+
+ if (darray_item(keymap->names->keys, key).name[0] == '\0')
+ continue;
+ if (XkbcFindKeycodeByName(keymap,
+ darray_item(keymap->names->keys, key).name,
+ true) != key)
+ alternate = "alternate ";
+ write_buf(keymap, buf, size, offset, "\t\t%s%6s = %d;\n", alternate,
+ XkbcKeyNameText(darray_item(keymap->names->keys, key).name),
+ key);
+ }
+
+ for (i = 0; i < XkbNumIndicators; i++) {
+ if (!keymap->names->indicators[i])
+ continue;
+ write_buf(keymap, buf, size, offset, "\t\tindicator %d = \"%s\";\n",
+ i + 1, keymap->names->indicators[i]);
+ }
+
+
+ for (i = 0; i < darray_size(keymap->names->key_aliases); i++) {
+ alias = &darray_item(keymap->names->key_aliases, i);
+ write_buf(keymap, buf, size, offset, "\t\talias %6s = %6s;\n",
+ XkbcKeyNameText(alias->alias),
+ XkbcKeyNameText(alias->real));
+ }
+
+ write_buf(keymap, buf, size, offset, "\t};\n\n");
+ return true;
+}
+
+static bool
+write_types(struct xkb_keymap *keymap, char **buf, size_t *size,
+ size_t *offset)
+{
+ int i, n;
+ struct xkb_key_type *type;
+
+ write_buf(keymap, buf, size, offset, "\txkb_types {\n\n");
+ write_vmods(keymap, buf, size, offset);
+
+ for (i = 0; i < darray_size(keymap->map->types); i++) {
+ type = &darray_item(keymap->map->types, i);
+ write_buf(keymap, buf, size, offset, "\t\ttype \"%s\" {\n",
+ type->name);
+ write_buf(keymap, buf, size, offset, "\t\t\tmodifiers= %s;\n",
+ get_mod_mask_text(keymap, type->mods.real_mods,
+ type->mods.vmods));
+
+ for (n = 0; n < darray_size(type->map); n++) {
+ struct xkb_kt_map_entry *entry = &darray_item(type->map, n);
+ char *str;
+
+ str = get_mod_mask_text(keymap, entry->mods.real_mods,
+ entry->mods.vmods);
+ write_buf(keymap, buf, size, offset, "\t\t\tmap[%s]= Level%d;\n",
+ str, entry->level + 1);
+
+ if (!type->preserve || (!type->preserve[n].real_mods &&
+ !type->preserve[n].vmods))
+ continue;
+ write_buf(keymap, buf, size, offset, "\t\t\tpreserve[%s]= ", str);
+ write_buf(keymap, buf, size, offset, "%s;\n",
+ get_mod_mask_text(keymap, type->preserve[n].real_mods,
+ type->preserve[n].vmods));
+ }
+
+ if (type->level_names) {
+ for (n = 0; n < type->num_levels; n++) {
+ if (!type->level_names[n])
+ continue;
+ write_buf(keymap, buf, size, offset,
+ "\t\t\tlevel_name[Level%d]= \"%s\";\n", n + 1,
+ type->level_names[n]);
+ }
+ }
+ write_buf(keymap, buf, size, offset, "\t\t};\n");
+ }
+
+ write_buf(keymap, buf, size, offset, "\t};\n\n");
+ return true;
+}
+
+static bool
+write_indicator_map(struct xkb_keymap *keymap, char **buf, size_t *size,
+ size_t *offset, int num)
+{
+ struct xkb_indicator_map *led = &keymap->indicators->maps[num];
+
+ write_buf(keymap, buf, size, offset, "\t\tindicator \"%s\" {\n",
+ keymap->names->indicators[num]);
+
+ if (led->which_groups) {
+ if (led->which_groups != XkbIM_UseEffective) {
+ write_buf(keymap, buf, size, offset, "\t\t\twhichGroupState= %s;\n",
+ get_indicator_state_text(led->which_groups));
+ }
+ write_buf(keymap, buf, size, offset, "\t\t\tgroups= 0x%02x;\n",
+ led->groups);
+ }
+
+ if (led->which_mods) {
+ if (led->which_mods != XkbIM_UseEffective) {
+ write_buf(keymap, buf, size, offset, "\t\t\twhichModState= %s;\n",
+ get_indicator_state_text(led->which_mods));
+ }
+ write_buf(keymap, buf, size, offset, "\t\t\tmodifiers= %s;\n",
+ get_mod_mask_text(keymap, led->mods.real_mods,
+ led->mods.vmods));
+ }
+
+ if (led->ctrls) {
+ write_buf(keymap, buf, size, offset, "\t\t\tcontrols= %s;\n",
+ get_control_mask_text(led->ctrls));
+ }
+
+ write_buf(keymap, buf, size, offset, "\t\t};\n");
+ return true;
+}
+
+static char *
+get_interp_match_text(uint8_t type)
+{
+ static char ret[16];
+
+ switch (type & XkbSI_OpMask) {
+ case XkbSI_NoneOf:
+ sprintf(ret, "NoneOf");
+ break;
+ case XkbSI_AnyOfOrNone:
+ sprintf(ret, "AnyOfOrNone");
+ break;
+ case XkbSI_AnyOf:
+ sprintf(ret, "AnyOf");
+ break;
+ case XkbSI_AllOf:
+ sprintf(ret, "AllOf");
+ break;
+ case XkbSI_Exactly:
+ sprintf(ret, "Exactly");
+ break;
+ default:
+ sprintf(ret, "0x%x", type & XkbSI_OpMask);
+ break;
+ }
+
+ return ret;
+}
+
+static bool
+write_action(struct xkb_keymap *keymap, char **buf, size_t *size,
+ size_t *offset, union xkb_action *action, const char *prefix,
+ const char *suffix)
+{
+ const char *type = NULL;
+ const char *args = NULL;
+
+ if (!prefix)
+ prefix = "";
+ if (!suffix)
+ suffix = "";
+
+ if (action->any.type == XkbSA_NoAction)
+ return true;
+
+ switch (action->any.type) {
+ case XkbSA_SetMods:
+ if (!type)
+ type = "SetMods";
+ case XkbSA_LatchMods:
+ if (!type)
+ type = "LatchMods";
+ case XkbSA_LockMods:
+ if (!type)
+ type = "LockMods";
+ if (action->mods.flags & XkbSA_UseModMapMods)
+ args = "modMapMods";
+ else
+ args = get_mod_mask_text(keymap, action->mods.real_mods,
+ action->mods.vmods);
+ write_buf(keymap, buf, size, offset, "%s%s(modifiers=%s%s%s)%s",
+ prefix, type, args,
+ (action->any.type != XkbSA_LockGroup &&
+ action->mods.flags & XkbSA_ClearLocks) ? ",clearLocks" : "",
+ (action->any.type != XkbSA_LockGroup &&
+ action->mods.flags & XkbSA_LatchToLock) ? ",latchToLock" : "",
+ suffix);
+ break;
+ case XkbSA_SetGroup:
+ if (!type)
+ type = "SetGroup";
+ case XkbSA_LatchGroup:
+ if (!type)
+ type = "LatchGroup";
+ case XkbSA_LockGroup:
+ if (!type)
+ type = "LockGroup";
+ write_buf(keymap, buf, size, offset, "%s%s(group=%s%d%s%s)%s",
+ prefix, type,
+ (!(action->group.flags & XkbSA_GroupAbsolute) &&
+ action->group.group > 0) ? "+" : "",
+ (action->group.flags & XkbSA_GroupAbsolute) ?
+ action->group.group + 1 : action->group.group,
+ (action->any.type != XkbSA_LockGroup &&
+ action->group.flags & XkbSA_ClearLocks) ? ",clearLocks" : "",
+ (action->any.type != XkbSA_LockGroup &&
+ action->group.flags & XkbSA_LatchToLock) ? ",latchToLock" : "",
+ suffix);
+ break;
+ case XkbSA_Terminate:
+ write_buf(keymap, buf, size, offset, "%sTerminate()%s", prefix, suffix);
+ break;
+ case XkbSA_MovePtr:
+ write_buf(keymap, buf, size, offset, "%sMovePtr(x=%s%d,y=%s%d%s)%s",
+ prefix,
+ (!(action->ptr.flags & XkbSA_MoveAbsoluteX) &&
+ action->ptr.x >= 0) ? "+" : "",
+ action->ptr.x,
+ (!(action->ptr.flags & XkbSA_MoveAbsoluteY) &&
+ action->ptr.y >= 0) ? "+" : "",
+ action->ptr.y,
+ (action->ptr.flags & XkbSA_NoAcceleration) ? ",!accel" : "",
+ suffix);
+ break;
+ case XkbSA_PtrBtn:
+ if (!type)
+ type = "PtrBtn";
+ case XkbSA_LockPtrBtn:
+ if (!type) {
+ type = "LockPtrBtn";
+ switch (action->btn.flags & (XkbSA_LockNoUnlock | XkbSA_LockNoLock)) {
+ case XkbSA_LockNoUnlock:
+ args = ",affect=lock";
+ break;
+ case XkbSA_LockNoLock:
+ args = ",affect=unlock";
+ break;
+ case XkbSA_LockNoLock | XkbSA_LockNoUnlock:
+ args = ",affect=neither";
+ break;
+ default:
+ args = ",affect=both";
+ break;
+ }
+ }
+ else {
+ args = NULL;
+ }
+ write_buf(keymap, buf, size, offset, "%s%s(button=", prefix, type);
+ if (action->btn.button > 0 && action->btn.button <= 5)
+ write_buf(keymap, buf, size, offset, "%d", action->btn.button);
+ else
+ write_buf(keymap, buf, size, offset, "default");
+ if (action->btn.count)
+ write_buf(keymap, buf, size, offset, ",count=%d",
+ action->btn.count);
+ if (args)
+ write_buf(keymap, buf, size, offset, "%s", args);
+ write_buf(keymap, buf, size, offset, ")%s", suffix);
+ break;
+ case XkbSA_SetPtrDflt:
+ write_buf(keymap, buf, size, offset, "%sSetPtrDflt(", prefix);
+ if (action->dflt.affect == XkbSA_AffectDfltBtn)
+ write_buf(keymap, buf, size, offset, "affect=button,button=%s%d",
+ (!(action->dflt.flags & XkbSA_DfltBtnAbsolute) &&
+ action->dflt.value >= 0) ? "+" : "",
+ action->dflt.value);
+ write_buf(keymap, buf, size, offset, ")%s", suffix);
+ break;
+ case XkbSA_SwitchScreen:
+ write_buf(keymap, buf, size, offset,
+ "%sSwitchScreen(screen=%s%d,%ssame)%s", prefix,
+ (!(action->screen.flags & XkbSA_SwitchAbsolute) &&
+ action->screen.screen >= 0) ? "+" : "",
+ action->screen.screen,
+ (action->screen.flags & XkbSA_SwitchApplication) ? "!" : "",
+ suffix);
+ break;
+ /* Deprecated actions below here */
+ case XkbSA_SetControls:
+ if (!type)
+ type = "SetControls";
+ case XkbSA_LockControls:
+ if (!type)
+ type = "LockControls";
+ write_buf(keymap, buf, size, offset, "%s%s(controls=%s)%s",
+ prefix, type, get_control_mask_text(action->ctrls.ctrls),
+ suffix);
+ break;
+ case XkbSA_ISOLock:
+ case XkbSA_ActionMessage:
+ case XkbSA_RedirectKey:
+ case XkbSA_DeviceBtn:
+ case XkbSA_LockDeviceBtn:
+ /* XXX TODO */
+ write_buf(keymap, buf, size, offset, "%sNoAction()%s", prefix, suffix);
+ break;
+ case XkbSA_XFree86Private:
+ default:
+ write_buf(keymap, buf, size, offset,
+ "%sPrivate(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",
+ prefix, action->any.type, action->any.data[0],
+ action->any.data[1], action->any.data[2],
+ action->any.data[3], action->any.data[4],
+ action->any.data[5], action->any.data[6], suffix);
+ break;
+ }
+
+ return true;
+}
+
+static bool
+write_compat(struct xkb_keymap *keymap, char **buf, size_t *size,
+ size_t *offset)
+{
+ int i;
+ struct xkb_sym_interpret *interp;
+
+ write_buf(keymap, buf, size, offset, "\txkb_compatibility {\n\n");
+
+ write_vmods(keymap, buf, size, offset);
+
+ write_buf(keymap, buf, size, offset, "\t\tinterpret.useModMapMods= AnyLevel;\n");
+ write_buf(keymap, buf, size, offset, "\t\tinterpret.repeat= false;\n");
+ write_buf(keymap, buf, size, offset, "\t\tinterpret.locking= false;\n");
+
+ for (i = 0; i < darray_size(keymap->compat->sym_interpret); i++) {
+ char keysym_name[64];
+ interp = &darray_item(keymap->compat->sym_interpret, i);
+
+ if (interp->sym == XKB_KEY_NoSymbol)
+ sprintf(keysym_name, "Any");
+ else
+ xkb_keysym_get_name(interp->sym, keysym_name, 64);
+
+ write_buf(keymap, buf, size, offset, "\t\tinterpret %s+%s(%s) {\n",
+ keysym_name,
+ get_interp_match_text(interp->match),
+ get_mod_mask_text(keymap, interp->mods, 0));
+
+ if (interp->virtual_mod != XkbNoModifier) {
+ write_buf(keymap, buf, size, offset, "\t\t\tvirtualModifier= %s;\n",
+ keymap->names->vmods[interp->virtual_mod]);
+ }
+
+ if (interp->match & XkbSI_LevelOneOnly)
+ write_buf(keymap, buf, size, offset, "\t\t\tuseModMapMods=level1;\n");
+ if (interp->flags & XkbSI_LockingKey)
+ write_buf(keymap, buf, size, offset, "\t\t\tlocking= true;\n");
+ if (interp->flags & XkbSI_AutoRepeat)
+ write_buf(keymap, buf, size, offset, "\t\t\trepeat= true;\n");
+
+ write_action(keymap, buf, size, offset, &interp->act,
+ "\t\t\taction= ", ";\n");
+ write_buf(keymap, buf, size, offset, "\t\t};\n");
+ }
+
+ for (i = 0; i < XkbNumKbdGroups; i++) {
+ struct xkb_mods *gc;
+
+ gc = &keymap->compat->groups[i];
+ if (gc->real_mods == 0 && gc->vmods ==0)
+ continue;
+ write_buf(keymap, buf, size, offset,
+ "\t\tgroup %d = %s;\n", i + 1,
+ get_mod_mask_text(keymap, gc->real_mods, gc->vmods));
+ }
+
+ for (i = 0; i < XkbNumIndicators; i++) {
+ struct xkb_indicator_map *map = &keymap->indicators->maps[i];
+ if (map->flags == 0 && map->which_groups == 0 &&
+ map->groups == 0 && map->which_mods == 0 &&
+ map->mods.real_mods == 0 && map->mods.vmods == 0 &&
+ map->ctrls == 0)
+ continue;
+ write_indicator_map(keymap, buf, size, offset, i);
+ }
+
+ write_buf(keymap, buf, size, offset, "\t};\n\n");
+
+ return true;
+}
+
+static bool
+write_keysyms(struct xkb_keymap *keymap, char **buf, size_t *size,
+ size_t *offset, xkb_keycode_t key, unsigned int group)
+{
+ const xkb_keysym_t *syms;
+ int num_syms, level;
+#define OUT_BUF_LEN 128
+ char out_buf[OUT_BUF_LEN];
+
+ for (level = 0; level < XkbKeyGroupWidth(keymap, key, group); level++) {
+ if (level != 0)
+ write_buf(keymap, buf, size, offset, ", ");
+ num_syms = xkb_key_get_syms_by_level(keymap, key, group, level,
+ &syms);
+ if (num_syms == 0) {
+ write_buf(keymap, buf, size, offset, "%15s", "NoSymbol");
+ }
+ else if (num_syms == 1) {
+ xkb_keysym_get_name(syms[0], out_buf, OUT_BUF_LEN);
+ write_buf(keymap, buf, size, offset, "%15s", out_buf);
+ }
+ else {
+ int s;
+ write_buf(keymap, buf, size, offset, "{ ");
+ for (s = 0; s < num_syms; s++) {
+ if (s != 0)
+ write_buf(keymap, buf, size, offset, ", ");
+ xkb_keysym_get_name(syms[s], out_buf, OUT_BUF_LEN);
+ write_buf(keymap, buf, size, offset, "%15s", out_buf);
+ }
+ write_buf(keymap, buf, size, offset, " }");
+ }
+ }
+#undef OUT_BUF_LEN
+
+ return true;
+}
+
+static bool
+write_symbols(struct xkb_keymap *keymap, char **buf, size_t *size,
+ size_t *offset)
+{
+ struct xkb_client_map *map = keymap->map;
+ struct xkb_server_map *srv = keymap->server;
+ xkb_keycode_t key;
+ int group, tmp;
+ bool showActions;
+
+ write_buf(keymap, buf, size, offset, "\txkb_symbols {\n\n");
+
+ for (tmp = group = 0; group < XkbNumKbdGroups; group++) {
+ if (!keymap->names->groups[group])
+ continue;
+ write_buf(keymap, buf, size, offset,
+ "\t\tname[group%d]=\"%s\";\n", group + 1,
+ keymap->names->groups[group]);
+ tmp++;
+ }
+ if (tmp > 0)
+ write_buf(keymap, buf, size, offset, "\n");
+
+ for (key = keymap->min_key_code; key <= keymap->max_key_code; key++) {
+ bool simple = true;
+
+ if (xkb_key_num_groups(keymap, key) == 0)
+ continue;
+ if (XkbcFindKeycodeByName(keymap,
+ darray_item(keymap->names->keys, key).name,
+ true) != key)
+ continue;
+
+ write_buf(keymap, buf, size, offset, "\t\tkey %6s {",
+ XkbcKeyNameText(darray_item(keymap->names->keys, key).name));
+ if (srv->explicit) {
+ if ((srv->explicit[key] & XkbExplicitKeyTypesMask)) {
+ bool multi_type = false;
+ int type = XkbKeyTypeIndex(keymap, key, 0);
+
+ simple = false;
+
+ for (group = 0; group < xkb_key_num_groups(keymap, key); group++) {
+ if (XkbKeyTypeIndex(keymap, key, group) != type) {
+ multi_type = true;
+ break;
+ }
+ }
+ if (multi_type) {
+ for (group = 0;
+ group < xkb_key_num_groups(keymap, key);
+ group++) {
+ if (!(srv->explicit[key] & (1 << group)))
+ continue;
+ type = XkbKeyTypeIndex(keymap, key, group);
+ write_buf(keymap, buf, size, offset,
+ "\n\t\t\ttype[Group%d]= \"%s\",",
+ group + 1,
+ darray_item(map->types, type).name);
+ }
+ }
+ else {
+ write_buf(keymap, buf, size, offset,
+ "\n\t\t\ttype= \"%s\",",
+ darray_item(map->types, type).name);
+ }
+ }
+ if (keymap->ctrls && (srv->explicit[key] & XkbExplicitAutoRepeatMask)) {
+ if (keymap->ctrls->per_key_repeat[key / 8] & (1 << (key % 8)))
+ write_buf(keymap, buf, size, offset,
+ "\n\t\t\trepeat= Yes,");
+ else
+ write_buf(keymap, buf, size, offset,
+ "\n\t\t\trepeat= No,");
+ simple = false;
+ }
+ if (keymap->server->vmodmap[key] &&
+ (srv->explicit[key] & XkbExplicitVModMapMask)) {
+ write_buf(keymap, buf, size, offset, "\n\t\t\tvirtualMods= %s,",
+ get_mod_mask_text(keymap, 0, keymap->server->vmodmap[key]));
+ }
+ }
+
+ switch (XkbOutOfRangeGroupAction(XkbKeyGroupInfo(keymap, key))) {
+ case XkbClampIntoRange:
+ write_buf(keymap, buf, size, offset, "\n\t\t\tgroupsClamp,");
+ break;
+ case XkbRedirectIntoRange:
+ write_buf(keymap, buf, size, offset,
+ "\n\t\t\tgroupsRedirect= Group%d,",
+ XkbOutOfRangeGroupNumber(XkbKeyGroupInfo(keymap, key)) + 1);
+ break;
+ }
+
+ if (srv->explicit == NULL ||
+ (srv->explicit[key] & XkbExplicitInterpretMask))
+ showActions = XkbKeyHasActions(keymap, key);
+ else
+ showActions = false;
+
+ if (xkb_key_num_groups(keymap, key) > 1 || showActions)
+ simple = false;
+
+ if (simple) {
+ write_buf(keymap, buf, size, offset, "\t[ ");
+ if (!write_keysyms(keymap, buf, size, offset, key, 0))
+ return false;
+ write_buf(keymap, buf, size, offset, " ] };\n");
+ }
+ else {
+ union xkb_action *acts;
+ int level;
+
+ acts = XkbKeyActionsPtr(keymap, key);
+ for (group = 0; group < xkb_key_num_groups(keymap, key); group++) {
+ if (group != 0)
+ write_buf(keymap, buf, size, offset, ",");
+ write_buf(keymap, buf, size, offset,
+ "\n\t\t\tsymbols[Group%d]= [ ", group + 1);
+ if (!write_keysyms(keymap, buf, size, offset, key, group))
+ return false;
+ write_buf(keymap, buf, size, offset, " ]");
+ if (showActions) {
+ write_buf(keymap, buf, size, offset,
+ ",\n\t\t\tactions[Group%d]= [ ", group + 1);
+ for (level = 0;
+ level < XkbKeyGroupWidth(keymap, key, group);
+ level++) {
+ if (level != 0)
+ write_buf(keymap, buf, size, offset, ", ");
+ write_action(keymap, buf, size, offset, &acts[level],
+ NULL, NULL);
+ }
+ write_buf(keymap, buf, size, offset, " ]");
+ acts += XkbKeyGroupsWidth(keymap, key);
+ }
+ }
+ write_buf(keymap, buf, size, offset, "\n\t\t};\n");
+ }
+ }
+ if (map && map->modmap) {
+ for (key = keymap->min_key_code; key <= keymap->max_key_code; key++) {
+ int mod;
+ char name[5];
+
+ if (map->modmap[key] == 0)
+ continue;
+
+ for (mod = 0; mod < XkbNumModifiers; mod++) {
+ if (!(map->modmap[key] & (1 << mod)))
+ continue;
+
+ memcpy(name, darray_item(keymap->names->keys, key).name, 4);
+ name[4]= '\0';
+
+ write_buf(keymap, buf, size, offset,
+ "\t\tmodifier_map %s { <%s> };\n",
+ get_mod_index_text(mod), name);
+ }
+ }
+ }
+
+ write_buf(keymap, buf, size, offset, "\t};\n\n");
+ return true;
+}
+
+_X_EXPORT char *
+xkb_map_get_as_string(struct xkb_keymap *keymap)
+{
+ char *ret = NULL;
+ size_t size = 0;
+ size_t offset = 0;
+
+ check_write_buf(keymap, &ret, &size, &offset, "xkb_keymap {\n");
+ if (ret == NULL)
+ return NULL;
+ if (!write_keycodes(keymap, &ret, &size, &offset))
+ return NULL;
+ if (!write_types(keymap, &ret, &size, &offset))
+ return NULL;
+ if (!write_compat(keymap, &ret, &size, &offset))
+ return NULL;
+ if (!write_symbols(keymap, &ret, &size, &offset))
+ return NULL;
+ check_write_buf(keymap, &ret, &size, &offset, "};\n");
+ if (ret == NULL)
+ return NULL;
+
+ return ret;
+}
diff --git a/src/misc.c b/src/misc.c
index e7ebbbd..e500548 100644
--- a/src/misc.c
+++ b/src/misc.c
@@ -243,3 +243,29 @@ _XkbcKSCheckCase(xkb_keysym_t ks)
return rtrn;
}
+
+xkb_keycode_t
+XkbcFindKeycodeByName(struct xkb_keymap *keymap, const char *name,
+ bool use_aliases)
+{
+ struct xkb_key_alias *alias;
+ xkb_keycode_t i;
+
+ for (i = keymap->min_key_code; i <= keymap->max_key_code; i++) {
+ if (strncmp(darray_item(keymap->names->keys, i).name, name,
+ XkbKeyNameLength) == 0)
+ return i;
+ }
+
+ if (!use_aliases)
+ return 0;
+
+
+ for (i = 0; i < darray_size(keymap->names->key_aliases); i++) {
+ alias = &darray_item(keymap->names->key_aliases, i);
+ if (strncmp(name, alias->alias, XkbKeyNameLength) == 0)
+ return XkbcFindKeycodeByName(keymap, alias->real, false);
+ }
+
+ return 0;
+}
diff --git a/src/xkb-priv.h b/src/xkb-priv.h
index c52a96e..a63ad1c 100644
--- a/src/xkb-priv.h
+++ b/src/xkb-priv.h
@@ -505,6 +505,10 @@ XkbcInitCanonicalKeyTypes(struct xkb_keymap *keymap, unsigned which,
extern unsigned
_XkbcKSCheckCase(xkb_keysym_t sym);
+extern xkb_keycode_t
+XkbcFindKeycodeByName(struct xkb_keymap *keymap, const char *name,
+ bool use_aliases);
+
#define _XkbKSLower (1 << 0)
#define _XkbKSUpper (1 << 1)
diff --git a/test/dump.c b/test/dump.c
new file mode 100644
index 0000000..5d2484e
--- /dev/null
+++ b/test/dump.c
@@ -0,0 +1,59 @@
+/*
+Copyright 2009 Dan Nicholson
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Except as contained in this notice, the names of the authors or their
+institutions shall not be used in advertising or otherwise to promote the
+sale, use or other dealings in this Software without prior written
+authorization from the authors.
+*/
+
+#include <assert.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include "xkbcommon/xkbcommon.h"
+
+int main(int argc, char *argv[])
+{
+ struct xkb_context *ctx = xkb_context_new(0);
+ struct xkb_keymap *keymap;
+ struct xkb_rule_names names = {
+ .rules = "evdev",
+ .model = "pc105",
+ .layout = "us",
+ .variant = NULL,
+ .options = NULL,
+ };
+ char *as_string;
+
+ assert(ctx);
+ keymap = xkb_map_new_from_names(ctx, &names, 0);
+
+ as_string = xkb_map_get_as_string(keymap);
+ assert(as_string);
+ printf("%s\n", as_string);
+
+ free(as_string);
+ xkb_map_unref(keymap);
+ xkb_context_unref(ctx);
+
+ return 0;
+}