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 * The parser should work with reasonably recent versions of either
29 * bison or byacc. So if you make changes, try to make sure it works
34 #include "xkbcomp-priv.h"
35 #include "ast-build.h"
36 #include "parser-priv.h"
37 #include "scanner-utils.h"
40 struct xkb_context *ctx;
41 struct scanner *scanner;
46 #define parser_err(param, fmt, ...) \
47 scanner_err((param)->scanner, fmt, ##__VA_ARGS__)
49 #define parser_warn(param, fmt, ...) \
50 scanner_warn((param)->scanner, fmt, ##__VA_ARGS__)
53 _xkbcommon_error(struct parser_param *param, const char *msg)
55 parser_err(param, "%s", msg);
59 resolve_keysym(const char *name, xkb_keysym_t *sym_rtrn)
63 if (!name || istreq(name, "any") || istreq(name, "nosymbol")) {
64 *sym_rtrn = XKB_KEY_NoSymbol;
68 if (istreq(name, "none") || istreq(name, "voidsymbol")) {
69 *sym_rtrn = XKB_KEY_VoidSymbol;
73 sym = xkb_keysym_from_name(name, XKB_KEYSYM_NO_FLAGS);
74 if (sym != XKB_KEY_NoSymbol) {
82 #define param_scanner param->scanner
86 %lex-param { struct scanner *param_scanner }
87 %parse-param { struct parser_param *param }
165 enum xkb_file_type file_type;
168 enum merge_mode merge;
169 enum xkb_map_flags mapFlags;
179 GroupCompatDef *groupCompat;
183 KeyAliasDef *keyAlias;
188 %type <num> INTEGER FLOAT
189 %type <str> IDENT STRING
192 %type <ival> Number Integer Float SignedNumber DoodadType
193 %type <merge> MergeMode OptMergeMode
194 %type <file_type> XkbCompositeType FileType
195 %type <mapFlags> Flag Flags OptFlags
196 %type <str> MapName OptMapName
197 %type <atom> FieldSpec Ident Element String
198 %type <keysym> KeySym
199 %type <any> DeclList Decl
200 %type <expr> OptExprList ExprList Expr Term Lhs Terminal ArrayInit KeySyms
201 %type <expr> OptKeySymList KeySymList Action ActionList Coord CoordList
202 %type <var> VarDecl VarDeclList SymbolsBody SymbolsVarDecl
203 %type <vmod> VModDecl VModDefList VModDef
204 %type <interp> InterpretDecl InterpretMatch
205 %type <keyType> KeyTypeDecl
206 %type <syms> SymbolsDecl
207 %type <modMask> ModMapDecl
208 %type <groupCompat> GroupCompatDecl
209 %type <ledMap> LedMapDecl
210 %type <ledName> LedNameDecl
211 %type <keyCode> KeyNameDecl
212 %type <keyAlias> KeyAliasDecl
213 %type <geom> ShapeDecl SectionDecl SectionBody SectionBodyItem RowBody RowBodyItem
214 %type <geom> Keys Key OverlayDecl OverlayKeyList OverlayKey OutlineList OutlineInList
215 %type <geom> DoodadDecl
216 %type <file> XkbFile XkbMapConfigList XkbMapConfig
217 %type <file> XkbCompositeMap
219 %destructor { FreeStmt((ParseCommon *) $$); }
220 <any> <expr> <var> <vmod> <interp> <keyType> <syms> <modMask> <groupCompat>
221 <ledMap> <ledName> <keyCode> <keyAlias>
222 /* The destructor also runs on the start symbol when the parser *succeeds*.
223 * The `if` here catches this case. */
224 %destructor { if (!param->rtrn) FreeXkbFile($$); } <file>
225 %destructor { free($$); } <str>
230 * An actual file may contain more than one map. However, if we do things
231 * in the normal yacc way, i.e. aggregate all of the maps into a list and
232 * let the caller find the map it wants, we end up scanning and parsing a
233 * lot of unneeded maps (in the end we always just need one).
234 * Instead of doing that, we make yyparse return one map at a time, and
235 * then call it repeatedly until we find the map we need. Once we find it,
236 * we don't need to parse everything that follows in the file.
237 * This does mean that if we e.g. always use the first map, the file may
238 * contain complete garbage after that. But it's worth it.
241 XkbFile : XkbCompositeMap
242 { $$ = param->rtrn = $1; param->more_maps = true; }
244 { $$ = param->rtrn = $1; param->more_maps = true; YYACCEPT; }
246 { $$ = param->rtrn = NULL; param->more_maps = false; }
249 XkbCompositeMap : OptFlags XkbCompositeType OptMapName OBRACE
252 { $$ = XkbFileCreate($2, $3, (ParseCommon *) $5, $1); }
255 XkbCompositeType: XKB_KEYMAP { $$ = FILE_TYPE_KEYMAP; }
256 | XKB_SEMANTICS { $$ = FILE_TYPE_KEYMAP; }
257 | XKB_LAYOUT { $$ = FILE_TYPE_KEYMAP; }
260 XkbMapConfigList : XkbMapConfigList XkbMapConfig
265 $$ = (XkbFile *) AppendStmt((ParseCommon *) $1,
272 XkbMapConfig : OptFlags FileType OptMapName OBRACE
276 if ($2 == FILE_TYPE_GEOMETRY) {
282 $$ = XkbFileCreate($2, $3, $5, $1);
287 FileType : XKB_KEYCODES { $$ = FILE_TYPE_KEYCODES; }
288 | XKB_TYPES { $$ = FILE_TYPE_TYPES; }
289 | XKB_COMPATMAP { $$ = FILE_TYPE_COMPAT; }
290 | XKB_SYMBOLS { $$ = FILE_TYPE_SYMBOLS; }
291 | XKB_GEOMETRY { $$ = FILE_TYPE_GEOMETRY; }
294 OptFlags : Flags { $$ = $1; }
298 Flags : Flags Flag { $$ = ($1 | $2); }
302 Flag : PARTIAL { $$ = MAP_IS_PARTIAL; }
303 | DEFAULT { $$ = MAP_IS_DEFAULT; }
304 | HIDDEN { $$ = MAP_IS_HIDDEN; }
305 | ALPHANUMERIC_KEYS { $$ = MAP_HAS_ALPHANUMERIC; }
306 | MODIFIER_KEYS { $$ = MAP_HAS_MODIFIER; }
307 | KEYPAD_KEYS { $$ = MAP_HAS_KEYPAD; }
308 | FUNCTION_KEYS { $$ = MAP_HAS_FN; }
309 | ALTERNATE_GROUP { $$ = MAP_IS_ALTGR; }
312 DeclList : DeclList Decl
313 { $$ = AppendStmt($1, $2); }
317 Decl : OptMergeMode VarDecl
320 $$ = (ParseCommon *) $2;
322 | OptMergeMode VModDecl
325 $$ = (ParseCommon *) $2;
327 | OptMergeMode InterpretDecl
330 $$ = (ParseCommon *) $2;
332 | OptMergeMode KeyNameDecl
335 $$ = (ParseCommon *) $2;
337 | OptMergeMode KeyAliasDecl
340 $$ = (ParseCommon *) $2;
342 | OptMergeMode KeyTypeDecl
345 $$ = (ParseCommon *) $2;
347 | OptMergeMode SymbolsDecl
350 $$ = (ParseCommon *) $2;
352 | OptMergeMode ModMapDecl
355 $$ = (ParseCommon *) $2;
357 | OptMergeMode GroupCompatDecl
360 $$ = (ParseCommon *) $2;
362 | OptMergeMode LedMapDecl
365 $$ = (ParseCommon *) $2;
367 | OptMergeMode LedNameDecl
370 $$ = (ParseCommon *) $2;
372 | OptMergeMode ShapeDecl { $$ = NULL; }
373 | OptMergeMode SectionDecl { $$ = NULL; }
374 | OptMergeMode DoodadDecl { $$ = NULL; }
377 $$ = (ParseCommon *) IncludeCreate(param->ctx, $2, $1);
382 VarDecl : Lhs EQUALS Expr SEMI
383 { $$ = VarCreate($1, $3); }
385 { $$ = BoolVarCreate($1, true); }
387 { $$ = BoolVarCreate($2, false); }
390 KeyNameDecl : KEYNAME EQUALS KeyCode SEMI
391 { $$ = KeycodeCreate($1, $3); }
394 KeyAliasDecl : ALIAS KEYNAME EQUALS KEYNAME SEMI
395 { $$ = KeyAliasCreate($2, $4); }
398 VModDecl : VIRTUAL_MODS VModDefList SEMI
402 VModDefList : VModDefList COMMA VModDef
403 { $$ = (VModDef *) AppendStmt((ParseCommon *) $1,
404 (ParseCommon *) $3); }
410 { $$ = VModCreate($1, NULL); }
412 { $$ = VModCreate($1, $3); }
415 InterpretDecl : INTERPRET InterpretMatch OBRACE
418 { $2->def = $4; $$ = $2; }
421 InterpretMatch : KeySym PLUS Expr
422 { $$ = InterpCreate($1, $3); }
424 { $$ = InterpCreate($1, NULL); }
427 VarDeclList : VarDeclList VarDecl
428 { $$ = (VarDef *) AppendStmt((ParseCommon *) $1,
429 (ParseCommon *) $2); }
434 KeyTypeDecl : TYPE String OBRACE
437 { $$ = KeyTypeCreate($2, $4); }
440 SymbolsDecl : KEY KEYNAME OBRACE
443 { $$ = SymbolsCreate($2, $4); }
446 SymbolsBody : SymbolsBody COMMA SymbolsVarDecl
447 { $$ = (VarDef *) AppendStmt((ParseCommon *) $1,
448 (ParseCommon *) $3); }
454 SymbolsVarDecl : Lhs EQUALS Expr { $$ = VarCreate($1, $3); }
455 | Lhs EQUALS ArrayInit { $$ = VarCreate($1, $3); }
456 | Ident { $$ = BoolVarCreate($1, true); }
457 | EXCLAM Ident { $$ = BoolVarCreate($2, false); }
458 | ArrayInit { $$ = VarCreate(NULL, $1); }
461 ArrayInit : OBRACKET OptKeySymList CBRACKET
463 | OBRACKET ActionList CBRACKET
464 { $$ = ExprCreateUnary(EXPR_ACTION_LIST, EXPR_TYPE_ACTION, $2); }
467 GroupCompatDecl : GROUP Integer EQUALS Expr SEMI
468 { $$ = GroupCompatCreate($2, $4); }
471 ModMapDecl : MODIFIER_MAP Ident OBRACE ExprList CBRACE SEMI
472 { $$ = ModMapCreate($2, $4); }
475 LedMapDecl: INDICATOR String OBRACE VarDeclList CBRACE SEMI
476 { $$ = LedMapCreate($2, $4); }
479 LedNameDecl: INDICATOR Integer EQUALS Expr SEMI
480 { $$ = LedNameCreate($2, $4, false); }
481 | VIRTUAL INDICATOR Integer EQUALS Expr SEMI
482 { $$ = LedNameCreate($3, $5, true); }
485 ShapeDecl : SHAPE String OBRACE OutlineList CBRACE SEMI
487 | SHAPE String OBRACE CoordList CBRACE SEMI
488 { (void) $4; $$ = NULL; }
491 SectionDecl : SECTION String OBRACE SectionBody CBRACE SEMI
495 SectionBody : SectionBody SectionBodyItem { $$ = NULL;}
496 | SectionBodyItem { $$ = NULL; }
499 SectionBodyItem : ROW OBRACE RowBody CBRACE SEMI
502 { FreeStmt((ParseCommon *) $1); $$ = NULL; }
506 { FreeStmt((ParseCommon *) $1); $$ = NULL; }
511 RowBody : RowBody RowBodyItem { $$ = NULL;}
512 | RowBodyItem { $$ = NULL; }
515 RowBodyItem : KEYS OBRACE Keys CBRACE SEMI { $$ = NULL; }
517 { FreeStmt((ParseCommon *) $1); $$ = NULL; }
520 Keys : Keys COMMA Key { $$ = NULL; }
526 | OBRACE ExprList CBRACE
527 { FreeStmt((ParseCommon *) $2); $$ = NULL; }
530 OverlayDecl : OVERLAY String OBRACE OverlayKeyList CBRACE SEMI
534 OverlayKeyList : OverlayKeyList COMMA OverlayKey { $$ = NULL; }
535 | OverlayKey { $$ = NULL; }
538 OverlayKey : KEYNAME EQUALS KEYNAME { $$ = NULL; }
541 OutlineList : OutlineList COMMA OutlineInList
547 OutlineInList : OBRACE CoordList CBRACE
548 { (void) $2; $$ = NULL; }
549 | Ident EQUALS OBRACE CoordList CBRACE
550 { (void) $4; $$ = NULL; }
552 { FreeStmt((ParseCommon *) $3); $$ = NULL; }
555 CoordList : CoordList COMMA Coord
556 { (void) $1; (void) $3; $$ = NULL; }
558 { (void) $1; $$ = NULL; }
561 Coord : OBRACKET SignedNumber COMMA SignedNumber CBRACKET
565 DoodadDecl : DoodadType String OBRACE VarDeclList CBRACE SEMI
566 { FreeStmt((ParseCommon *) $4); $$ = NULL; }
569 DoodadType : TEXT { $$ = 0; }
570 | OUTLINE { $$ = 0; }
575 FieldSpec : Ident { $$ = $1; }
576 | Element { $$ = $1; }
580 { $$ = xkb_atom_intern_literal(param->ctx, "action"); }
582 { $$ = xkb_atom_intern_literal(param->ctx, "interpret"); }
584 { $$ = xkb_atom_intern_literal(param->ctx, "type"); }
586 { $$ = xkb_atom_intern_literal(param->ctx, "key"); }
588 { $$ = xkb_atom_intern_literal(param->ctx, "group"); }
590 {$$ = xkb_atom_intern_literal(param->ctx, "modifier_map");}
592 { $$ = xkb_atom_intern_literal(param->ctx, "indicator"); }
594 { $$ = XKB_ATOM_NONE; }
596 { $$ = XKB_ATOM_NONE; }
598 { $$ = XKB_ATOM_NONE; }
600 { $$ = XKB_ATOM_NONE; }
603 OptMergeMode : MergeMode { $$ = $1; }
604 | { $$ = MERGE_DEFAULT; }
607 MergeMode : INCLUDE { $$ = MERGE_DEFAULT; }
608 | AUGMENT { $$ = MERGE_AUGMENT; }
609 | OVERRIDE { $$ = MERGE_OVERRIDE; }
610 | REPLACE { $$ = MERGE_REPLACE; }
614 * This used to be MERGE_ALT_FORM. This functionality was
615 * unused and has been removed.
621 OptExprList : ExprList { $$ = $1; }
625 ExprList : ExprList COMMA Expr
626 { $$ = (ExprDef *) AppendStmt((ParseCommon *) $1,
627 (ParseCommon *) $3); }
632 Expr : Expr DIVIDE Expr
633 { $$ = ExprCreateBinary(EXPR_DIVIDE, $1, $3); }
635 { $$ = ExprCreateBinary(EXPR_ADD, $1, $3); }
637 { $$ = ExprCreateBinary(EXPR_SUBTRACT, $1, $3); }
639 { $$ = ExprCreateBinary(EXPR_MULTIPLY, $1, $3); }
641 { $$ = ExprCreateBinary(EXPR_ASSIGN, $1, $3); }
647 { $$ = ExprCreateUnary(EXPR_NEGATE, $2->expr.value_type, $2); }
649 { $$ = ExprCreateUnary(EXPR_UNARY_PLUS, $2->expr.value_type, $2); }
651 { $$ = ExprCreateUnary(EXPR_NOT, EXPR_TYPE_BOOLEAN, $2); }
653 { $$ = ExprCreateUnary(EXPR_INVERT, $2->expr.value_type, $2); }
656 | FieldSpec OPAREN OptExprList CPAREN %prec OPAREN
657 { $$ = ExprCreateAction($1, $3); }
664 ActionList : ActionList COMMA Action
665 { $$ = (ExprDef *) AppendStmt((ParseCommon *) $1,
666 (ParseCommon *) $3); }
671 Action : FieldSpec OPAREN OptExprList CPAREN
672 { $$ = ExprCreateAction($1, $3); }
676 { $$ = ExprCreateIdent($1); }
677 | FieldSpec DOT FieldSpec
678 { $$ = ExprCreateFieldRef($1, $3); }
679 | FieldSpec OBRACKET Expr CBRACKET
680 { $$ = ExprCreateArrayRef(XKB_ATOM_NONE, $1, $3); }
681 | FieldSpec DOT FieldSpec OBRACKET Expr CBRACKET
682 { $$ = ExprCreateArrayRef($1, $3, $5); }
686 { $$ = ExprCreateString($1); }
688 { $$ = ExprCreateInteger($1); }
692 { $$ = ExprCreateKeyName($1); }
695 OptKeySymList : KeySymList { $$ = $1; }
699 KeySymList : KeySymList COMMA KeySym
700 { $$ = ExprAppendKeysymList($1, $3); }
701 | KeySymList COMMA KeySyms
702 { $$ = ExprAppendMultiKeysymList($1, $3); }
704 { $$ = ExprCreateKeysymList($1); }
706 { $$ = ExprCreateMultiKeysymList($1); }
709 KeySyms : OBRACE KeySymList CBRACE
715 if (!resolve_keysym($1, &$$))
716 parser_warn(param, "unrecognized keysym \"%s\"", $1);
719 | SECTION { $$ = XKB_KEY_section; }
723 parser_warn(param, "unrecognized keysym \"%d\"", $1);
724 $$ = XKB_KEY_NoSymbol;
726 else if ($1 < 10) { /* XKB_KEY_0 .. XKB_KEY_9 */
727 $$ = XKB_KEY_0 + (xkb_keysym_t) $1;
731 snprintf(buf, sizeof(buf), "0x%x", $1);
732 if (!resolve_keysym(buf, &$$)) {
733 parser_warn(param, "unrecognized keysym \"%s\"", buf);
734 $$ = XKB_KEY_NoSymbol;
740 SignedNumber : MINUS Number { $$ = -$2; }
741 | Number { $$ = $1; }
744 Number : FLOAT { $$ = $1; }
745 | INTEGER { $$ = $1; }
748 Float : FLOAT { $$ = 0; }
751 Integer : INTEGER { $$ = $1; }
754 KeyCode : INTEGER { $$ = $1; }
757 Ident : IDENT { $$ = xkb_atom_steal(param->ctx, $1); }
758 | DEFAULT { $$ = xkb_atom_intern_literal(param->ctx, "default"); }
761 String : STRING { $$ = xkb_atom_steal(param->ctx, $1); }
764 OptMapName : MapName { $$ = $1; }
768 MapName : STRING { $$ = $1; }
774 parse(struct xkb_context *ctx, struct scanner *scanner, const char *map)
777 XkbFile *first = NULL;
778 struct parser_param param = {
785 * If we got a specific map, we look for it exclusively and return
786 * immediately upon finding it. Otherwise, we need to get the
787 * default map. If we find a map marked as default, we return it
788 * immediately. If there are no maps marked as default, we return
789 * the first map in the file.
792 while ((ret = yyparse(¶m)) == 0 && param.more_maps) {
794 if (streq_not_null(map, param.rtrn->name))
797 FreeXkbFile(param.rtrn);
800 if (param.rtrn->flags & MAP_IS_DEFAULT) {
808 FreeXkbFile(param.rtrn);
821 "No map in include statement, but \"%s\" contains several; "
822 "Using first defined map, \"%s\"\n",
823 scanner->file_name, first->name);