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 = 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 $$ = 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
318 $$ = (ParseCommon *) $2;
320 | OptMergeMode InterpretDecl
323 $$ = (ParseCommon *) $2;
325 | OptMergeMode KeyNameDecl
328 $$ = (ParseCommon *) $2;
330 | OptMergeMode KeyAliasDecl
333 $$ = (ParseCommon *) $2;
335 | OptMergeMode KeyTypeDecl
338 $$ = (ParseCommon *) $2;
340 | OptMergeMode SymbolsDecl
343 $$ = (ParseCommon *) $2;
345 | OptMergeMode ModMapDecl
348 $$ = (ParseCommon *) $2;
350 | OptMergeMode GroupCompatDecl
353 $$ = (ParseCommon *) $2;
355 | OptMergeMode LedMapDecl
358 $$ = (ParseCommon *) $2;
360 | OptMergeMode LedNameDecl
363 $$ = (ParseCommon *) $2;
365 | OptMergeMode ShapeDecl { $$ = NULL; }
366 | OptMergeMode SectionDecl { $$ = NULL; }
367 | OptMergeMode DoodadDecl { $$ = NULL; }
370 $$ = (ParseCommon *) IncludeCreate(param->ctx, $2, $1);
375 VarDecl : Lhs EQUALS Expr SEMI
376 { $$ = VarCreate($1, $3); }
378 { $$ = BoolVarCreate($1, true); }
380 { $$ = BoolVarCreate($2, false); }
383 KeyNameDecl : KEYNAME EQUALS KeyCode SEMI
384 { $$ = KeycodeCreate($1, $3); }
387 KeyAliasDecl : ALIAS KEYNAME EQUALS KEYNAME SEMI
388 { $$ = KeyAliasCreate($2, $4); }
391 VModDecl : VIRTUAL_MODS VModDefList SEMI
395 VModDefList : VModDefList COMMA VModDef
396 { $$ = (VModDef *) AppendStmt((ParseCommon *) $1,
397 (ParseCommon *) $3); }
403 { $$ = VModCreate($1, NULL); }
405 { $$ = VModCreate($1, $3); }
408 InterpretDecl : INTERPRET InterpretMatch OBRACE
411 { $2->def = $4; $$ = $2; }
414 InterpretMatch : KeySym PLUS Expr
415 { $$ = InterpCreate($1, $3); }
417 { $$ = InterpCreate($1, NULL); }
420 VarDeclList : VarDeclList VarDecl
421 { $$ = (VarDef *) AppendStmt((ParseCommon *) $1,
422 (ParseCommon *) $2); }
427 KeyTypeDecl : TYPE String OBRACE
430 { $$ = KeyTypeCreate($2, $4); }
433 SymbolsDecl : KEY KEYNAME OBRACE
436 { $$ = SymbolsCreate($2, $4); }
439 SymbolsBody : SymbolsBody COMMA SymbolsVarDecl
440 { $$ = (VarDef *) AppendStmt((ParseCommon *) $1,
441 (ParseCommon *) $3); }
447 SymbolsVarDecl : Lhs EQUALS Expr { $$ = VarCreate($1, $3); }
448 | Lhs EQUALS ArrayInit { $$ = VarCreate($1, $3); }
449 | Ident { $$ = BoolVarCreate($1, true); }
450 | EXCLAM Ident { $$ = BoolVarCreate($2, false); }
451 | ArrayInit { $$ = VarCreate(NULL, $1); }
454 ArrayInit : OBRACKET OptKeySymList CBRACKET
456 | OBRACKET ActionList CBRACKET
457 { $$ = ExprCreateUnary(EXPR_ACTION_LIST, EXPR_TYPE_ACTION, $2); }
460 GroupCompatDecl : GROUP Integer EQUALS Expr SEMI
461 { $$ = GroupCompatCreate($2, $4); }
464 ModMapDecl : MODIFIER_MAP Ident OBRACE ExprList CBRACE SEMI
465 { $$ = ModMapCreate($2, $4); }
468 LedMapDecl: INDICATOR String OBRACE VarDeclList CBRACE SEMI
469 { $$ = LedMapCreate($2, $4); }
472 LedNameDecl: INDICATOR Integer EQUALS Expr SEMI
473 { $$ = LedNameCreate($2, $4, false); }
474 | VIRTUAL INDICATOR Integer EQUALS Expr SEMI
475 { $$ = LedNameCreate($3, $5, true); }
478 ShapeDecl : SHAPE String OBRACE OutlineList CBRACE SEMI
480 | SHAPE String OBRACE CoordList CBRACE SEMI
481 { (void) $4; $$ = NULL; }
484 SectionDecl : SECTION String OBRACE SectionBody CBRACE SEMI
488 SectionBody : SectionBody SectionBodyItem { $$ = NULL;}
489 | SectionBodyItem { $$ = NULL; }
492 SectionBodyItem : ROW OBRACE RowBody CBRACE SEMI
495 { FreeStmt((ParseCommon *) $1); $$ = NULL; }
499 { FreeStmt((ParseCommon *) $1); $$ = NULL; }
504 RowBody : RowBody RowBodyItem { $$ = NULL;}
505 | RowBodyItem { $$ = NULL; }
508 RowBodyItem : KEYS OBRACE Keys CBRACE SEMI { $$ = NULL; }
510 { FreeStmt((ParseCommon *) $1); $$ = NULL; }
513 Keys : Keys COMMA Key { $$ = NULL; }
519 | OBRACE ExprList CBRACE
520 { FreeStmt((ParseCommon *) $2); $$ = NULL; }
523 OverlayDecl : OVERLAY String OBRACE OverlayKeyList CBRACE SEMI
527 OverlayKeyList : OverlayKeyList COMMA OverlayKey { $$ = NULL; }
528 | OverlayKey { $$ = NULL; }
531 OverlayKey : KEYNAME EQUALS KEYNAME { $$ = NULL; }
534 OutlineList : OutlineList COMMA OutlineInList
540 OutlineInList : OBRACE CoordList CBRACE
541 { (void) $2; $$ = NULL; }
542 | Ident EQUALS OBRACE CoordList CBRACE
543 { (void) $4; $$ = NULL; }
545 { FreeStmt((ParseCommon *) $3); $$ = NULL; }
548 CoordList : CoordList COMMA Coord
549 { (void) $1; (void) $3; $$ = NULL; }
551 { (void) $1; $$ = NULL; }
554 Coord : OBRACKET SignedNumber COMMA SignedNumber CBRACKET
558 DoodadDecl : DoodadType String OBRACE VarDeclList CBRACE SEMI
559 { FreeStmt((ParseCommon *) $4); $$ = NULL; }
562 DoodadType : TEXT { $$ = 0; }
563 | OUTLINE { $$ = 0; }
568 FieldSpec : Ident { $$ = $1; }
569 | Element { $$ = $1; }
573 { $$ = xkb_atom_intern_literal(param->ctx, "action"); }
575 { $$ = xkb_atom_intern_literal(param->ctx, "interpret"); }
577 { $$ = xkb_atom_intern_literal(param->ctx, "type"); }
579 { $$ = xkb_atom_intern_literal(param->ctx, "key"); }
581 { $$ = xkb_atom_intern_literal(param->ctx, "group"); }
583 {$$ = xkb_atom_intern_literal(param->ctx, "modifier_map");}
585 { $$ = xkb_atom_intern_literal(param->ctx, "indicator"); }
587 { $$ = xkb_atom_intern_literal(param->ctx, "shape"); }
589 { $$ = xkb_atom_intern_literal(param->ctx, "row"); }
591 { $$ = xkb_atom_intern_literal(param->ctx, "section"); }
593 { $$ = xkb_atom_intern_literal(param->ctx, "text"); }
596 OptMergeMode : MergeMode { $$ = $1; }
597 | { $$ = MERGE_DEFAULT; }
600 MergeMode : INCLUDE { $$ = MERGE_DEFAULT; }
601 | AUGMENT { $$ = MERGE_AUGMENT; }
602 | OVERRIDE { $$ = MERGE_OVERRIDE; }
603 | REPLACE { $$ = MERGE_REPLACE; }
607 * This used to be MERGE_ALT_FORM. This functionality was
608 * unused and has been removed.
614 OptExprList : ExprList { $$ = $1; }
618 ExprList : ExprList COMMA Expr
619 { $$ = (ExprDef *) AppendStmt((ParseCommon *) $1,
620 (ParseCommon *) $3); }
625 Expr : Expr DIVIDE Expr
626 { $$ = ExprCreateBinary(EXPR_DIVIDE, $1, $3); }
628 { $$ = ExprCreateBinary(EXPR_ADD, $1, $3); }
630 { $$ = ExprCreateBinary(EXPR_SUBTRACT, $1, $3); }
632 { $$ = ExprCreateBinary(EXPR_MULTIPLY, $1, $3); }
634 { $$ = ExprCreateBinary(EXPR_ASSIGN, $1, $3); }
640 { $$ = ExprCreateUnary(EXPR_NEGATE, $2->expr.value_type, $2); }
642 { $$ = ExprCreateUnary(EXPR_UNARY_PLUS, $2->expr.value_type, $2); }
644 { $$ = ExprCreateUnary(EXPR_NOT, EXPR_TYPE_BOOLEAN, $2); }
646 { $$ = ExprCreateUnary(EXPR_INVERT, $2->expr.value_type, $2); }
649 | FieldSpec OPAREN OptExprList CPAREN %prec OPAREN
650 { $$ = ExprCreateAction($1, $3); }
657 ActionList : ActionList COMMA Action
658 { $$ = (ExprDef *) AppendStmt((ParseCommon *) $1,
659 (ParseCommon *) $3); }
664 Action : FieldSpec OPAREN OptExprList CPAREN
665 { $$ = ExprCreateAction($1, $3); }
669 { $$ = ExprCreateIdent($1); }
670 | FieldSpec DOT FieldSpec
671 { $$ = ExprCreateFieldRef($1, $3); }
672 | FieldSpec OBRACKET Expr CBRACKET
673 { $$ = ExprCreateArrayRef(XKB_ATOM_NONE, $1, $3); }
674 | FieldSpec DOT FieldSpec OBRACKET Expr CBRACKET
675 { $$ = ExprCreateArrayRef($1, $3, $5); }
679 { $$ = ExprCreateString($1); }
681 { $$ = ExprCreateInteger($1); }
683 { $$ = ExprCreateFloat(/* Discard $1 */); }
685 { $$ = ExprCreateKeyName($1); }
688 OptKeySymList : KeySymList { $$ = $1; }
692 KeySymList : KeySymList COMMA KeySym
693 { $$ = ExprAppendKeysymList($1, $3); }
694 | KeySymList COMMA KeySyms
695 { $$ = ExprAppendMultiKeysymList($1, $3); }
697 { $$ = ExprCreateKeysymList($1); }
699 { $$ = ExprCreateMultiKeysymList($1); }
702 KeySyms : OBRACE KeySymList CBRACE
708 if (!resolve_keysym($1, &$$))
709 parser_warn(param, "unrecognized keysym \"%s\"", $1);
712 | SECTION { $$ = XKB_KEY_section; }
716 parser_warn(param, "unrecognized keysym \"%d\"", $1);
717 $$ = XKB_KEY_NoSymbol;
719 else if ($1 < 10) { /* XKB_KEY_0 .. XKB_KEY_9 */
720 $$ = XKB_KEY_0 + (xkb_keysym_t) $1;
724 snprintf(buf, sizeof(buf), "0x%x", $1);
725 if (!resolve_keysym(buf, &$$)) {
726 parser_warn(param, "unrecognized keysym \"%s\"", buf);
727 $$ = XKB_KEY_NoSymbol;
733 SignedNumber : MINUS Number { $$ = -$2; }
734 | Number { $$ = $1; }
737 Number : FLOAT { $$ = $1; }
738 | INTEGER { $$ = $1; }
741 Float : FLOAT { $$ = 0; }
744 Integer : INTEGER { $$ = $1; }
747 KeyCode : INTEGER { $$ = $1; }
750 Ident : IDENT { $$ = xkb_atom_steal(param->ctx, $1); }
751 | DEFAULT { $$ = xkb_atom_intern_literal(param->ctx, "default"); }
754 String : STRING { $$ = xkb_atom_steal(param->ctx, $1); }
757 OptMapName : MapName { $$ = $1; }
761 MapName : STRING { $$ = $1; }
767 parse(struct xkb_context *ctx, struct scanner *scanner, const char *map)
770 XkbFile *first = NULL;
771 struct parser_param param = {
778 * If we got a specific map, we look for it exclusively and return
779 * immediately upon finding it. Otherwise, we need to get the
780 * default map. If we find a map marked as default, we return it
781 * immediately. If there are no maps marked as default, we return
782 * the first map in the file.
785 while ((ret = yyparse(¶m)) == 0 && param.more_maps) {
787 if (streq_not_null(map, param.rtrn->name))
790 FreeXkbFile(param.rtrn);
793 if (param.rtrn->flags & MAP_IS_DEFAULT) {
801 FreeXkbFile(param.rtrn);
814 "No map in include statement, but \"%s\" contains several; "
815 "Using first defined map, \"%s\"\n",
816 scanner->file_name, first->name);