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>
52 #include "xkbcomp-priv.h"
55 #define BUF_CHUNK_SIZE 4096
64 do_realloc(struct buf *buf, size_t at_least)
68 buf->alloc += BUF_CHUNK_SIZE;
69 if (at_least >= BUF_CHUNK_SIZE)
70 buf->alloc += at_least;
72 new = realloc(buf->buf, buf->alloc);
80 ATTR_PRINTF(2, 3) static bool
81 check_write_buf(struct buf *buf, const char *fmt, ...)
87 available = buf->alloc - buf->size;
89 printed = vsnprintf(buf->buf + buf->size, available, fmt, args);
95 if ((size_t) printed >= available)
96 if (!do_realloc(buf, printed))
99 /* The buffer has enough space now. */
101 available = buf->alloc - buf->size;
103 printed = vsnprintf(buf->buf + buf->size, available, fmt, args);
106 if (printed < 0 || (size_t) printed >= available)
109 buf->size += printed;
118 #define write_buf(buf, ...) do { \
119 if (!check_write_buf(buf, __VA_ARGS__)) \
124 write_vmods(struct xkb_keymap *keymap, struct buf *buf)
126 const struct xkb_mod *mod;
127 xkb_mod_index_t num_vmods = 0;
129 darray_foreach(mod, keymap->mods) {
130 if (mod->type != MOD_VIRT)
134 write_buf(buf, "\tvirtual_modifiers ");
137 write_buf(buf, "%s", xkb_atom_text(keymap->ctx, mod->name));
142 write_buf(buf, ";\n\n");
148 write_keycodes(struct xkb_keymap *keymap, struct buf *buf)
150 const struct xkb_key *key;
152 const struct xkb_led *led;
154 if (keymap->keycodes_section_name)
155 write_buf(buf, "xkb_keycodes \"%s\" {\n",
156 keymap->keycodes_section_name);
158 write_buf(buf, "xkb_keycodes {\n");
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));
167 xkb_foreach_key(key, keymap) {
168 if (key->name == XKB_ATOM_NONE)
171 write_buf(buf, "\t%-20s = %u;\n",
172 KeyNameText(keymap->ctx, key->name), key->keycode);
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));
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));
186 write_buf(buf, "};\n\n");
191 write_types(struct xkb_keymap *keymap, struct buf *buf)
193 if (keymap->types_section_name)
194 write_buf(buf, "xkb_types \"%s\" {\n",
195 keymap->types_section_name);
197 write_buf(buf, "xkb_types {\n");
199 write_vmods(keymap, buf);
201 for (unsigned i = 0; i < keymap->num_types; i++) {
202 const struct xkb_key_type *type = &keymap->types[i];
204 write_buf(buf, "\ttype \"%s\" {\n",
205 xkb_atom_text(keymap->ctx, type->name));
207 write_buf(buf, "\t\tmodifiers= %s;\n",
208 ModMaskText(keymap, type->mods.mods));
210 for (unsigned j = 0; j < type->num_entries; j++) {
212 const struct xkb_key_type_entry *entry = &type->entries[j];
215 * Printing level 1 entries is redundant, it's the default,
216 * unless there's preserve info.
218 if (entry->level == 0 && entry->preserve.mods == 0)
221 str = ModMaskText(keymap, entry->mods.mods);
222 write_buf(buf, "\t\tmap[%s]= Level%u;\n",
223 str, entry->level + 1);
225 if (entry->preserve.mods)
226 write_buf(buf, "\t\tpreserve[%s]= %s;\n",
227 str, ModMaskText(keymap, entry->preserve.mods));
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]));
235 write_buf(buf, "\t};\n");
238 write_buf(buf, "};\n\n");
243 write_led_map(struct xkb_keymap *keymap, struct buf *buf,
244 const struct xkb_led *led)
246 write_buf(buf, "\tindicator \"%s\" {\n",
247 xkb_atom_text(keymap->ctx, led->name));
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));
254 write_buf(buf, "\t\tgroups= 0x%02x;\n",
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));
263 write_buf(buf, "\t\tmodifiers= %s;\n",
264 ModMaskText(keymap, led->mods.mods));
268 write_buf(buf, "\t\tcontrols= %s;\n",
269 ControlMaskText(keymap->ctx, led->ctrls));
272 write_buf(buf, "\t};\n");
277 affect_lock_text(enum xkb_action_flags flags)
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";
291 write_action(struct xkb_keymap *keymap, struct buf *buf,
292 const union xkb_action *action,
293 const char *prefix, const char *suffix)
296 const char *args = NULL;
303 type = ActionTypeText(action->type);
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)
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) : "",
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" : "",
331 case ACTION_TYPE_TERMINATE:
332 write_buf(buf, "%s%s()%s", prefix, type, suffix);
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) &&
338 action->ptr.x >= 0) ? "+" : "",
340 (!(action->ptr.flags & ACTION_ABSOLUTE_Y) &&
341 action->ptr.y >= 0) ? "+" : "",
343 (action->ptr.flags & ACTION_NO_ACCEL) ? ",!accel" : "",
347 case ACTION_TYPE_PTR_LOCK:
348 args = affect_lock_text(action->btn.flags);
350 case ACTION_TYPE_PTR_BUTTON:
351 write_buf(buf, "%s%s(button=", prefix, type);
352 if (action->btn.button > 0 && action->btn.button <= 5)
353 write_buf(buf, "%d", action->btn.button);
355 write_buf(buf, "default");
356 if (action->btn.count)
357 write_buf(buf, ",count=%d", action->btn.count);
359 write_buf(buf, "%s", args);
360 write_buf(buf, ")%s", suffix);
363 case ACTION_TYPE_PTR_DEFAULT:
364 write_buf(buf, "%s%s(", prefix, type);
365 write_buf(buf, "affect=button,button=%s%d",
366 (!(action->dflt.flags & ACTION_ABSOLUTE_SWITCH) && action->dflt.value >= 0) ? "+" : "",
368 write_buf(buf, ")%s", suffix);
371 case ACTION_TYPE_SWITCH_VT:
372 write_buf(buf, "%s%s(screen=%s%d,%ssame)%s", prefix, type,
373 (!(action->screen.flags & ACTION_ABSOLUTE_SWITCH) && action->screen.screen >= 0) ? "+" : "",
374 action->screen.screen,
375 (action->screen.flags & ACTION_SAME_SCREEN) ? "!" : "",
379 case ACTION_TYPE_CTRL_SET:
380 case ACTION_TYPE_CTRL_LOCK:
381 write_buf(buf, "%s%s(controls=%s%s)%s", prefix, type,
382 ControlMaskText(keymap->ctx, action->ctrls.ctrls),
383 (action->type == ACTION_TYPE_CTRL_LOCK) ? affect_lock_text(action->ctrls.flags) : "",
387 case ACTION_TYPE_NONE:
388 write_buf(buf, "%sNoAction()%s", prefix, suffix);
393 "%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",
394 prefix, type, action->type, action->priv.data[0],
395 action->priv.data[1], action->priv.data[2],
396 action->priv.data[3], action->priv.data[4],
397 action->priv.data[5], action->priv.data[6],
406 write_compat(struct xkb_keymap *keymap, struct buf *buf)
408 const struct xkb_led *led;
410 if (keymap->compat_section_name)
411 write_buf(buf, "xkb_compatibility \"%s\" {\n",
412 keymap->compat_section_name);
414 write_buf(buf, "xkb_compatibility {\n");
416 write_vmods(keymap, buf);
418 write_buf(buf, "\tinterpret.useModMapMods= AnyLevel;\n");
419 write_buf(buf, "\tinterpret.repeat= False;\n");
421 for (unsigned i = 0; i < keymap->num_sym_interprets; i++) {
422 const struct xkb_sym_interpret *si = &keymap->sym_interprets[i];
424 write_buf(buf, "\tinterpret %s+%s(%s) {\n",
425 si->sym ? KeysymText(keymap->ctx, si->sym) : "Any",
426 SIMatchText(si->match),
427 ModMaskText(keymap, si->mods));
429 if (si->virtual_mod != XKB_MOD_INVALID)
430 write_buf(buf, "\t\tvirtualModifier= %s;\n",
431 ModIndexText(keymap, si->virtual_mod));
433 if (si->level_one_only)
434 write_buf(buf, "\t\tuseModMapMods=level1;\n");
437 write_buf(buf, "\t\trepeat= True;\n");
439 write_action(keymap, buf, &si->action, "\t\taction= ", ";\n");
440 write_buf(buf, "\t};\n");
443 darray_foreach(led, keymap->leds)
444 if (led->which_groups || led->groups || led->which_mods ||
445 led->mods.mods || led->ctrls)
446 write_led_map(keymap, buf, led);
448 write_buf(buf, "};\n\n");
454 write_keysyms(struct xkb_keymap *keymap, struct buf *buf,
455 const struct xkb_key *key, xkb_layout_index_t group)
457 for (xkb_level_index_t level = 0; level < XkbKeyGroupWidth(key, group);
459 const xkb_keysym_t *syms;
463 write_buf(buf, ", ");
465 num_syms = xkb_keymap_key_get_syms_by_level(keymap, key->keycode,
466 group, level, &syms);
468 write_buf(buf, "%15s", "NoSymbol");
470 else if (num_syms == 1) {
471 write_buf(buf, "%15s", KeysymText(keymap->ctx, syms[0]));
474 write_buf(buf, "{ ");
475 for (int s = 0; s < num_syms; s++) {
477 write_buf(buf, ", ");
478 write_buf(buf, "%s", KeysymText(keymap->ctx, syms[s]));
480 write_buf(buf, " }");
488 write_key(struct xkb_keymap *keymap, struct buf *buf,
489 const struct xkb_key *key)
491 xkb_layout_index_t group;
493 bool explicit_types = false;
494 bool multi_type = false;
497 write_buf(buf, "\tkey %-20s {", KeyNameText(keymap->ctx, key->name));
499 for (group = 0; group < key->num_groups; group++) {
500 if (key->groups[group].explicit_type)
501 explicit_types = true;
503 if (group != 0 && key->groups[group].type != key->groups[0].type)
507 if (explicit_types) {
508 const struct xkb_key_type *type;
512 for (group = 0; group < key->num_groups; group++) {
513 if (!key->groups[group].explicit_type)
516 type = key->groups[group].type;
517 write_buf(buf, "\n\t\ttype[group%u]= \"%s\",",
519 xkb_atom_text(keymap->ctx, type->name));
523 type = key->groups[0].type;
524 write_buf(buf, "\n\t\ttype= \"%s\",",
525 xkb_atom_text(keymap->ctx, type->name));
529 if (key->explicit & EXPLICIT_REPEAT) {
531 write_buf(buf, "\n\t\trepeat= Yes,");
533 write_buf(buf, "\n\t\trepeat= No,");
537 if (key->vmodmap && (key->explicit & EXPLICIT_VMODMAP))
538 write_buf(buf, "\n\t\tvirtualMods= %s,",
539 ModMaskText(keymap, key->vmodmap));
541 switch (key->out_of_range_group_action) {
543 write_buf(buf, "\n\t\tgroupsClamp,");
547 write_buf(buf, "\n\t\tgroupsRedirect= Group%u,",
548 key->out_of_range_group_number + 1);
555 show_actions = !!(key->explicit & EXPLICIT_INTERP);
557 if (key->num_groups > 1 || show_actions)
561 write_buf(buf, "\t[ ");
562 if (!write_keysyms(keymap, buf, key, 0))
564 write_buf(buf, " ] };\n");
567 xkb_level_index_t level;
569 for (group = 0; group < key->num_groups; group++) {
572 write_buf(buf, "\n\t\tsymbols[Group%u]= [ ", group + 1);
573 if (!write_keysyms(keymap, buf, key, group))
575 write_buf(buf, " ]");
577 write_buf(buf, ",\n\t\tactions[Group%u]= [ ", group + 1);
579 level < XkbKeyGroupWidth(key, group); level++) {
581 write_buf(buf, ", ");
582 write_action(keymap, buf,
583 &key->groups[group].levels[level].action,
586 write_buf(buf, " ]");
589 write_buf(buf, "\n\t};\n");
596 write_symbols(struct xkb_keymap *keymap, struct buf *buf)
598 const struct xkb_key *key;
599 xkb_layout_index_t group;
601 if (keymap->symbols_section_name)
602 write_buf(buf, "xkb_symbols \"%s\" {\n",
603 keymap->symbols_section_name);
605 write_buf(buf, "xkb_symbols {\n");
607 for (group = 0; group < keymap->num_group_names; group++)
608 if (keymap->group_names[group])
610 "\tname[group%u]=\"%s\";\n", group + 1,
611 xkb_atom_text(keymap->ctx, keymap->group_names[group]));
613 write_buf(buf, "\n");
615 xkb_foreach_key(key, keymap)
616 if (key->num_groups > 0)
617 write_key(keymap, buf, key);
619 xkb_foreach_key(key, keymap) {
621 const struct xkb_mod *mod;
623 if (key->modmap == 0)
626 darray_enumerate(i, mod, keymap->mods)
627 if (key->modmap & (1u << i))
628 write_buf(buf, "\tmodifier_map %s { %s };\n",
629 xkb_atom_text(keymap->ctx, mod->name),
630 KeyNameText(keymap->ctx, key->name));
633 write_buf(buf, "};\n\n");
638 write_keymap(struct xkb_keymap *keymap, struct buf *buf)
640 return (check_write_buf(buf, "xkb_keymap {\n") &&
641 write_keycodes(keymap, buf) &&
642 write_types(keymap, buf) &&
643 write_compat(keymap, buf) &&
644 write_symbols(keymap, buf) &&
645 check_write_buf(buf, "};\n"));
649 text_v1_keymap_get_as_string(struct xkb_keymap *keymap)
651 struct buf buf = { NULL, 0, 0 };
653 if (!write_keymap(keymap, &buf)) {