5f0bb6375c25563d8593c7b4e524463fe9575a38
[xonotic/gmqcc.git] / lexer.h
1 /*
2  * Copyright (C) 2012, 2013
3  *     Wolfgang Bumiller
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
6  * this software and associated documentation files (the "Software"), to deal in
7  * the Software without restriction, including without limitation the rights to
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9  * of the Software, and to permit persons to whom the Software is furnished to do
10  * so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21  * SOFTWARE.
22  */
23 #ifndef GMQCC_LEXER_HDR
24 #define GMQCC_LEXER_HDR
25
26 typedef struct token_s token;
27
28 struct token_s {
29     int ttype;
30
31     char *value;
32
33     union {
34         vector v;
35         int    i;
36         double f;
37         int    t; /* type */
38     } constval;
39
40 #if 0
41     struct token_s *next;
42     struct token_s *prev;
43 #endif
44
45     lex_ctx ctx;
46 };
47
48 #if 0
49 token* token_new();
50 void   token_delete(token*);
51 token* token_copy(const token *cp);
52 void   token_delete_all(token *t);
53 token* token_copy_all(const token *cp);
54 #endif
55
56 /* Lexer
57  *
58  */
59 enum {
60     /* Other tokens which we can return: */
61     TOKEN_NONE = 0,
62     TOKEN_START = 128,
63
64     TOKEN_IDENT,
65
66     TOKEN_TYPENAME,
67
68     TOKEN_OPERATOR,
69
70     TOKEN_KEYWORD, /* loop */
71
72     TOKEN_DOTS, /* 3 dots, ... */
73
74     TOKEN_ATTRIBUTE_OPEN,  /* [[ */
75     TOKEN_ATTRIBUTE_CLOSE, /* ]] */
76
77     TOKEN_VA_ARGS, /* for the ftepp only */
78     TOKEN_VA_ARGS_ARRAY, /* for the ftepp only */
79     TOKEN_VA_COUNT,     /* to get the count of vaargs */
80
81     TOKEN_STRINGCONST, /* not the typename but an actual "string" */
82     TOKEN_CHARCONST,
83     TOKEN_VECTORCONST,
84     TOKEN_INTCONST,
85     TOKEN_FLOATCONST,
86
87     TOKEN_WHITE,
88     TOKEN_EOL,
89
90     /* if we add additional tokens before this, the exposed API
91      * should not be broken anyway, but EOF/ERROR/... should
92      * still be at the bottom
93      */
94     TOKEN_EOF = 1024,
95
96     /* We use '< TOKEN_ERROR', so TOKEN_FATAL must come after it and any
97      * other error related tokens as well
98      */
99     TOKEN_ERROR,
100     TOKEN_FATAL /* internal error, eg out of memory */
101 };
102
103 typedef struct {
104     char *name;
105     int   value;
106 } frame_macro;
107
108 typedef struct lex_file_s {
109     FILE   *file;
110     const char *open_string;
111     size_t      open_string_length;
112     size_t      open_string_pos;
113
114     char   *name;
115     size_t  line;
116     size_t  sline; /* line at the start of a token */
117
118     int     peek[256];
119     size_t  peekpos;
120
121     bool    eof;
122
123     token   tok; /* not a pointer anymore */
124
125     struct {
126         bool noops;
127         bool nodigraphs; /* used when lexing string constants */
128         bool preprocessing; /* whitespace and EOLs become actual tokens */
129         bool mergelines; /* backslash at the end of a line escapes the newline */
130     } flags;
131
132     int framevalue;
133     frame_macro *frames;
134     char *modelname;
135
136     size_t push_line;
137 } lex_file;
138
139 lex_file* lex_open (const char *file);
140 lex_file* lex_open_string(const char *str, size_t len, const char *name);
141 void      lex_close(lex_file   *lex);
142 int       lex_do   (lex_file   *lex);
143 void      lex_cleanup(void);
144
145 /* Parser
146  *
147  */
148
149 enum {
150     ASSOC_LEFT,
151     ASSOC_RIGHT
152 };
153
154 #define OP_SUFFIX 1
155 #define OP_PREFIX 2
156
157 typedef struct {
158     const char   *op;
159     unsigned int operands;
160     unsigned int id;
161     unsigned int assoc;
162     signed int   prec;
163     unsigned int flags;
164 } oper_info;
165
166 /*
167  * Explicit uint8_t casts since the left operand of shift operator cannot
168  * be negative, even though it won't happen, this supresses the future
169  * possibility.
170  */
171 #define opid1(a)     ((uint8_t)a)
172 #define opid2(a,b)   (((uint8_t)a<<8) |(uint8_t)b)
173 #define opid3(a,b,c) (((uint8_t)a<<16)|((uint8_t)b<<8)|(uint8_t)c)
174
175 static const oper_info c_operators[] = {
176     { "(",   0, opid1('('),         ASSOC_LEFT,  99, OP_PREFIX}, /* paren expression - non function call */
177
178     { "++",  1, opid3('S','+','+'), ASSOC_LEFT,  17, OP_SUFFIX},
179     { "--",  1, opid3('S','-','-'), ASSOC_LEFT,  17, OP_SUFFIX},
180     { ".",   2, opid1('.'),         ASSOC_LEFT,  17, 0 },
181     { "(",   0, opid1('('),         ASSOC_LEFT,  17, 0 }, /* function call */
182     { "[",   2, opid1('['),         ASSOC_LEFT,  17, 0 }, /* array subscript */
183
184     { "++",  1, opid3('+','+','P'), ASSOC_RIGHT, 16, OP_PREFIX },
185     { "--",  1, opid3('-','-','P'), ASSOC_RIGHT, 16, OP_PREFIX },
186
187     { "**",  2, opid2('*', '*'),    ASSOC_RIGHT, 15, 0 },
188
189     { "!",   1, opid2('!', 'P'),    ASSOC_RIGHT, 14, OP_PREFIX },
190     { "~",   1, opid2('~', 'P'),    ASSOC_RIGHT, 14, OP_PREFIX },
191     { "+",   1, opid2('+','P'),     ASSOC_RIGHT, 14, OP_PREFIX },
192     { "-",   1, opid2('-','P'),     ASSOC_RIGHT, 14, OP_PREFIX },
193 /*  { "&",   1, opid2('&','P'),     ASSOC_RIGHT, 14, OP_PREFIX }, */
194
195     { "*",   2, opid1('*'),         ASSOC_LEFT,  13, 0 },
196     { "/",   2, opid1('/'),         ASSOC_LEFT,  13, 0 },
197     { "%",   2, opid1('%'),         ASSOC_LEFT,  13, 0 },
198
199     { "+",   2, opid1('+'),         ASSOC_LEFT,  12, 0 },
200     { "-",   2, opid1('-'),         ASSOC_LEFT,  12, 0 },
201
202     { "<<",  2, opid2('<','<'),     ASSOC_LEFT,  11, 0 },
203     { ">>",  2, opid2('>','>'),     ASSOC_LEFT,  11, 0 },
204
205     { "<",   2, opid1('<'),         ASSOC_LEFT,  10, 0 },
206     { ">",   2, opid1('>'),         ASSOC_LEFT,  10, 0 },
207     { "<=>", 2, opid3('<','=','>'), ASSOC_LEFT,  10, 0 },
208     { "<=",  2, opid2('<','='),     ASSOC_LEFT,  10, 0 },
209     { ">=",  2, opid2('>','='),     ASSOC_LEFT,  10, 0 },
210
211     { "==",  2, opid2('=','='),     ASSOC_LEFT,  9,  0 },
212     { "!=",  2, opid2('!','='),     ASSOC_LEFT,  9,  0 },
213
214     { "&",   2, opid1('&'),         ASSOC_LEFT,  8,  0 },
215
216     { "^",   2, opid1('^'),         ASSOC_LEFT,  7,  0 },
217
218     { "|",   2, opid1('|'),         ASSOC_LEFT,  6,  0 },
219
220     { "&&",  2, opid2('&','&'),     ASSOC_LEFT,  5,  0 },
221
222     { "||",  2, opid2('|','|'),     ASSOC_LEFT,  4,  0 },
223
224     { "?",   3, opid2('?',':'),     ASSOC_RIGHT, 3,  0 },
225
226     { "=",   2, opid1('='),         ASSOC_RIGHT, 2,  0 },
227     { "+=",  2, opid2('+','='),     ASSOC_RIGHT, 2,  0 },
228     { "-=",  2, opid2('-','='),     ASSOC_RIGHT, 2,  0 },
229     { "*=",  2, opid2('*','='),     ASSOC_RIGHT, 2,  0 },
230     { "/=",  2, opid2('/','='),     ASSOC_RIGHT, 2,  0 },
231     { "%=",  2, opid2('%','='),     ASSOC_RIGHT, 2,  0 },
232     { ">>=", 2, opid3('>','>','='), ASSOC_RIGHT, 2,  0 },
233     { "<<=", 2, opid3('<','<','='), ASSOC_RIGHT, 2,  0 },
234     { "&=",  2, opid2('&','='),     ASSOC_RIGHT, 2,  0 },
235     { "^=",  2, opid2('^','='),     ASSOC_RIGHT, 2,  0 },
236     { "|=",  2, opid2('|','='),     ASSOC_RIGHT, 2,  0 },
237     { "&~=", 2, opid3('&','~','='), ASSOC_RIGHT, 2,  0 },
238
239     { ":",   0, opid2(':','?'),     ASSOC_RIGHT, 1,  0 },
240
241     { ",",   2, opid1(','),         ASSOC_LEFT,  0,  0 }
242 };
243 static const size_t c_operator_count = (sizeof(c_operators) / sizeof(c_operators[0]));
244
245 static const oper_info fte_operators[] = {
246     { "(",   0, opid1('('),         ASSOC_LEFT,  99, OP_PREFIX}, /* paren expression - non function call */
247
248     { "++",  1, opid3('S','+','+'), ASSOC_LEFT,  15, OP_SUFFIX},
249     { "--",  1, opid3('S','-','-'), ASSOC_LEFT,  15, OP_SUFFIX},
250     { ".",   2, opid1('.'),         ASSOC_LEFT,  15, 0 },
251     { "(",   0, opid1('('),         ASSOC_LEFT,  15, 0 }, /* function call */
252     { "[",   2, opid1('['),         ASSOC_LEFT,  15, 0 }, /* array subscript */
253
254     { "!",   1, opid2('!', 'P'),    ASSOC_RIGHT, 14, OP_PREFIX },
255     { "+",   1, opid2('+','P'),     ASSOC_RIGHT, 14, OP_PREFIX },
256     { "-",   1, opid2('-','P'),     ASSOC_RIGHT, 14, OP_PREFIX },
257     { "++",  1, opid3('+','+','P'), ASSOC_RIGHT, 14, OP_PREFIX },
258     { "--",  1, opid3('-','-','P'), ASSOC_RIGHT, 14, OP_PREFIX },
259
260     { "*",   2, opid1('*'),         ASSOC_LEFT,  13, 0 },
261     { "/",   2, opid1('/'),         ASSOC_LEFT,  13, 0 },
262     { "&",   2, opid1('&'),         ASSOC_LEFT,  13, 0 },
263     { "|",   2, opid1('|'),         ASSOC_LEFT,  13, 0 },
264
265     { "+",   2, opid1('+'),         ASSOC_LEFT,  12, 0 },
266     { "-",   2, opid1('-'),         ASSOC_LEFT,  12, 0 },
267
268     { "<<",  2, opid2('<','<'),     ASSOC_LEFT,  11, 0 },
269     { ">>",  2, opid2('>','>'),     ASSOC_LEFT,  11, 0 },
270
271     { "<",   2, opid1('<'),         ASSOC_LEFT,  10, 0 },
272     { ">",   2, opid1('>'),         ASSOC_LEFT,  10, 0 },
273     { "<=",  2, opid2('<','='),     ASSOC_LEFT,  10, 0 },
274     { ">=",  2, opid2('>','='),     ASSOC_LEFT,  10, 0 },
275     { "==",  2, opid2('=','='),     ASSOC_LEFT,  10,  0 },
276     { "!=",  2, opid2('!','='),     ASSOC_LEFT,  10,  0 },
277
278     { "?",   3, opid2('?',':'),     ASSOC_RIGHT, 9,  0 },
279
280     { "=",   2, opid1('='),         ASSOC_RIGHT, 8,  0 },
281     { "+=",  2, opid2('+','='),     ASSOC_RIGHT, 8,  0 },
282     { "-=",  2, opid2('-','='),     ASSOC_RIGHT, 8,  0 },
283     { "*=",  2, opid2('*','='),     ASSOC_RIGHT, 8,  0 },
284     { "/=",  2, opid2('/','='),     ASSOC_RIGHT, 8,  0 },
285     { "%=",  2, opid2('%','='),     ASSOC_RIGHT, 8,  0 },
286     { "&=",  2, opid2('&','='),     ASSOC_RIGHT, 8,  0 },
287     { "|=",  2, opid2('|','='),     ASSOC_RIGHT, 8,  0 },
288     { "&~=", 2, opid3('&','~','='), ASSOC_RIGHT, 8,  0 },
289
290     { "&&",  2, opid2('&','&'),     ASSOC_LEFT,  5,  0 },
291     { "||",  2, opid2('|','|'),     ASSOC_LEFT,  5,  0 },
292
293     /* Leave precedence 3 for : with -fcorrect-ternary */
294     { ",",   2, opid1(','),         ASSOC_LEFT,  2,  0 },
295     { ":",   0, opid2(':','?'),     ASSOC_RIGHT, 1,  0 }
296 };
297 static const size_t fte_operator_count = (sizeof(fte_operators) / sizeof(fte_operators[0]));
298
299 static const oper_info qcc_operators[] = {
300     { "(",   0, opid1('('),         ASSOC_LEFT,  99, OP_PREFIX}, /* paren expression - non function call */
301
302     { ".",   2, opid1('.'),         ASSOC_LEFT,  15, 0 },
303     { "(",   0, opid1('('),         ASSOC_LEFT,  15, 0 }, /* function call */
304     { "[",   2, opid1('['),         ASSOC_LEFT,  15, 0 }, /* array subscript */
305
306     { "!",   1, opid2('!', 'P'),    ASSOC_RIGHT, 14, OP_PREFIX },
307     { "+",   1, opid2('+','P'),     ASSOC_RIGHT, 14, OP_PREFIX },
308     { "-",   1, opid2('-','P'),     ASSOC_RIGHT, 14, OP_PREFIX },
309
310     { "*",   2, opid1('*'),         ASSOC_LEFT,  13, 0 },
311     { "/",   2, opid1('/'),         ASSOC_LEFT,  13, 0 },
312     { "&",   2, opid1('&'),         ASSOC_LEFT,  13, 0 },
313     { "|",   2, opid1('|'),         ASSOC_LEFT,  13, 0 },
314
315     { "+",   2, opid1('+'),         ASSOC_LEFT,  12, 0 },
316     { "-",   2, opid1('-'),         ASSOC_LEFT,  12, 0 },
317
318     { "<",   2, opid1('<'),         ASSOC_LEFT,  10, 0 },
319     { ">",   2, opid1('>'),         ASSOC_LEFT,  10, 0 },
320     { "<=",  2, opid2('<','='),     ASSOC_LEFT,  10, 0 },
321     { ">=",  2, opid2('>','='),     ASSOC_LEFT,  10, 0 },
322     { "==",  2, opid2('=','='),     ASSOC_LEFT,  10,  0 },
323     { "!=",  2, opid2('!','='),     ASSOC_LEFT,  10,  0 },
324
325     { "=",   2, opid1('='),         ASSOC_RIGHT, 8,  0 },
326     { "+=",  2, opid2('+','='),     ASSOC_RIGHT, 8,  0 },
327     { "-=",  2, opid2('-','='),     ASSOC_RIGHT, 8,  0 },
328     { "*=",  2, opid2('*','='),     ASSOC_RIGHT, 8,  0 },
329     { "/=",  2, opid2('/','='),     ASSOC_RIGHT, 8,  0 },
330     { "%=",  2, opid2('%','='),     ASSOC_RIGHT, 8,  0 },
331     { "&=",  2, opid2('&','='),     ASSOC_RIGHT, 8,  0 },
332     { "|=",  2, opid2('|','='),     ASSOC_RIGHT, 8,  0 },
333
334     { "&&",  2, opid2('&','&'),     ASSOC_LEFT,  5,  0 },
335     { "||",  2, opid2('|','|'),     ASSOC_LEFT,  5,  0 },
336
337     { ",",   2, opid1(','),         ASSOC_LEFT,  2,  0 },
338 };
339 static const size_t qcc_operator_count = (sizeof(qcc_operators) / sizeof(qcc_operators[0]));
340
341 extern const oper_info *operators;
342 extern size_t           operator_count;
343 /*void lexerror(lex_file*, const char *fmt, ...);*/
344
345 #endif