Merge branch 'master' of github.com:graphitemaster/gmqcc
[xonotic/gmqcc.git] / lexer.h
1 /*
2  * Copyright (C) 2012
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 #include "ast.h"
29
30 struct token_s {
31         int ttype;
32
33         char *value;
34
35         union {
36                 vector v;
37                 int    i;
38                 double f;
39                 int    t; /* type */
40         } constval;
41
42 #if 0
43         struct token_s *next;
44         struct token_s *prev;
45 #endif
46
47         lex_ctx ctx;
48 };
49
50 #if 0
51 token* token_new();
52 void   token_delete(token*);
53 token* token_copy(const token *cp);
54 void   token_delete_all(token *t);
55 token* token_copy_all(const token *cp);
56 #endif
57
58 /* Lexer
59  *
60  */
61 enum {
62     /* Other tokens which we can return: */
63     TOKEN_NONE = 0,
64     TOKEN_START = 128,
65
66     TOKEN_IDENT,
67
68     TOKEN_TYPENAME,
69
70     TOKEN_OPERATOR,
71
72     TOKEN_KEYWORD, /* loop */
73
74     TOKEN_DOTS, /* 3 dots, ... */
75
76     TOKEN_ATTRIBUTE_OPEN,  /* [[ */
77     TOKEN_ATTRIBUTE_CLOSE, /* ]] */
78
79     TOKEN_STRINGCONST, /* not the typename but an actual "string" */
80     TOKEN_CHARCONST,
81     TOKEN_VECTORCONST,
82     TOKEN_INTCONST,
83     TOKEN_FLOATCONST,
84
85     TOKEN_WHITE,
86     TOKEN_EOL,
87
88     TOKEN_EOF,
89
90     /* We use '< TOKEN_ERROR', so TOKEN_FATAL must come after it and any
91      * other error related tokens as well
92      */
93     TOKEN_ERROR,
94     TOKEN_FATAL /* internal error, eg out of memory */
95 };
96
97 typedef struct {
98     char *name;
99     int   value;
100 } frame_macro;
101
102 typedef struct {
103         FILE   *file;
104         const char *open_string;
105         size_t      open_string_length;
106         size_t      open_string_pos;
107
108         char   *name;
109         size_t  line;
110         size_t  sline; /* line at the start of a token */
111
112         char    peek[256];
113         size_t  peekpos;
114
115         bool    eof;
116
117         token   tok; /* not a pointer anymore */
118
119         struct {
120             bool noops;
121             bool nodigraphs; /* used when lexing string constants */
122             bool preprocessing; /* whitespace and EOLs become actual tokens */
123             bool mergelines; /* backslash at the end of a line escapes the newline */
124         } flags;
125
126     int framevalue;
127         frame_macro *frames;
128         char *modelname;
129
130         size_t push_line;
131 } lex_file;
132
133 lex_file* lex_open (const char *file);
134 lex_file* lex_open_string(const char *str, size_t len, const char *name);
135 void      lex_close(lex_file   *lex);
136 int       lex_do   (lex_file   *lex);
137 void      lex_cleanup(void);
138
139 /* Parser
140  *
141  */
142
143 enum {
144     ASSOC_LEFT,
145     ASSOC_RIGHT
146 };
147
148 #define OP_SUFFIX 1
149 #define OP_PREFIX 2
150
151 typedef struct {
152     const char   *op;
153     unsigned int operands;
154     unsigned int id;
155     unsigned int assoc;
156     signed int   prec;
157     unsigned int flags;
158 } oper_info;
159
160 #define opid1(a) (a)
161 #define opid2(a,b) ((a<<8)|b)
162 #define opid3(a,b,c) ((a<<16)|(b<<8)|c)
163
164 static const oper_info c_operators[] = {
165     { "(",   0, opid1('('),         ASSOC_LEFT,  99, OP_PREFIX}, /* paren expression - non function call */
166
167     { "++",  1, opid3('S','+','+'), ASSOC_LEFT,  15, OP_SUFFIX},
168     { "--",  1, opid3('S','-','-'), ASSOC_LEFT,  15, OP_SUFFIX},
169     { ".",   2, opid1('.'),         ASSOC_LEFT,  15, 0 },
170     { "(",   0, opid1('('),         ASSOC_LEFT,  15, 0 }, /* function call */
171     { "[",   2, opid1('['),         ASSOC_LEFT,  15, 0 }, /* array subscript */
172
173     { "!",   1, opid2('!', 'P'),    ASSOC_RIGHT, 14, OP_PREFIX },
174     { "~",   1, opid2('~', 'P'),    ASSOC_RIGHT, 14, OP_PREFIX },
175     { "+",   1, opid2('+','P'),     ASSOC_RIGHT, 14, OP_PREFIX },
176     { "-",   1, opid2('-','P'),     ASSOC_RIGHT, 14, OP_PREFIX },
177     { "++",  1, opid3('+','+','P'), ASSOC_RIGHT, 14, OP_PREFIX },
178     { "--",  1, opid3('-','-','P'), ASSOC_RIGHT, 14, OP_PREFIX },
179 /*  { "&",   1, opid2('&','P'),     ASSOC_RIGHT, 14, OP_PREFIX }, */
180
181     { "*",   2, opid1('*'),         ASSOC_LEFT,  13, 0 },
182     { "/",   2, opid1('/'),         ASSOC_LEFT,  13, 0 },
183     { "%",   2, opid1('%'),         ASSOC_LEFT,  13, 0 },
184
185     { "+",   2, opid1('+'),         ASSOC_LEFT,  12, 0 },
186     { "-",   2, opid1('-'),         ASSOC_LEFT,  12, 0 },
187
188     { "<<",  2, opid2('<','<'),     ASSOC_LEFT,  11, 0 },
189     { ">>",  2, opid2('>','>'),     ASSOC_LEFT,  11, 0 },
190
191     { "<",   2, opid1('<'),         ASSOC_LEFT,  10, 0 },
192     { ">",   2, opid1('>'),         ASSOC_LEFT,  10, 0 },
193     { "<=",  2, opid2('<','='),     ASSOC_LEFT,  10, 0 },
194     { ">=",  2, opid2('>','='),     ASSOC_LEFT,  10, 0 },
195
196     { "==",  2, opid2('=','='),     ASSOC_LEFT,  9,  0 },
197     { "!=",  2, opid2('!','='),     ASSOC_LEFT,  9,  0 },
198
199     { "&",   2, opid1('&'),         ASSOC_LEFT,  8,  0 },
200
201     { "^",   2, opid1('^'),         ASSOC_LEFT,  7,  0 },
202
203     { "|",   2, opid1('|'),         ASSOC_LEFT,  6,  0 },
204
205     { "&&",  2, opid2('&','&'),     ASSOC_LEFT,  5,  0 },
206
207     { "||",  2, opid2('|','|'),     ASSOC_LEFT,  4,  0 },
208
209     { "?",   3, opid2('?',':'),     ASSOC_RIGHT, 3,  0 },
210
211     { "=",   2, opid1('='),         ASSOC_RIGHT, 2,  0 },
212     { "+=",  2, opid2('+','='),     ASSOC_RIGHT, 2,  0 },
213     { "-=",  2, opid2('-','='),     ASSOC_RIGHT, 2,  0 },
214     { "*=",  2, opid2('*','='),     ASSOC_RIGHT, 2,  0 },
215     { "/=",  2, opid2('/','='),     ASSOC_RIGHT, 2,  0 },
216     { "%=",  2, opid2('%','='),     ASSOC_RIGHT, 2,  0 },
217     { ">>=", 2, opid3('>','>','='), ASSOC_RIGHT, 2,  0 },
218     { "<<=", 2, opid3('<','<','='), ASSOC_RIGHT, 2,  0 },
219     { "&=",  2, opid2('&','='),     ASSOC_RIGHT, 2,  0 },
220     { "^=",  2, opid2('^','='),     ASSOC_RIGHT, 2,  0 },
221     { "|=",  2, opid2('|','='),     ASSOC_RIGHT, 2,  0 },
222
223     { ":",   0, opid2(':','?'),     ASSOC_RIGHT, 1,  0 },
224
225     { ",",   2, opid1(','),         ASSOC_LEFT,  0,  0 }
226 };
227 static const size_t c_operator_count = (sizeof(c_operators) / sizeof(c_operators[0]));
228
229 static const oper_info fte_operators[] = {
230     { "(",   0, opid1('('),         ASSOC_LEFT,  99, OP_PREFIX}, /* paren expression - non function call */
231
232     { "++",  1, opid3('S','+','+'), ASSOC_LEFT,  15, OP_SUFFIX},
233     { "--",  1, opid3('S','-','-'), ASSOC_LEFT,  15, OP_SUFFIX},
234     { ".",   2, opid1('.'),         ASSOC_LEFT,  15, 0 },
235     { "(",   0, opid1('('),         ASSOC_LEFT,  15, 0 }, /* function call */
236     { "[",   2, opid1('['),         ASSOC_LEFT,  15, 0 }, /* array subscript */
237
238     { "!",   1, opid2('!', 'P'),    ASSOC_RIGHT, 14, OP_PREFIX },
239     { "+",   1, opid2('+','P'),     ASSOC_RIGHT, 14, OP_PREFIX },
240     { "-",   1, opid2('-','P'),     ASSOC_RIGHT, 14, OP_PREFIX },
241     { "++",  1, opid3('+','+','P'), ASSOC_RIGHT, 14, OP_PREFIX },
242     { "--",  1, opid3('-','-','P'), ASSOC_RIGHT, 14, OP_PREFIX },
243
244     { "*",   2, opid1('*'),         ASSOC_LEFT,  13, 0 },
245     { "/",   2, opid1('/'),         ASSOC_LEFT,  13, 0 },
246     { "&",   2, opid1('&'),         ASSOC_LEFT,  13, 0 },
247     { "|",   2, opid1('|'),         ASSOC_LEFT,  13, 0 },
248
249     { "+",   2, opid1('+'),         ASSOC_LEFT,  12, 0 },
250     { "-",   2, opid1('-'),         ASSOC_LEFT,  12, 0 },
251
252     { "<",   2, opid1('<'),         ASSOC_LEFT,  10, 0 },
253     { ">",   2, opid1('>'),         ASSOC_LEFT,  10, 0 },
254     { "<=",  2, opid2('<','='),     ASSOC_LEFT,  10, 0 },
255     { ">=",  2, opid2('>','='),     ASSOC_LEFT,  10, 0 },
256     { "==",  2, opid2('=','='),     ASSOC_LEFT,  10,  0 },
257     { "!=",  2, opid2('!','='),     ASSOC_LEFT,  10,  0 },
258
259     { "?",   3, opid2('?',':'),     ASSOC_RIGHT, 9,  0 },
260
261     { "=",   2, opid1('='),         ASSOC_RIGHT, 8,  0 },
262     { "+=",  2, opid2('+','='),     ASSOC_RIGHT, 8,  0 },
263     { "-=",  2, opid2('-','='),     ASSOC_RIGHT, 8,  0 },
264     { "*=",  2, opid2('*','='),     ASSOC_RIGHT, 8,  0 },
265     { "/=",  2, opid2('/','='),     ASSOC_RIGHT, 8,  0 },
266     { "%=",  2, opid2('%','='),     ASSOC_RIGHT, 8,  0 },
267     { "&=",  2, opid2('&','='),     ASSOC_RIGHT, 8,  0 },
268     { "|=",  2, opid2('|','='),     ASSOC_RIGHT, 8,  0 },
269     { "&~=", 2, opid3('&','~','='), ASSOC_RIGHT, 8,  0 },
270
271     { "&&",  2, opid2('&','&'),     ASSOC_LEFT,  5,  0 },
272     { "||",  2, opid2('|','|'),     ASSOC_LEFT,  5,  0 },
273
274     /* Leave precedence 3 for : with -fcorrect-ternary */
275     { ",",   2, opid1(','),         ASSOC_LEFT,  2,  0 },
276     { ":",   0, opid2(':','?'),     ASSOC_RIGHT, 1,  0 }
277 };
278 static const size_t fte_operator_count = (sizeof(fte_operators) / sizeof(fte_operators[0]));
279
280 static const oper_info qcc_operators[] = {
281     { "(",   0, opid1('('),         ASSOC_LEFT,  99, OP_PREFIX}, /* paren expression - non function call */
282
283     { ".",   2, opid1('.'),         ASSOC_LEFT,  15, 0 },
284     { "(",   0, opid1('('),         ASSOC_LEFT,  15, 0 }, /* function call */
285     { "[",   2, opid1('['),         ASSOC_LEFT,  15, 0 }, /* array subscript */
286
287     { "!",   1, opid2('!', 'P'),    ASSOC_RIGHT, 14, OP_PREFIX },
288     { "+",   1, opid2('+','P'),     ASSOC_RIGHT, 14, OP_PREFIX },
289     { "-",   1, opid2('-','P'),     ASSOC_RIGHT, 14, OP_PREFIX },
290
291     { "*",   2, opid1('*'),         ASSOC_LEFT,  13, 0 },
292     { "/",   2, opid1('/'),         ASSOC_LEFT,  13, 0 },
293     { "&",   2, opid1('&'),         ASSOC_LEFT,  13, 0 },
294     { "|",   2, opid1('|'),         ASSOC_LEFT,  13, 0 },
295
296     { "+",   2, opid1('+'),         ASSOC_LEFT,  12, 0 },
297     { "-",   2, opid1('-'),         ASSOC_LEFT,  12, 0 },
298
299     { "<",   2, opid1('<'),         ASSOC_LEFT,  10, 0 },
300     { ">",   2, opid1('>'),         ASSOC_LEFT,  10, 0 },
301     { "<=",  2, opid2('<','='),     ASSOC_LEFT,  10, 0 },
302     { ">=",  2, opid2('>','='),     ASSOC_LEFT,  10, 0 },
303     { "==",  2, opid2('=','='),     ASSOC_LEFT,  10,  0 },
304     { "!=",  2, opid2('!','='),     ASSOC_LEFT,  10,  0 },
305
306     { "=",   2, opid1('='),         ASSOC_RIGHT, 8,  0 },
307     { "+=",  2, opid2('+','='),     ASSOC_RIGHT, 8,  0 },
308     { "-=",  2, opid2('-','='),     ASSOC_RIGHT, 8,  0 },
309     { "*=",  2, opid2('*','='),     ASSOC_RIGHT, 8,  0 },
310     { "/=",  2, opid2('/','='),     ASSOC_RIGHT, 8,  0 },
311     { "%=",  2, opid2('%','='),     ASSOC_RIGHT, 8,  0 },
312     { "&=",  2, opid2('&','='),     ASSOC_RIGHT, 8,  0 },
313     { "|=",  2, opid2('|','='),     ASSOC_RIGHT, 8,  0 },
314
315     { "&&",  2, opid2('&','&'),     ASSOC_LEFT,  5,  0 },
316     { "||",  2, opid2('|','|'),     ASSOC_LEFT,  5,  0 },
317
318     { ",",   2, opid1(','),         ASSOC_LEFT,  2,  0 },
319 };
320 static const size_t qcc_operator_count = (sizeof(qcc_operators) / sizeof(qcc_operators[0]));
321
322 extern const oper_info *operators;
323 extern size_t           operator_count;
324 void lexerror(lex_file*, const char *fmt, ...);
325
326 #endif