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