1 /************************************************************
2 * Copyright (c) 1994 by Silicon Graphics Computer Systems, Inc.
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.
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.
25 ********************************************************/
28 * Copyright © 2012 Intel Corporation
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:
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
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.
49 * Author: Daniel Stone <daniel@fooishbar.org>
60 #define VMOD_HIDE_VALUE 0
61 #define VMOD_SHOW_VALUE 1
62 #define VMOD_COMMENT_VALUE 2
64 #define BUF_CHUNK_SIZE 4096
73 do_realloc(struct buf *buf, size_t at_least)
77 buf->alloc += BUF_CHUNK_SIZE;
78 if (at_least >= BUF_CHUNK_SIZE)
79 buf->alloc += at_least;
81 new = realloc(buf->buf, buf->alloc);
89 ATTR_PRINTF(2, 3) static bool
90 check_write_buf(struct buf *buf, const char *fmt, ...)
96 available = buf->alloc - buf->size;
98 printed = vsnprintf(buf->buf + buf->size, available, fmt, args);
104 if (printed >= available)
105 if (!do_realloc(buf, printed))
108 /* The buffer has enough space now. */
110 available = buf->alloc - buf->size;
112 printed = vsnprintf(buf->buf + buf->size, available, fmt, args);
115 if (printed >= available || printed < 0)
118 buf->size += printed;
127 #define write_buf(buf, ...) do { \
128 if (!check_write_buf(buf, __VA_ARGS__)) \
133 write_vmods(struct xkb_keymap *keymap, struct buf *buf)
138 for (i = 0; i < XkbNumVirtualMods; i++) {
139 if (!keymap->vmod_names[i])
142 write_buf(buf, "\t\tvirtual_modifiers ");
145 write_buf(buf, "%s", keymap->vmod_names[i]);
150 write_buf(buf, ";\n\n");
155 #define GET_TEXT_BUF_SIZE 512
157 #define append_get_text(...) do { \
158 int _size = snprintf(ret, GET_TEXT_BUF_SIZE, __VA_ARGS__); \
159 if (_size >= GET_TEXT_BUF_SIZE) \
164 get_indicator_state_text(uint8_t which)
167 static char ret[GET_TEXT_BUF_SIZE];
168 /* FIXME: Merge with ... something ... in xkbcomp? */
169 static const char *state_names[] = {
177 memset(ret, 0, GET_TEXT_BUF_SIZE);
179 which &= XkbIM_UseAnyMods;
186 for (i = 0; which != 0; i++) {
187 if (!(which & (1 << i)))
192 append_get_text("%s+%s", ret, state_names[i]);
194 append_get_text("%s", state_names[i]);
201 get_control_mask_text(uint32_t control_mask)
204 static char ret[GET_TEXT_BUF_SIZE];
205 /* FIXME: Merge with ... something ... in xkbcomp. */
206 static const char *ctrl_names[] = {
222 memset(ret, 0, GET_TEXT_BUF_SIZE);
224 control_mask &= XkbAllBooleanCtrlsMask;
226 if (control_mask == 0) {
230 else if (control_mask == XkbAllBooleanCtrlsMask) {
235 for (i = 0; control_mask; i++) {
236 if (!(control_mask & (1 << i)))
238 control_mask &= ~(1 << i);
241 append_get_text("%s+%s", ret, ctrl_names[i]);
243 append_get_text("%s", ctrl_names[i]);
250 write_keycodes(struct xkb_keymap *keymap, struct buf *buf)
253 struct xkb_key_alias *alias;
256 if (keymap->keycodes_section_name)
257 write_buf(buf, "\txkb_keycodes \"%s\" {\n",
258 keymap->keycodes_section_name);
260 write_buf(buf, "\txkb_keycodes {\n");
262 write_buf(buf, "\t\tminimum = %d;\n",
263 keymap->min_key_code);
264 write_buf(buf, "\t\tmaximum = %d;\n",
265 keymap->max_key_code);
267 xkb_foreach_key(key, keymap) {
268 if (key->name[0] == '\0')
271 write_buf(buf, "\t\t%6s = %d;\n",
272 KeyNameText(key->name), XkbKeyGetKeycode(keymap, key));
275 for (i = 0; i < XkbNumIndicators; i++) {
276 if (!keymap->indicator_names[i])
278 write_buf(buf, "\t\tindicator %d = \"%s\";\n",
279 i + 1, keymap->indicator_names[i]);
283 darray_foreach(alias, keymap->key_aliases)
284 write_buf(buf, "\t\talias %6s = %6s;\n",
285 KeyNameText(alias->alias),
286 KeyNameText(alias->real));
288 write_buf(buf, "\t};\n\n");
293 write_types(struct xkb_keymap *keymap, struct buf *buf)
297 struct xkb_key_type *type;
298 struct xkb_kt_map_entry *entry;
300 if (keymap->types_section_name)
301 write_buf(buf, "\txkb_types \"%s\" {\n\n",
302 keymap->types_section_name);
304 write_buf(buf, "\txkb_types {\n\n");
306 write_vmods(keymap, buf);
308 for (i = 0; i < keymap->num_types; i++) {
309 type = &keymap->types[i];
311 write_buf(buf, "\t\ttype \"%s\" {\n",
312 xkb_atom_text(keymap->ctx, type->name));
313 write_buf(buf, "\t\t\tmodifiers= %s;\n",
314 VModMaskText(keymap, type->mods.mods));
316 for (j = 0; j < type->num_entries; j++) {
318 entry = &type->map[j];
321 * Printing level 1 entries is redundant, it's the default,
322 * unless there's preserve info.
324 if (entry->level == 0 && entry->preserve.mods == 0)
327 str = VModMaskText(keymap, entry->mods.mods);
328 write_buf(buf, "\t\t\tmap[%s]= Level%d;\n",
329 str, entry->level + 1);
331 if (entry->preserve.mods == 0)
334 write_buf(buf, "\t\t\tpreserve[%s]= ", str);
335 write_buf(buf, "%s;\n", VModMaskText(keymap, entry->preserve.mods));
338 if (type->level_names) {
339 for (n = 0; n < type->num_levels; n++) {
340 if (!type->level_names[n])
342 write_buf(buf, "\t\t\tlevel_name[Level%d]= \"%s\";\n", n + 1,
343 xkb_atom_text(keymap->ctx, type->level_names[n]));
346 write_buf(buf, "\t\t};\n");
349 write_buf(buf, "\t};\n\n");
354 write_indicator_map(struct xkb_keymap *keymap, struct buf *buf, int num)
356 struct xkb_indicator_map *led = &keymap->indicators[num];
358 write_buf(buf, "\t\tindicator \"%s\" {\n",
359 keymap->indicator_names[num]);
361 if (led->which_groups) {
362 if (led->which_groups != XkbIM_UseEffective) {
363 write_buf(buf, "\t\t\twhichGroupState= %s;\n",
364 get_indicator_state_text(led->which_groups));
366 write_buf(buf, "\t\t\tgroups= 0x%02x;\n",
370 if (led->which_mods) {
371 if (led->which_mods != XkbIM_UseEffective) {
372 write_buf(buf, "\t\t\twhichModState= %s;\n",
373 get_indicator_state_text(led->which_mods));
375 write_buf(buf, "\t\t\tmodifiers= %s;\n",
376 VModMaskText(keymap, led->mods.mods));
380 write_buf(buf, "\t\t\tcontrols= %s;\n",
381 get_control_mask_text(led->ctrls));
384 write_buf(buf, "\t\t};\n");
389 write_action(struct xkb_keymap *keymap, struct buf *buf,
390 union xkb_action *action, const char *prefix, const char *suffix)
393 const char *args = NULL;
400 type = ActionTypeText(action->type);
402 switch (action->type) {
404 case XkbSA_LatchMods:
406 if (action->mods.flags & XkbSA_UseModMapMods)
409 args = VModMaskText(keymap, action->mods.mods.mods);
410 write_buf(buf, "%s%s(modifiers=%s%s%s)%s", prefix, type, args,
411 (action->type != XkbSA_LockGroup &&
412 (action->mods.flags & XkbSA_ClearLocks)) ?
414 (action->type != XkbSA_LockGroup &&
415 (action->mods.flags & XkbSA_LatchToLock)) ?
421 case XkbSA_LatchGroup:
422 case XkbSA_LockGroup:
423 write_buf(buf, "%s%s(group=%s%d%s%s)%s", prefix, type,
424 (!(action->group.flags & XkbSA_GroupAbsolute) &&
425 action->group.group > 0) ? "+" : "",
426 (action->group.flags & XkbSA_GroupAbsolute) ?
427 action->group.group + 1 : action->group.group,
428 (action->type != XkbSA_LockGroup &&
429 (action->group.flags & XkbSA_ClearLocks)) ?
431 (action->type != XkbSA_LockGroup &&
432 (action->group.flags & XkbSA_LatchToLock)) ?
437 case XkbSA_Terminate:
438 write_buf(buf, "%s%s()%s", prefix, type, suffix);
442 write_buf(buf, "%s%s(x=%s%d,y=%s%d%s)%s", prefix, type,
443 (!(action->ptr.flags & XkbSA_MoveAbsoluteX) &&
444 action->ptr.x >= 0) ? "+" : "",
446 (!(action->ptr.flags & XkbSA_MoveAbsoluteY) &&
447 action->ptr.y >= 0) ? "+" : "",
449 (action->ptr.flags & XkbSA_NoAcceleration) ? ",!accel" : "",
453 case XkbSA_LockPtrBtn:
454 switch (action->btn.flags & (XkbSA_LockNoUnlock | XkbSA_LockNoLock)) {
455 case XkbSA_LockNoUnlock:
456 args = ",affect=lock";
459 case XkbSA_LockNoLock:
460 args = ",affect=unlock";
463 case XkbSA_LockNoLock | XkbSA_LockNoUnlock:
464 args = ",affect=neither";
468 args = ",affect=both";
472 write_buf(buf, "%s%s(button=", prefix, type);
473 if (action->btn.button > 0 && action->btn.button <= 5)
474 write_buf(buf, "%d", action->btn.button);
476 write_buf(buf, "default");
477 if (action->btn.count)
478 write_buf(buf, ",count=%d", action->btn.count);
480 write_buf(buf, "%s", args);
481 write_buf(buf, ")%s", suffix);
484 case XkbSA_SetPtrDflt:
485 write_buf(buf, "%s%s(", prefix, type);
486 if (action->dflt.affect == XkbSA_AffectDfltBtn)
487 write_buf(buf, "affect=button,button=%s%d",
488 (!(action->dflt.flags & XkbSA_DfltBtnAbsolute) &&
489 action->dflt.value >= 0) ? "+" : "",
491 write_buf(buf, ")%s", suffix);
494 case XkbSA_SwitchScreen:
495 write_buf(buf, "%s%s(screen=%s%d,%ssame)%s", prefix, type,
496 (!(action->screen.flags & XkbSA_SwitchAbsolute) &&
497 action->screen.screen >= 0) ? "+" : "",
498 action->screen.screen,
499 (action->screen.flags & XkbSA_SwitchApplication) ? "!" : "",
503 /* Deprecated actions below here */
504 case XkbSA_SetControls:
505 case XkbSA_LockControls:
506 write_buf(buf, "%s%s(controls=%s)%s", prefix, type,
507 get_control_mask_text(action->ctrls.ctrls), suffix);
511 case XkbSA_ActionMessage:
512 case XkbSA_RedirectKey:
513 case XkbSA_DeviceBtn:
514 case XkbSA_LockDeviceBtn:
517 write_buf(buf, "%sNoAction()%s", prefix, suffix);
520 case XkbSA_XFree86Private:
523 "%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",
524 prefix, type, action->type, action->priv.data[0],
525 action->priv.data[1], action->priv.data[2],
526 action->priv.data[3], action->priv.data[4],
527 action->priv.data[5], action->priv.data[6],
536 write_compat(struct xkb_keymap *keymap, struct buf *buf)
539 struct xkb_sym_interpret *interp;
541 if (keymap->compat_section_name)
542 write_buf(buf, "\txkb_compatibility \"%s\" {\n\n",
543 keymap->compat_section_name);
545 write_buf(buf, "\txkb_compatibility {\n\n");
547 write_vmods(keymap, buf);
549 write_buf(buf, "\t\tinterpret.useModMapMods= AnyLevel;\n");
550 write_buf(buf, "\t\tinterpret.repeat= False;\n");
552 darray_foreach(interp, keymap->sym_interpret) {
553 char keysym_name[64];
555 if (interp->sym == XKB_KEY_NoSymbol)
556 sprintf(keysym_name, "Any");
558 xkb_keysym_get_name(interp->sym, keysym_name, sizeof(keysym_name));
560 write_buf(buf, "\t\tinterpret %s+%s(%s) {\n",
562 SIMatchText(interp->match),
563 VModMaskText(keymap, interp->mods));
565 if (interp->virtual_mod != XKB_MOD_INVALID) {
566 write_buf(buf, "\t\t\tvirtualModifier= %s;\n",
567 keymap->vmod_names[interp->virtual_mod]);
570 if (interp->match & XkbSI_LevelOneOnly)
572 "\t\t\tuseModMapMods=level1;\n");
573 if (interp->flags & XkbSI_AutoRepeat)
574 write_buf(buf, "\t\t\trepeat= True;\n");
576 write_action(keymap, buf, &interp->act, "\t\t\taction= ", ";\n");
577 write_buf(buf, "\t\t};\n");
580 for (i = 0; i < XkbNumIndicators; i++) {
581 struct xkb_indicator_map *map = &keymap->indicators[i];
582 if (map->which_groups == 0 && map->groups == 0 &&
583 map->which_mods == 0 && map->mods.mods == 0 &&
586 write_indicator_map(keymap, buf, i);
589 write_buf(buf, "\t};\n\n");
595 write_keysyms(struct xkb_keymap *keymap, struct buf *buf,
596 struct xkb_key *key, xkb_group_index_t group)
598 const xkb_keysym_t *syms;
600 xkb_level_index_t level;
601 #define OUT_BUF_LEN 128
602 char out_buf[OUT_BUF_LEN];
604 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group); level++) {
606 write_buf(buf, ", ");
607 num_syms = xkb_key_get_syms_by_level(keymap, key, group, level,
610 write_buf(buf, "%15s", "NoSymbol");
612 else if (num_syms == 1) {
613 xkb_keysym_get_name(syms[0], out_buf, OUT_BUF_LEN);
614 write_buf(buf, "%15s", out_buf);
618 write_buf(buf, "{ ");
619 for (s = 0; s < num_syms; s++) {
621 write_buf(buf, ", ");
622 xkb_keysym_get_name(syms[s], out_buf, OUT_BUF_LEN);
623 write_buf(buf, "%15s", out_buf);
625 write_buf(buf, " }");
634 write_symbols(struct xkb_keymap *keymap, struct buf *buf)
637 xkb_group_index_t group, tmp;
640 if (keymap->symbols_section_name)
641 write_buf(buf, "\txkb_symbols \"%s\" {\n\n",
642 keymap->symbols_section_name);
644 write_buf(buf, "\txkb_symbols {\n\n");
646 for (tmp = group = 0; group < XkbNumKbdGroups; group++) {
647 if (!keymap->group_names[group])
650 "\t\tname[group%d]=\"%s\";\n", group + 1,
651 keymap->group_names[group]);
655 write_buf(buf, "\n");
657 xkb_foreach_key(key, keymap) {
660 if (key->num_groups == 0)
663 write_buf(buf, "\t\tkey %6s {", KeyNameText(key->name));
665 if (key->explicit & XkbExplicitKeyTypesMask) {
666 bool multi_type = false;
667 struct xkb_key_type *type = XkbKeyType(keymap, key, 0);
671 for (group = 1; group < key->num_groups; group++) {
672 if (XkbKeyType(keymap, key, group) != type) {
679 for (group = 0; group < key->num_groups; group++) {
680 if (!(key->explicit & (1 << group)))
682 type = XkbKeyType(keymap, key, group);
683 write_buf(buf, "\n\t\t\ttype[group%u]= \"%s\",",
685 xkb_atom_text(keymap->ctx, type->name));
689 write_buf(buf, "\n\t\t\ttype= \"%s\",",
690 xkb_atom_text(keymap->ctx, type->name));
694 if (key->explicit & XkbExplicitAutoRepeatMask) {
696 write_buf(buf, "\n\t\t\trepeat= Yes,");
698 write_buf(buf, "\n\t\t\trepeat= No,");
702 if (key->vmodmap && (key->explicit & XkbExplicitVModMapMask)) {
703 /* XXX: vmodmap cmask? */
704 write_buf(buf, "\n\t\t\tvirtualMods= %s,",
705 VModMaskText(keymap, key->vmodmap << XkbNumModifiers));
708 switch (key->out_of_range_group_action) {
709 case XkbClampIntoRange:
710 write_buf(buf, "\n\t\t\tgroupsClamp,");
713 case XkbRedirectIntoRange:
714 write_buf(buf, "\n\t\t\tgroupsRedirect= Group%u,",
715 key->out_of_range_group_number + 1);
719 if (key->explicit & XkbExplicitInterpretMask)
720 showActions = (key->actions != NULL);
724 if (key->num_groups > 1 || showActions)
728 write_buf(buf, "\t[ ");
729 if (!write_keysyms(keymap, buf, key, 0))
731 write_buf(buf, " ] };\n");
734 xkb_level_index_t level;
736 for (group = 0; group < key->num_groups; group++) {
739 write_buf(buf, "\n\t\t\tsymbols[Group%u]= [ ", group + 1);
740 if (!write_keysyms(keymap, buf, key, group))
742 write_buf(buf, " ]");
744 write_buf(buf, ",\n\t\t\tactions[Group%u]= [ ",
747 level < XkbKeyGroupWidth(keymap, key, group);
750 write_buf(buf, ", ");
751 write_action(keymap, buf,
752 XkbKeyActionEntry(key, group, level),
755 write_buf(buf, " ]");
758 write_buf(buf, "\n\t\t};\n");
762 xkb_foreach_key(key, keymap) {
765 if (key->modmap == 0)
768 for (mod = 0; mod < XkbNumModifiers; mod++) {
769 if (!(key->modmap & (1 << mod)))
772 write_buf(buf, "\t\tmodifier_map %s { %s };\n",
773 ModIndexToName(mod), KeyNameText(key->name));
777 write_buf(buf, "\t};\n\n");
782 xkb_map_get_as_string(struct xkb_keymap *keymap)
785 struct buf buf = { NULL, 0, 0 };
787 ok = (check_write_buf(&buf, "xkb_keymap {\n") &&
788 write_keycodes(keymap, &buf) &&
789 write_types(keymap, &buf) &&
790 write_compat(keymap, &buf) &&
791 write_symbols(keymap, &buf) &&
792 check_write_buf(&buf, "};\n"));
794 return (ok ? buf.buf : NULL);