Make printing asm statements a bit nicer by using fewer spaces.
[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 const *const arguments)
1009 {
1010         print_string(" :");
1011         separator_t sep = { " ", ", " };
1012         for (asm_argument_t const *i = arguments; i; i = i->next) {
1013                 print_string(sep_next(&sep));
1014                 if (i->symbol)
1015                         print_format("[%s] ", i->symbol->string);
1016                 print_quoted_string(&i->constraints, '"');
1017                 print_string(" (");
1018                 print_expression(i->expression);
1019                 print_char(')');
1020         }
1021 }
1022
1023 /**
1024  * Print assembler clobbers.
1025  *
1026  * @param clobbers   the clobbers
1027  */
1028 static void print_asm_clobbers(asm_clobber_t const *const clobbers)
1029 {
1030         print_string(" :");
1031         separator_t sep = { " ", ", " };
1032         for (asm_clobber_t const *i = clobbers; i; i = i->next) {
1033                 print_string(sep_next(&sep));
1034                 print_quoted_string(&i->clobber, '"');
1035         }
1036 }
1037
1038 /**
1039  * Print an assembler statement.
1040  *
1041  * @param stmt   the statement
1042  */
1043 static void print_asm_statement(asm_statement_t const *const stmt)
1044 {
1045         print_string("asm");
1046         if (stmt->is_volatile) print_string(" volatile");
1047         print_char('(');
1048         print_quoted_string(&stmt->asm_text, '"');
1049
1050         unsigned const n =
1051                 stmt->clobbers ? 3 :
1052                 stmt->inputs   ? 2 :
1053                 stmt->outputs  ? 1 :
1054                 0;
1055         if (n >= 1) print_asm_arguments(stmt->outputs);
1056         if (n >= 2) print_asm_arguments(stmt->inputs);
1057         if (n >= 3) print_asm_clobbers( stmt->clobbers);
1058
1059         print_string(");");
1060 }
1061
1062 /**
1063  * Print a microsoft __try statement.
1064  *
1065  * @param statement   the statement
1066  */
1067 static void print_ms_try_statement(const ms_try_statement_t *statement)
1068 {
1069         print_string("__try");
1070         print_inner_statement(statement->try_statement);
1071         print_after_inner_statement(statement->try_statement);
1072         if (statement->except_expression != NULL) {
1073                 print_string("__except(");
1074                 print_expression(statement->except_expression);
1075                 print_char(')');
1076         } else {
1077                 print_string("__finally");
1078         }
1079         print_inner_statement(statement->final_statement);
1080 }
1081
1082 /**
1083  * Print a microsoft __leave statement.
1084  *
1085  * @param statement   the statement
1086  */
1087 static void print_leave_statement(const leave_statement_t *statement)
1088 {
1089         (void)statement;
1090         print_string("__leave;");
1091 }
1092
1093 /**
1094  * Print a statement.
1095  *
1096  * @param statement   the statement
1097  */
1098 void print_statement(statement_t const *const stmt)
1099 {
1100         switch (stmt->kind) {
1101         case STATEMENT_ASM:           print_asm_statement(          &stmt->asms);          break;
1102         case STATEMENT_BREAK:         print_string("break;");                              break;
1103         case STATEMENT_CASE_LABEL:    print_case_label(             &stmt->case_label);    break;
1104         case STATEMENT_COMPOUND:      print_compound_statement(     &stmt->compound);      break;
1105         case STATEMENT_COMPUTED_GOTO: print_computed_goto_statement(&stmt->computed_goto); break;
1106         case STATEMENT_CONTINUE:      print_string("continue;");                           break;
1107         case STATEMENT_DECLARATION:   print_declaration_statement(  &stmt->declaration);   break;
1108         case STATEMENT_DO_WHILE:      print_do_while_statement(     &stmt->do_while);      break;
1109         case STATEMENT_EMPTY:         print_char(';');                                     break;
1110         case STATEMENT_ERROR:         print_string("$error statement$");                   break;
1111         case STATEMENT_EXPRESSION:    print_expression_statement(   &stmt->expression);    break;
1112         case STATEMENT_FOR:           print_for_statement(          &stmt->fors);          break;
1113         case STATEMENT_GOTO:          print_goto_statement(         &stmt->gotos);         break;
1114         case STATEMENT_IF:            print_if_statement(           &stmt->ifs);           break;
1115         case STATEMENT_LABEL:         print_label_statement(        &stmt->label);         break;
1116         case STATEMENT_LEAVE:         print_leave_statement(        &stmt->leave);         break;
1117         case STATEMENT_MS_TRY:        print_ms_try_statement(       &stmt->ms_try);        break;
1118         case STATEMENT_RETURN:        print_return_statement(       &stmt->returns);       break;
1119         case STATEMENT_SWITCH:        print_switch_statement(       &stmt->switchs);       break;
1120         }
1121 }
1122
1123 /**
1124  * Print a storage class.
1125  *
1126  * @param storage_class   the storage class
1127  */
1128 static void print_storage_class(storage_class_tag_t storage_class)
1129 {
1130         switch (storage_class) {
1131         case STORAGE_CLASS_NONE:     return;
1132         case STORAGE_CLASS_TYPEDEF:  print_string("typedef ");  return;
1133         case STORAGE_CLASS_EXTERN:   print_string("extern ");   return;
1134         case STORAGE_CLASS_STATIC:   print_string("static ");   return;
1135         case STORAGE_CLASS_AUTO:     print_string("auto ");     return;
1136         case STORAGE_CLASS_REGISTER: print_string("register "); return;
1137         }
1138         panic("invalid storage class");
1139 }
1140
1141 /**
1142  * Print an initializer.
1143  *
1144  * @param initializer  the initializer
1145  */
1146 void print_initializer(const initializer_t *initializer)
1147 {
1148         if (initializer == NULL) {
1149                 print_string("{}");
1150                 return;
1151         }
1152
1153         switch (initializer->kind) {
1154         case INITIALIZER_STRING:
1155         case INITIALIZER_VALUE:
1156                 print_assignment_expression(initializer->value.value);
1157                 return;
1158
1159         case INITIALIZER_LIST: {
1160                 print_string("{ ");
1161                 const initializer_list_t *list = &initializer->list;
1162
1163                 for (size_t i = 0 ; i < list->len; ++i) {
1164                         const initializer_t *sub_init = list->initializers[i];
1165                         print_initializer(list->initializers[i]);
1166                         if (i < list->len-1) {
1167                                 if (sub_init == NULL || sub_init->kind != INITIALIZER_DESIGNATOR)
1168                                         print_string(", ");
1169                         }
1170                 }
1171                 print_string(" }");
1172                 return;
1173         }
1174
1175         case INITIALIZER_DESIGNATOR:
1176                 print_designator(initializer->designator.designator);
1177                 print_string(" = ");
1178                 return;
1179         }
1180
1181         panic("invalid initializer kind found");
1182 }
1183
1184 #if 0
1185 /**
1186  * Print microsoft extended declaration modifiers.
1187  */
1188 static void print_ms_modifiers(const declaration_t *declaration)
1189 {
1190         if ((c_mode & _MS) == 0)
1191                 return;
1192
1193         decl_modifiers_t modifiers = declaration->modifiers;
1194
1195         separator_t sep = { "__declspec(", ", " };
1196
1197         if (declaration->base.kind == ENTITY_VARIABLE) {
1198                 variable_t *variable = (variable_t*)declaration;
1199                 if (variable->alignment != 0
1200                                 || variable->get_property_sym != NULL
1201                                 || variable->put_property_sym != NULL) {
1202                         if (variable->alignment != 0) {
1203                                 print_format("%salign(%u)", sep_next(&sep), variable->alignment);
1204                         }
1205                         if (variable->get_property_sym != NULL
1206                                         || variable->put_property_sym != NULL) {
1207                                 char *comma = "";
1208                                 print_format("%sproperty(", sep_next(&sep));
1209                                 if (variable->get_property_sym != NULL) {
1210                                         print_format("get=%s", variable->get_property_sym->string);
1211                                         comma = ", ";
1212                                 }
1213                                 if (variable->put_property_sym != NULL)
1214                                         print_format("%sput=%s", comma, variable->put_property_sym->string);
1215                                 print_char(')');
1216                         }
1217                 }
1218         }
1219
1220         /* DM_FORCEINLINE handled outside. */
1221         if ((modifiers & ~DM_FORCEINLINE) != 0) {
1222                 if (modifiers & DM_DLLIMPORT) {
1223                         print_format("%sdllimport", sep_next(&sep));
1224                 }
1225                 if (modifiers & DM_DLLEXPORT) {
1226                         print_format("%sdllexport", sep_next(&sep));
1227                 }
1228                 if (modifiers & DM_THREAD) {
1229                         print_format("%sthread", sep_next(&sep));
1230                 }
1231                 if (modifiers & DM_NAKED) {
1232                         print_format("%snaked", sep_next(&sep));
1233                 }
1234                 if (modifiers & DM_THREAD) {
1235                         print_format("%sthread", sep_next(&sep));
1236                 }
1237                 if (modifiers & DM_SELECTANY) {
1238                         print_format("%sselectany", sep_next(&sep));
1239                 }
1240                 if (modifiers & DM_NOTHROW) {
1241                         print_format("%snothrow", sep_next(&sep));
1242                 }
1243                 if (modifiers & DM_NORETURN) {
1244                         print_format("%snoreturn", sep_next(&sep));
1245                 }
1246                 if (modifiers & DM_NOINLINE) {
1247                         print_format("%snoinline", sep_next(&sep));
1248                 }
1249                 if (modifiers & DM_DEPRECATED) {
1250                         print_format("%sdeprecated", sep_next(&sep));
1251                         if (declaration->deprecated_string != NULL)
1252                                 print_format("(\"%s\")",
1253                                         declaration->deprecated_string);
1254                 }
1255                 if (modifiers & DM_RESTRICT) {
1256                         print_format("%srestrict", sep_next(&sep));
1257                 }
1258                 if (modifiers & DM_NOALIAS) {
1259                         print_format("%snoalias", sep_next(&sep));
1260                 }
1261         }
1262
1263         if (!sep_at_first(&sep))
1264                 print_string(") ");
1265 }
1266 #endif
1267
1268 static void print_scope(const scope_t *scope)
1269 {
1270         const entity_t *entity = scope->entities;
1271         for ( ; entity != NULL; entity = entity->base.next) {
1272                 print_indent();
1273                 print_entity(entity);
1274                 print_char('\n');
1275         }
1276 }
1277
1278 static void print_namespace(const namespace_t *namespace)
1279 {
1280         print_string("namespace ");
1281         if (namespace->base.symbol != NULL) {
1282                 print_string(namespace->base.symbol->string);
1283                 print_char(' ');
1284         }
1285
1286         print_string("{\n");
1287         ++indent;
1288
1289         print_scope(&namespace->members);
1290
1291         --indent;
1292         print_indent();
1293         print_string("}\n");
1294 }
1295
1296 /**
1297  * Print a variable or function declaration
1298  */
1299 void print_declaration(const entity_t *entity)
1300 {
1301         assert(is_declaration(entity));
1302         const declaration_t *declaration = &entity->declaration;
1303
1304         print_storage_class((storage_class_tag_t)declaration->declared_storage_class);
1305         if (entity->kind == ENTITY_FUNCTION) {
1306                 function_t *function = (function_t*)declaration;
1307                 if (function->is_inline) {
1308                         if (declaration->modifiers & DM_FORCEINLINE) {
1309                                 print_string("__forceinline ");
1310                         } else if (declaration->modifiers & DM_MICROSOFT_INLINE) {
1311                                 print_string("__inline ");
1312                         } else {
1313                                 print_string("inline ");
1314                         }
1315                 }
1316         }
1317         //print_ms_modifiers(declaration);
1318         switch (entity->kind) {
1319                 case ENTITY_FUNCTION:
1320                         print_type_ext(entity->declaration.type, entity->base.symbol,
1321                                         &entity->function.parameters);
1322
1323                         if (entity->function.body != NULL) {
1324                                 print_char('\n');
1325                                 print_indented_statement(entity->function.body);
1326                                 print_char('\n');
1327                                 return;
1328                         }
1329                         break;
1330
1331                 case ENTITY_VARIABLE:
1332                         if (entity->variable.thread_local)
1333                                 print_string(c_mode & _C11 ? "_Thread_local " : "__thread ");
1334                         print_type_ext(declaration->type, declaration->base.symbol, NULL);
1335                         if (entity->variable.initializer != NULL) {
1336                                 print_string(" = ");
1337                                 print_initializer(entity->variable.initializer);
1338                         }
1339                         break;
1340
1341                 case ENTITY_COMPOUND_MEMBER:
1342                         print_type_ext(declaration->type, declaration->base.symbol, NULL);
1343                         if (entity->compound_member.bitfield) {
1344                                 print_format(" : %u", entity->compound_member.bit_size);
1345                         }
1346                         break;
1347
1348                 default:
1349                         print_type_ext(declaration->type, declaration->base.symbol, NULL);
1350                         break;
1351         }
1352         print_char(';');
1353 }
1354
1355 /**
1356  * Prints an expression.
1357  *
1358  * @param expression  the expression
1359  */
1360 void print_expression(const expression_t *expression)
1361 {
1362         print_expression_prec(expression, PREC_BOTTOM);
1363 }
1364
1365 /**
1366  * Print a declaration.
1367  *
1368  * @param declaration  the declaration
1369  */
1370 void print_entity(const entity_t *entity)
1371 {
1372         if (entity->base.namespc != NAMESPACE_NORMAL && entity->base.symbol == NULL)
1373                 return;
1374
1375         switch ((entity_kind_tag_t)entity->kind) {
1376         case ENTITY_VARIABLE:
1377         case ENTITY_PARAMETER:
1378         case ENTITY_COMPOUND_MEMBER:
1379         case ENTITY_FUNCTION:
1380                 print_declaration(entity);
1381                 return;
1382         case ENTITY_TYPEDEF:
1383                 print_typedef(entity);
1384                 return;
1385         case ENTITY_CLASS:
1386                 /* TODO */
1387                 print_string("class ");
1388                 print_string(entity->base.symbol->string);
1389                 print_string("; /* TODO */\n");
1390                 return;
1391         case ENTITY_STRUCT:
1392                 print_string("struct ");
1393                 goto print_compound;
1394         case ENTITY_UNION:
1395                 print_string("union ");
1396 print_compound:
1397                 print_string(entity->base.symbol->string);
1398                 if (entity->compound.complete) {
1399                         print_char(' ');
1400                         print_compound_definition(&entity->compound);
1401                 }
1402                 print_char(';');
1403                 return;
1404         case ENTITY_ENUM:
1405                 print_string("enum ");
1406                 print_string(entity->base.symbol->string);
1407                 print_char(' ');
1408                 print_enum_definition(&entity->enume);
1409                 print_char(';');
1410                 return;
1411         case ENTITY_NAMESPACE:
1412                 print_namespace(&entity->namespacee);
1413                 return;
1414         case ENTITY_LOCAL_LABEL:
1415                 print_string("__label__ ");
1416                 print_string(entity->base.symbol->string);
1417                 print_char(';');
1418                 return;
1419         case ENTITY_LABEL:
1420         case ENTITY_ENUM_VALUE:
1421                 panic("print_entity used on unexpected entity type");
1422         }
1423         panic("Invalid entity type encountered");
1424 }
1425
1426 /**
1427  * Print the AST of a translation unit.
1428  *
1429  * @param unit   the translation unit
1430  */
1431 void print_ast(const translation_unit_t *unit)
1432 {
1433         entity_t *entity = unit->scope.entities;
1434         for ( ; entity != NULL; entity = entity->base.next) {
1435                 if (entity->kind == ENTITY_ENUM_VALUE)
1436                         continue;
1437                 if (entity->base.namespc != NAMESPACE_NORMAL
1438                                 && entity->base.symbol == NULL)
1439                         continue;
1440                 if (is_generated_entity(entity))
1441                         continue;
1442
1443                 print_indent();
1444                 print_entity(entity);
1445                 print_char('\n');
1446         }
1447 }
1448
1449 expression_classification_t is_constant_initializer(const initializer_t *initializer)
1450 {
1451         switch (initializer->kind) {
1452         case INITIALIZER_STRING:
1453         case INITIALIZER_DESIGNATOR:
1454                 return EXPR_CLASS_CONSTANT;
1455
1456         case INITIALIZER_VALUE:
1457                 return is_linker_constant(initializer->value.value);
1458
1459         case INITIALIZER_LIST: {
1460                 expression_classification_t all = EXPR_CLASS_CONSTANT;
1461                 for (size_t i = 0; i < initializer->list.len; ++i) {
1462                         initializer_t *sub_initializer = initializer->list.initializers[i];
1463                         expression_classification_t const cur = is_constant_initializer(sub_initializer);
1464                         if (all > cur) {
1465                                 all = cur;
1466                         }
1467                 }
1468                 return all;
1469         }
1470         }
1471         panic("invalid initializer kind found");
1472 }
1473
1474 /**
1475  * Checks if an expression references an object with a constant/known location
1476  * to the linker. Example:
1477  *  - "x", "*&x" with x being a global variable. The value of x need not be
1478  *         constant but the address of x is.
1479  *  - "a.b.c" when a has a constant/known location to the linker
1480  */
1481 static expression_classification_t is_object_with_linker_constant_address(
1482         const expression_t *expression)
1483 {
1484         switch (expression->kind) {
1485         case EXPR_UNARY_DEREFERENCE:
1486                 return is_linker_constant(expression->unary.value);
1487
1488         case EXPR_SELECT: {
1489                 type_t *base_type = skip_typeref(expression->select.compound->base.type);
1490                 if (is_type_pointer(base_type)) {
1491                         /* it's a -> */
1492                         return is_linker_constant(expression->select.compound);
1493                 } else {
1494                         return is_object_with_linker_constant_address(expression->select.compound);
1495                 }
1496         }
1497
1498         case EXPR_ARRAY_ACCESS: {
1499                 expression_classification_t const ref = is_linker_constant(expression->array_access.array_ref);
1500                 expression_classification_t const idx = is_constant_expression(expression->array_access.index);
1501                 return ref < idx ? ref : idx;
1502         }
1503
1504         case EXPR_REFERENCE: {
1505                 entity_t *entity = expression->reference.entity;
1506                 if (!is_declaration(entity))
1507                         return EXPR_CLASS_VARIABLE;
1508
1509                 switch ((storage_class_tag_t)entity->declaration.storage_class) {
1510                 case STORAGE_CLASS_NONE:
1511                 case STORAGE_CLASS_EXTERN:
1512                 case STORAGE_CLASS_STATIC:
1513                         return
1514                                 entity->kind != ENTITY_VARIABLE ||
1515                                 !entity->variable.thread_local ? EXPR_CLASS_CONSTANT :
1516                                 EXPR_CLASS_VARIABLE;
1517
1518                 case STORAGE_CLASS_REGISTER:
1519                 case STORAGE_CLASS_TYPEDEF:
1520                 case STORAGE_CLASS_AUTO:
1521                         break;
1522                 }
1523                 return EXPR_CLASS_VARIABLE;
1524         }
1525
1526         case EXPR_ERROR:
1527                 return EXPR_CLASS_ERROR;
1528
1529         default:
1530                 return EXPR_CLASS_VARIABLE;
1531         }
1532 }
1533
1534 expression_classification_t is_linker_constant(const expression_t *expression)
1535 {
1536         switch (expression->kind) {
1537         case EXPR_STRING_LITERAL:
1538         case EXPR_FUNCNAME:
1539         case EXPR_LABEL_ADDRESS:
1540                 return EXPR_CLASS_CONSTANT;
1541
1542         case EXPR_COMPOUND_LITERAL:
1543                 return is_constant_initializer(expression->compound_literal.initializer);
1544
1545         case EXPR_UNARY_TAKE_ADDRESS:
1546                 return is_object_with_linker_constant_address(expression->unary.value);
1547
1548         case EXPR_UNARY_DEREFERENCE: {
1549                 type_t *real_type
1550                         = revert_automatic_type_conversion(expression->unary.value);
1551                 /* dereferencing a function is a NOP */
1552                 if (is_type_function(real_type)) {
1553                         return is_linker_constant(expression->unary.value);
1554                 }
1555                 /* FALLTHROUGH */
1556         }
1557
1558         case EXPR_UNARY_CAST: {
1559                 type_t *dest = skip_typeref(expression->base.type);
1560                 if (!is_type_pointer(dest) && (
1561                                 dest->kind != TYPE_ATOMIC                                               ||
1562                                 !(get_atomic_type_flags(dest->atomic.akind) & ATOMIC_TYPE_FLAG_INTEGER) ||
1563                                 get_atomic_type_size(dest->atomic.akind) < get_type_size(type_void_ptr)
1564                     ))
1565                         return is_constant_expression(expression);
1566
1567                 return is_linker_constant(expression->unary.value);
1568         }
1569
1570         case EXPR_BINARY_ADD:
1571         case EXPR_BINARY_SUB: {
1572                 expression_t *const left  = expression->binary.left;
1573                 expression_t *const right = expression->binary.right;
1574                 type_t       *const ltype = skip_typeref(left->base.type);
1575                 type_t       *const rtype = skip_typeref(right->base.type);
1576
1577                 if (is_type_pointer(ltype)) {
1578                         expression_classification_t const l = is_linker_constant(left);
1579                         expression_classification_t const r = is_constant_expression(right);
1580                         return l < r ? l : r;
1581                 } else if (is_type_pointer(rtype)) {
1582                         expression_classification_t const l = is_constant_expression(left);
1583                         expression_classification_t const r = is_linker_constant(right);
1584                         return l < r ? l : r;
1585                 } else if (!is_type_valid(ltype) || !is_type_valid(rtype)) {
1586                         return EXPR_CLASS_ERROR;
1587                 } else {
1588                         return is_constant_expression(expression);
1589                 }
1590         }
1591
1592         case EXPR_REFERENCE: {
1593                 entity_t *entity = expression->reference.entity;
1594                 if (!is_declaration(entity))
1595                         return EXPR_CLASS_VARIABLE;
1596
1597                 type_t *type = skip_typeref(entity->declaration.type);
1598                 if (is_type_function(type))
1599                         return EXPR_CLASS_CONSTANT;
1600                 if (is_type_array(type)) {
1601                         return is_object_with_linker_constant_address(expression);
1602                 }
1603                 /* Prevent stray errors */
1604                 if (!is_type_valid(type))
1605                         return EXPR_CLASS_ERROR;
1606                 return EXPR_CLASS_VARIABLE;
1607         }
1608
1609         case EXPR_ARRAY_ACCESS: {
1610                 type_t *const type =
1611                         skip_typeref(revert_automatic_type_conversion(expression));
1612                 if (!is_type_array(type))
1613                         return EXPR_CLASS_VARIABLE;
1614                 return is_linker_constant(expression->array_access.array_ref);
1615         }
1616
1617         case EXPR_CONDITIONAL: {
1618                 expression_t *const c = expression->conditional.condition;
1619                 expression_classification_t const cclass = is_constant_expression(c);
1620                 if (cclass != EXPR_CLASS_CONSTANT)
1621                         return cclass;
1622
1623                 if (fold_constant_to_bool(c)) {
1624                         expression_t const *const t = expression->conditional.true_expression;
1625                         return is_linker_constant(t != NULL ? t : c);
1626                 } else {
1627                         return is_linker_constant(expression->conditional.false_expression);
1628                 }
1629         }
1630
1631         case EXPR_SELECT: {
1632                 entity_t *entity = expression->select.compound_entry;
1633                 if (!is_declaration(entity))
1634                         return EXPR_CLASS_VARIABLE;
1635                 type_t *type = skip_typeref(entity->declaration.type);
1636                 if (is_type_array(type)) {
1637                         /* arrays automatically convert to their address */
1638                         expression_t *compound  = expression->select.compound;
1639                         type_t       *base_type = skip_typeref(compound->base.type);
1640                         if (is_type_pointer(base_type)) {
1641                                 /* it's a -> */
1642                                 return is_linker_constant(compound);
1643                         } else {
1644                                 return is_object_with_linker_constant_address(compound);
1645                         }
1646                 }
1647                 return EXPR_CLASS_VARIABLE;
1648         }
1649
1650         default:
1651                 return is_constant_expression(expression);
1652         }
1653 }
1654
1655 /**
1656  * Check if the given expression is a call to a builtin function
1657  * returning a constant result.
1658  */
1659 static expression_classification_t is_builtin_const_call(const expression_t *expression)
1660 {
1661         expression_t *function = expression->call.function;
1662         if (function->kind != EXPR_REFERENCE)
1663                 return EXPR_CLASS_VARIABLE;
1664         reference_expression_t *ref = &function->reference;
1665         if (ref->entity->kind != ENTITY_FUNCTION)
1666                 return EXPR_CLASS_VARIABLE;
1667
1668         switch (ref->entity->function.btk) {
1669         case BUILTIN_INF:
1670         case BUILTIN_NAN:
1671                 return EXPR_CLASS_CONSTANT;
1672         default:
1673                 return EXPR_CLASS_VARIABLE;
1674         }
1675
1676 }
1677
1678 static expression_classification_t is_constant_pointer(const expression_t *expression)
1679 {
1680         expression_classification_t const expr_class = is_constant_expression(expression);
1681         if (expr_class != EXPR_CLASS_VARIABLE)
1682                 return expr_class;
1683
1684         switch (expression->kind) {
1685         case EXPR_UNARY_CAST:
1686                 return is_constant_pointer(expression->unary.value);
1687         default:
1688                 return EXPR_CLASS_VARIABLE;
1689         }
1690 }
1691
1692 static expression_classification_t is_object_with_constant_address(const expression_t *expression)
1693 {
1694         switch (expression->kind) {
1695         case EXPR_SELECT: {
1696                 expression_t *compound      = expression->select.compound;
1697                 type_t       *compound_type = compound->base.type;
1698                 compound_type = skip_typeref(compound_type);
1699                 if (is_type_pointer(compound_type)) {
1700                         return is_constant_pointer(compound);
1701                 } else {
1702                         return is_object_with_constant_address(compound);
1703                 }
1704         }
1705
1706         case EXPR_ARRAY_ACCESS: {
1707                 array_access_expression_t const* const array_access =
1708                         &expression->array_access;
1709                 expression_classification_t const idx_class = is_constant_expression(array_access->index);
1710                 if (idx_class != EXPR_CLASS_CONSTANT)
1711                         return idx_class;
1712                 expression_classification_t const ref_addr = is_object_with_constant_address(array_access->array_ref);
1713                 expression_classification_t const ref_ptr  = is_constant_pointer(array_access->array_ref);
1714                 return ref_addr > ref_ptr ? ref_addr : ref_ptr;
1715         }
1716
1717         case EXPR_UNARY_DEREFERENCE:
1718                 return is_constant_pointer(expression->unary.value);
1719
1720         case EXPR_ERROR:
1721                 return EXPR_CLASS_ERROR;
1722
1723         default:
1724                 return EXPR_CLASS_VARIABLE;
1725         }
1726 }
1727
1728 expression_classification_t is_constant_expression(const expression_t *expression)
1729 {
1730         switch (expression->kind) {
1731         case EXPR_LITERAL_CHARACTER:
1732         case EXPR_BUILTIN_TYPES_COMPATIBLE_P:
1733         case EXPR_ENUM_CONSTANT:
1734         case EXPR_LITERAL_BOOLEAN:
1735         case EXPR_LITERAL_MS_NOOP:
1736                 return EXPR_CLASS_CONSTANT;
1737
1738         {
1739                 type_t *type;
1740         case EXPR_ALIGNOF:
1741                 type = skip_typeref(expression->typeprop.type);
1742                 goto check_type;
1743
1744         case EXPR_CLASSIFY_TYPE:
1745                 type = skip_typeref(expression->classify_type.type_expression->base.type);
1746                 goto check_type;
1747
1748         case EXPR_LITERAL_INTEGER:
1749         case EXPR_LITERAL_FLOATINGPOINT:
1750                 type = skip_typeref(expression->base.type);
1751                 goto check_type;
1752
1753         case EXPR_OFFSETOF:
1754                 type = skip_typeref(expression->offsetofe.type);
1755                 goto check_type;
1756
1757         case EXPR_SIZEOF:
1758                 type = skip_typeref(expression->typeprop.type);
1759                 if (is_type_array(type) && type->array.is_vla)
1760                         return EXPR_CLASS_VARIABLE;
1761                 goto check_type;
1762
1763 check_type:
1764                 return is_type_valid(type) ? EXPR_CLASS_CONSTANT : EXPR_CLASS_ERROR;
1765         }
1766
1767         case EXPR_BUILTIN_CONSTANT_P: {
1768                 expression_classification_t const c = is_constant_expression(expression->builtin_constant.value);
1769                 return c != EXPR_CLASS_ERROR ? EXPR_CLASS_CONSTANT : EXPR_CLASS_ERROR;
1770         }
1771
1772         case EXPR_STRING_LITERAL:
1773         case EXPR_FUNCNAME:
1774         case EXPR_LABEL_ADDRESS:
1775         case EXPR_SELECT:
1776         case EXPR_VA_START:
1777         case EXPR_VA_ARG:
1778         case EXPR_VA_COPY:
1779         case EXPR_STATEMENT:
1780         case EXPR_UNARY_POSTFIX_INCREMENT:
1781         case EXPR_UNARY_POSTFIX_DECREMENT:
1782         case EXPR_UNARY_PREFIX_INCREMENT:
1783         case EXPR_UNARY_PREFIX_DECREMENT:
1784         case EXPR_UNARY_ASSUME: /* has VOID type */
1785         case EXPR_UNARY_DEREFERENCE:
1786         case EXPR_UNARY_DELETE:
1787         case EXPR_UNARY_DELETE_ARRAY:
1788         case EXPR_UNARY_THROW:
1789         case EXPR_BINARY_ASSIGN:
1790         case EXPR_BINARY_MUL_ASSIGN:
1791         case EXPR_BINARY_DIV_ASSIGN:
1792         case EXPR_BINARY_MOD_ASSIGN:
1793         case EXPR_BINARY_ADD_ASSIGN:
1794         case EXPR_BINARY_SUB_ASSIGN:
1795         case EXPR_BINARY_SHIFTLEFT_ASSIGN:
1796         case EXPR_BINARY_SHIFTRIGHT_ASSIGN:
1797         case EXPR_BINARY_BITWISE_AND_ASSIGN:
1798         case EXPR_BINARY_BITWISE_XOR_ASSIGN:
1799         case EXPR_BINARY_BITWISE_OR_ASSIGN:
1800         case EXPR_BINARY_COMMA:
1801         case EXPR_ARRAY_ACCESS:
1802                 return EXPR_CLASS_VARIABLE;
1803
1804         case EXPR_REFERENCE: {
1805                 type_t *const type = skip_typeref(expression->base.type);
1806                 return is_type_valid(type) ? EXPR_CLASS_VARIABLE : EXPR_CLASS_ERROR;
1807         }
1808
1809         case EXPR_UNARY_TAKE_ADDRESS:
1810                 return is_object_with_constant_address(expression->unary.value);
1811
1812         case EXPR_CALL:
1813                 return is_builtin_const_call(expression);
1814
1815         case EXPR_UNARY_NEGATE:
1816         case EXPR_UNARY_PLUS:
1817         case EXPR_UNARY_BITWISE_NEGATE:
1818         case EXPR_UNARY_NOT:
1819                 return is_constant_expression(expression->unary.value);
1820
1821         case EXPR_UNARY_CAST: {
1822                 type_t *const type = skip_typeref(expression->base.type);
1823                 if (is_type_scalar(type))
1824                         return is_constant_expression(expression->unary.value);
1825                 if (!is_type_valid(type))
1826                         return EXPR_CLASS_ERROR;
1827                 return EXPR_CLASS_VARIABLE;
1828         }
1829
1830         case EXPR_BINARY_ADD:
1831         case EXPR_BINARY_SUB:
1832         case EXPR_BINARY_MUL:
1833         case EXPR_BINARY_DIV:
1834         case EXPR_BINARY_MOD:
1835         case EXPR_BINARY_EQUAL:
1836         case EXPR_BINARY_NOTEQUAL:
1837         case EXPR_BINARY_LESS:
1838         case EXPR_BINARY_LESSEQUAL:
1839         case EXPR_BINARY_GREATER:
1840         case EXPR_BINARY_GREATEREQUAL:
1841         case EXPR_BINARY_BITWISE_AND:
1842         case EXPR_BINARY_BITWISE_OR:
1843         case EXPR_BINARY_BITWISE_XOR:
1844         case EXPR_BINARY_SHIFTLEFT:
1845         case EXPR_BINARY_SHIFTRIGHT:
1846         case EXPR_BINARY_ISGREATER:
1847         case EXPR_BINARY_ISGREATEREQUAL:
1848         case EXPR_BINARY_ISLESS:
1849         case EXPR_BINARY_ISLESSEQUAL:
1850         case EXPR_BINARY_ISLESSGREATER:
1851         case EXPR_BINARY_ISUNORDERED: {
1852                 expression_classification_t const l = is_constant_expression(expression->binary.left);
1853                 expression_classification_t const r = is_constant_expression(expression->binary.right);
1854                 return l < r ? l : r;
1855         }
1856
1857         case EXPR_BINARY_LOGICAL_AND: {
1858                 expression_t const         *const left   = expression->binary.left;
1859                 expression_classification_t const lclass = is_constant_expression(left);
1860                 if (lclass != EXPR_CLASS_CONSTANT)
1861                         return lclass;
1862                 if (!fold_constant_to_bool(left))
1863                         return EXPR_CLASS_CONSTANT;
1864                 return is_constant_expression(expression->binary.right);
1865         }
1866
1867         case EXPR_BINARY_LOGICAL_OR: {
1868                 expression_t const         *const left   = expression->binary.left;
1869                 expression_classification_t const lclass = is_constant_expression(left);
1870                 if (lclass != EXPR_CLASS_CONSTANT)
1871                         return lclass;
1872                 if (fold_constant_to_bool(left))
1873                         return EXPR_CLASS_CONSTANT;
1874                 return is_constant_expression(expression->binary.right);
1875         }
1876
1877         case EXPR_COMPOUND_LITERAL:
1878                 return is_constant_initializer(expression->compound_literal.initializer);
1879
1880         case EXPR_CONDITIONAL: {
1881                 expression_t               *const condition = expression->conditional.condition;
1882                 expression_classification_t const cclass    = is_constant_expression(condition);
1883                 if (cclass != EXPR_CLASS_CONSTANT)
1884                         return cclass;
1885
1886                 if (fold_constant_to_bool(condition)) {
1887                         expression_t const *const t = expression->conditional.true_expression;
1888                         return t == NULL ? EXPR_CLASS_CONSTANT : is_constant_expression(t);
1889                 } else {
1890                         return is_constant_expression(expression->conditional.false_expression);
1891                 }
1892         }
1893
1894         case EXPR_ERROR:
1895                 return EXPR_CLASS_ERROR;
1896         }
1897         panic("invalid expression");
1898 }
1899
1900 void init_ast(void)
1901 {
1902         obstack_init(&ast_obstack);
1903 }
1904
1905 void exit_ast(void)
1906 {
1907         obstack_free(&ast_obstack, NULL);
1908 }