utils: add/replace string equality macros
[platform/upstream/libxkbcommon.git] / src / xkbcomp / parseutils.h
1 /************************************************************
2  * Copyright (c) 1994 by Silicon Graphics Computer Systems, Inc.
3  *
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.
15  *
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.
24  *
25  ********************************************************/
26
27 #ifndef PARSEUTILS_H
28 #define PARSEUTILS_H
29
30 #include <stdio.h>
31
32 #include "xkbcomp-priv.h"
33
34 struct parser_param {
35     struct xkb_context *ctx;
36     void *scanner;
37     XkbFile *rtrn;
38 };
39
40 #include "parser.h"
41
42 struct scanner_extra {
43     struct xkb_context *ctx;
44     char *scanFile;
45     char scanBuf[1024];
46     char *s;
47 };
48
49 extern ParseCommon *
50 AppendStmt(ParseCommon *to, ParseCommon *append);
51
52 extern ExprDef *
53 ExprCreate(unsigned op, unsigned type);
54
55 extern ExprDef *
56 ExprCreateUnary(unsigned op, unsigned type, ExprDef *child);
57
58 extern ExprDef *
59 ExprCreateBinary(unsigned op, ExprDef *left, ExprDef *right);
60
61 KeycodeDef *
62 KeycodeCreate(char keyName[XkbKeyNameLength], unsigned long value);
63
64 extern KeyAliasDef *
65 KeyAliasCreate(char keyName[XkbKeyNameLength], char real[XkbKeyNameLength]);
66
67 extern VModDef *
68 VModCreate(xkb_atom_t name, ExprDef *value);
69
70 extern VarDef *
71 VarCreate(ExprDef *name, ExprDef *value);
72
73 extern VarDef *
74 BoolVarCreate(xkb_atom_t nameToken, unsigned set);
75
76 extern InterpDef *
77 InterpCreate(char *sym, ExprDef *match);
78
79 extern KeyTypeDef *
80 KeyTypeCreate(xkb_atom_t name, VarDef *body);
81
82 extern SymbolsDef *
83 SymbolsCreate(char keyName[XkbKeyNameLength], ExprDef *symbols);
84
85 extern GroupCompatDef *
86 GroupCompatCreate(int group, ExprDef *def);
87
88 extern ModMapDef *
89 ModMapCreate(uint32_t modifier, ExprDef *keys);
90
91 extern IndicatorMapDef *
92 IndicatorMapCreate(xkb_atom_t name, VarDef *body);
93
94 extern IndicatorNameDef *
95 IndicatorNameCreate(int ndx, ExprDef *name, bool virtual);
96
97 extern ExprDef *
98 ActionCreate(xkb_atom_t name, ExprDef *args);
99
100 extern ExprDef *
101 CreateMultiKeysymList(ExprDef *list);
102
103 extern ExprDef *
104 CreateKeysymList(char *sym);
105
106 extern ExprDef *
107 AppendMultiKeysymList(ExprDef *list, ExprDef *append);
108
109 extern ExprDef *
110 AppendKeysymList(ExprDef *list, char *sym);
111
112 bool
113 LookupKeysym(const char *str, xkb_keysym_t *sym_rtrn);
114
115 extern IncludeStmt *
116 IncludeCreate(struct xkb_context *ctx, char *str, enum merge_mode merge);
117
118 extern void
119 CheckDefaultMap(struct xkb_context *ctx, XkbFile *maps, const char *fileName);
120
121 extern XkbFile *
122 CreateXKBFile(struct xkb_context *ctx, enum xkb_file_type type, char *name,
123               ParseCommon *defs,
124               unsigned flags);
125
126 extern bool
127 XKBParseFile(struct xkb_context *ctx, FILE *file, const char *file_name,
128              XkbFile **out);
129
130 extern bool
131 XKBParseString(struct xkb_context *context, const char *string,
132                const char *file_name,
133                XkbFile **out);
134
135 extern void
136 FreeXKBFile(XkbFile *file);
137
138 extern void
139 FreeStmt(ParseCommon *stmt);
140
141 void
142 scanner_error(struct YYLTYPE *loc, void *scanner, const char *msg);
143
144 #endif /* PARSEUTILS_H */