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 ExprCreateFloat(void)
111 EXPR_CREATE(ExprFloat, expr, EXPR_VALUE, EXPR_TYPE_FLOAT);
116 ExprCreateBoolean(bool set)
118 EXPR_CREATE(ExprBoolean, expr, EXPR_VALUE, EXPR_TYPE_BOOLEAN);
119 expr->boolean.set = set;
124 ExprCreateKeyName(xkb_atom_t key_name)
126 EXPR_CREATE(ExprKeyName, expr, EXPR_VALUE, EXPR_TYPE_KEYNAME);
127 expr->key_name.key_name = key_name;
132 ExprCreateIdent(xkb_atom_t ident)
134 EXPR_CREATE(ExprIdent, expr, EXPR_IDENT, EXPR_TYPE_UNKNOWN);
135 expr->ident.ident = ident;
140 ExprCreateUnary(enum expr_op_type op, enum expr_value_type type,
143 EXPR_CREATE(ExprUnary, expr, op, type);
144 expr->unary.child = child;
149 ExprCreateBinary(enum expr_op_type op, ExprDef *left, ExprDef *right)
151 EXPR_CREATE(ExprBinary, expr, op, EXPR_TYPE_UNKNOWN);
153 if (op == EXPR_ASSIGN || left->expr.value_type == EXPR_TYPE_UNKNOWN)
154 expr->expr.value_type = right->expr.value_type;
155 else if (left->expr.value_type == right->expr.value_type ||
156 right->expr.value_type == EXPR_TYPE_UNKNOWN)
157 expr->expr.value_type = left->expr.value_type;
158 expr->binary.left = left;
159 expr->binary.right = right;
165 ExprCreateFieldRef(xkb_atom_t element, xkb_atom_t field)
167 EXPR_CREATE(ExprFieldRef, expr, EXPR_FIELD_REF, EXPR_TYPE_UNKNOWN);
168 expr->field_ref.element = element;
169 expr->field_ref.field = field;
174 ExprCreateArrayRef(xkb_atom_t element, xkb_atom_t field, ExprDef *entry)
176 EXPR_CREATE(ExprArrayRef, expr, EXPR_ARRAY_REF, EXPR_TYPE_UNKNOWN);
177 expr->array_ref.element = element;
178 expr->array_ref.field = field;
179 expr->array_ref.entry = entry;
184 ExprCreateAction(xkb_atom_t name, ExprDef *args)
186 EXPR_CREATE(ExprAction, expr, EXPR_ACTION_DECL, EXPR_TYPE_UNKNOWN);
187 expr->action.name = name;
188 expr->action.args = args;
193 ExprCreateKeysymList(xkb_keysym_t sym)
195 EXPR_CREATE(ExprKeysymList, expr, EXPR_KEYSYM_LIST, EXPR_TYPE_SYMBOLS);
197 darray_init(expr->keysym_list.syms);
198 darray_init(expr->keysym_list.symsMapIndex);
199 darray_init(expr->keysym_list.symsNumEntries);
201 darray_append(expr->keysym_list.syms, sym);
202 darray_append(expr->keysym_list.symsMapIndex, 0);
203 darray_append(expr->keysym_list.symsNumEntries, 1);
209 ExprCreateMultiKeysymList(ExprDef *expr)
211 unsigned nLevels = darray_size(expr->keysym_list.symsMapIndex);
213 darray_resize(expr->keysym_list.symsMapIndex, 1);
214 darray_resize(expr->keysym_list.symsNumEntries, 1);
215 darray_item(expr->keysym_list.symsMapIndex, 0) = 0;
216 darray_item(expr->keysym_list.symsNumEntries, 0) = nLevels;
222 ExprAppendKeysymList(ExprDef *expr, xkb_keysym_t sym)
224 unsigned nSyms = darray_size(expr->keysym_list.syms);
226 darray_append(expr->keysym_list.symsMapIndex, nSyms);
227 darray_append(expr->keysym_list.symsNumEntries, 1);
228 darray_append(expr->keysym_list.syms, sym);
234 ExprAppendMultiKeysymList(ExprDef *expr, ExprDef *append)
236 unsigned nSyms = darray_size(expr->keysym_list.syms);
237 unsigned numEntries = darray_size(append->keysym_list.syms);
239 darray_append(expr->keysym_list.symsMapIndex, nSyms);
240 darray_append(expr->keysym_list.symsNumEntries, numEntries);
241 darray_concat(expr->keysym_list.syms, append->keysym_list.syms);
243 FreeStmt((ParseCommon *) append);
249 KeycodeCreate(xkb_atom_t name, int64_t value)
251 KeycodeDef *def = malloc(sizeof(*def));
255 def->common.type = STMT_KEYCODE;
256 def->common.next = NULL;
264 KeyAliasCreate(xkb_atom_t alias, xkb_atom_t real)
266 KeyAliasDef *def = malloc(sizeof(*def));
270 def->common.type = STMT_ALIAS;
271 def->common.next = NULL;
279 VModCreate(xkb_atom_t name, ExprDef *value)
281 VModDef *def = malloc(sizeof(*def));
285 def->common.type = STMT_VMOD;
286 def->common.next = NULL;
294 VarCreate(ExprDef *name, ExprDef *value)
296 VarDef *def = malloc(sizeof(*def));
300 def->common.type = STMT_VAR;
301 def->common.next = NULL;
309 BoolVarCreate(xkb_atom_t ident, bool set)
311 ExprDef *name, *value;
313 if (!(name = ExprCreateIdent(ident))) {
316 if (!(value = ExprCreateBoolean(set))) {
317 FreeStmt((ParseCommon *) name);
320 if (!(def = VarCreate(name, value))) {
321 FreeStmt((ParseCommon *) name);
322 FreeStmt((ParseCommon *) value);
329 InterpCreate(xkb_keysym_t sym, ExprDef *match)
331 InterpDef *def = malloc(sizeof(*def));
335 def->common.type = STMT_INTERP;
336 def->common.next = NULL;
345 KeyTypeCreate(xkb_atom_t name, VarDef *body)
347 KeyTypeDef *def = malloc(sizeof(*def));
351 def->common.type = STMT_TYPE;
352 def->common.next = NULL;
353 def->merge = MERGE_DEFAULT;
361 SymbolsCreate(xkb_atom_t keyName, VarDef *symbols)
363 SymbolsDef *def = malloc(sizeof(*def));
367 def->common.type = STMT_SYMBOLS;
368 def->common.next = NULL;
369 def->merge = MERGE_DEFAULT;
370 def->keyName = keyName;
371 def->symbols = symbols;
377 GroupCompatCreate(unsigned group, ExprDef *val)
379 GroupCompatDef *def = malloc(sizeof(*def));
383 def->common.type = STMT_GROUP_COMPAT;
384 def->common.next = NULL;
385 def->merge = MERGE_DEFAULT;
393 ModMapCreate(xkb_atom_t modifier, ExprDef *keys)
395 ModMapDef *def = malloc(sizeof(*def));
399 def->common.type = STMT_MODMAP;
400 def->common.next = NULL;
401 def->merge = MERGE_DEFAULT;
402 def->modifier = modifier;
409 LedMapCreate(xkb_atom_t name, VarDef *body)
411 LedMapDef *def = malloc(sizeof(*def));
415 def->common.type = STMT_LED_MAP;
416 def->common.next = NULL;
417 def->merge = MERGE_DEFAULT;
425 LedNameCreate(unsigned ndx, ExprDef *name, bool virtual)
427 LedNameDef *def = malloc(sizeof(*def));
431 def->common.type = STMT_LED_NAME;
432 def->common.next = NULL;
433 def->merge = MERGE_DEFAULT;
436 def->virtual = virtual;
442 FreeInclude(IncludeStmt *incl);
445 IncludeCreate(struct xkb_context *ctx, char *str, enum merge_mode merge)
447 IncludeStmt *incl, *first;
448 char *file, *map, *stmt, *tmp, *extra_data;
454 stmt = strdup_safe(str);
457 if (!ParseIncludeMap(&tmp, &file, &map, &nextop, &extra_data))
461 * Given an RMLVO (here layout) like 'us,,fr', the rules parser
462 * will give out something like 'pc+us+:2+fr:3+inet(evdev)'.
463 * We should just skip the ':2' in this case and leave it to the
464 * appropriate section to deal with the empty group.
474 first = incl = malloc(sizeof(*first));
476 incl->next_incl = malloc(sizeof(*first));
477 incl = incl->next_incl;
483 incl->common.type = STMT_INCLUDE;
484 incl->common.next = NULL;
489 incl->modifier = extra_data;
490 incl->next_incl = NULL;
493 merge = MERGE_AUGMENT;
495 merge = MERGE_OVERRIDE;
506 log_err(ctx, "Illegal include statement \"%s\"; Ignored\n", stmt);
513 XkbFileCreate(enum xkb_file_type type, char *name, ParseCommon *defs,
514 enum xkb_map_flags flags)
518 file = calloc(1, sizeof(*file));
522 XkbEscapeMapName(name);
523 file->file_type = type;
524 file->name = name ? name : strdup("(unnamed)");
532 XkbFileFromComponents(struct xkb_context *ctx,
533 const struct xkb_component_names *kkctgs)
535 char *const components[] = {
536 kkctgs->keycodes, kkctgs->types,
537 kkctgs->compat, kkctgs->symbols,
539 enum xkb_file_type type;
540 IncludeStmt *include = NULL;
541 XkbFile *file = NULL;
542 ParseCommon *defs = NULL;
544 for (type = FIRST_KEYMAP_FILE_TYPE; type <= LAST_KEYMAP_FILE_TYPE; type++) {
545 include = IncludeCreate(ctx, components[type], MERGE_DEFAULT);
549 file = XkbFileCreate(type, NULL, (ParseCommon *) include, 0);
551 FreeInclude(include);
555 defs = AppendStmt(defs, &file->common);
558 file = XkbFileCreate(FILE_TYPE_KEYMAP, NULL, defs, 0);
565 FreeXkbFile((XkbFile *) defs);
570 FreeExpr(ExprDef *expr)
575 switch (expr->expr.op) {
576 case EXPR_ACTION_LIST:
578 case EXPR_UNARY_PLUS:
581 FreeStmt((ParseCommon *) expr->unary.child);
589 FreeStmt((ParseCommon *) expr->binary.left);
590 FreeStmt((ParseCommon *) expr->binary.right);
593 case EXPR_ACTION_DECL:
594 FreeStmt((ParseCommon *) expr->action.args);
598 FreeStmt((ParseCommon *) expr->array_ref.entry);
601 case EXPR_KEYSYM_LIST:
602 darray_free(expr->keysym_list.syms);
603 darray_free(expr->keysym_list.symsMapIndex);
604 darray_free(expr->keysym_list.symsNumEntries);
613 FreeInclude(IncludeStmt *incl)
619 next = incl->next_incl;
623 free(incl->modifier);
632 FreeStmt(ParseCommon *stmt)
640 switch (stmt->type) {
642 FreeInclude((IncludeStmt *) stmt);
643 /* stmt is already free'd here. */
647 FreeExpr((ExprDef *) stmt);
650 FreeStmt((ParseCommon *) ((VarDef *) stmt)->name);
651 FreeStmt((ParseCommon *) ((VarDef *) stmt)->value);
654 FreeStmt((ParseCommon *) ((KeyTypeDef *) stmt)->body);
657 FreeStmt((ParseCommon *) ((InterpDef *) stmt)->match);
658 FreeStmt((ParseCommon *) ((InterpDef *) stmt)->def);
661 FreeStmt((ParseCommon *) ((VModDef *) stmt)->value);
664 FreeStmt((ParseCommon *) ((SymbolsDef *) stmt)->symbols);
667 FreeStmt((ParseCommon *) ((ModMapDef *) stmt)->keys);
669 case STMT_GROUP_COMPAT:
670 FreeStmt((ParseCommon *) ((GroupCompatDef *) stmt)->def);
673 FreeStmt((ParseCommon *) ((LedMapDef *) stmt)->body);
676 FreeStmt((ParseCommon *) ((LedNameDef *) stmt)->name);
688 FreeXkbFile(XkbFile *file)
694 next = (XkbFile *) file->common.next;
696 switch (file->file_type) {
697 case FILE_TYPE_KEYMAP:
698 FreeXkbFile((XkbFile *) file->defs);
701 case FILE_TYPE_TYPES:
702 case FILE_TYPE_COMPAT:
703 case FILE_TYPE_SYMBOLS:
704 case FILE_TYPE_KEYCODES:
705 case FILE_TYPE_GEOMETRY:
706 FreeStmt(file->defs);
719 static const char *xkb_file_type_strings[_FILE_TYPE_NUM_ENTRIES] = {
720 [FILE_TYPE_KEYCODES] = "xkb_keycodes",
721 [FILE_TYPE_TYPES] = "xkb_types",
722 [FILE_TYPE_COMPAT] = "xkb_compatibility",
723 [FILE_TYPE_SYMBOLS] = "xkb_symbols",
724 [FILE_TYPE_GEOMETRY] = "xkb_geometry",
725 [FILE_TYPE_KEYMAP] = "xkb_keymap",
726 [FILE_TYPE_RULES] = "rules",
730 xkb_file_type_to_string(enum xkb_file_type type)
732 if (type >= _FILE_TYPE_NUM_ENTRIES)
734 return xkb_file_type_strings[type];
737 static const char *stmt_type_strings[_STMT_NUM_VALUES] = {
738 [STMT_UNKNOWN] = "unknown statement",
739 [STMT_INCLUDE] = "include statement",
740 [STMT_KEYCODE] = "key name definition",
741 [STMT_ALIAS] = "key alias definition",
742 [STMT_EXPR] = "expression",
743 [STMT_VAR] = "variable definition",
744 [STMT_TYPE] = "key type definition",
745 [STMT_INTERP] = "symbol interpretation definition",
746 [STMT_VMOD] = "virtual modifiers definition",
747 [STMT_SYMBOLS] = "key symbols definition",
748 [STMT_MODMAP] = "modifier map declaration",
749 [STMT_GROUP_COMPAT] = "group declaration",
750 [STMT_LED_MAP] = "indicator map declaration",
751 [STMT_LED_NAME] = "indicator name declaration",
755 stmt_type_to_string(enum stmt_type type)
757 if (type >= _STMT_NUM_VALUES)
759 return stmt_type_strings[type];
762 static const char *expr_op_type_strings[_EXPR_NUM_VALUES] = {
763 [EXPR_VALUE] = "literal",
764 [EXPR_IDENT] = "identifier",
765 [EXPR_ACTION_DECL] = "action declaration",
766 [EXPR_FIELD_REF] = "field reference",
767 [EXPR_ARRAY_REF] = "array reference",
768 [EXPR_KEYSYM_LIST] = "list of keysyms",
769 [EXPR_ACTION_LIST] = "list of actions",
770 [EXPR_ADD] = "addition",
771 [EXPR_SUBTRACT] = "subtraction",
772 [EXPR_MULTIPLY] = "multiplication",
773 [EXPR_DIVIDE] = "division",
774 [EXPR_ASSIGN] = "assignment",
775 [EXPR_NOT] = "logical negation",
776 [EXPR_NEGATE] = "arithmetic negation",
777 [EXPR_INVERT] = "bitwise inversion",
778 [EXPR_UNARY_PLUS] = "unary plus",
782 expr_op_type_to_string(enum expr_op_type type)
784 if (type >= _EXPR_NUM_VALUES)
786 return expr_op_type_strings[type];
789 static const char *expr_value_type_strings[_EXPR_TYPE_NUM_VALUES] = {
790 [EXPR_TYPE_UNKNOWN] = "unknown",
791 [EXPR_TYPE_BOOLEAN] = "boolean",
792 [EXPR_TYPE_INT] = "int",
793 [EXPR_TYPE_FLOAT] = "float",
794 [EXPR_TYPE_STRING] = "string",
795 [EXPR_TYPE_ACTION] = "action",
796 [EXPR_TYPE_KEYNAME] = "keyname",
797 [EXPR_TYPE_SYMBOLS] = "symbols",
801 expr_value_type_to_string(enum expr_value_type type)
803 if (type >= _EXPR_TYPE_NUM_VALUES)
805 return expr_value_type_strings[type];