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)
229 unsigned nSyms = darray_size(expr->keysym_list.syms);
230 unsigned numEntries = darray_size(append->keysym_list.syms);
232 darray_append(expr->keysym_list.symsMapIndex, nSyms);
233 darray_append(expr->keysym_list.symsNumEntries, numEntries);
234 darray_append_items(expr->keysym_list.syms,
235 darray_mem(append->keysym_list.syms, 0), numEntries);
237 darray_resize(append->keysym_list.syms, 0);
238 FreeStmt(&append->common);
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 return VarCreate((ExprDef *) ExprCreateIdent(ident),
307 (ExprDef *) ExprCreateBoolean(set));
311 InterpCreate(xkb_keysym_t sym, ExprDef *match)
313 InterpDef *def = malloc(sizeof(*def));
317 def->common.type = STMT_INTERP;
318 def->common.next = NULL;
326 KeyTypeCreate(xkb_atom_t name, VarDef *body)
328 KeyTypeDef *def = malloc(sizeof(*def));
332 def->common.type = STMT_TYPE;
333 def->common.next = NULL;
334 def->merge = MERGE_DEFAULT;
342 SymbolsCreate(xkb_atom_t keyName, VarDef *symbols)
344 SymbolsDef *def = malloc(sizeof(*def));
348 def->common.type = STMT_SYMBOLS;
349 def->common.next = NULL;
350 def->merge = MERGE_DEFAULT;
351 def->keyName = keyName;
352 def->symbols = symbols;
358 GroupCompatCreate(unsigned group, ExprDef *val)
360 GroupCompatDef *def = malloc(sizeof(*def));
364 def->common.type = STMT_GROUP_COMPAT;
365 def->common.next = NULL;
366 def->merge = MERGE_DEFAULT;
374 ModMapCreate(xkb_atom_t modifier, ExprDef *keys)
376 ModMapDef *def = malloc(sizeof(*def));
380 def->common.type = STMT_MODMAP;
381 def->common.next = NULL;
382 def->merge = MERGE_DEFAULT;
383 def->modifier = modifier;
390 LedMapCreate(xkb_atom_t name, VarDef *body)
392 LedMapDef *def = malloc(sizeof(*def));
396 def->common.type = STMT_LED_MAP;
397 def->common.next = NULL;
398 def->merge = MERGE_DEFAULT;
406 LedNameCreate(unsigned ndx, ExprDef *name, bool virtual)
408 LedNameDef *def = malloc(sizeof(*def));
412 def->common.type = STMT_LED_NAME;
413 def->common.next = NULL;
414 def->merge = MERGE_DEFAULT;
417 def->virtual = virtual;
423 FreeInclude(IncludeStmt *incl);
426 IncludeCreate(struct xkb_context *ctx, char *str, enum merge_mode merge)
428 IncludeStmt *incl, *first;
429 char *file, *map, *stmt, *tmp, *extra_data;
435 stmt = strdup_safe(str);
438 if (!ParseIncludeMap(&tmp, &file, &map, &nextop, &extra_data))
442 * Given an RMLVO (here layout) like 'us,,fr', the rules parser
443 * will give out something like 'pc+us+:2+fr:3+inet(evdev)'.
444 * We should just skip the ':2' in this case and leave it to the
445 * appropriate section to deal with the empty group.
455 first = incl = malloc(sizeof(*first));
457 incl->next_incl = malloc(sizeof(*first));
458 incl = incl->next_incl;
463 "Allocation failure in IncludeCreate; "
464 "Using only part of the include\n");
468 incl->common.type = STMT_INCLUDE;
469 incl->common.next = NULL;
474 incl->modifier = extra_data;
475 incl->next_incl = NULL;
478 merge = MERGE_AUGMENT;
480 merge = MERGE_OVERRIDE;
491 log_err(ctx, "Illegal include statement \"%s\"; Ignored\n", stmt);
498 XkbFileCreate(enum xkb_file_type type, char *name, ParseCommon *defs,
499 enum xkb_map_flags flags)
503 file = calloc(1, sizeof(*file));
507 XkbEscapeMapName(name);
508 file->file_type = type;
509 file->topName = strdup_safe(name);
518 XkbFileFromComponents(struct xkb_context *ctx,
519 const struct xkb_component_names *kkctgs)
521 char *const components[] = {
522 kkctgs->keycodes, kkctgs->types,
523 kkctgs->compat, kkctgs->symbols,
525 enum xkb_file_type type;
526 IncludeStmt *include = NULL;
527 XkbFile *file = NULL;
528 ParseCommon *defs = NULL;
530 for (type = FIRST_KEYMAP_FILE_TYPE; type <= LAST_KEYMAP_FILE_TYPE; type++) {
531 include = IncludeCreate(ctx, components[type], MERGE_DEFAULT);
535 file = XkbFileCreate(type, NULL, (ParseCommon *) include, 0);
537 FreeInclude(include);
541 defs = AppendStmt(defs, &file->common);
544 file = XkbFileCreate(FILE_TYPE_KEYMAP, NULL, defs, 0);
551 FreeXkbFile((XkbFile *) defs);
556 FreeExpr(ExprDef *expr)
561 switch (expr->expr.op) {
562 case EXPR_ACTION_LIST:
564 case EXPR_UNARY_PLUS:
567 FreeStmt((ParseCommon *) expr->unary.child);
575 FreeStmt((ParseCommon *) expr->binary.left);
576 FreeStmt((ParseCommon *) expr->binary.right);
579 case EXPR_ACTION_DECL:
580 FreeStmt((ParseCommon *) expr->action.args);
584 FreeStmt((ParseCommon *) expr->array_ref.entry);
587 case EXPR_KEYSYM_LIST:
588 darray_free(expr->keysym_list.syms);
589 darray_free(expr->keysym_list.symsMapIndex);
590 darray_free(expr->keysym_list.symsNumEntries);
599 FreeInclude(IncludeStmt *incl)
605 next = incl->next_incl;
609 free(incl->modifier);
618 FreeStmt(ParseCommon *stmt)
626 switch (stmt->type) {
628 FreeInclude((IncludeStmt *) stmt);
629 /* stmt is already free'd here. */
633 FreeExpr((ExprDef *) stmt);
636 FreeStmt((ParseCommon *) ((VarDef *) stmt)->name);
637 FreeStmt((ParseCommon *) ((VarDef *) stmt)->value);
640 FreeStmt((ParseCommon *) ((KeyTypeDef *) stmt)->body);
643 FreeStmt((ParseCommon *) ((InterpDef *) stmt)->match);
644 FreeStmt((ParseCommon *) ((InterpDef *) stmt)->def);
647 FreeStmt((ParseCommon *) ((VModDef *) stmt)->value);
650 FreeStmt((ParseCommon *) ((SymbolsDef *) stmt)->symbols);
653 FreeStmt((ParseCommon *) ((ModMapDef *) stmt)->keys);
655 case STMT_GROUP_COMPAT:
656 FreeStmt((ParseCommon *) ((GroupCompatDef *) stmt)->def);
659 FreeStmt((ParseCommon *) ((LedMapDef *) stmt)->body);
662 FreeStmt((ParseCommon *) ((LedNameDef *) stmt)->name);
674 FreeXkbFile(XkbFile *file)
680 next = (XkbFile *) file->common.next;
682 switch (file->file_type) {
683 case FILE_TYPE_KEYMAP:
684 FreeXkbFile((XkbFile *) file->defs);
687 case FILE_TYPE_TYPES:
688 case FILE_TYPE_COMPAT:
689 case FILE_TYPE_SYMBOLS:
690 case FILE_TYPE_KEYCODES:
691 case FILE_TYPE_GEOMETRY:
692 FreeStmt(file->defs);
706 static const char *xkb_file_type_strings[_FILE_TYPE_NUM_ENTRIES] = {
707 [FILE_TYPE_KEYCODES] = "xkb_keycodes",
708 [FILE_TYPE_TYPES] = "xkb_types",
709 [FILE_TYPE_COMPAT] = "xkb_compatibility",
710 [FILE_TYPE_SYMBOLS] = "xkb_symbols",
711 [FILE_TYPE_GEOMETRY] = "xkb_geometry",
712 [FILE_TYPE_KEYMAP] = "xkb_keymap",
713 [FILE_TYPE_RULES] = "rules",
717 xkb_file_type_to_string(enum xkb_file_type type)
719 if (type > _FILE_TYPE_NUM_ENTRIES)
721 return xkb_file_type_strings[type];
724 static const char *stmt_type_strings[_STMT_NUM_VALUES] = {
725 [STMT_UNKNOWN] = "unknown statement",
726 [STMT_INCLUDE] = "include statement",
727 [STMT_KEYCODE] = "key name definition",
728 [STMT_ALIAS] = "key alias definition",
729 [STMT_EXPR] = "expression",
730 [STMT_VAR] = "variable definition",
731 [STMT_TYPE] = "key type definition",
732 [STMT_INTERP] = "symbol interpretation definition",
733 [STMT_VMOD] = "virtual modifiers definition",
734 [STMT_SYMBOLS] = "key symbols definition",
735 [STMT_MODMAP] = "modifier map declaration",
736 [STMT_GROUP_COMPAT] = "group declaration",
737 [STMT_LED_MAP] = "indicator map declaration",
738 [STMT_LED_NAME] = "indicator name declaration",
742 stmt_type_to_string(enum stmt_type type)
744 if (type >= _STMT_NUM_VALUES)
746 return stmt_type_strings[type];
749 static const char *expr_op_type_strings[_EXPR_NUM_VALUES] = {
750 [EXPR_VALUE] = "literal",
751 [EXPR_IDENT] = "identifier",
752 [EXPR_ACTION_DECL] = "action declaration",
753 [EXPR_FIELD_REF] = "field reference",
754 [EXPR_ARRAY_REF] = "array reference",
755 [EXPR_KEYSYM_LIST] = "list of keysyms",
756 [EXPR_ACTION_LIST] = "list of actions",
757 [EXPR_ADD] = "addition",
758 [EXPR_SUBTRACT] = "subtraction",
759 [EXPR_MULTIPLY] = "multiplication",
760 [EXPR_DIVIDE] = "division",
761 [EXPR_ASSIGN] = "assignment",
762 [EXPR_NOT] = "logical negation",
763 [EXPR_NEGATE] = "arithmetic negation",
764 [EXPR_INVERT] = "bitwise inversion",
765 [EXPR_UNARY_PLUS] = "unary plus",
769 expr_op_type_to_string(enum expr_op_type type)
771 if (type >= _EXPR_NUM_VALUES)
773 return expr_op_type_strings[type];
776 static const char *expr_value_type_strings[_EXPR_TYPE_NUM_VALUES] = {
777 [EXPR_TYPE_UNKNOWN] = "unknown",
778 [EXPR_TYPE_BOOLEAN] = "boolean",
779 [EXPR_TYPE_INT] = "int",
780 [EXPR_TYPE_STRING] = "string",
781 [EXPR_TYPE_ACTION] = "action",
782 [EXPR_TYPE_KEYNAME] = "keyname",
783 [EXPR_TYPE_SYMBOLS] = "symbols",
787 expr_value_type_to_string(enum expr_value_type type)
789 if (type >= _EXPR_TYPE_NUM_VALUES)
791 return expr_value_type_strings[type];