1 /*
2 * This file is part of cparser.
3 * Copyright (C) 2007-2009 Matthias Braun <matze@braunis.de>
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
18 * 02111-1307, USA.
19 */
20 #ifndef AST_T_H
21 #define AST_T_H
22
23 #include <libfirm/firm_types.h>
24 #include <assert.h>
25
26 #include "ast.h"
27 #include "symbol.h"
28 #include "token_t.h"
29 #include "type.h"
30 #include "entity_t.h"
31 #include "adt/obst.h"
32
33 /** The AST obstack contains all data that must stay in the AST. */
34 extern struct obstack ast_obstack;
35
36 /**
37 * Operator precedence classes
38 */
39 typedef enum precedence_t {
40 PREC_BOTTOM,
41 PREC_EXPRESSION, /* , left to right */
42 PREC_ASSIGNMENT, /* = += -= *= /= %= <<= >>= &= ^= |= right to left */
43 PREC_CONDITIONAL, /* ?: right to left */
44 PREC_LOGICAL_OR, /* || left to right */
45 PREC_LOGICAL_AND, /* && left to right */
46 PREC_OR, /* | left to right */
47 PREC_XOR, /* ^ left to right */
48 PREC_AND, /* & left to right */
49 PREC_EQUALITY, /* == != left to right */
50 PREC_RELATIONAL, /* < <= > >= left to right */
51 PREC_SHIFT, /* << >> left to right */
52 PREC_ADDITIVE, /* + - left to right */
53 PREC_MULTIPLICATIVE, /* * / % left to right */
54 PREC_CAST, /* (type) right to left */
55 PREC_UNARY, /* ! ~ ++ -- + - * & sizeof right to left */
56 PREC_POSTFIX, /* () [] -> . left to right */
57 PREC_PRIMARY,
58 PREC_TOP
59 } precedence_t;
60
61 /**
62 * Expression kinds.
63 */
64 typedef enum expression_kind_t {
65 EXPR_ERROR = 1,
66 EXPR_REFERENCE,
67 EXPR_ENUM_CONSTANT,
68 EXPR_LITERAL_BOOLEAN,
69 EXPR_LITERAL_INTEGER,
70 EXPR_LITERAL_FLOATINGPOINT,
71 EXPR_LITERAL_CHARACTER,
72 EXPR_LITERAL_MS_NOOP, /**< MS __noop extension */
73 EXPR_STRING_LITERAL,
74 EXPR_COMPOUND_LITERAL,
75 EXPR_CALL,
76 EXPR_CONDITIONAL,
77 EXPR_SELECT,
78 EXPR_ARRAY_ACCESS,
79 EXPR_SIZEOF,
80 EXPR_CLASSIFY_TYPE,
81 EXPR_ALIGNOF,
82
83 EXPR_FUNCNAME,
84 EXPR_BUILTIN_CONSTANT_P,
85 EXPR_BUILTIN_TYPES_COMPATIBLE_P,
86 EXPR_OFFSETOF,
87 EXPR_VA_START,
88 EXPR_VA_ARG,
89 EXPR_VA_COPY,
90 EXPR_STATEMENT,
91 EXPR_LABEL_ADDRESS, /**< GCC extension &&label operator */
92
93 EXPR_UNARY_FIRST,
94 EXPR_UNARY_NEGATE = EXPR_UNARY_FIRST,
95 EXPR_UNARY_PLUS,
96 EXPR_UNARY_BITWISE_NEGATE,
97 EXPR_UNARY_NOT,
98 EXPR_UNARY_DEREFERENCE,
99 EXPR_UNARY_TAKE_ADDRESS,
100 EXPR_UNARY_POSTFIX_INCREMENT,
101 EXPR_UNARY_POSTFIX_DECREMENT,
102 EXPR_UNARY_PREFIX_INCREMENT,
103 EXPR_UNARY_PREFIX_DECREMENT,
104 EXPR_UNARY_CAST,
105 EXPR_UNARY_ASSUME, /**< MS __assume() */
106 EXPR_UNARY_DELETE,
107 EXPR_UNARY_DELETE_ARRAY,
108 EXPR_UNARY_THROW,
109 EXPR_UNARY_LAST = EXPR_UNARY_THROW,
110
111 EXPR_BINARY_FIRST,
112 EXPR_BINARY_ADD = EXPR_BINARY_FIRST,
113 EXPR_BINARY_SUB,
114 EXPR_BINARY_MUL,
115 EXPR_BINARY_DIV,
116 EXPR_BINARY_MOD,
117 EXPR_BINARY_EQUAL,
118 EXPR_BINARY_NOTEQUAL,
119 EXPR_BINARY_LESS,
120 EXPR_BINARY_LESSEQUAL,
121 EXPR_BINARY_GREATER,
122 EXPR_BINARY_GREATEREQUAL,
123 EXPR_BINARY_BITWISE_AND,
124 EXPR_BINARY_BITWISE_OR,
125 EXPR_BINARY_BITWISE_XOR,
126 EXPR_BINARY_LOGICAL_AND,
127 EXPR_BINARY_LOGICAL_OR,
128 EXPR_BINARY_SHIFTLEFT,
129 EXPR_BINARY_SHIFTRIGHT,
130 EXPR_BINARY_ASSIGN,
131 EXPR_BINARY_MUL_ASSIGN,
132 EXPR_BINARY_DIV_ASSIGN,
133 EXPR_BINARY_MOD_ASSIGN,
134 EXPR_BINARY_ADD_ASSIGN,
135 EXPR_BINARY_SUB_ASSIGN,
136 EXPR_BINARY_SHIFTLEFT_ASSIGN,
137 EXPR_BINARY_SHIFTRIGHT_ASSIGN,
138 EXPR_BINARY_BITWISE_AND_ASSIGN,
139 EXPR_BINARY_BITWISE_XOR_ASSIGN,
140 EXPR_BINARY_BITWISE_OR_ASSIGN,
141 EXPR_BINARY_COMMA,
142
143 EXPR_BINARY_ISGREATER,
144 EXPR_BINARY_ISGREATEREQUAL,
145 EXPR_BINARY_ISLESS,
146 EXPR_BINARY_ISLESSEQUAL,
147 EXPR_BINARY_ISLESSGREATER,
148 EXPR_BINARY_ISUNORDERED,
149 EXPR_BINARY_LAST = EXPR_BINARY_ISUNORDERED,
150 } expression_kind_t;
151
152 typedef enum funcname_kind_t {
153 FUNCNAME_FUNCTION, /**< C99 __func__, older __FUNCTION__ */
154 FUNCNAME_PRETTY_FUNCTION, /**< GNUC __PRETTY_FUNCTION__ */
155 FUNCNAME_FUNCSIG, /**< MS __FUNCSIG__ */
156 FUNCNAME_FUNCDNAME /**< MS __FUNCDNAME__ */
157 } funcname_kind_t;
158
159 /* convenience macros */
160 #define EXPR_BINARY_CASES \
161 EXPR_BINARY_ADD: \
162 case EXPR_BINARY_SUB: \
163 case EXPR_BINARY_MUL: \
164 case EXPR_BINARY_DIV: \
165 case EXPR_BINARY_MOD: \
166 case EXPR_BINARY_EQUAL: \
167 case EXPR_BINARY_NOTEQUAL: \
168 case EXPR_BINARY_LESS: \
169 case EXPR_BINARY_LESSEQUAL: \
170 case EXPR_BINARY_GREATER: \
171 case EXPR_BINARY_GREATEREQUAL: \
172 case EXPR_BINARY_BITWISE_AND: \
173 case EXPR_BINARY_BITWISE_OR: \
174 case EXPR_BINARY_BITWISE_XOR: \
175 case EXPR_BINARY_LOGICAL_AND: \
176 case EXPR_BINARY_LOGICAL_OR: \
177 case EXPR_BINARY_SHIFTLEFT: \
178 case EXPR_BINARY_SHIFTRIGHT: \
179 case EXPR_BINARY_ASSIGN: \
180 case EXPR_BINARY_MUL_ASSIGN: \
181 case EXPR_BINARY_DIV_ASSIGN: \
182 case EXPR_BINARY_MOD_ASSIGN: \
183 case EXPR_BINARY_ADD_ASSIGN: \
184 case EXPR_BINARY_SUB_ASSIGN: \
185 case EXPR_BINARY_SHIFTLEFT_ASSIGN: \
186 case EXPR_BINARY_SHIFTRIGHT_ASSIGN: \
187 case EXPR_BINARY_BITWISE_AND_ASSIGN: \
188 case EXPR_BINARY_BITWISE_XOR_ASSIGN: \
189 case EXPR_BINARY_BITWISE_OR_ASSIGN: \
190 case EXPR_BINARY_COMMA: \
191 case EXPR_BINARY_ISGREATER: \
192 case EXPR_BINARY_ISGREATEREQUAL: \
193 case EXPR_BINARY_ISLESS: \
194 case EXPR_BINARY_ISLESSEQUAL: \
195 case EXPR_BINARY_ISLESSGREATER: \
196 case EXPR_BINARY_ISUNORDERED
197
198 /**
199 * unary expression with mandatory operand
200 */
201 #define EXPR_UNARY_CASES_MANDATORY \
202 EXPR_UNARY_NEGATE: \
203 case EXPR_UNARY_PLUS: \
204 case EXPR_UNARY_BITWISE_NEGATE: \
205 case EXPR_UNARY_NOT: \
206 case EXPR_UNARY_DEREFERENCE: \
207 case EXPR_UNARY_TAKE_ADDRESS: \
208 case EXPR_UNARY_POSTFIX_INCREMENT: \
209 case EXPR_UNARY_POSTFIX_DECREMENT: \
210 case EXPR_UNARY_PREFIX_INCREMENT: \
211 case EXPR_UNARY_PREFIX_DECREMENT: \
212 case EXPR_UNARY_CAST: \
213 case EXPR_UNARY_ASSUME: \
214 case EXPR_UNARY_DELETE: \
215 case EXPR_UNARY_DELETE_ARRAY
216
217 /**
218 * unary expression with optional operand
219 */
220 #define EXPR_UNARY_CASES_OPTIONAL \
221 EXPR_UNARY_THROW
222
223 #define EXPR_UNARY_CASES \
224 EXPR_UNARY_CASES_MANDATORY: \
225 case EXPR_UNARY_CASES_OPTIONAL
226
227 #define EXPR_LITERAL_CASES \
228 EXPR_LITERAL_BOOLEAN: \
229 case EXPR_LITERAL_INTEGER: \
230 case EXPR_LITERAL_FLOATINGPOINT: \
231 case EXPR_LITERAL_MS_NOOP
232
233 /**
234 * The base class of every expression.
235 */
236 struct expression_base_t {
237 expression_kind_t kind; /**< The expression kind. */
238 type_t *type; /**< The type of the expression. */
239 source_position_t source_position; /**< The source position of this expression. */
240 bool parenthesized : 1;
241 #ifndef NDEBUG
242 bool transformed : 1; /**< Set if this expression was transformed. */
243 #endif
244 bool implicit : 1; /**< compiler generated expression.
245 Examples:
246 select into anonymous structs
247 implicit casts
248 */
249 };
250
251 /**
252 * integer, float and boolean constants
253 */
254 struct literal_expression_t {
255 expression_base_t base;
256 string_t value;
257 char const *suffix; /**< Start of the suffix in value. */
258
259 /* ast2firm data */
260 ir_tarval *target_value;
261 };
262
263 /**
264 * string and character literals
265 */
266 struct string_literal_expression_t {
267 expression_base_t base;
268 string_t value;
269 };
270
271 struct funcname_expression_t {
272 expression_base_t base;
273 funcname_kind_t kind;
274 };
275
276 struct compound_literal_expression_t {
277 expression_base_t base;
278 type_t *type;
279 initializer_t *initializer;
280 };
281
282 struct builtin_constant_expression_t {
283 expression_base_t base;
284 expression_t *value;
285 };
286
287 struct builtin_types_compatible_expression_t {
288 expression_base_t base;
289 type_t *left;
290 type_t *right;
291 };
292
293 struct reference_expression_t {
294 expression_base_t base;
295 entity_t *entity;
296 };
297
298 /**
299 * An argument of a call.
300 */
301 struct call_argument_t {
302 expression_t *expression; /**< The expression which value is transmitted. */
303 call_argument_t *next; /**< Links to the next argument of this call. */
304 };
305
306
307 struct call_expression_t {
308 expression_base_t base;
309 expression_t *function; /**< The address of the function to call. */
310 call_argument_t *arguments; /**< List of arguments of this call. */
311 };
312
313
314 struct unary_expression_t {
315 expression_base_t base;
316 expression_t *value; /**< The unary operand. */
317 };
318
319 struct binary_expression_t {
320 expression_base_t base;
321 expression_t *left;
322 expression_t *right;
323 };
324
325 struct select_expression_t {
326 expression_base_t base;
327 expression_t *compound;
328 entity_t *compound_entry;
329 };
330
331 struct array_access_expression_t {
332 expression_base_t base;
333 expression_t *array_ref; /**< the referenced array */
334 expression_t *index; /**< the index used */
335 bool flipped; /**< True if index/ref was written in a 5[a] way */
336 };
337
338 struct typeprop_expression_t {
339 expression_base_t base;
340 type_t *type;
341 expression_t *tp_expression;
342 };
343
344 struct designator_t {
345 source_position_t source_position;
346 symbol_t *symbol; /**< the symbol if any */
347 expression_t *array_index; /**< the array index if any */
348 designator_t *next;
349 };
350
351 struct offsetof_expression_t {
352 expression_base_t base;
353 type_t *type;
354 designator_t *designator;
355 };
356
357 struct va_start_expression_t {
358 expression_base_t base;
359 expression_t *ap;
360 expression_t *parameter;
361 };
362
363 struct va_arg_expression_t {
364 expression_base_t base;
365 expression_t *ap;
366 };
367
368 struct va_copy_expression_t {
369 expression_base_t base;
370 expression_t *dst; /**< destination argument */
371 expression_t *src; /**< source argument */
372 };
373
374 struct conditional_expression_t {
375 expression_base_t base;
376 expression_t *condition;
377 expression_t *true_expression;
378 expression_t *false_expression;
379 };
380
381 struct statement_expression_t {
382 expression_base_t base;
383 statement_t *statement;
384 };
385
386 struct classify_type_expression_t {
387 expression_base_t base;
388 expression_t *type_expression;
389 };
390
391 struct label_address_expression_t {
392 expression_base_t base;
393 label_t *label;
394 };
395
396 union expression_t {
397 expression_kind_t kind;
398 expression_base_t base;
399 literal_expression_t literal;
400 string_literal_expression_t string_literal;
401 funcname_expression_t funcname;
402 compound_literal_expression_t compound_literal;
403 builtin_constant_expression_t builtin_constant;
404 builtin_types_compatible_expression_t builtin_types_compatible;
405 reference_expression_t reference;
406 call_expression_t call;
407 unary_expression_t unary;
408 binary_expression_t binary;
409 select_expression_t select;
410 array_access_expression_t array_access;
411 typeprop_expression_t typeprop;
412 offsetof_expression_t offsetofe;
413 va_start_expression_t va_starte;
414 va_arg_expression_t va_arge;
415 va_copy_expression_t va_copye;
416 conditional_expression_t conditional;
417 statement_expression_t statement;
418 classify_type_expression_t classify_type;
419 label_address_expression_t label_address;
420 };
421
422 typedef enum initializer_kind_t {
423 INITIALIZER_VALUE,
424 INITIALIZER_LIST,
425 INITIALIZER_STRING,
426 INITIALIZER_DESIGNATOR
427 } initializer_kind_t;
428
429 struct initializer_base_t {
430 initializer_kind_t kind;
431 };
432
433 struct initializer_value_t {
434 initializer_base_t base;
435 expression_t *value;
436 };
437
438 struct initializer_list_t {
439 initializer_base_t base;
440 size_t len;
441 initializer_t *initializers[];
442 };
443
444 struct initializer_designator_t {
445 initializer_base_t base;
446 designator_t *designator;
447 };
448
449 union initializer_t {
450 initializer_kind_t kind;
451 initializer_base_t base;
452 initializer_value_t value;
453 initializer_list_t list;
454 initializer_designator_t designator;
455 };
456
get_init_string(initializer_t const * const init)457 static inline string_literal_expression_t const *get_init_string(initializer_t const *const init)
458 {
459 assert(init->kind == INITIALIZER_STRING);
460 assert(init->value.value->kind == EXPR_STRING_LITERAL);
461 return &init->value.value->string_literal;
462 }
463
464 /**
465 * The statement kinds.
466 */
467 typedef enum statement_kind_t {
468 STATEMENT_ERROR = 1,
469 STATEMENT_EMPTY,
470 STATEMENT_COMPOUND,
471 STATEMENT_RETURN,
472 STATEMENT_DECLARATION,
473 STATEMENT_IF,
474 STATEMENT_SWITCH,
475 STATEMENT_EXPRESSION,
476 STATEMENT_CONTINUE,
477 STATEMENT_BREAK,
478 STATEMENT_COMPUTED_GOTO,
479 STATEMENT_GOTO,
480 STATEMENT_LABEL,
481 STATEMENT_CASE_LABEL,
482 STATEMENT_DO_WHILE,
483 STATEMENT_FOR,
484 STATEMENT_ASM,
485 STATEMENT_MS_TRY, /**< MS __try/__finally or __try/__except */
486 STATEMENT_LEAVE /**< MS __leave */
487 } statement_kind_t;
488
489 /**
490 * The base class of every statement.
491 */
492 struct statement_base_t {
493 statement_kind_t kind;
494 statement_t *next; /**< Point to the next statement in a compound statement. */
495 source_position_t source_position;
496 statement_t *parent; /**< The Parent statement that controls the execution. */
497 bool reachable; /**< True, if this statement is reachable. */
498 #ifndef NDEBUG
499 bool transformed;
500 #endif
501 };
502
503 struct return_statement_t {
504 statement_base_t base;
505 expression_t *value; /**< The return value if any. */
506 };
507
508 struct compound_statement_t {
509 statement_base_t base;
510 statement_t *statements;
511 scope_t scope;
512 bool stmt_expr; /**< True if this compound statement is a statement expression. */
513 };
514
515 struct declaration_statement_t {
516 statement_base_t base;
517 entity_t *declarations_begin;
518 entity_t *declarations_end;
519 };
520
521 struct if_statement_t {
522 statement_base_t base;
523 scope_t scope;
524 expression_t *condition;
525 statement_t *true_statement;
526 statement_t *false_statement;
527 };
528
529 struct switch_statement_t {
530 statement_base_t base;
531 scope_t scope;
532 expression_t *expression;
533 statement_t *body;
534 case_label_statement_t *first_case, *last_case; /**< List of all cases, including default. */
535 case_label_statement_t *default_label; /**< The default label if existent. */
536 };
537
538 struct goto_statement_t {
539 statement_base_t base;
540 label_t *label; /**< The destination label. */
541 goto_statement_t *next; /**< links all goto statements of a function */
542 };
543
544 struct computed_goto_statement_t {
545 statement_base_t base;
546 expression_t *expression; /**< The expression for the computed goto. */
547 };
548
549 struct case_label_statement_t {
550 statement_base_t base;
551 expression_t *expression; /**< The case label expression, NULL for default label. */
552 expression_t *end_range; /**< For GNUC case a .. b: the end range expression, NULL else. */
553 case_label_statement_t *next; /**< link to the next case label in switch */
554 statement_t *statement;
555 ir_tarval *first_case;
556 ir_tarval *last_case;
557 bool is_bad; /**< If set marked as bad to suppress warnings. */
558 bool is_empty_range; /**< If set marked this as an empty range. */
559 long pn;
560 };
561
562 struct label_statement_t {
563 statement_base_t base;
564 label_t *label;
565 statement_t *statement;
566 label_statement_t *next; /**< links all label statements of a function */
567 };
568
569 struct expression_statement_t {
570 statement_base_t base;
571 expression_t *expression;
572 };
573
574 struct do_while_statement_t {
575 statement_base_t base;
576 scope_t scope;
577 expression_t *condition;
578 statement_t *body;
579 };
580
581 struct for_statement_t {
582 statement_base_t base;
583 scope_t scope;
584 expression_t *initialisation;
585 expression_t *condition;
586 expression_t *step;
587 statement_t *body;
588 bool condition_reachable:1;
589 bool step_reachable:1;
590 };
591
592 struct asm_argument_t {
593 string_t constraints;
594 expression_t *expression;
595 symbol_t *symbol;
596 asm_argument_t *next;
597 };
598
599 struct asm_clobber_t {
600 string_t clobber;
601 asm_clobber_t *next;
602 };
603
604 struct asm_label_t {
605 label_t *label;
606 asm_label_t *next;
607 };
608
609 struct asm_statement_t {
610 statement_base_t base;
611 string_t asm_text;
612 asm_argument_t *inputs;
613 asm_argument_t *outputs;
614 asm_clobber_t *clobbers;
615 asm_label_t *labels;
616 bool is_volatile;
617 };
618
619 struct ms_try_statement_t {
620 statement_base_t base;
621 statement_t *try_statement;
622 expression_t *except_expression; /**< non-null for except, NULL for finally */
623 statement_t *final_statement;
624 };
625
626 struct leave_statement_t {
627 statement_base_t base;
628 };
629
630 union statement_t {
631 statement_kind_t kind;
632 statement_base_t base;
633 return_statement_t returns;
634 compound_statement_t compound;
635 declaration_statement_t declaration;
636 if_statement_t ifs;
637 switch_statement_t switchs;
638 computed_goto_statement_t computed_goto;
639 goto_statement_t gotos;
640 case_label_statement_t case_label;
641 label_statement_t label;
642 expression_statement_t expression;
643 do_while_statement_t do_while;
644 for_statement_t fors;
645 asm_statement_t asms;
646 ms_try_statement_t ms_try;
647 leave_statement_t leave;
648 };
649
650 struct translation_unit_t {
651 scope_t scope;
652 statement_t *global_asm;
653 };
654
655 /**
656 * Allocate an AST node with given size and
657 * initialize all fields with zero.
658 */
allocate_ast_zero(size_t size)659 static inline void *allocate_ast_zero(size_t size)
660 {
661 return memset(obstack_alloc(&ast_obstack, size), 0, size);
662 }
663
664 /** If set, implicit casts are printed. */
665 extern bool print_implicit_casts;
666 /** If set parenthesis are printed to indicate operator precedence. */
667 extern bool print_parenthesis;
668
669 #endif
670