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 ");
146 xkb_atom_text(keymap->ctx, keymap->vmod_names[i]));
151 write_buf(buf, ";\n\n");
156 #define GET_TEXT_BUF_SIZE 512
158 #define append_get_text(...) do { \
159 int _size = snprintf(ret, GET_TEXT_BUF_SIZE, __VA_ARGS__); \
160 if (_size >= GET_TEXT_BUF_SIZE) \
165 get_indicator_state_text(uint8_t which)
168 static char ret[GET_TEXT_BUF_SIZE];
170 memset(ret, 0, GET_TEXT_BUF_SIZE);
172 which &= XkbIM_UseAnyMods;
179 for (i = 0; which != 0; i++) {
182 if (!(which & (1 << i)))
186 name = LookupValue(modComponentMaskNames, (1 << i));
189 append_get_text("%s+%s", ret, name);
191 append_get_text("%s", name);
198 get_control_mask_text(uint32_t control_mask)
201 static char ret[GET_TEXT_BUF_SIZE];
202 const char *control_name;
204 memset(ret, 0, GET_TEXT_BUF_SIZE);
206 control_mask &= XkbAllBooleanCtrlsMask;
208 if (control_mask == 0) {
212 else if (control_mask == XkbAllBooleanCtrlsMask) {
217 for (i = 0; control_mask; i++) {
218 if (!(control_mask & (1 << i)))
221 control_mask &= ~(1 << i);
222 control_name = LookupValue(ctrlMaskNames, (1 << i));
225 append_get_text("%s+%s", ret, control_name);
227 append_get_text("%s", control_name);
234 write_keycodes(struct xkb_keymap *keymap, struct buf *buf)
237 struct xkb_key_alias *alias;
240 if (keymap->keycodes_section_name)
241 write_buf(buf, "\txkb_keycodes \"%s\" {\n",
242 keymap->keycodes_section_name);
244 write_buf(buf, "\txkb_keycodes {\n");
246 write_buf(buf, "\t\tminimum = %d;\n",
247 keymap->min_key_code);
248 write_buf(buf, "\t\tmaximum = %d;\n",
249 keymap->max_key_code);
251 xkb_foreach_key(key, keymap) {
252 if (key->name[0] == '\0')
255 write_buf(buf, "\t\t%6s = %d;\n",
256 KeyNameText(key->name), XkbKeyGetKeycode(keymap, key));
259 for (i = 0; i < XkbNumIndicators; i++) {
260 if (keymap->indicators[i].name == XKB_ATOM_NONE)
262 write_buf(buf, "\t\tindicator %d = \"%s\";\n", i + 1,
263 xkb_atom_text(keymap->ctx, keymap->indicators[i].name));
267 darray_foreach(alias, keymap->key_aliases)
268 write_buf(buf, "\t\talias %6s = %6s;\n",
269 KeyNameText(alias->alias),
270 KeyNameText(alias->real));
272 write_buf(buf, "\t};\n\n");
277 write_types(struct xkb_keymap *keymap, struct buf *buf)
281 struct xkb_key_type *type;
282 struct xkb_kt_map_entry *entry;
284 if (keymap->types_section_name)
285 write_buf(buf, "\txkb_types \"%s\" {\n\n",
286 keymap->types_section_name);
288 write_buf(buf, "\txkb_types {\n\n");
290 write_vmods(keymap, buf);
292 for (i = 0; i < keymap->num_types; i++) {
293 type = &keymap->types[i];
295 write_buf(buf, "\t\ttype \"%s\" {\n",
296 xkb_atom_text(keymap->ctx, type->name));
297 write_buf(buf, "\t\t\tmodifiers= %s;\n",
298 VModMaskText(keymap, type->mods.mods));
300 for (j = 0; j < type->num_entries; j++) {
302 entry = &type->map[j];
305 * Printing level 1 entries is redundant, it's the default,
306 * unless there's preserve info.
308 if (entry->level == 0 && entry->preserve.mods == 0)
311 str = VModMaskText(keymap, entry->mods.mods);
312 write_buf(buf, "\t\t\tmap[%s]= Level%d;\n",
313 str, entry->level + 1);
315 if (entry->preserve.mods == 0)
318 write_buf(buf, "\t\t\tpreserve[%s]= ", str);
319 write_buf(buf, "%s;\n", VModMaskText(keymap, entry->preserve.mods));
322 if (type->level_names) {
323 for (n = 0; n < type->num_levels; n++) {
324 if (!type->level_names[n])
326 write_buf(buf, "\t\t\tlevel_name[Level%d]= \"%s\";\n", n + 1,
327 xkb_atom_text(keymap->ctx, type->level_names[n]));
330 write_buf(buf, "\t\t};\n");
333 write_buf(buf, "\t};\n\n");
338 write_indicator_map(struct xkb_keymap *keymap, struct buf *buf, int num)
340 struct xkb_indicator_map *led = &keymap->indicators[num];
342 write_buf(buf, "\t\tindicator \"%s\" {\n",
343 xkb_atom_text(keymap->ctx, keymap->indicators[num].name));
345 if (led->which_groups) {
346 if (led->which_groups != XkbIM_UseEffective) {
347 write_buf(buf, "\t\t\twhichGroupState= %s;\n",
348 get_indicator_state_text(led->which_groups));
350 write_buf(buf, "\t\t\tgroups= 0x%02x;\n",
354 if (led->which_mods) {
355 if (led->which_mods != XkbIM_UseEffective) {
356 write_buf(buf, "\t\t\twhichModState= %s;\n",
357 get_indicator_state_text(led->which_mods));
359 write_buf(buf, "\t\t\tmodifiers= %s;\n",
360 VModMaskText(keymap, led->mods.mods));
364 write_buf(buf, "\t\t\tcontrols= %s;\n",
365 get_control_mask_text(led->ctrls));
368 write_buf(buf, "\t\t};\n");
373 write_action(struct xkb_keymap *keymap, struct buf *buf,
374 union xkb_action *action, const char *prefix, const char *suffix)
377 const char *args = NULL;
384 type = ActionTypeText(action->type);
386 switch (action->type) {
388 case XkbSA_LatchMods:
390 if (action->mods.flags & XkbSA_UseModMapMods)
393 args = VModMaskText(keymap, action->mods.mods.mods);
394 write_buf(buf, "%s%s(modifiers=%s%s%s)%s", prefix, type, args,
395 (action->type != XkbSA_LockGroup &&
396 (action->mods.flags & XkbSA_ClearLocks)) ?
398 (action->type != XkbSA_LockGroup &&
399 (action->mods.flags & XkbSA_LatchToLock)) ?
405 case XkbSA_LatchGroup:
406 case XkbSA_LockGroup:
407 write_buf(buf, "%s%s(group=%s%d%s%s)%s", prefix, type,
408 (!(action->group.flags & XkbSA_GroupAbsolute) &&
409 action->group.group > 0) ? "+" : "",
410 (action->group.flags & XkbSA_GroupAbsolute) ?
411 action->group.group + 1 : action->group.group,
412 (action->type != XkbSA_LockGroup &&
413 (action->group.flags & XkbSA_ClearLocks)) ?
415 (action->type != XkbSA_LockGroup &&
416 (action->group.flags & XkbSA_LatchToLock)) ?
421 case XkbSA_Terminate:
422 write_buf(buf, "%s%s()%s", prefix, type, suffix);
426 write_buf(buf, "%s%s(x=%s%d,y=%s%d%s)%s", prefix, type,
427 (!(action->ptr.flags & XkbSA_MoveAbsoluteX) &&
428 action->ptr.x >= 0) ? "+" : "",
430 (!(action->ptr.flags & XkbSA_MoveAbsoluteY) &&
431 action->ptr.y >= 0) ? "+" : "",
433 (action->ptr.flags & XkbSA_NoAcceleration) ? ",!accel" : "",
437 case XkbSA_LockPtrBtn:
438 switch (action->btn.flags & (XkbSA_LockNoUnlock | XkbSA_LockNoLock)) {
439 case XkbSA_LockNoUnlock:
440 args = ",affect=lock";
443 case XkbSA_LockNoLock:
444 args = ",affect=unlock";
447 case XkbSA_LockNoLock | XkbSA_LockNoUnlock:
448 args = ",affect=neither";
452 args = ",affect=both";
456 write_buf(buf, "%s%s(button=", prefix, type);
457 if (action->btn.button > 0 && action->btn.button <= 5)
458 write_buf(buf, "%d", action->btn.button);
460 write_buf(buf, "default");
461 if (action->btn.count)
462 write_buf(buf, ",count=%d", action->btn.count);
464 write_buf(buf, "%s", args);
465 write_buf(buf, ")%s", suffix);
468 case XkbSA_SetPtrDflt:
469 write_buf(buf, "%s%s(", prefix, type);
470 if (action->dflt.affect == XkbSA_AffectDfltBtn)
471 write_buf(buf, "affect=button,button=%s%d",
472 (!(action->dflt.flags & XkbSA_DfltBtnAbsolute) &&
473 action->dflt.value >= 0) ? "+" : "",
475 write_buf(buf, ")%s", suffix);
478 case XkbSA_SwitchScreen:
479 write_buf(buf, "%s%s(screen=%s%d,%ssame)%s", prefix, type,
480 (!(action->screen.flags & XkbSA_SwitchAbsolute) &&
481 action->screen.screen >= 0) ? "+" : "",
482 action->screen.screen,
483 (action->screen.flags & XkbSA_SwitchApplication) ? "!" : "",
487 /* Deprecated actions below here */
488 case XkbSA_SetControls:
489 case XkbSA_LockControls:
490 write_buf(buf, "%s%s(controls=%s)%s", prefix, type,
491 get_control_mask_text(action->ctrls.ctrls), suffix);
495 case XkbSA_ActionMessage:
496 case XkbSA_RedirectKey:
497 case XkbSA_DeviceBtn:
498 case XkbSA_LockDeviceBtn:
501 write_buf(buf, "%sNoAction()%s", prefix, suffix);
506 "%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",
507 prefix, type, action->type, action->priv.data[0],
508 action->priv.data[1], action->priv.data[2],
509 action->priv.data[3], action->priv.data[4],
510 action->priv.data[5], action->priv.data[6],
519 write_compat(struct xkb_keymap *keymap, struct buf *buf)
522 struct xkb_sym_interpret *interp;
524 if (keymap->compat_section_name)
525 write_buf(buf, "\txkb_compatibility \"%s\" {\n\n",
526 keymap->compat_section_name);
528 write_buf(buf, "\txkb_compatibility {\n\n");
530 write_vmods(keymap, buf);
532 write_buf(buf, "\t\tinterpret.useModMapMods= AnyLevel;\n");
533 write_buf(buf, "\t\tinterpret.repeat= False;\n");
535 darray_foreach(interp, keymap->sym_interpret) {
536 char keysym_name[64];
538 if (interp->sym == XKB_KEY_NoSymbol)
539 sprintf(keysym_name, "Any");
541 xkb_keysym_get_name(interp->sym, keysym_name, sizeof(keysym_name));
543 write_buf(buf, "\t\tinterpret %s+%s(%s) {\n",
545 SIMatchText(interp->match),
546 VModMaskText(keymap, interp->mods));
548 if (interp->virtual_mod != XKB_MOD_INVALID) {
549 write_buf(buf, "\t\t\tvirtualModifier= %s;\n",
550 xkb_atom_text(keymap->ctx,
551 keymap->vmod_names[interp->virtual_mod]));
554 if (interp->match & XkbSI_LevelOneOnly)
556 "\t\t\tuseModMapMods=level1;\n");
557 if (interp->flags & XkbSI_AutoRepeat)
558 write_buf(buf, "\t\t\trepeat= True;\n");
560 write_action(keymap, buf, &interp->act, "\t\t\taction= ", ";\n");
561 write_buf(buf, "\t\t};\n");
564 for (i = 0; i < XkbNumIndicators; i++) {
565 struct xkb_indicator_map *map = &keymap->indicators[i];
566 if (map->which_groups == 0 && map->groups == 0 &&
567 map->which_mods == 0 && map->mods.mods == 0 &&
570 write_indicator_map(keymap, buf, i);
573 write_buf(buf, "\t};\n\n");
579 write_keysyms(struct xkb_keymap *keymap, struct buf *buf,
580 struct xkb_key *key, xkb_group_index_t group)
582 const xkb_keysym_t *syms;
584 xkb_level_index_t level;
585 #define OUT_BUF_LEN 128
586 char out_buf[OUT_BUF_LEN];
588 for (level = 0; level < XkbKeyGroupWidth(keymap, key, group); level++) {
590 write_buf(buf, ", ");
591 num_syms = xkb_key_get_syms_by_level(keymap, key, group, level,
594 write_buf(buf, "%15s", "NoSymbol");
596 else if (num_syms == 1) {
597 xkb_keysym_get_name(syms[0], out_buf, OUT_BUF_LEN);
598 write_buf(buf, "%15s", out_buf);
602 write_buf(buf, "{ ");
603 for (s = 0; s < num_syms; s++) {
605 write_buf(buf, ", ");
606 xkb_keysym_get_name(syms[s], out_buf, OUT_BUF_LEN);
607 write_buf(buf, "%15s", out_buf);
609 write_buf(buf, " }");
618 write_symbols(struct xkb_keymap *keymap, struct buf *buf)
621 xkb_group_index_t group, tmp;
624 if (keymap->symbols_section_name)
625 write_buf(buf, "\txkb_symbols \"%s\" {\n\n",
626 keymap->symbols_section_name);
628 write_buf(buf, "\txkb_symbols {\n\n");
630 for (tmp = group = 0; group < XkbNumKbdGroups; group++) {
631 if (!keymap->group_names[group])
634 "\t\tname[group%d]=\"%s\";\n", group + 1,
635 xkb_atom_text(keymap->ctx, keymap->group_names[group]));
639 write_buf(buf, "\n");
641 xkb_foreach_key(key, keymap) {
644 if (key->num_groups == 0)
647 write_buf(buf, "\t\tkey %6s {", KeyNameText(key->name));
649 if (key->explicit & XkbExplicitKeyTypesMask) {
650 bool multi_type = false;
651 struct xkb_key_type *type = XkbKeyType(keymap, key, 0);
655 for (group = 1; group < key->num_groups; group++) {
656 if (XkbKeyType(keymap, key, group) != type) {
663 for (group = 0; group < key->num_groups; group++) {
664 if (!(key->explicit & (1 << group)))
666 type = XkbKeyType(keymap, key, group);
667 write_buf(buf, "\n\t\t\ttype[group%u]= \"%s\",",
669 xkb_atom_text(keymap->ctx, type->name));
673 write_buf(buf, "\n\t\t\ttype= \"%s\",",
674 xkb_atom_text(keymap->ctx, type->name));
678 if (key->explicit & XkbExplicitAutoRepeatMask) {
680 write_buf(buf, "\n\t\t\trepeat= Yes,");
682 write_buf(buf, "\n\t\t\trepeat= No,");
686 if (key->vmodmap && (key->explicit & XkbExplicitVModMapMask)) {
687 /* XXX: vmodmap cmask? */
688 write_buf(buf, "\n\t\t\tvirtualMods= %s,",
689 VModMaskText(keymap, key->vmodmap << XkbNumModifiers));
692 switch (key->out_of_range_group_action) {
693 case XkbClampIntoRange:
694 write_buf(buf, "\n\t\t\tgroupsClamp,");
697 case XkbRedirectIntoRange:
698 write_buf(buf, "\n\t\t\tgroupsRedirect= Group%u,",
699 key->out_of_range_group_number + 1);
703 if (key->explicit & XkbExplicitInterpretMask)
704 showActions = (key->actions != NULL);
708 if (key->num_groups > 1 || showActions)
712 write_buf(buf, "\t[ ");
713 if (!write_keysyms(keymap, buf, key, 0))
715 write_buf(buf, " ] };\n");
718 xkb_level_index_t level;
720 for (group = 0; group < key->num_groups; group++) {
723 write_buf(buf, "\n\t\t\tsymbols[Group%u]= [ ", group + 1);
724 if (!write_keysyms(keymap, buf, key, group))
726 write_buf(buf, " ]");
728 write_buf(buf, ",\n\t\t\tactions[Group%u]= [ ",
731 level < XkbKeyGroupWidth(keymap, key, group);
734 write_buf(buf, ", ");
735 write_action(keymap, buf,
736 XkbKeyActionEntry(key, group, level),
739 write_buf(buf, " ]");
742 write_buf(buf, "\n\t\t};\n");
746 xkb_foreach_key(key, keymap) {
749 if (key->modmap == 0)
752 for (mod = 0; mod < XkbNumModifiers; mod++) {
753 if (!(key->modmap & (1 << mod)))
756 write_buf(buf, "\t\tmodifier_map %s { %s };\n",
757 ModIndexToName(mod), KeyNameText(key->name));
761 write_buf(buf, "\t};\n\n");
766 xkb_map_get_as_string(struct xkb_keymap *keymap)
769 struct buf buf = { NULL, 0, 0 };
771 ok = (check_write_buf(&buf, "xkb_keymap {\n") &&
772 write_keycodes(keymap, &buf) &&
773 write_types(keymap, &buf) &&
774 write_compat(keymap, &buf) &&
775 write_symbols(keymap, &buf) &&
776 check_write_buf(&buf, "};\n"));
778 return (ok ? buf.buf : NULL);