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/xkbcomp-priv.h"
35 #include "xkbcomp/ast-build.h"
36 #include "xkbcomp/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 = !!param->rtrn; }
244 { $$ = param->rtrn = $1; param->more_maps = !!param->rtrn; 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 $$ = XkbFileCreate($2, $3, $5, $1);
280 FileType : XKB_KEYCODES { $$ = FILE_TYPE_KEYCODES; }
281 | XKB_TYPES { $$ = FILE_TYPE_TYPES; }
282 | XKB_COMPATMAP { $$ = FILE_TYPE_COMPAT; }
283 | XKB_SYMBOLS { $$ = FILE_TYPE_SYMBOLS; }
284 | XKB_GEOMETRY { $$ = FILE_TYPE_GEOMETRY; }
287 OptFlags : Flags { $$ = $1; }
291 Flags : Flags Flag { $$ = ($1 | $2); }
295 Flag : PARTIAL { $$ = MAP_IS_PARTIAL; }
296 | DEFAULT { $$ = MAP_IS_DEFAULT; }
297 | HIDDEN { $$ = MAP_IS_HIDDEN; }
298 | ALPHANUMERIC_KEYS { $$ = MAP_HAS_ALPHANUMERIC; }
299 | MODIFIER_KEYS { $$ = MAP_HAS_MODIFIER; }
300 | KEYPAD_KEYS { $$ = MAP_HAS_KEYPAD; }
301 | FUNCTION_KEYS { $$ = MAP_HAS_FN; }
302 | ALTERNATE_GROUP { $$ = MAP_IS_ALTGR; }
305 DeclList : DeclList Decl
306 { $$ = AppendStmt($1, $2); }
310 Decl : OptMergeMode VarDecl
313 $$ = (ParseCommon *) $2;
315 | OptMergeMode VModDecl
317 for (VModDef *vmod = $2; vmod; vmod = (VModDef *) vmod->common.next)
319 $$ = (ParseCommon *) $2;
321 | OptMergeMode InterpretDecl
324 $$ = (ParseCommon *) $2;
326 | OptMergeMode KeyNameDecl
329 $$ = (ParseCommon *) $2;
331 | OptMergeMode KeyAliasDecl
334 $$ = (ParseCommon *) $2;
336 | OptMergeMode KeyTypeDecl
339 $$ = (ParseCommon *) $2;
341 | OptMergeMode SymbolsDecl
344 $$ = (ParseCommon *) $2;
346 | OptMergeMode ModMapDecl
349 $$ = (ParseCommon *) $2;
351 | OptMergeMode GroupCompatDecl
354 $$ = (ParseCommon *) $2;
356 | OptMergeMode LedMapDecl
359 $$ = (ParseCommon *) $2;
361 | OptMergeMode LedNameDecl
364 $$ = (ParseCommon *) $2;
366 | OptMergeMode ShapeDecl { $$ = NULL; }
367 | OptMergeMode SectionDecl { $$ = NULL; }
368 | OptMergeMode DoodadDecl { $$ = NULL; }
371 $$ = (ParseCommon *) IncludeCreate(param->ctx, $2, $1);
376 VarDecl : Lhs EQUALS Expr SEMI
377 { $$ = VarCreate($1, $3); }
379 { $$ = BoolVarCreate($1, true); }
381 { $$ = BoolVarCreate($2, false); }
384 KeyNameDecl : KEYNAME EQUALS KeyCode SEMI
385 { $$ = KeycodeCreate($1, $3); }
388 KeyAliasDecl : ALIAS KEYNAME EQUALS KEYNAME SEMI
389 { $$ = KeyAliasCreate($2, $4); }
392 VModDecl : VIRTUAL_MODS VModDefList SEMI
396 VModDefList : VModDefList COMMA VModDef
397 { $$ = (VModDef *) AppendStmt((ParseCommon *) $1,
398 (ParseCommon *) $3); }
404 { $$ = VModCreate($1, NULL); }
406 { $$ = VModCreate($1, $3); }
409 InterpretDecl : INTERPRET InterpretMatch OBRACE
412 { $2->def = $4; $$ = $2; }
415 InterpretMatch : KeySym PLUS Expr
416 { $$ = InterpCreate($1, $3); }
418 { $$ = InterpCreate($1, NULL); }
421 VarDeclList : VarDeclList VarDecl
422 { $$ = (VarDef *) AppendStmt((ParseCommon *) $1,
423 (ParseCommon *) $2); }
428 KeyTypeDecl : TYPE String OBRACE
431 { $$ = KeyTypeCreate($2, $4); }
434 SymbolsDecl : KEY KEYNAME OBRACE
437 { $$ = SymbolsCreate($2, $4); }
440 SymbolsBody : SymbolsBody COMMA SymbolsVarDecl
441 { $$ = (VarDef *) AppendStmt((ParseCommon *) $1,
442 (ParseCommon *) $3); }
448 SymbolsVarDecl : Lhs EQUALS Expr { $$ = VarCreate($1, $3); }
449 | Lhs EQUALS ArrayInit { $$ = VarCreate($1, $3); }
450 | Ident { $$ = BoolVarCreate($1, true); }
451 | EXCLAM Ident { $$ = BoolVarCreate($2, false); }
452 | ArrayInit { $$ = VarCreate(NULL, $1); }
455 ArrayInit : OBRACKET OptKeySymList CBRACKET
457 | OBRACKET ActionList CBRACKET
458 { $$ = ExprCreateActionList($2); }
461 GroupCompatDecl : GROUP Integer EQUALS Expr SEMI
462 { $$ = GroupCompatCreate($2, $4); }
465 ModMapDecl : MODIFIER_MAP Ident OBRACE ExprList CBRACE SEMI
466 { $$ = ModMapCreate($2, $4); }
469 LedMapDecl: INDICATOR String OBRACE VarDeclList CBRACE SEMI
470 { $$ = LedMapCreate($2, $4); }
473 LedNameDecl: INDICATOR Integer EQUALS Expr SEMI
474 { $$ = LedNameCreate($2, $4, false); }
475 | VIRTUAL INDICATOR Integer EQUALS Expr SEMI
476 { $$ = LedNameCreate($3, $5, true); }
479 ShapeDecl : SHAPE String OBRACE OutlineList CBRACE SEMI
481 | SHAPE String OBRACE CoordList CBRACE SEMI
482 { (void) $4; $$ = NULL; }
485 SectionDecl : SECTION String OBRACE SectionBody CBRACE SEMI
489 SectionBody : SectionBody SectionBodyItem { $$ = NULL;}
490 | SectionBodyItem { $$ = NULL; }
493 SectionBodyItem : ROW OBRACE RowBody CBRACE SEMI
496 { FreeStmt((ParseCommon *) $1); $$ = NULL; }
500 { FreeStmt((ParseCommon *) $1); $$ = NULL; }
505 RowBody : RowBody RowBodyItem { $$ = NULL;}
506 | RowBodyItem { $$ = NULL; }
509 RowBodyItem : KEYS OBRACE Keys CBRACE SEMI { $$ = NULL; }
511 { FreeStmt((ParseCommon *) $1); $$ = NULL; }
514 Keys : Keys COMMA Key { $$ = NULL; }
520 | OBRACE ExprList CBRACE
521 { FreeStmt((ParseCommon *) $2); $$ = NULL; }
524 OverlayDecl : OVERLAY String OBRACE OverlayKeyList CBRACE SEMI
528 OverlayKeyList : OverlayKeyList COMMA OverlayKey { $$ = NULL; }
529 | OverlayKey { $$ = NULL; }
532 OverlayKey : KEYNAME EQUALS KEYNAME { $$ = NULL; }
535 OutlineList : OutlineList COMMA OutlineInList
541 OutlineInList : OBRACE CoordList CBRACE
542 { (void) $2; $$ = NULL; }
543 | Ident EQUALS OBRACE CoordList CBRACE
544 { (void) $4; $$ = NULL; }
546 { FreeStmt((ParseCommon *) $3); $$ = NULL; }
549 CoordList : CoordList COMMA Coord
550 { (void) $1; (void) $3; $$ = NULL; }
552 { (void) $1; $$ = NULL; }
555 Coord : OBRACKET SignedNumber COMMA SignedNumber CBRACKET
559 DoodadDecl : DoodadType String OBRACE VarDeclList CBRACE SEMI
560 { FreeStmt((ParseCommon *) $4); $$ = NULL; }
563 DoodadType : TEXT { $$ = 0; }
564 | OUTLINE { $$ = 0; }
569 FieldSpec : Ident { $$ = $1; }
570 | Element { $$ = $1; }
574 { $$ = xkb_atom_intern_literal(param->ctx, "action"); }
576 { $$ = xkb_atom_intern_literal(param->ctx, "interpret"); }
578 { $$ = xkb_atom_intern_literal(param->ctx, "type"); }
580 { $$ = xkb_atom_intern_literal(param->ctx, "key"); }
582 { $$ = xkb_atom_intern_literal(param->ctx, "group"); }
584 {$$ = xkb_atom_intern_literal(param->ctx, "modifier_map");}
586 { $$ = xkb_atom_intern_literal(param->ctx, "indicator"); }
588 { $$ = xkb_atom_intern_literal(param->ctx, "shape"); }
590 { $$ = xkb_atom_intern_literal(param->ctx, "row"); }
592 { $$ = xkb_atom_intern_literal(param->ctx, "section"); }
594 { $$ = xkb_atom_intern_literal(param->ctx, "text"); }
597 OptMergeMode : MergeMode { $$ = $1; }
598 | { $$ = MERGE_DEFAULT; }
601 MergeMode : INCLUDE { $$ = MERGE_DEFAULT; }
602 | AUGMENT { $$ = MERGE_AUGMENT; }
603 | OVERRIDE { $$ = MERGE_OVERRIDE; }
604 | REPLACE { $$ = MERGE_REPLACE; }
608 * This used to be MERGE_ALT_FORM. This functionality was
609 * unused and has been removed.
615 OptExprList : ExprList { $$ = $1; }
619 ExprList : ExprList COMMA Expr
620 { $$ = (ExprDef *) AppendStmt((ParseCommon *) $1,
621 (ParseCommon *) $3); }
626 Expr : Expr DIVIDE Expr
627 { $$ = ExprCreateBinary(EXPR_DIVIDE, $1, $3); }
629 { $$ = ExprCreateBinary(EXPR_ADD, $1, $3); }
631 { $$ = ExprCreateBinary(EXPR_SUBTRACT, $1, $3); }
633 { $$ = ExprCreateBinary(EXPR_MULTIPLY, $1, $3); }
635 { $$ = ExprCreateBinary(EXPR_ASSIGN, $1, $3); }
641 { $$ = ExprCreateUnary(EXPR_NEGATE, $2->expr.value_type, $2); }
643 { $$ = ExprCreateUnary(EXPR_UNARY_PLUS, $2->expr.value_type, $2); }
645 { $$ = ExprCreateUnary(EXPR_NOT, EXPR_TYPE_BOOLEAN, $2); }
647 { $$ = ExprCreateUnary(EXPR_INVERT, $2->expr.value_type, $2); }
650 | FieldSpec OPAREN OptExprList CPAREN %prec OPAREN
651 { $$ = ExprCreateAction($1, $3); }
658 ActionList : ActionList COMMA Action
659 { $$ = (ExprDef *) AppendStmt((ParseCommon *) $1,
660 (ParseCommon *) $3); }
665 Action : FieldSpec OPAREN OptExprList CPAREN
666 { $$ = ExprCreateAction($1, $3); }
670 { $$ = ExprCreateIdent($1); }
671 | FieldSpec DOT FieldSpec
672 { $$ = ExprCreateFieldRef($1, $3); }
673 | FieldSpec OBRACKET Expr CBRACKET
674 { $$ = ExprCreateArrayRef(XKB_ATOM_NONE, $1, $3); }
675 | FieldSpec DOT FieldSpec OBRACKET Expr CBRACKET
676 { $$ = ExprCreateArrayRef($1, $3, $5); }
680 { $$ = ExprCreateString($1); }
682 { $$ = ExprCreateInteger($1); }
684 { $$ = ExprCreateFloat(/* Discard $1 */); }
686 { $$ = ExprCreateKeyName($1); }
689 OptKeySymList : KeySymList { $$ = $1; }
693 KeySymList : KeySymList COMMA KeySym
694 { $$ = ExprAppendKeysymList($1, $3); }
695 | KeySymList COMMA KeySyms
696 { $$ = ExprAppendMultiKeysymList($1, $3); }
698 { $$ = ExprCreateKeysymList($1); }
700 { $$ = ExprCreateMultiKeysymList($1); }
703 KeySyms : OBRACE KeySymList CBRACE
709 if (!resolve_keysym($1, &$$))
710 parser_warn(param, "unrecognized keysym \"%s\"", $1);
713 | SECTION { $$ = XKB_KEY_section; }
717 parser_warn(param, "unrecognized keysym \"%d\"", $1);
718 $$ = XKB_KEY_NoSymbol;
720 else if ($1 < 10) { /* XKB_KEY_0 .. XKB_KEY_9 */
721 $$ = XKB_KEY_0 + (xkb_keysym_t) $1;
725 snprintf(buf, sizeof(buf), "0x%x", $1);
726 if (!resolve_keysym(buf, &$$)) {
727 parser_warn(param, "unrecognized keysym \"%s\"", buf);
728 $$ = XKB_KEY_NoSymbol;
734 SignedNumber : MINUS Number { $$ = -$2; }
735 | Number { $$ = $1; }
738 Number : FLOAT { $$ = $1; }
739 | INTEGER { $$ = $1; }
742 Float : FLOAT { $$ = 0; }
745 Integer : INTEGER { $$ = $1; }
748 KeyCode : INTEGER { $$ = $1; }
751 Ident : IDENT { $$ = xkb_atom_intern(param->ctx, $1, strlen($1)); free($1); }
752 | DEFAULT { $$ = xkb_atom_intern_literal(param->ctx, "default"); }
755 String : STRING { $$ = xkb_atom_intern(param->ctx, $1, strlen($1)); free($1); }
758 OptMapName : MapName { $$ = $1; }
762 MapName : STRING { $$ = $1; }
768 parse(struct xkb_context *ctx, struct scanner *scanner, const char *map)
771 XkbFile *first = NULL;
772 struct parser_param param = {
780 * If we got a specific map, we look for it exclusively and return
781 * immediately upon finding it. Otherwise, we need to get the
782 * default map. If we find a map marked as default, we return it
783 * immediately. If there are no maps marked as default, we return
784 * the first map in the file.
787 while ((ret = yyparse(¶m)) == 0 && param.more_maps) {
789 if (streq_not_null(map, param.rtrn->name))
792 FreeXkbFile(param.rtrn);
795 if (param.rtrn->flags & MAP_IS_DEFAULT) {
803 FreeXkbFile(param.rtrn);
816 "No map in include statement, but \"%s\" contains several; "
817 "Using first defined map, \"%s\"\n",
818 scanner->file_name, first->name);