Add separator_t to aid printing lists with separators.
[cparser] / ast.c
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 #include <config.h>
21
22 #include "ast_t.h"
23 #include "symbol_t.h"
24 #include "type_t.h"
25 #include "parser.h"
26 #include "lang_features.h"
27 #include "entity_t.h"
28 #include "printer.h"
29 #include "separator_t.h"
30 #include "types.h"
31
32 #include <assert.h>
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <ctype.h>
36
37 #if defined(__INTEL_COMPILER)
38 #include <mathimf.h>
39 #elif defined(__CYGWIN__)
40 #include "win32/cygwin_math_ext.h"
41 #else
42 #include <math.h>
43 #endif
44
45 #include "adt/error.h"
46 #include "adt/util.h"
47
48 struct obstack ast_obstack;
49
50 static int indent;
51 static int case_indent;
52
53 bool print_implicit_casts = false;
54 bool print_parenthesis = false;
55
56 static void print_statement(const statement_t *statement);
57 static void print_expression_prec(const expression_t *expression, unsigned prec);
58
59 void change_indent(int delta)
60 {
61         indent += delta;
62         assert(indent >= 0);
63 }
64
65 void print_indent(void)
66 {
67         for (int i = 0; i < indent; ++i)
68                 print_char('\t');
69 }
70
71 /**
72  * Returns 1 if a given precedence level has right-to-left
73  * associativity, else 0.
74  *
75  * @param precedence   the operator precedence
76  */
77 static int right_to_left(unsigned precedence)
78 {
79         switch (precedence) {
80         case PREC_ASSIGNMENT:
81         case PREC_CONDITIONAL:
82         case PREC_UNARY:
83                 return 1;
84
85         default:
86                 return 0;
87         }
88 }
89
90 /**
91  * Return the precedence of an expression given by its kind.
92  *
93  * @param kind   the expression kind
94  */
95 static unsigned get_expression_precedence(expression_kind_t kind)
96 {
97         static const unsigned prec[] = {
98                 [EXPR_ERROR]                      = PREC_PRIMARY,
99                 [EXPR_REFERENCE]                  = PREC_PRIMARY,
100                 [EXPR_ENUM_CONSTANT]              = PREC_PRIMARY,
101                 [EXPR_LITERAL_INTEGER]            = PREC_PRIMARY,
102                 [EXPR_LITERAL_FLOATINGPOINT]      = PREC_PRIMARY,
103                 [EXPR_LITERAL_CHARACTER]          = PREC_PRIMARY,
104                 [EXPR_LITERAL_MS_NOOP]            = PREC_PRIMARY,
105                 [EXPR_STRING_LITERAL]             = PREC_PRIMARY,
106                 [EXPR_COMPOUND_LITERAL]           = PREC_UNARY,
107                 [EXPR_CALL]                       = PREC_POSTFIX,
108                 [EXPR_CONDITIONAL]                = PREC_CONDITIONAL,
109                 [EXPR_SELECT]                     = PREC_POSTFIX,
110                 [EXPR_ARRAY_ACCESS]               = PREC_POSTFIX,
111                 [EXPR_SIZEOF]                     = PREC_UNARY,
112                 [EXPR_CLASSIFY_TYPE]              = PREC_UNARY,
113                 [EXPR_ALIGNOF]                    = PREC_UNARY,
114
115                 [EXPR_FUNCNAME]                   = PREC_PRIMARY,
116                 [EXPR_BUILTIN_CONSTANT_P]         = PREC_PRIMARY,
117                 [EXPR_BUILTIN_TYPES_COMPATIBLE_P] = PREC_PRIMARY,
118                 [EXPR_OFFSETOF]                   = PREC_PRIMARY,
119                 [EXPR_VA_START]                   = PREC_PRIMARY,
120                 [EXPR_VA_ARG]                     = PREC_PRIMARY,
121                 [EXPR_VA_COPY]                    = PREC_PRIMARY,
122                 [EXPR_STATEMENT]                  = PREC_PRIMARY,
123                 [EXPR_LABEL_ADDRESS]              = PREC_PRIMARY,
124
125                 [EXPR_UNARY_NEGATE]               = PREC_UNARY,
126                 [EXPR_UNARY_PLUS]                 = PREC_UNARY,
127                 [EXPR_UNARY_BITWISE_NEGATE]       = PREC_UNARY,
128                 [EXPR_UNARY_NOT]                  = PREC_UNARY,
129                 [EXPR_UNARY_DEREFERENCE]          = PREC_UNARY,
130                 [EXPR_UNARY_TAKE_ADDRESS]         = PREC_UNARY,
131                 [EXPR_UNARY_POSTFIX_INCREMENT]    = PREC_POSTFIX,
132                 [EXPR_UNARY_POSTFIX_DECREMENT]    = PREC_POSTFIX,
133                 [EXPR_UNARY_PREFIX_INCREMENT]     = PREC_UNARY,
134                 [EXPR_UNARY_PREFIX_DECREMENT]     = PREC_UNARY,
135                 [EXPR_UNARY_CAST]                 = PREC_UNARY,
136                 [EXPR_UNARY_ASSUME]               = PREC_PRIMARY,
137                 [EXPR_UNARY_DELETE]               = PREC_UNARY,
138                 [EXPR_UNARY_DELETE_ARRAY]         = PREC_UNARY,
139                 [EXPR_UNARY_THROW]                = PREC_ASSIGNMENT,
140
141                 [EXPR_BINARY_ADD]                 = PREC_ADDITIVE,
142                 [EXPR_BINARY_SUB]                 = PREC_ADDITIVE,
143                 [EXPR_BINARY_MUL]                 = PREC_MULTIPLICATIVE,
144                 [EXPR_BINARY_DIV]                 = PREC_MULTIPLICATIVE,
145                 [EXPR_BINARY_MOD]                 = PREC_MULTIPLICATIVE,
146                 [EXPR_BINARY_EQUAL]               = PREC_EQUALITY,
147                 [EXPR_BINARY_NOTEQUAL]            = PREC_EQUALITY,
148                 [EXPR_BINARY_LESS]                = PREC_RELATIONAL,
149                 [EXPR_BINARY_LESSEQUAL]           = PREC_RELATIONAL,
150                 [EXPR_BINARY_GREATER]             = PREC_RELATIONAL,
151                 [EXPR_BINARY_GREATEREQUAL]        = PREC_RELATIONAL,
152                 [EXPR_BINARY_BITWISE_AND]         = PREC_AND,
153                 [EXPR_BINARY_BITWISE_OR]          = PREC_OR,
154                 [EXPR_BINARY_BITWISE_XOR]         = PREC_XOR,
155                 [EXPR_BINARY_LOGICAL_AND]         = PREC_LOGICAL_AND,
156                 [EXPR_BINARY_LOGICAL_OR]          = PREC_LOGICAL_OR,
157                 [EXPR_BINARY_SHIFTLEFT]           = PREC_SHIFT,
158                 [EXPR_BINARY_SHIFTRIGHT]          = PREC_SHIFT,
159                 [EXPR_BINARY_ASSIGN]              = PREC_ASSIGNMENT,
160                 [EXPR_BINARY_MUL_ASSIGN]          = PREC_ASSIGNMENT,
161                 [EXPR_BINARY_DIV_ASSIGN]          = PREC_ASSIGNMENT,
162                 [EXPR_BINARY_MOD_ASSIGN]          = PREC_ASSIGNMENT,
163                 [EXPR_BINARY_ADD_ASSIGN]          = PREC_ASSIGNMENT,
164                 [EXPR_BINARY_SUB_ASSIGN]          = PREC_ASSIGNMENT,
165                 [EXPR_BINARY_SHIFTLEFT_ASSIGN]    = PREC_ASSIGNMENT,
166                 [EXPR_BINARY_SHIFTRIGHT_ASSIGN]   = PREC_ASSIGNMENT,
167                 [EXPR_BINARY_BITWISE_AND_ASSIGN]  = PREC_ASSIGNMENT,
168                 [EXPR_BINARY_BITWISE_XOR_ASSIGN]  = PREC_ASSIGNMENT,
169                 [EXPR_BINARY_BITWISE_OR_ASSIGN]   = PREC_ASSIGNMENT,
170                 [EXPR_BINARY_COMMA]               = PREC_EXPRESSION,
171
172                 [EXPR_BINARY_ISGREATER]           = PREC_PRIMARY,
173                 [EXPR_BINARY_ISGREATEREQUAL]      = PREC_PRIMARY,
174                 [EXPR_BINARY_ISLESS]              = PREC_PRIMARY,
175                 [EXPR_BINARY_ISLESSEQUAL]         = PREC_PRIMARY,
176                 [EXPR_BINARY_ISLESSGREATER]       = PREC_PRIMARY,
177                 [EXPR_BINARY_ISUNORDERED]         = PREC_PRIMARY
178         };
179         assert((size_t)kind < lengthof(prec));
180         unsigned res = prec[kind];
181
182         assert(res != PREC_BOTTOM);
183         return res;
184 }
185
186 /**
187  * Print a quoted string constant.
188  *
189  * @param string  the string constant
190  * @param border  the border char
191  */
192 static void print_quoted_string(const string_t *const string, char border)
193 {
194         print_string(get_string_encoding_prefix(string->encoding));
195
196         print_char(border);
197         const char *end = string->begin + string->size;
198         for (const char *c = string->begin; c != end; ++c) {
199                 const char tc = *c;
200                 if (tc == border) {
201                         print_char('\\');
202                 }
203                 switch (tc) {
204                 case '\\': print_string("\\\\"); break;
205                 case '\a': print_string("\\a"); break;
206                 case '\b': print_string("\\b"); break;
207                 case '\f': print_string("\\f"); break;
208                 case '\n': print_string("\\n"); break;
209                 case '\r': print_string("\\r"); break;
210                 case '\t': print_string("\\t"); break;
211                 case '\v': print_string("\\v"); break;
212                 case '\?': print_string("\\?"); break;
213                 case 27:
214                         if (c_mode & _GNUC) {
215                                 print_string("\\e"); break;
216                         }
217                         /* FALLTHROUGH */
218                 default:
219                         if ((unsigned)tc < 0x80 && !isprint(tc)) {
220                                 print_format("\\%03o", (unsigned)tc);
221                         } else {
222                                 print_char(tc);
223                         }
224                         break;
225                 }
226         }
227         print_char(border);
228 }
229
230 static void print_string_literal(string_literal_expression_t const *const literal, char const delimiter)
231 {
232         print_quoted_string(&literal->value, delimiter);
233 }
234
235 static void print_literal(const literal_expression_t *literal)
236 {
237         switch (literal->base.kind) {
238         case EXPR_LITERAL_MS_NOOP:
239                 print_string("__noop");
240                 return;
241
242         case EXPR_LITERAL_BOOLEAN:
243         case EXPR_LITERAL_FLOATINGPOINT:
244         case EXPR_LITERAL_INTEGER:
245                 print_string(literal->value.begin);
246                 return;
247
248         default:
249                 break;
250         }
251         print_string("INVALID LITERAL KIND");
252 }
253
254 /**
255  * Prints a predefined symbol.
256  */
257 static void print_funcname(const funcname_expression_t *funcname)
258 {
259         const char *s = "";
260         switch (funcname->kind) {
261         case FUNCNAME_FUNCTION:        s = (c_mode & _C99) ? "__func__" : "__FUNCTION__"; break;
262         case FUNCNAME_PRETTY_FUNCTION: s = "__PRETTY_FUNCTION__"; break;
263         case FUNCNAME_FUNCSIG:         s = "__FUNCSIG__"; break;
264         case FUNCNAME_FUNCDNAME:       s = "__FUNCDNAME__"; break;
265         }
266         print_string(s);
267 }
268
269 static void print_compound_literal(
270                 const compound_literal_expression_t *expression)
271 {
272         print_char('(');
273         print_type(expression->type);
274         print_char(')');
275         print_initializer(expression->initializer);
276 }
277
278 static void print_assignment_expression(const expression_t *const expr)
279 {
280         print_expression_prec(expr, PREC_ASSIGNMENT);
281 }
282
283 /**
284  * Prints a call expression.
285  *
286  * @param call  the call expression
287  */
288 static void print_call_expression(const call_expression_t *call)
289 {
290         print_expression_prec(call->function, PREC_POSTFIX);
291         print_char('(');
292         separator_t sep = { "", ", " };
293         for (call_argument_t const *arg = call->arguments; arg; arg = arg->next) {
294                 print_string(sep_next(&sep));
295                 print_assignment_expression(arg->expression);
296         }
297         print_char(')');
298 }
299
300 /**
301  * Prints a binary expression.
302  *
303  * @param binexpr   the binary expression
304  */
305 static void print_binary_expression(const binary_expression_t *binexpr)
306 {
307         unsigned prec = get_expression_precedence(binexpr->base.kind);
308         int      r2l  = right_to_left(prec);
309
310         print_expression_prec(binexpr->left, prec + r2l);
311         char const* op;
312         switch (binexpr->base.kind) {
313         case EXPR_BINARY_COMMA:              op = ", ";    break;
314         case EXPR_BINARY_ASSIGN:             op = " = ";   break;
315         case EXPR_BINARY_ADD:                op = " + ";   break;
316         case EXPR_BINARY_SUB:                op = " - ";   break;
317         case EXPR_BINARY_MUL:                op = " * ";   break;
318         case EXPR_BINARY_MOD:                op = " % ";   break;
319         case EXPR_BINARY_DIV:                op = " / ";   break;
320         case EXPR_BINARY_BITWISE_OR:         op = " | ";   break;
321         case EXPR_BINARY_BITWISE_AND:        op = " & ";   break;
322         case EXPR_BINARY_BITWISE_XOR:        op = " ^ ";   break;
323         case EXPR_BINARY_LOGICAL_OR:         op = " || ";  break;
324         case EXPR_BINARY_LOGICAL_AND:        op = " && ";  break;
325         case EXPR_BINARY_NOTEQUAL:           op = " != ";  break;
326         case EXPR_BINARY_EQUAL:              op = " == ";  break;
327         case EXPR_BINARY_LESS:               op = " < ";   break;
328         case EXPR_BINARY_LESSEQUAL:          op = " <= ";  break;
329         case EXPR_BINARY_GREATER:            op = " > ";   break;
330         case EXPR_BINARY_GREATEREQUAL:       op = " >= ";  break;
331         case EXPR_BINARY_SHIFTLEFT:          op = " << ";  break;
332         case EXPR_BINARY_SHIFTRIGHT:         op = " >> ";  break;
333
334         case EXPR_BINARY_ADD_ASSIGN:         op = " += ";  break;
335         case EXPR_BINARY_SUB_ASSIGN:         op = " -= ";  break;
336         case EXPR_BINARY_MUL_ASSIGN:         op = " *= ";  break;
337         case EXPR_BINARY_MOD_ASSIGN:         op = " %= ";  break;
338         case EXPR_BINARY_DIV_ASSIGN:         op = " /= ";  break;
339         case EXPR_BINARY_BITWISE_OR_ASSIGN:  op = " |= ";  break;
340         case EXPR_BINARY_BITWISE_AND_ASSIGN: op = " &= ";  break;
341         case EXPR_BINARY_BITWISE_XOR_ASSIGN: op = " ^= ";  break;
342         case EXPR_BINARY_SHIFTLEFT_ASSIGN:   op = " <<= "; break;
343         case EXPR_BINARY_SHIFTRIGHT_ASSIGN:  op = " >>= "; break;
344         default: panic("invalid binexpression found");
345         }
346         print_string(op);
347         print_expression_prec(binexpr->right, prec + 1 - r2l);
348 }
349
350 /**
351  * Prints an unary expression.
352  *
353  * @param unexpr   the unary expression
354  */
355 static void print_unary_expression(const unary_expression_t *unexpr)
356 {
357         unsigned prec = get_expression_precedence(unexpr->base.kind);
358         switch (unexpr->base.kind) {
359         case EXPR_UNARY_NEGATE:           print_char  ('-' ); break;
360         case EXPR_UNARY_PLUS:             print_char  ('+' ); break;
361         case EXPR_UNARY_NOT:              print_char  ('!' ); break;
362         case EXPR_UNARY_BITWISE_NEGATE:   print_char  ('~' ); break;
363         case EXPR_UNARY_PREFIX_INCREMENT: print_string("++"); break;
364         case EXPR_UNARY_PREFIX_DECREMENT: print_string("--"); break;
365         case EXPR_UNARY_DEREFERENCE:      print_char  ('*' ); break;
366         case EXPR_UNARY_TAKE_ADDRESS:     print_char  ('&' ); break;
367         case EXPR_UNARY_DELETE:           print_string("delete "); break;
368         case EXPR_UNARY_DELETE_ARRAY:     print_string("delete [] "); break;
369
370         case EXPR_UNARY_POSTFIX_INCREMENT:
371                 print_expression_prec(unexpr->value, prec);
372                 print_string("++");
373                 return;
374         case EXPR_UNARY_POSTFIX_DECREMENT:
375                 print_expression_prec(unexpr->value, prec);
376                 print_string("--");
377                 return;
378         case EXPR_UNARY_CAST:
379                 print_char('(');
380                 print_type(unexpr->base.type);
381                 print_char(')');
382                 break;
383         case EXPR_UNARY_ASSUME:
384                 print_string("__assume(");
385                 print_assignment_expression(unexpr->value);
386                 print_char(')');
387                 return;
388
389         case EXPR_UNARY_THROW:
390                 if (unexpr->value == NULL) {
391                         print_string("throw");
392                         return;
393                 }
394                 print_string("throw ");
395                 break;
396
397         default:
398                 panic("invalid unary expression found");
399         }
400         print_expression_prec(unexpr->value, prec);
401 }
402
403 /**
404  * Prints a reference expression.
405  *
406  * @param ref   the reference expression
407  */
408 static void print_reference_expression(const reference_expression_t *ref)
409 {
410         print_string(ref->entity->base.symbol->string);
411 }
412
413 /**
414  * Prints a label address expression.
415  *
416  * @param ref   the reference expression
417  */
418 static void print_label_address_expression(const label_address_expression_t *le)
419 {
420         print_format("&&%s", le->label->base.symbol->string);
421 }
422
423 /**
424  * Prints an array expression.
425  *
426  * @param expression   the array expression
427  */
428 static void print_array_expression(const array_access_expression_t *expression)
429 {
430         if (!expression->flipped) {
431                 print_expression_prec(expression->array_ref, PREC_POSTFIX);
432                 print_char('[');
433                 print_expression(expression->index);
434                 print_char(']');
435         } else {
436                 print_expression_prec(expression->index, PREC_POSTFIX);
437                 print_char('[');
438                 print_expression(expression->array_ref);
439                 print_char(']');
440         }
441 }
442
443 /**
444  * Prints a typeproperty expression (sizeof or __alignof__).
445  *
446  * @param expression   the type property expression
447  */
448 static void print_typeprop_expression(const typeprop_expression_t *expression)
449 {
450         switch (expression->base.kind) {
451         case EXPR_SIZEOF:  print_string("sizeof");                                   break;
452         case EXPR_ALIGNOF: print_string(c_mode & _C11 ? "_Alignof" : "__alignof__"); break;
453         default:           panic("invalid typeprop kind");
454         }
455         if (expression->tp_expression != NULL) {
456                 /* PREC_TOP: always print the '()' here, sizeof x is right but unusual */
457                 print_expression_prec(expression->tp_expression, PREC_TOP);
458         } else {
459                 print_char('(');
460                 print_type(expression->type);
461                 print_char(')');
462         }
463 }
464
465 /**
466  * Prints a builtin constant expression.
467  *
468  * @param expression   the builtin constant expression
469  */
470 static void print_builtin_constant(const builtin_constant_expression_t *expression)
471 {
472         print_string("__builtin_constant_p(");
473         print_assignment_expression(expression->value);
474         print_char(')');
475 }
476
477 /**
478  * Prints a builtin types compatible expression.
479  *
480  * @param expression   the builtin types compatible expression
481  */
482 static void print_builtin_types_compatible(
483                 const builtin_types_compatible_expression_t *expression)
484 {
485         print_string("__builtin_types_compatible_p(");
486         print_type(expression->left);
487         print_string(", ");
488         print_type(expression->right);
489         print_char(')');
490 }
491
492 /**
493  * Prints a conditional expression.
494  *
495  * @param expression   the conditional expression
496  */
497 static void print_conditional(const conditional_expression_t *expression)
498 {
499         print_expression_prec(expression->condition, PREC_LOGICAL_OR);
500         if (expression->true_expression != NULL) {
501                 print_string(" ? ");
502                 print_expression_prec(expression->true_expression, PREC_EXPRESSION);
503                 print_string(" : ");
504         } else {
505                 print_string(" ?: ");
506         }
507         precedence_t prec = c_mode & _CXX ? PREC_ASSIGNMENT : PREC_CONDITIONAL;
508         print_expression_prec(expression->false_expression, prec);
509 }
510
511 /**
512  * Prints a va_start expression.
513  *
514  * @param expression   the va_start expression
515  */
516 static void print_va_start(const va_start_expression_t *const expression)
517 {
518         print_string("__builtin_va_start(");
519         print_assignment_expression(expression->ap);
520         print_string(", ");
521         print_assignment_expression(expression->parameter);
522         print_char(')');
523 }
524
525 /**
526  * Prints a va_arg expression.
527  *
528  * @param expression   the va_arg expression
529  */
530 static void print_va_arg(const va_arg_expression_t *expression)
531 {
532         print_string("__builtin_va_arg(");
533         print_assignment_expression(expression->ap);
534         print_string(", ");
535         print_type(expression->base.type);
536         print_char(')');
537 }
538
539 /**
540  * Prints a va_copy expression.
541  *
542  * @param expression   the va_copy expression
543  */
544 static void print_va_copy(const va_copy_expression_t *expression)
545 {
546         print_string("__builtin_va_copy(");
547         print_assignment_expression(expression->dst);
548         print_string(", ");
549         print_assignment_expression(expression->src);
550         print_char(')');
551 }
552
553 /**
554  * Prints a select expression (. or ->).
555  *
556  * @param expression   the select expression
557  */
558 static void print_select(const select_expression_t *expression)
559 {
560         print_expression_prec(expression->compound, PREC_POSTFIX);
561         /* do not print anything for anonymous struct/union selects
562          * FIXME: if the anonymous select was a '->' this will print '.'
563          */
564         if (expression->compound_entry->base.symbol == NULL)
565                 return;
566
567         if (is_type_pointer(skip_typeref(expression->compound->base.type))) {
568                 print_string("->");
569         } else {
570                 print_char('.');
571         }
572         print_string(expression->compound_entry->base.symbol->string);
573 }
574
575 /**
576  * Prints a type classify expression.
577  *
578  * @param expr   the type classify expression
579  */
580 static void print_classify_type_expression(
581         const classify_type_expression_t *const expr)
582 {
583         print_string("__builtin_classify_type(");
584         print_assignment_expression(expr->type_expression);
585         print_char(')');
586 }
587
588 /**
589  * Prints a designator.
590  *
591  * @param designator  the designator
592  */
593 static void print_designator(const designator_t *designator)
594 {
595         for ( ; designator != NULL; designator = designator->next) {
596                 if (designator->symbol == NULL) {
597                         print_char('[');
598                         print_expression(designator->array_index);
599                         print_char(']');
600                 } else {
601                         print_char('.');
602                         print_string(designator->symbol->string);
603                 }
604         }
605 }
606
607 /**
608  * Prints an offsetof expression.
609  *
610  * @param expression   the offset expression
611  */
612 static void print_offsetof_expression(const offsetof_expression_t *expression)
613 {
614         print_string("__builtin_offsetof(");
615         print_type(expression->type);
616         print_char(',');
617         print_designator(expression->designator);
618         print_char(')');
619 }
620
621 /**
622  * Prints a statement expression.
623  *
624  * @param expression   the statement expression
625  */
626 static void print_statement_expression(const statement_expression_t *expression)
627 {
628         print_char('(');
629         print_statement(expression->statement);
630         print_char(')');
631 }
632
633 static bool needs_parentheses(expression_t const *const expr, unsigned const top_prec)
634 {
635         if (expr->base.parenthesized)
636                 return true;
637
638         if (top_prec > get_expression_precedence(expr->base.kind))
639                 return true;
640
641         if (print_parenthesis && top_prec != PREC_BOTTOM) {
642                 switch (expr->kind) {
643                 case EXPR_ENUM_CONSTANT:
644                 case EXPR_FUNCNAME:
645                 case EXPR_LITERAL_CASES:
646                 case EXPR_LITERAL_CHARACTER:
647                 case EXPR_REFERENCE:
648                 case EXPR_STRING_LITERAL:
649                         /* Do not print () around subexpressions consisting of a single token. */
650                         return false;
651
652                 default:
653                         return true;
654                 }
655         }
656
657         return false;
658 }
659
660 /**
661  * Prints an expression with parenthesis if needed.
662  *
663  * @param expression  the expression to print
664  * @param top_prec    the precedence of the user of this expression.
665  */
666 static void print_expression_prec(expression_t const *expr, unsigned const top_prec)
667 {
668         if (expr->kind == EXPR_UNARY_CAST && expr->base.implicit && !print_implicit_casts) {
669                 expr = expr->unary.value;
670         }
671
672         bool const parenthesized = needs_parentheses(expr, top_prec);
673
674         if (parenthesized)
675                 print_char('(');
676         switch (expr->kind) {
677         case EXPR_ALIGNOF:
678         case EXPR_SIZEOF:                     print_typeprop_expression(     &expr->typeprop);                 break;
679         case EXPR_ARRAY_ACCESS:               print_array_expression(        &expr->array_access);             break;
680         case EXPR_BINARY_CASES:               print_binary_expression(       &expr->binary);                   break;
681         case EXPR_BUILTIN_CONSTANT_P:         print_builtin_constant(        &expr->builtin_constant);         break;
682         case EXPR_BUILTIN_TYPES_COMPATIBLE_P: print_builtin_types_compatible(&expr->builtin_types_compatible); break;
683         case EXPR_CALL:                       print_call_expression(         &expr->call);                     break;
684         case EXPR_CLASSIFY_TYPE:              print_classify_type_expression(&expr->classify_type);            break;
685         case EXPR_COMPOUND_LITERAL:           print_compound_literal(        &expr->compound_literal);         break;
686         case EXPR_CONDITIONAL:                print_conditional(             &expr->conditional);              break;
687         case EXPR_ERROR:                      print_string("$error$");                                         break;
688         case EXPR_FUNCNAME:                   print_funcname(                &expr->funcname);                 break;
689         case EXPR_LABEL_ADDRESS:              print_label_address_expression(&expr->label_address);            break;
690         case EXPR_LITERAL_CASES:              print_literal(                 &expr->literal);                  break;
691         case EXPR_LITERAL_CHARACTER:          print_string_literal(          &expr->string_literal, '\'');     break;
692         case EXPR_OFFSETOF:                   print_offsetof_expression(     &expr->offsetofe);                break;
693         case EXPR_REFERENCE:
694         case EXPR_ENUM_CONSTANT:              print_reference_expression(    &expr->reference);                break;
695         case EXPR_SELECT:                     print_select(                  &expr->select);                   break;
696         case EXPR_STATEMENT:                  print_statement_expression(    &expr->statement);                break;
697         case EXPR_STRING_LITERAL:             print_string_literal(          &expr->string_literal, '"');      break;
698         case EXPR_UNARY_CASES:                print_unary_expression(        &expr->unary);                    break;
699         case EXPR_VA_ARG:                     print_va_arg(                  &expr->va_arge);                  break;
700         case EXPR_VA_COPY:                    print_va_copy(                 &expr->va_copye);                 break;
701         case EXPR_VA_START:                   print_va_start(                &expr->va_starte);                break;
702         }
703         if (parenthesized)
704                 print_char(')');
705 }
706
707 static void print_indented_statement(statement_t const *const stmt)
708 {
709         switch (stmt->kind) {
710         case STATEMENT_LABEL:
711                 break;
712
713         case STATEMENT_CASE_LABEL:
714                 for (int i = 0; i != case_indent; ++i)
715                         print_char('\t');
716                 break;
717
718         default:
719                 print_indent();
720                 break;
721         }
722         print_statement(stmt);
723 }
724
725 /**
726  * Print an compound statement.
727  *
728  * @param block  the compound statement
729  */
730 static void print_compound_statement(const compound_statement_t *block)
731 {
732         print_string("{\n");
733         ++indent;
734
735         for (statement_t const *stmt = block->statements; stmt; stmt = stmt->base.next) {
736                 print_indented_statement(stmt);
737                 print_char('\n');
738         }
739
740         --indent;
741         print_indent();
742         print_char('}');
743 }
744
745 /**
746  * Print a return statement.
747  *
748  * @param statement  the return statement
749  */
750 static void print_return_statement(const return_statement_t *statement)
751 {
752         expression_t const *const val = statement->value;
753         if (val != NULL) {
754                 print_string("return ");
755                 print_expression(val);
756                 print_char(';');
757         } else {
758                 print_string("return;");
759         }
760 }
761
762 /**
763  * Print an expression statement.
764  *
765  * @param statement  the expression statement
766  */
767 static void print_expression_statement(const expression_statement_t *statement)
768 {
769         print_expression(statement->expression);
770         print_char(';');
771 }
772
773 /**
774  * Print a computed goto statement.
775  *
776  * @param statement  the computed goto statement
777  */
778 static void print_computed_goto_statement(computed_goto_statement_t const *const stmt)
779 {
780         print_string("goto *");
781         print_expression(stmt->expression);
782         print_char(';');
783 }
784
785 /**
786  * Print a goto statement.
787  *
788  * @param statement  the goto statement
789  */
790 static void print_goto_statement(const goto_statement_t *statement)
791 {
792         print_string("goto ");
793         print_string(statement->label->base.symbol->string);
794         print_char(';');
795 }
796
797 /**
798  * Print a label statement.
799  *
800  * @param statement  the label statement
801  */
802 static void print_label_statement(const label_statement_t *statement)
803 {
804         print_format("%s:\n", statement->label->base.symbol->string);
805         print_indented_statement(statement->statement);
806 }
807
808 static void print_inner_statement(statement_t const *const stmt)
809 {
810         if (stmt->kind == STATEMENT_COMPOUND) {
811                 print_char(' ');
812                 print_compound_statement(&stmt->compound);
813         } else {
814                 print_char('\n');
815                 ++indent;
816                 print_indented_statement(stmt);
817                 --indent;
818         }
819 }
820
821 static void print_after_inner_statement(statement_t const *const stmt)
822 {
823         if (stmt->kind == STATEMENT_COMPOUND) {
824                 print_char(' ');
825         } else {
826                 print_char('\n');
827                 print_indent();
828         }
829 }
830
831 /**
832  * Print an if statement.
833  *
834  * @param statement  the if statement
835  */
836 static void print_if_statement(const if_statement_t *statement)
837 {
838         print_string("if (");
839         print_expression(statement->condition);
840         print_char(')');
841         print_inner_statement(statement->true_statement);
842
843         statement_t const *const f = statement->false_statement;
844         if (f) {
845                 print_after_inner_statement(statement->true_statement);
846                 print_string("else");
847                 if (f->kind == STATEMENT_IF) {
848                         print_char(' ');
849                         print_if_statement(&f->ifs);
850                 } else {
851                         print_inner_statement(f);
852                 }
853         }
854 }
855
856 /**
857  * Print a switch statement.
858  *
859  * @param statement  the switch statement
860  */
861 static void print_switch_statement(const switch_statement_t *statement)
862 {
863         int const old_case_indent = case_indent;
864         case_indent = indent;
865
866         print_string("switch (");
867         print_expression(statement->expression);
868         print_char(')');
869         print_inner_statement(statement->body);
870
871         case_indent = old_case_indent;
872 }
873
874 /**
875  * Print a case label (including the default label).
876  *
877  * @param statement  the case label statement
878  */
879 static void print_case_label(const case_label_statement_t *statement)
880 {
881         if (statement->expression == NULL) {
882                 print_string("default:\n");
883         } else {
884                 print_string("case ");
885                 print_expression(statement->expression);
886                 if (statement->end_range != NULL) {
887                         print_string(" ... ");
888                         print_expression(statement->end_range);
889                 }
890                 print_string(":\n");
891         }
892         print_indented_statement(statement->statement);
893 }
894
895 static void print_typedef(const entity_t *entity)
896 {
897         print_string("typedef ");
898         print_type_ext(entity->typedefe.type, entity->base.symbol, NULL);
899         print_char(';');
900 }
901
902 /**
903  * returns true if the entity is a compiler generated one and has no real
904  * correspondenc in the source file
905  */
906 static bool is_generated_entity(const entity_t *entity)
907 {
908         if (entity->kind == ENTITY_TYPEDEF)
909                 return entity->typedefe.builtin;
910
911         if (is_declaration(entity))
912                 return entity->declaration.implicit;
913
914         return false;
915 }
916
917 /**
918  * Print a declaration statement.
919  *
920  * @param statement   the statement
921  */
922 static void print_declaration_statement(
923                 const declaration_statement_t *statement)
924 {
925         bool first = true;
926         entity_t *entity = statement->declarations_begin;
927         if (entity == NULL) {
928                 print_string("/* empty declaration statement */");
929                 return;
930         }
931
932         entity_t *const end = statement->declarations_end->base.next;
933         for (; entity != end; entity = entity->base.next) {
934                 if (entity->kind == ENTITY_ENUM_VALUE)
935                         continue;
936                 if (is_generated_entity(entity))
937                         continue;
938
939                 if (!first) {
940                         print_char('\n');
941                         print_indent();
942                 } else {
943                         first = false;
944                 }
945
946                 print_entity(entity);
947         }
948 }
949
950 /**
951  * Print a do-while statement.
952  *
953  * @param statement   the statement
954  */
955 static void print_do_while_statement(const do_while_statement_t *statement)
956 {
957         print_string("do");
958         print_inner_statement(statement->body);
959         print_after_inner_statement(statement->body);
960         print_string("while (");
961         print_expression(statement->condition);
962         print_string(");");
963 }
964
965 /**
966  * Print a for statement.
967  *
968  * @param statement   the statement
969  */
970 static void print_for_statement(const for_statement_t *statement)
971 {
972         if (statement->initialisation || statement->scope.entities || !statement->condition || statement->step) {
973                 print_string("for (");
974                 if (statement->initialisation != NULL) {
975                         print_expression(statement->initialisation);
976                         print_char(';');
977                 } else {
978                         entity_t const *entity = statement->scope.entities;
979                         for (; entity != NULL; entity = entity->base.next) {
980                                 if (is_generated_entity(entity))
981                                         continue;
982                                 /* FIXME display of multiple declarations is wrong */
983                                 print_declaration(entity);
984                         }
985                 }
986                 if (statement->condition != NULL) {
987                         print_char(' ');
988                         print_expression(statement->condition);
989                 }
990                 print_char(';');
991                 if (statement->step != NULL) {
992                         print_char(' ');
993                         print_expression(statement->step);
994                 }
995         } else {
996                 print_string("while (");
997                 print_expression(statement->condition);
998         }
999         print_char(')');
1000         print_inner_statement(statement->body);
1001 }
1002
1003 /**
1004  * Print assembler arguments.
1005  *
1006  * @param arguments   the arguments
1007  */
1008 static void print_asm_arguments(asm_argument_t *arguments)
1009 {
1010         separator_t     sep      = { "", ", " };
1011         asm_argument_t *argument = arguments;
1012         for (; argument != NULL; argument = argument->next) {
1013                 print_string(sep_next(&sep));
1014                 if (argument->symbol) {
1015                         print_format("[%s] ", argument->symbol->string);
1016                 }
1017                 print_quoted_string(&argument->constraints, '"');
1018                 print_string(" (");
1019                 print_expression(argument->expression);
1020                 print_char(')');
1021         }
1022 }
1023
1024 /**
1025  * Print assembler clobbers.
1026  *
1027  * @param clobbers   the clobbers
1028  */
1029 static void print_asm_clobbers(asm_clobber_t *clobbers)
1030 {
1031         separator_t    sep     = { "", ", " };
1032         asm_clobber_t *clobber = clobbers;
1033         for (; clobber != NULL; clobber = clobber->next) {
1034                 print_string(sep_next(&sep));
1035                 print_quoted_string(&clobber->clobber, '"');
1036         }
1037 }
1038
1039 /**
1040  * Print an assembler statement.
1041  *
1042  * @param statement   the statement
1043  */
1044 static void print_asm_statement(const asm_statement_t *statement)
1045 {
1046         print_string("asm ");
1047         if (statement->is_volatile) {
1048                 print_string("volatile ");
1049         }
1050         print_char('(');
1051         print_quoted_string(&statement->asm_text, '"');
1052         if (statement->outputs  == NULL &&
1053             statement->inputs   == NULL &&
1054             statement->clobbers == NULL)
1055                 goto end_of_print_asm_statement;
1056
1057         print_string(" : ");
1058         print_asm_arguments(statement->outputs);
1059         if (statement->inputs == NULL && statement->clobbers == NULL)
1060                 goto end_of_print_asm_statement;
1061
1062         print_string(" : ");
1063         print_asm_arguments(statement->inputs);
1064         if (statement->clobbers == NULL)
1065                 goto end_of_print_asm_statement;
1066
1067         print_string(" : ");
1068         print_asm_clobbers(statement->clobbers);
1069
1070 end_of_print_asm_statement:
1071         print_string(");");
1072 }
1073
1074 /**
1075  * Print a microsoft __try statement.
1076  *
1077  * @param statement   the statement
1078  */
1079 static void print_ms_try_statement(const ms_try_statement_t *statement)
1080 {
1081         print_string("__try");
1082         print_inner_statement(statement->try_statement);
1083         print_after_inner_statement(statement->try_statement);
1084         if (statement->except_expression != NULL) {
1085                 print_string("__except(");
1086                 print_expression(statement->except_expression);
1087                 print_char(')');
1088         } else {
1089                 print_string("__finally");
1090         }
1091         print_inner_statement(statement->final_statement);
1092 }
1093
1094 /**
1095  * Print a microsoft __leave statement.
1096  *
1097  * @param statement   the statement
1098  */
1099 static void print_leave_statement(const leave_statement_t *statement)
1100 {
1101         (void)statement;
1102         print_string("__leave;");
1103 }
1104
1105 /**
1106  * Print a statement.
1107  *
1108  * @param statement   the statement
1109  */
1110 void print_statement(statement_t const *const stmt)
1111 {
1112         switch (stmt->kind) {
1113         case STATEMENT_ASM:           print_asm_statement(          &stmt->asms);          break;
1114         case STATEMENT_BREAK:         print_string("break;");                              break;
1115         case STATEMENT_CASE_LABEL:    print_case_label(             &stmt->case_label);    break;
1116         case STATEMENT_COMPOUND:      print_compound_statement(     &stmt->compound);      break;
1117         case STATEMENT_COMPUTED_GOTO: print_computed_goto_statement(&stmt->computed_goto); break;
1118         case STATEMENT_CONTINUE:      print_string("continue;");                           break;
1119         case STATEMENT_DECLARATION:   print_declaration_statement(  &stmt->declaration);   break;
1120         case STATEMENT_DO_WHILE:      print_do_while_statement(     &stmt->do_while);      break;
1121         case STATEMENT_EMPTY:         print_char(';');                                     break;
1122         case STATEMENT_ERROR:         print_string("$error statement$");                   break;
1123         case STATEMENT_EXPRESSION:    print_expression_statement(   &stmt->expression);    break;
1124         case STATEMENT_FOR:           print_for_statement(          &stmt->fors);          break;
1125         case STATEMENT_GOTO:          print_goto_statement(         &stmt->gotos);         break;
1126         case STATEMENT_IF:            print_if_statement(           &stmt->ifs);           break;
1127         case STATEMENT_LABEL:         print_label_statement(        &stmt->label);         break;
1128         case STATEMENT_LEAVE:         print_leave_statement(        &stmt->leave);         break;
1129         case STATEMENT_MS_TRY:        print_ms_try_statement(       &stmt->ms_try);        break;
1130         case STATEMENT_RETURN:        print_return_statement(       &stmt->returns);       break;
1131         case STATEMENT_SWITCH:        print_switch_statement(       &stmt->switchs);       break;
1132         }
1133 }
1134
1135 /**
1136  * Print a storage class.
1137  *
1138  * @param storage_class   the storage class
1139  */
1140 static void print_storage_class(storage_class_tag_t storage_class)
1141 {
1142         switch (storage_class) {
1143         case STORAGE_CLASS_NONE:     return;
1144         case STORAGE_CLASS_TYPEDEF:  print_string("typedef ");  return;
1145         case STORAGE_CLASS_EXTERN:   print_string("extern ");   return;
1146         case STORAGE_CLASS_STATIC:   print_string("static ");   return;
1147         case STORAGE_CLASS_AUTO:     print_string("auto ");     return;
1148         case STORAGE_CLASS_REGISTER: print_string("register "); return;
1149         }
1150         panic("invalid storage class");
1151 }
1152
1153 /**
1154  * Print an initializer.
1155  *
1156  * @param initializer  the initializer
1157  */
1158 void print_initializer(const initializer_t *initializer)
1159 {
1160         if (initializer == NULL) {
1161                 print_string("{}");
1162                 return;
1163         }
1164
1165         switch (initializer->kind) {
1166         case INITIALIZER_STRING:
1167         case INITIALIZER_VALUE:
1168                 print_assignment_expression(initializer->value.value);
1169                 return;
1170
1171         case INITIALIZER_LIST: {
1172                 print_string("{ ");
1173                 const initializer_list_t *list = &initializer->list;
1174
1175                 for (size_t i = 0 ; i < list->len; ++i) {
1176                         const initializer_t *sub_init = list->initializers[i];
1177                         print_initializer(list->initializers[i]);
1178                         if (i < list->len-1) {
1179                                 if (sub_init == NULL || sub_init->kind != INITIALIZER_DESIGNATOR)
1180                                         print_string(", ");
1181                         }
1182                 }
1183                 print_string(" }");
1184                 return;
1185         }
1186
1187         case INITIALIZER_DESIGNATOR:
1188                 print_designator(initializer->designator.designator);
1189                 print_string(" = ");
1190                 return;
1191         }
1192
1193         panic("invalid initializer kind found");
1194 }
1195
1196 #if 0
1197 /**
1198  * Print microsoft extended declaration modifiers.
1199  */
1200 static void print_ms_modifiers(const declaration_t *declaration)
1201 {
1202         if ((c_mode & _MS) == 0)
1203                 return;
1204
1205         decl_modifiers_t modifiers = declaration->modifiers;
1206
1207         separator_t sep = { "__declspec(", ", " };
1208
1209         if (declaration->base.kind == ENTITY_VARIABLE) {
1210                 variable_t *variable = (variable_t*)declaration;
1211                 if (variable->alignment != 0
1212                                 || variable->get_property_sym != NULL
1213                                 || variable->put_property_sym != NULL) {
1214                         if (variable->alignment != 0) {
1215                                 print_format("%salign(%u)", sep_next(&sep), variable->alignment);
1216                         }
1217                         if (variable->get_property_sym != NULL
1218                                         || variable->put_property_sym != NULL) {
1219                                 char *comma = "";
1220                                 print_format("%sproperty(", sep_next(&sep));
1221                                 if (variable->get_property_sym != NULL) {
1222                                         print_format("get=%s", variable->get_property_sym->string);
1223                                         comma = ", ";
1224                                 }
1225                                 if (variable->put_property_sym != NULL)
1226                                         print_format("%sput=%s", comma, variable->put_property_sym->string);
1227                                 print_char(')');
1228                         }
1229                 }
1230         }
1231
1232         /* DM_FORCEINLINE handled outside. */
1233         if ((modifiers & ~DM_FORCEINLINE) != 0) {
1234                 if (modifiers & DM_DLLIMPORT) {
1235                         print_format("%sdllimport", sep_next(&sep));
1236                 }
1237                 if (modifiers & DM_DLLEXPORT) {
1238                         print_format("%sdllexport", sep_next(&sep));
1239                 }
1240                 if (modifiers & DM_THREAD) {
1241                         print_format("%sthread", sep_next(&sep));
1242                 }
1243                 if (modifiers & DM_NAKED) {
1244                         print_format("%snaked", sep_next(&sep));
1245                 }
1246                 if (modifiers & DM_THREAD) {
1247                         print_format("%sthread", sep_next(&sep));
1248                 }
1249                 if (modifiers & DM_SELECTANY) {
1250                         print_format("%sselectany", sep_next(&sep));
1251                 }
1252                 if (modifiers & DM_NOTHROW) {
1253                         print_format("%snothrow", sep_next(&sep));
1254                 }
1255                 if (modifiers & DM_NORETURN) {
1256                         print_format("%snoreturn", sep_next(&sep));
1257                 }
1258                 if (modifiers & DM_NOINLINE) {
1259                         print_format("%snoinline", sep_next(&sep));
1260                 }
1261                 if (modifiers & DM_DEPRECATED) {
1262                         print_format("%sdeprecated", sep_next(&sep));
1263                         if (declaration->deprecated_string != NULL)
1264                                 print_format("(\"%s\")",
1265                                         declaration->deprecated_string);
1266                 }
1267                 if (modifiers & DM_RESTRICT) {
1268                         print_format("%srestrict", sep_next(&sep));
1269                 }
1270                 if (modifiers & DM_NOALIAS) {
1271                         print_format("%snoalias", sep_next(&sep));
1272                 }
1273         }
1274
1275         if (!sep_at_first(&sep))
1276                 print_string(") ");
1277 }
1278 #endif
1279
1280 static void print_scope(const scope_t *scope)
1281 {
1282         const entity_t *entity = scope->entities;
1283         for ( ; entity != NULL; entity = entity->base.next) {
1284                 print_indent();
1285                 print_entity(entity);
1286                 print_char('\n');
1287         }
1288 }
1289
1290 static void print_namespace(const namespace_t *namespace)
1291 {
1292         print_string("namespace ");
1293         if (namespace->base.symbol != NULL) {
1294                 print_string(namespace->base.symbol->string);
1295                 print_char(' ');
1296         }
1297
1298         print_string("{\n");
1299         ++indent;
1300
1301         print_scope(&namespace->members);
1302
1303         --indent;
1304         print_indent();
1305         print_string("}\n");
1306 }
1307
1308 /**
1309  * Print a variable or function declaration
1310  */
1311 void print_declaration(const entity_t *entity)
1312 {
1313         assert(is_declaration(entity));
1314         const declaration_t *declaration = &entity->declaration;
1315
1316         print_storage_class((storage_class_tag_t)declaration->declared_storage_class);
1317         if (entity->kind == ENTITY_FUNCTION) {
1318                 function_t *function = (function_t*)declaration;
1319                 if (function->is_inline) {
1320                         if (declaration->modifiers & DM_FORCEINLINE) {
1321                                 print_string("__forceinline ");
1322                         } else if (declaration->modifiers & DM_MICROSOFT_INLINE) {
1323                                 print_string("__inline ");
1324                         } else {
1325                                 print_string("inline ");
1326                         }
1327                 }
1328         }
1329         //print_ms_modifiers(declaration);
1330         switch (entity->kind) {
1331                 case ENTITY_FUNCTION:
1332                         print_type_ext(entity->declaration.type, entity->base.symbol,
1333                                         &entity->function.parameters);
1334
1335                         if (entity->function.body != NULL) {
1336                                 print_char('\n');
1337                                 print_indented_statement(entity->function.body);
1338                                 print_char('\n');
1339                                 return;
1340                         }
1341                         break;
1342
1343                 case ENTITY_VARIABLE:
1344                         if (entity->variable.thread_local)
1345                                 print_string(c_mode & _C11 ? "_Thread_local " : "__thread ");
1346                         print_type_ext(declaration->type, declaration->base.symbol, NULL);
1347                         if (entity->variable.initializer != NULL) {
1348                                 print_string(" = ");
1349                                 print_initializer(entity->variable.initializer);
1350                         }
1351                         break;
1352
1353                 case ENTITY_COMPOUND_MEMBER:
1354                         print_type_ext(declaration->type, declaration->base.symbol, NULL);
1355                         if (entity->compound_member.bitfield) {
1356                                 print_format(" : %u", entity->compound_member.bit_size);
1357                         }
1358                         break;
1359
1360                 default:
1361                         print_type_ext(declaration->type, declaration->base.symbol, NULL);
1362                         break;
1363         }
1364         print_char(';');
1365 }
1366
1367 /**
1368  * Prints an expression.
1369  *
1370  * @param expression  the expression
1371  */
1372 void print_expression(const expression_t *expression)
1373 {
1374         print_expression_prec(expression, PREC_BOTTOM);
1375 }
1376
1377 /**
1378  * Print a declaration.
1379  *
1380  * @param declaration  the declaration
1381  */
1382 void print_entity(const entity_t *entity)
1383 {
1384         if (entity->base.namespc != NAMESPACE_NORMAL && entity->base.symbol == NULL)
1385                 return;
1386
1387         switch ((entity_kind_tag_t)entity->kind) {
1388         case ENTITY_VARIABLE:
1389         case ENTITY_PARAMETER:
1390         case ENTITY_COMPOUND_MEMBER:
1391         case ENTITY_FUNCTION:
1392                 print_declaration(entity);
1393                 return;
1394         case ENTITY_TYPEDEF:
1395                 print_typedef(entity);
1396                 return;
1397         case ENTITY_CLASS:
1398                 /* TODO */
1399                 print_string("class ");
1400                 print_string(entity->base.symbol->string);
1401                 print_string("; /* TODO */\n");
1402                 return;
1403         case ENTITY_STRUCT:
1404                 print_string("struct ");
1405                 goto print_compound;
1406         case ENTITY_UNION:
1407                 print_string("union ");
1408 print_compound:
1409                 print_string(entity->base.symbol->string);
1410                 if (entity->compound.complete) {
1411                         print_char(' ');
1412                         print_compound_definition(&entity->compound);
1413                 }
1414                 print_char(';');
1415                 return;
1416         case ENTITY_ENUM:
1417                 print_string("enum ");
1418                 print_string(entity->base.symbol->string);
1419                 print_char(' ');
1420                 print_enum_definition(&entity->enume);
1421                 print_char(';');
1422                 return;
1423         case ENTITY_NAMESPACE:
1424                 print_namespace(&entity->namespacee);
1425                 return;
1426         case ENTITY_LOCAL_LABEL:
1427                 print_string("__label__ ");
1428                 print_string(entity->base.symbol->string);
1429                 print_char(';');
1430                 return;
1431         case ENTITY_LABEL:
1432         case ENTITY_ENUM_VALUE:
1433                 panic("print_entity used on unexpected entity type");
1434         }
1435         panic("Invalid entity type encountered");
1436 }
1437
1438 /**
1439  * Print the AST of a translation unit.
1440  *
1441  * @param unit   the translation unit
1442  */
1443 void print_ast(const translation_unit_t *unit)
1444 {
1445         entity_t *entity = unit->scope.entities;
1446         for ( ; entity != NULL; entity = entity->base.next) {
1447                 if (entity->kind == ENTITY_ENUM_VALUE)
1448                         continue;
1449                 if (entity->base.namespc != NAMESPACE_NORMAL
1450                                 && entity->base.symbol == NULL)
1451                         continue;
1452                 if (is_generated_entity(entity))
1453                         continue;
1454
1455                 print_indent();
1456                 print_entity(entity);
1457                 print_char('\n');
1458         }
1459 }
1460
1461 expression_classification_t is_constant_initializer(const initializer_t *initializer)
1462 {
1463         switch (initializer->kind) {
1464         case INITIALIZER_STRING:
1465         case INITIALIZER_DESIGNATOR:
1466                 return EXPR_CLASS_CONSTANT;
1467
1468         case INITIALIZER_VALUE:
1469                 return is_linker_constant(initializer->value.value);
1470
1471         case INITIALIZER_LIST: {
1472                 expression_classification_t all = EXPR_CLASS_CONSTANT;
1473                 for (size_t i = 0; i < initializer->list.len; ++i) {
1474                         initializer_t *sub_initializer = initializer->list.initializers[i];
1475                         expression_classification_t const cur = is_constant_initializer(sub_initializer);
1476                         if (all > cur) {
1477                                 all = cur;
1478                         }
1479                 }
1480                 return all;
1481         }
1482         }
1483         panic("invalid initializer kind found");
1484 }
1485
1486 /**
1487  * Checks if an expression references an object with a constant/known location
1488  * to the linker. Example:
1489  *  - "x", "*&x" with x being a global variable. The value of x need not be
1490  *         constant but the address of x is.
1491  *  - "a.b.c" when a has a constant/known location to the linker
1492  */
1493 static expression_classification_t is_object_with_linker_constant_address(
1494         const expression_t *expression)
1495 {
1496         switch (expression->kind) {
1497         case EXPR_UNARY_DEREFERENCE:
1498                 return is_linker_constant(expression->unary.value);
1499
1500         case EXPR_SELECT: {
1501                 type_t *base_type = skip_typeref(expression->select.compound->base.type);
1502                 if (is_type_pointer(base_type)) {
1503                         /* it's a -> */
1504                         return is_linker_constant(expression->select.compound);
1505                 } else {
1506                         return is_object_with_linker_constant_address(expression->select.compound);
1507                 }
1508         }
1509
1510         case EXPR_ARRAY_ACCESS: {
1511                 expression_classification_t const ref = is_linker_constant(expression->array_access.array_ref);
1512                 expression_classification_t const idx = is_constant_expression(expression->array_access.index);
1513                 return ref < idx ? ref : idx;
1514         }
1515
1516         case EXPR_REFERENCE: {
1517                 entity_t *entity = expression->reference.entity;
1518                 if (!is_declaration(entity))
1519                         return EXPR_CLASS_VARIABLE;
1520
1521                 switch ((storage_class_tag_t)entity->declaration.storage_class) {
1522                 case STORAGE_CLASS_NONE:
1523                 case STORAGE_CLASS_EXTERN:
1524                 case STORAGE_CLASS_STATIC:
1525                         return
1526                                 entity->kind != ENTITY_VARIABLE ||
1527                                 !entity->variable.thread_local ? EXPR_CLASS_CONSTANT :
1528                                 EXPR_CLASS_VARIABLE;
1529
1530                 case STORAGE_CLASS_REGISTER:
1531                 case STORAGE_CLASS_TYPEDEF:
1532                 case STORAGE_CLASS_AUTO:
1533                         break;
1534                 }
1535                 return EXPR_CLASS_VARIABLE;
1536         }
1537
1538         case EXPR_ERROR:
1539                 return EXPR_CLASS_ERROR;
1540
1541         default:
1542                 return EXPR_CLASS_VARIABLE;
1543         }
1544 }
1545
1546 expression_classification_t is_linker_constant(const expression_t *expression)
1547 {
1548         switch (expression->kind) {
1549         case EXPR_STRING_LITERAL:
1550         case EXPR_FUNCNAME:
1551         case EXPR_LABEL_ADDRESS:
1552                 return EXPR_CLASS_CONSTANT;
1553
1554         case EXPR_COMPOUND_LITERAL:
1555                 return is_constant_initializer(expression->compound_literal.initializer);
1556
1557         case EXPR_UNARY_TAKE_ADDRESS:
1558                 return is_object_with_linker_constant_address(expression->unary.value);
1559
1560         case EXPR_UNARY_DEREFERENCE: {
1561                 type_t *real_type
1562                         = revert_automatic_type_conversion(expression->unary.value);
1563                 /* dereferencing a function is a NOP */
1564                 if (is_type_function(real_type)) {
1565                         return is_linker_constant(expression->unary.value);
1566                 }
1567                 /* FALLTHROUGH */
1568         }
1569
1570         case EXPR_UNARY_CAST: {
1571                 type_t *dest = skip_typeref(expression->base.type);
1572                 if (!is_type_pointer(dest) && (
1573                                 dest->kind != TYPE_ATOMIC                                               ||
1574                                 !(get_atomic_type_flags(dest->atomic.akind) & ATOMIC_TYPE_FLAG_INTEGER) ||
1575                                 get_atomic_type_size(dest->atomic.akind) < get_type_size(type_void_ptr)
1576                     ))
1577                         return is_constant_expression(expression);
1578
1579                 return is_linker_constant(expression->unary.value);
1580         }
1581
1582         case EXPR_BINARY_ADD:
1583         case EXPR_BINARY_SUB: {
1584                 expression_t *const left  = expression->binary.left;
1585                 expression_t *const right = expression->binary.right;
1586                 type_t       *const ltype = skip_typeref(left->base.type);
1587                 type_t       *const rtype = skip_typeref(right->base.type);
1588
1589                 if (is_type_pointer(ltype)) {
1590                         expression_classification_t const l = is_linker_constant(left);
1591                         expression_classification_t const r = is_constant_expression(right);
1592                         return l < r ? l : r;
1593                 } else if (is_type_pointer(rtype)) {
1594                         expression_classification_t const l = is_constant_expression(left);
1595                         expression_classification_t const r = is_linker_constant(right);
1596                         return l < r ? l : r;
1597                 } else if (!is_type_valid(ltype) || !is_type_valid(rtype)) {
1598                         return EXPR_CLASS_ERROR;
1599                 } else {
1600                         return is_constant_expression(expression);
1601                 }
1602         }
1603
1604         case EXPR_REFERENCE: {
1605                 entity_t *entity = expression->reference.entity;
1606                 if (!is_declaration(entity))
1607                         return EXPR_CLASS_VARIABLE;
1608
1609                 type_t *type = skip_typeref(entity->declaration.type);
1610                 if (is_type_function(type))
1611                         return EXPR_CLASS_CONSTANT;
1612                 if (is_type_array(type)) {
1613                         return is_object_with_linker_constant_address(expression);
1614                 }
1615                 /* Prevent stray errors */
1616                 if (!is_type_valid(type))
1617                         return EXPR_CLASS_ERROR;
1618                 return EXPR_CLASS_VARIABLE;
1619         }
1620
1621         case EXPR_ARRAY_ACCESS: {
1622                 type_t *const type =
1623                         skip_typeref(revert_automatic_type_conversion(expression));
1624                 if (!is_type_array(type))
1625                         return EXPR_CLASS_VARIABLE;
1626                 return is_linker_constant(expression->array_access.array_ref);
1627         }
1628
1629         case EXPR_CONDITIONAL: {
1630                 expression_t *const c = expression->conditional.condition;
1631                 expression_classification_t const cclass = is_constant_expression(c);
1632                 if (cclass != EXPR_CLASS_CONSTANT)
1633                         return cclass;
1634
1635                 if (fold_constant_to_bool(c)) {
1636                         expression_t const *const t = expression->conditional.true_expression;
1637                         return is_linker_constant(t != NULL ? t : c);
1638                 } else {
1639                         return is_linker_constant(expression->conditional.false_expression);
1640                 }
1641         }
1642
1643         case EXPR_SELECT: {
1644                 entity_t *entity = expression->select.compound_entry;
1645                 if (!is_declaration(entity))
1646                         return EXPR_CLASS_VARIABLE;
1647                 type_t *type = skip_typeref(entity->declaration.type);
1648                 if (is_type_array(type)) {
1649                         /* arrays automatically convert to their address */
1650                         expression_t *compound  = expression->select.compound;
1651                         type_t       *base_type = skip_typeref(compound->base.type);
1652                         if (is_type_pointer(base_type)) {
1653                                 /* it's a -> */
1654                                 return is_linker_constant(compound);
1655                         } else {
1656                                 return is_object_with_linker_constant_address(compound);
1657                         }
1658                 }
1659                 return EXPR_CLASS_VARIABLE;
1660         }
1661
1662         default:
1663                 return is_constant_expression(expression);
1664         }
1665 }
1666
1667 /**
1668  * Check if the given expression is a call to a builtin function
1669  * returning a constant result.
1670  */
1671 static expression_classification_t is_builtin_const_call(const expression_t *expression)
1672 {
1673         expression_t *function = expression->call.function;
1674         if (function->kind != EXPR_REFERENCE)
1675                 return EXPR_CLASS_VARIABLE;
1676         reference_expression_t *ref = &function->reference;
1677         if (ref->entity->kind != ENTITY_FUNCTION)
1678                 return EXPR_CLASS_VARIABLE;
1679
1680         switch (ref->entity->function.btk) {
1681         case BUILTIN_INF:
1682         case BUILTIN_NAN:
1683                 return EXPR_CLASS_CONSTANT;
1684         default:
1685                 return EXPR_CLASS_VARIABLE;
1686         }
1687
1688 }
1689
1690 static expression_classification_t is_constant_pointer(const expression_t *expression)
1691 {
1692         expression_classification_t const expr_class = is_constant_expression(expression);
1693         if (expr_class != EXPR_CLASS_VARIABLE)
1694                 return expr_class;
1695
1696         switch (expression->kind) {
1697         case EXPR_UNARY_CAST:
1698                 return is_constant_pointer(expression->unary.value);
1699         default:
1700                 return EXPR_CLASS_VARIABLE;
1701         }
1702 }
1703
1704 static expression_classification_t is_object_with_constant_address(const expression_t *expression)
1705 {
1706         switch (expression->kind) {
1707         case EXPR_SELECT: {
1708                 expression_t *compound      = expression->select.compound;
1709                 type_t       *compound_type = compound->base.type;
1710                 compound_type = skip_typeref(compound_type);
1711                 if (is_type_pointer(compound_type)) {
1712                         return is_constant_pointer(compound);
1713                 } else {
1714                         return is_object_with_constant_address(compound);
1715                 }
1716         }
1717
1718         case EXPR_ARRAY_ACCESS: {
1719                 array_access_expression_t const* const array_access =
1720                         &expression->array_access;
1721                 expression_classification_t const idx_class = is_constant_expression(array_access->index);
1722                 if (idx_class != EXPR_CLASS_CONSTANT)
1723                         return idx_class;
1724                 expression_classification_t const ref_addr = is_object_with_constant_address(array_access->array_ref);
1725                 expression_classification_t const ref_ptr  = is_constant_pointer(array_access->array_ref);
1726                 return ref_addr > ref_ptr ? ref_addr : ref_ptr;
1727         }
1728
1729         case EXPR_UNARY_DEREFERENCE:
1730                 return is_constant_pointer(expression->unary.value);
1731
1732         case EXPR_ERROR:
1733                 return EXPR_CLASS_ERROR;
1734
1735         default:
1736                 return EXPR_CLASS_VARIABLE;
1737         }
1738 }
1739
1740 expression_classification_t is_constant_expression(const expression_t *expression)
1741 {
1742         switch (expression->kind) {
1743         case EXPR_LITERAL_CHARACTER:
1744         case EXPR_BUILTIN_TYPES_COMPATIBLE_P:
1745         case EXPR_ENUM_CONSTANT:
1746         case EXPR_LITERAL_BOOLEAN:
1747         case EXPR_LITERAL_MS_NOOP:
1748                 return EXPR_CLASS_CONSTANT;
1749
1750         {
1751                 type_t *type;
1752         case EXPR_ALIGNOF:
1753                 type = skip_typeref(expression->typeprop.type);
1754                 goto check_type;
1755
1756         case EXPR_CLASSIFY_TYPE:
1757                 type = skip_typeref(expression->classify_type.type_expression->base.type);
1758                 goto check_type;
1759
1760         case EXPR_LITERAL_INTEGER:
1761         case EXPR_LITERAL_FLOATINGPOINT:
1762                 type = skip_typeref(expression->base.type);
1763                 goto check_type;
1764
1765         case EXPR_OFFSETOF:
1766                 type = skip_typeref(expression->offsetofe.type);
1767                 goto check_type;
1768
1769         case EXPR_SIZEOF:
1770                 type = skip_typeref(expression->typeprop.type);
1771                 if (is_type_array(type) && type->array.is_vla)
1772                         return EXPR_CLASS_VARIABLE;
1773                 goto check_type;
1774
1775 check_type:
1776                 return is_type_valid(type) ? EXPR_CLASS_CONSTANT : EXPR_CLASS_ERROR;
1777         }
1778
1779         case EXPR_BUILTIN_CONSTANT_P: {
1780                 expression_classification_t const c = is_constant_expression(expression->builtin_constant.value);
1781                 return c != EXPR_CLASS_ERROR ? EXPR_CLASS_CONSTANT : EXPR_CLASS_ERROR;
1782         }
1783
1784         case EXPR_STRING_LITERAL:
1785         case EXPR_FUNCNAME:
1786         case EXPR_LABEL_ADDRESS:
1787         case EXPR_SELECT:
1788         case EXPR_VA_START:
1789         case EXPR_VA_ARG:
1790         case EXPR_VA_COPY:
1791         case EXPR_STATEMENT:
1792         case EXPR_UNARY_POSTFIX_INCREMENT:
1793         case EXPR_UNARY_POSTFIX_DECREMENT:
1794         case EXPR_UNARY_PREFIX_INCREMENT:
1795         case EXPR_UNARY_PREFIX_DECREMENT:
1796         case EXPR_UNARY_ASSUME: /* has VOID type */
1797         case EXPR_UNARY_DEREFERENCE:
1798         case EXPR_UNARY_DELETE:
1799         case EXPR_UNARY_DELETE_ARRAY:
1800         case EXPR_UNARY_THROW:
1801         case EXPR_BINARY_ASSIGN:
1802         case EXPR_BINARY_MUL_ASSIGN:
1803         case EXPR_BINARY_DIV_ASSIGN:
1804         case EXPR_BINARY_MOD_ASSIGN:
1805         case EXPR_BINARY_ADD_ASSIGN:
1806         case EXPR_BINARY_SUB_ASSIGN:
1807         case EXPR_BINARY_SHIFTLEFT_ASSIGN:
1808         case EXPR_BINARY_SHIFTRIGHT_ASSIGN:
1809         case EXPR_BINARY_BITWISE_AND_ASSIGN:
1810         case EXPR_BINARY_BITWISE_XOR_ASSIGN:
1811         case EXPR_BINARY_BITWISE_OR_ASSIGN:
1812         case EXPR_BINARY_COMMA:
1813         case EXPR_ARRAY_ACCESS:
1814                 return EXPR_CLASS_VARIABLE;
1815
1816         case EXPR_REFERENCE: {
1817                 type_t *const type = skip_typeref(expression->base.type);
1818                 return is_type_valid(type) ? EXPR_CLASS_VARIABLE : EXPR_CLASS_ERROR;
1819         }
1820
1821         case EXPR_UNARY_TAKE_ADDRESS:
1822                 return is_object_with_constant_address(expression->unary.value);
1823
1824         case EXPR_CALL:
1825                 return is_builtin_const_call(expression);
1826
1827         case EXPR_UNARY_NEGATE:
1828         case EXPR_UNARY_PLUS:
1829         case EXPR_UNARY_BITWISE_NEGATE:
1830         case EXPR_UNARY_NOT:
1831                 return is_constant_expression(expression->unary.value);
1832
1833         case EXPR_UNARY_CAST: {
1834                 type_t *const type = skip_typeref(expression->base.type);
1835                 if (is_type_scalar(type))
1836                         return is_constant_expression(expression->unary.value);
1837                 if (!is_type_valid(type))
1838                         return EXPR_CLASS_ERROR;
1839                 return EXPR_CLASS_VARIABLE;
1840         }
1841
1842         case EXPR_BINARY_ADD:
1843         case EXPR_BINARY_SUB:
1844         case EXPR_BINARY_MUL:
1845         case EXPR_BINARY_DIV:
1846         case EXPR_BINARY_MOD:
1847         case EXPR_BINARY_EQUAL:
1848         case EXPR_BINARY_NOTEQUAL:
1849         case EXPR_BINARY_LESS:
1850         case EXPR_BINARY_LESSEQUAL:
1851         case EXPR_BINARY_GREATER:
1852         case EXPR_BINARY_GREATEREQUAL:
1853         case EXPR_BINARY_BITWISE_AND:
1854         case EXPR_BINARY_BITWISE_OR:
1855         case EXPR_BINARY_BITWISE_XOR:
1856         case EXPR_BINARY_SHIFTLEFT:
1857         case EXPR_BINARY_SHIFTRIGHT:
1858         case EXPR_BINARY_ISGREATER:
1859         case EXPR_BINARY_ISGREATEREQUAL:
1860         case EXPR_BINARY_ISLESS:
1861         case EXPR_BINARY_ISLESSEQUAL:
1862         case EXPR_BINARY_ISLESSGREATER:
1863         case EXPR_BINARY_ISUNORDERED: {
1864                 expression_classification_t const l = is_constant_expression(expression->binary.left);
1865                 expression_classification_t const r = is_constant_expression(expression->binary.right);
1866                 return l < r ? l : r;
1867         }
1868
1869         case EXPR_BINARY_LOGICAL_AND: {
1870                 expression_t const         *const left   = expression->binary.left;
1871                 expression_classification_t const lclass = is_constant_expression(left);
1872                 if (lclass != EXPR_CLASS_CONSTANT)
1873                         return lclass;
1874                 if (!fold_constant_to_bool(left))
1875                         return EXPR_CLASS_CONSTANT;
1876                 return is_constant_expression(expression->binary.right);
1877         }
1878
1879         case EXPR_BINARY_LOGICAL_OR: {
1880                 expression_t const         *const left   = expression->binary.left;
1881                 expression_classification_t const lclass = is_constant_expression(left);
1882                 if (lclass != EXPR_CLASS_CONSTANT)
1883                         return lclass;
1884                 if (fold_constant_to_bool(left))
1885                         return EXPR_CLASS_CONSTANT;
1886                 return is_constant_expression(expression->binary.right);
1887         }
1888
1889         case EXPR_COMPOUND_LITERAL:
1890                 return is_constant_initializer(expression->compound_literal.initializer);
1891
1892         case EXPR_CONDITIONAL: {
1893                 expression_t               *const condition = expression->conditional.condition;
1894                 expression_classification_t const cclass    = is_constant_expression(condition);
1895                 if (cclass != EXPR_CLASS_CONSTANT)
1896                         return cclass;
1897
1898                 if (fold_constant_to_bool(condition)) {
1899                         expression_t const *const t = expression->conditional.true_expression;
1900                         return t == NULL ? EXPR_CLASS_CONSTANT : is_constant_expression(t);
1901                 } else {
1902                         return is_constant_expression(expression->conditional.false_expression);
1903                 }
1904         }
1905
1906         case EXPR_ERROR:
1907                 return EXPR_CLASS_ERROR;
1908         }
1909         panic("invalid expression");
1910 }
1911
1912 void init_ast(void)
1913 {
1914         obstack_init(&ast_obstack);
1915 }
1916
1917 void exit_ast(void)
1918 {
1919         obstack_free(&ast_obstack, NULL);
1920 }