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
29 * Copyright © 2012 Ran Benita <ran234@gmail.com>
31 * Permission is hereby granted, free of charge, to any person obtaining a
32 * copy of this software and associated documentation files (the "Software"),
33 * to deal in the Software without restriction, including without limitation
34 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
35 * and/or sell copies of the Software, and to permit persons to whom the
36 * Software is furnished to do so, subject to the following conditions:
38 * The above copyright notice and this permission notice (including the next
39 * paragraph) shall be included in all copies or substantial portions of the
42 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
43 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
44 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
45 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
46 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
47 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
48 * DEALINGS IN THE SOFTWARE.
50 * Author: Daniel Stone <daniel@fooishbar.org>
51 * Ran Benita <ran234@gmail.com>
54 #include "xkbcomp-priv.h"
55 #include "ast-build.h"
59 AppendStmt(ParseCommon *to, ParseCommon *append)
66 for (iter = to; iter->next; iter = iter->next);
73 ExprCreate(enum expr_op_type op, enum expr_value_type type, size_t size)
75 ExprDef *expr = malloc(size);
79 expr->common.type = STMT_EXPR;
80 expr->common.next = NULL;
82 expr->expr.value_type = type;
87 #define EXPR_CREATE(type_, name_, op_, value_type_) \
88 ExprDef *name_ = ExprCreate(op_, value_type_, sizeof(type_)); \
93 ExprCreateString(xkb_atom_t str)
95 EXPR_CREATE(ExprString, expr, EXPR_VALUE, EXPR_TYPE_STRING);
96 expr->string.str = str;
101 ExprCreateInteger(int ival)
103 EXPR_CREATE(ExprInteger, expr, EXPR_VALUE, EXPR_TYPE_INT);
104 expr->integer.ival = ival;
109 ExprCreateBoolean(bool set)
111 EXPR_CREATE(ExprBoolean, expr, EXPR_VALUE, EXPR_TYPE_BOOLEAN);
112 expr->boolean.set = set;
117 ExprCreateKeyName(xkb_atom_t key_name)
119 EXPR_CREATE(ExprKeyName, expr, EXPR_VALUE, EXPR_TYPE_KEYNAME);
120 expr->key_name.key_name = key_name;
125 ExprCreateIdent(xkb_atom_t ident)
127 EXPR_CREATE(ExprIdent, expr, EXPR_IDENT, EXPR_TYPE_UNKNOWN);
128 expr->ident.ident = ident;
133 ExprCreateUnary(enum expr_op_type op, enum expr_value_type type,
136 EXPR_CREATE(ExprUnary, expr, op, type);
137 expr->unary.child = child;
142 ExprCreateBinary(enum expr_op_type op, ExprDef *left, ExprDef *right)
144 EXPR_CREATE(ExprBinary, expr, op, EXPR_TYPE_UNKNOWN);
146 if (op == EXPR_ASSIGN || left->expr.value_type == EXPR_TYPE_UNKNOWN)
147 expr->expr.value_type = right->expr.value_type;
148 else if (left->expr.value_type == right->expr.value_type ||
149 right->expr.value_type == EXPR_TYPE_UNKNOWN)
150 expr->expr.value_type = left->expr.value_type;
151 expr->binary.left = left;
152 expr->binary.right = right;
158 ExprCreateFieldRef(xkb_atom_t element, xkb_atom_t field)
160 EXPR_CREATE(ExprFieldRef, expr, EXPR_FIELD_REF, EXPR_TYPE_UNKNOWN);
161 expr->field_ref.element = element;
162 expr->field_ref.field = field;
167 ExprCreateArrayRef(xkb_atom_t element, xkb_atom_t field, ExprDef *entry)
169 EXPR_CREATE(ExprArrayRef, expr, EXPR_ARRAY_REF, EXPR_TYPE_UNKNOWN);
170 expr->array_ref.element = element;
171 expr->array_ref.field = field;
172 expr->array_ref.entry = entry;
177 ExprCreateAction(xkb_atom_t name, ExprDef *args)
179 EXPR_CREATE(ExprAction, expr, EXPR_ACTION_DECL, EXPR_TYPE_UNKNOWN);
180 expr->action.name = name;
181 expr->action.args = args;
186 ExprCreateKeysymList(xkb_keysym_t sym)
188 EXPR_CREATE(ExprKeysymList, expr, EXPR_KEYSYM_LIST, EXPR_TYPE_SYMBOLS);
190 darray_init(expr->keysym_list.syms);
191 darray_init(expr->keysym_list.symsMapIndex);
192 darray_init(expr->keysym_list.symsNumEntries);
194 darray_append(expr->keysym_list.syms, sym);
195 darray_append(expr->keysym_list.symsMapIndex, 0);
196 darray_append(expr->keysym_list.symsNumEntries, 1);
202 ExprCreateMultiKeysymList(ExprDef *expr)
204 unsigned nLevels = darray_size(expr->keysym_list.symsMapIndex);
206 darray_resize(expr->keysym_list.symsMapIndex, 1);
207 darray_resize(expr->keysym_list.symsNumEntries, 1);
208 darray_item(expr->keysym_list.symsMapIndex, 0) = 0;
209 darray_item(expr->keysym_list.symsNumEntries, 0) = nLevels;
215 ExprAppendKeysymList(ExprDef *expr, xkb_keysym_t sym)
217 unsigned nSyms = darray_size(expr->keysym_list.syms);
219 darray_append(expr->keysym_list.symsMapIndex, nSyms);
220 darray_append(expr->keysym_list.symsNumEntries, 1);
221 darray_append(expr->keysym_list.syms, sym);
227 ExprAppendMultiKeysymList(ExprDef *expr, ExprDef *append)
230 unsigned nSyms = darray_size(expr->keysym_list.syms);
231 unsigned numEntries = darray_size(append->keysym_list.syms);
233 darray_append(expr->keysym_list.symsMapIndex, nSyms);
234 darray_append(expr->keysym_list.symsNumEntries, numEntries);
235 darray_steal(append->keysym_list.syms, &syms, NULL);
236 darray_append_items(expr->keysym_list.syms, syms, numEntries);
238 FreeStmt((ParseCommon *) &append);
244 KeycodeCreate(xkb_atom_t name, int64_t value)
246 KeycodeDef *def = malloc(sizeof(*def));
250 def->common.type = STMT_KEYCODE;
251 def->common.next = NULL;
259 KeyAliasCreate(xkb_atom_t alias, xkb_atom_t real)
261 KeyAliasDef *def = malloc(sizeof(*def));
265 def->common.type = STMT_ALIAS;
266 def->common.next = NULL;
274 VModCreate(xkb_atom_t name, ExprDef *value)
276 VModDef *def = malloc(sizeof(*def));
280 def->common.type = STMT_VMOD;
281 def->common.next = NULL;
289 VarCreate(ExprDef *name, ExprDef *value)
291 VarDef *def = malloc(sizeof(*def));
295 def->common.type = STMT_VAR;
296 def->common.next = NULL;
304 BoolVarCreate(xkb_atom_t ident, bool set)
306 ExprDef *name, *value;
308 if (!(name = ExprCreateIdent(ident))) {
311 if (!(value = ExprCreateBoolean(set))) {
312 FreeStmt((ParseCommon *) name);
315 if (!(def = VarCreate(name, value))) {
316 FreeStmt((ParseCommon *) name);
317 FreeStmt((ParseCommon *) value);
324 InterpCreate(xkb_keysym_t sym, ExprDef *match)
326 InterpDef *def = malloc(sizeof(*def));
330 def->common.type = STMT_INTERP;
331 def->common.next = NULL;
340 KeyTypeCreate(xkb_atom_t name, VarDef *body)
342 KeyTypeDef *def = malloc(sizeof(*def));
346 def->common.type = STMT_TYPE;
347 def->common.next = NULL;
348 def->merge = MERGE_DEFAULT;
356 SymbolsCreate(xkb_atom_t keyName, VarDef *symbols)
358 SymbolsDef *def = malloc(sizeof(*def));
362 def->common.type = STMT_SYMBOLS;
363 def->common.next = NULL;
364 def->merge = MERGE_DEFAULT;
365 def->keyName = keyName;
366 def->symbols = symbols;
372 GroupCompatCreate(unsigned group, ExprDef *val)
374 GroupCompatDef *def = malloc(sizeof(*def));
378 def->common.type = STMT_GROUP_COMPAT;
379 def->common.next = NULL;
380 def->merge = MERGE_DEFAULT;
388 ModMapCreate(xkb_atom_t modifier, ExprDef *keys)
390 ModMapDef *def = malloc(sizeof(*def));
394 def->common.type = STMT_MODMAP;
395 def->common.next = NULL;
396 def->merge = MERGE_DEFAULT;
397 def->modifier = modifier;
404 LedMapCreate(xkb_atom_t name, VarDef *body)
406 LedMapDef *def = malloc(sizeof(*def));
410 def->common.type = STMT_LED_MAP;
411 def->common.next = NULL;
412 def->merge = MERGE_DEFAULT;
420 LedNameCreate(unsigned ndx, ExprDef *name, bool virtual)
422 LedNameDef *def = malloc(sizeof(*def));
426 def->common.type = STMT_LED_NAME;
427 def->common.next = NULL;
428 def->merge = MERGE_DEFAULT;
431 def->virtual = virtual;
437 FreeInclude(IncludeStmt *incl);
440 IncludeCreate(struct xkb_context *ctx, char *str, enum merge_mode merge)
442 IncludeStmt *incl, *first;
443 char *file, *map, *stmt, *tmp, *extra_data;
449 stmt = strdup_safe(str);
452 if (!ParseIncludeMap(&tmp, &file, &map, &nextop, &extra_data))
456 * Given an RMLVO (here layout) like 'us,,fr', the rules parser
457 * will give out something like 'pc+us+:2+fr:3+inet(evdev)'.
458 * We should just skip the ':2' in this case and leave it to the
459 * appropriate section to deal with the empty group.
469 first = incl = malloc(sizeof(*first));
471 incl->next_incl = malloc(sizeof(*first));
472 incl = incl->next_incl;
478 incl->common.type = STMT_INCLUDE;
479 incl->common.next = NULL;
484 incl->modifier = extra_data;
485 incl->next_incl = NULL;
488 merge = MERGE_AUGMENT;
490 merge = MERGE_OVERRIDE;
501 log_err(ctx, "Illegal include statement \"%s\"; Ignored\n", stmt);
508 XkbFileCreate(enum xkb_file_type type, char *name, ParseCommon *defs,
509 enum xkb_map_flags flags)
513 file = calloc(1, sizeof(*file));
517 XkbEscapeMapName(name);
518 file->file_type = type;
519 file->name = name ? name : strdup("(unnamed)");
527 XkbFileFromComponents(struct xkb_context *ctx,
528 const struct xkb_component_names *kkctgs)
530 char *const components[] = {
531 kkctgs->keycodes, kkctgs->types,
532 kkctgs->compat, kkctgs->symbols,
534 enum xkb_file_type type;
535 IncludeStmt *include = NULL;
536 XkbFile *file = NULL;
537 ParseCommon *defs = NULL;
539 for (type = FIRST_KEYMAP_FILE_TYPE; type <= LAST_KEYMAP_FILE_TYPE; type++) {
540 include = IncludeCreate(ctx, components[type], MERGE_DEFAULT);
544 file = XkbFileCreate(type, NULL, (ParseCommon *) include, 0);
546 FreeInclude(include);
550 defs = AppendStmt(defs, &file->common);
553 file = XkbFileCreate(FILE_TYPE_KEYMAP, NULL, defs, 0);
560 FreeXkbFile((XkbFile *) defs);
565 FreeExpr(ExprDef *expr)
570 switch (expr->expr.op) {
571 case EXPR_ACTION_LIST:
573 case EXPR_UNARY_PLUS:
576 FreeStmt((ParseCommon *) expr->unary.child);
584 FreeStmt((ParseCommon *) expr->binary.left);
585 FreeStmt((ParseCommon *) expr->binary.right);
588 case EXPR_ACTION_DECL:
589 FreeStmt((ParseCommon *) expr->action.args);
593 FreeStmt((ParseCommon *) expr->array_ref.entry);
596 case EXPR_KEYSYM_LIST:
597 darray_free(expr->keysym_list.syms);
598 darray_free(expr->keysym_list.symsMapIndex);
599 darray_free(expr->keysym_list.symsNumEntries);
608 FreeInclude(IncludeStmt *incl)
614 next = incl->next_incl;
618 free(incl->modifier);
627 FreeStmt(ParseCommon *stmt)
635 switch (stmt->type) {
637 FreeInclude((IncludeStmt *) stmt);
638 /* stmt is already free'd here. */
642 FreeExpr((ExprDef *) stmt);
645 FreeStmt((ParseCommon *) ((VarDef *) stmt)->name);
646 FreeStmt((ParseCommon *) ((VarDef *) stmt)->value);
649 FreeStmt((ParseCommon *) ((KeyTypeDef *) stmt)->body);
652 FreeStmt((ParseCommon *) ((InterpDef *) stmt)->match);
653 FreeStmt((ParseCommon *) ((InterpDef *) stmt)->def);
656 FreeStmt((ParseCommon *) ((VModDef *) stmt)->value);
659 FreeStmt((ParseCommon *) ((SymbolsDef *) stmt)->symbols);
662 FreeStmt((ParseCommon *) ((ModMapDef *) stmt)->keys);
664 case STMT_GROUP_COMPAT:
665 FreeStmt((ParseCommon *) ((GroupCompatDef *) stmt)->def);
668 FreeStmt((ParseCommon *) ((LedMapDef *) stmt)->body);
671 FreeStmt((ParseCommon *) ((LedNameDef *) stmt)->name);
683 FreeXkbFile(XkbFile *file)
689 next = (XkbFile *) file->common.next;
691 switch (file->file_type) {
692 case FILE_TYPE_KEYMAP:
693 FreeXkbFile((XkbFile *) file->defs);
696 case FILE_TYPE_TYPES:
697 case FILE_TYPE_COMPAT:
698 case FILE_TYPE_SYMBOLS:
699 case FILE_TYPE_KEYCODES:
700 case FILE_TYPE_GEOMETRY:
701 FreeStmt(file->defs);
714 static const char *xkb_file_type_strings[_FILE_TYPE_NUM_ENTRIES] = {
715 [FILE_TYPE_KEYCODES] = "xkb_keycodes",
716 [FILE_TYPE_TYPES] = "xkb_types",
717 [FILE_TYPE_COMPAT] = "xkb_compatibility",
718 [FILE_TYPE_SYMBOLS] = "xkb_symbols",
719 [FILE_TYPE_GEOMETRY] = "xkb_geometry",
720 [FILE_TYPE_KEYMAP] = "xkb_keymap",
721 [FILE_TYPE_RULES] = "rules",
725 xkb_file_type_to_string(enum xkb_file_type type)
727 if (type > _FILE_TYPE_NUM_ENTRIES)
729 return xkb_file_type_strings[type];
732 static const char *stmt_type_strings[_STMT_NUM_VALUES] = {
733 [STMT_UNKNOWN] = "unknown statement",
734 [STMT_INCLUDE] = "include statement",
735 [STMT_KEYCODE] = "key name definition",
736 [STMT_ALIAS] = "key alias definition",
737 [STMT_EXPR] = "expression",
738 [STMT_VAR] = "variable definition",
739 [STMT_TYPE] = "key type definition",
740 [STMT_INTERP] = "symbol interpretation definition",
741 [STMT_VMOD] = "virtual modifiers definition",
742 [STMT_SYMBOLS] = "key symbols definition",
743 [STMT_MODMAP] = "modifier map declaration",
744 [STMT_GROUP_COMPAT] = "group declaration",
745 [STMT_LED_MAP] = "indicator map declaration",
746 [STMT_LED_NAME] = "indicator name declaration",
750 stmt_type_to_string(enum stmt_type type)
752 if (type >= _STMT_NUM_VALUES)
754 return stmt_type_strings[type];
757 static const char *expr_op_type_strings[_EXPR_NUM_VALUES] = {
758 [EXPR_VALUE] = "literal",
759 [EXPR_IDENT] = "identifier",
760 [EXPR_ACTION_DECL] = "action declaration",
761 [EXPR_FIELD_REF] = "field reference",
762 [EXPR_ARRAY_REF] = "array reference",
763 [EXPR_KEYSYM_LIST] = "list of keysyms",
764 [EXPR_ACTION_LIST] = "list of actions",
765 [EXPR_ADD] = "addition",
766 [EXPR_SUBTRACT] = "subtraction",
767 [EXPR_MULTIPLY] = "multiplication",
768 [EXPR_DIVIDE] = "division",
769 [EXPR_ASSIGN] = "assignment",
770 [EXPR_NOT] = "logical negation",
771 [EXPR_NEGATE] = "arithmetic negation",
772 [EXPR_INVERT] = "bitwise inversion",
773 [EXPR_UNARY_PLUS] = "unary plus",
777 expr_op_type_to_string(enum expr_op_type type)
779 if (type >= _EXPR_NUM_VALUES)
781 return expr_op_type_strings[type];
784 static const char *expr_value_type_strings[_EXPR_TYPE_NUM_VALUES] = {
785 [EXPR_TYPE_UNKNOWN] = "unknown",
786 [EXPR_TYPE_BOOLEAN] = "boolean",
787 [EXPR_TYPE_INT] = "int",
788 [EXPR_TYPE_STRING] = "string",
789 [EXPR_TYPE_ACTION] = "action",
790 [EXPR_TYPE_KEYNAME] = "keyname",
791 [EXPR_TYPE_SYMBOLS] = "symbols",
795 expr_value_type_to_string(enum expr_value_type type)
797 if (type >= _EXPR_TYPE_NUM_VALUES)
799 return expr_value_type_strings[type];