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