use INLINE instead of inline
[cparser] / ast.c
diff --git a/ast.c b/ast.c
index 91d3cfe..4bf3258 100644 (file)
--- a/ast.c
+++ b/ast.c
@@ -15,7 +15,11 @@ struct obstack ast_obstack;
 static FILE *out;
 static int   indent;
 
-bool print_implicit_casts = true;
+/** If set, implicit casts are printed. */
+bool print_implicit_casts = false;
+
+/** If set parenthesis are printed to indicate operator precedence. */
+bool print_parenthesis = false;
 
 static void print_statement(const statement_t *statement);
 static void print_expression_prec(const expression_t *expression, unsigned prec);
@@ -33,28 +37,31 @@ void print_indent(void)
 }
 
 enum precedence_t {
-       PREC_BAD = 0,
-       PREC_COMMA,   /* ,                                    left to right */
-       PREC_ASSIGN,  /* = += -= *= /= %= <<= >>= &= ^= |=    right to left */
-       PREC_COND,    /* ?:                                   right to left */
-       PREC_LOG_OR,  /* ||                                   left to right */
-       PREC_LOG_AND, /* &&                                   left to right */
-       PREC_BIT_OR,  /* |                                    left to right */
-       PREC_BIT_XOR, /* ^                                    left to right */
-       PREC_BIT_AND, /* &                                    left to right */
-       PREC_EQ,      /* == !=                                left to right */
-       PREC_CMP,     /* < <= > >=                            left to right */
-       PREC_SHF,     /* << >>                                left to right */
-       PREC_PLUS,    /* + -                                  left to right */
-       PREC_MUL,     /* * / %                                left to right */
-       PREC_UNARY,   /* ! ~ ++ -- + - (type) * & sizeof      right to left */
-       PREC_ACCESS,  /* () [] -> .                           left to right */
-       PREC_PRIM,    /* primary */
+       PREC_BOTTOM  =  0,
+       PREC_COMMA   =  2, /* ,                                    left to right */
+       PREC_ASSIGN  =  4, /* = += -= *= /= %= <<= >>= &= ^= |=    right to left */
+       PREC_COND    =  6, /* ?:                                   right to left */
+       PREC_LOG_OR  =  8, /* ||                                   left to right */
+       PREC_LOG_AND = 10, /* &&                                   left to right */
+       PREC_BIT_OR  = 12, /* |                                    left to right */
+       PREC_BIT_XOR = 14, /* ^                                    left to right */
+       PREC_BIT_AND = 16, /* &                                    left to right */
+       PREC_EQ      = 18, /* == !=                                left to right */
+       PREC_CMP     = 20, /* < <= > >=                            left to right */
+       PREC_SHF     = 22, /* << >>                                left to right */
+       PREC_PLUS    = 24, /* + -                                  left to right */
+       PREC_MUL     = 26, /* * / %                                left to right */
+       PREC_UNARY   = 28, /* ! ~ ++ -- + - (type) * & sizeof      right to left */
+       PREC_ACCESS  = 30, /* () [] -> .                           left to right */
+       PREC_PRIM    = 32, /* primary */
+       PREC_TOP     = 34
 };
 
 /**
  * Returns 1 if a given precedence level has right-to-left
  * associativity, else -1.
+ *
+ * @param precedence   the operator precedence
  */
 static int right_to_left(unsigned precedence) {
        return (precedence == PREC_ASSIGN || precedence == PREC_COND ||
@@ -62,7 +69,9 @@ static int right_to_left(unsigned precedence) {
 }
 
 /**
- * Return the precedence of an expression.
+ * Return the precedence of an expression given by its kind.
+ *
+ * @param kind   the expression kind
  */
 static unsigned get_expression_precedence(expression_kind_t kind)
 {
@@ -70,6 +79,7 @@ static unsigned get_expression_precedence(expression_kind_t kind)
                [EXPR_UNKNOWN]                   = PREC_PRIM,
                [EXPR_INVALID]                   = PREC_PRIM,
                [EXPR_REFERENCE]                 = PREC_PRIM,
+               [EXPR_CHAR_CONST]                = PREC_PRIM,
                [EXPR_CONST]                     = PREC_PRIM,
                [EXPR_STRING_LITERAL]            = PREC_PRIM,
                [EXPR_WIDE_STRING_LITERAL]       = PREC_PRIM,
@@ -150,7 +160,7 @@ static unsigned get_expression_precedence(expression_kind_t kind)
                panic("wrong expression kind");
        }
        unsigned res = prec[kind];
-       if (res == PREC_BAD) {
+       if (res == PREC_BOTTOM) {
                panic("expression kind not defined in get_expression_precedence()");
        }
 #endif
@@ -159,29 +169,40 @@ static unsigned get_expression_precedence(expression_kind_t kind)
 
 /**
  * Print a constant expression.
+ *
+ * @param cnst  the constant expression
  */
 static void print_const(const const_expression_t *cnst)
 {
        if(cnst->base.type == NULL)
                return;
 
-       if(is_type_integer(cnst->base.type)) {
+       const type_t *const type = skip_typeref(cnst->base.type);
+
+       if (is_type_integer(type)) {
                fprintf(out, "%lld", cnst->v.int_value);
-       } else if(is_type_float(cnst->base.type)) {
+       } else if (is_type_float(type)) {
                fprintf(out, "%Lf", cnst->v.float_value);
+       } else {
+               panic("unknown constant");
        }
 }
 
 /**
  * Print a quoted string constant.
+ *
+ * @param string  the string constant
+ * @param border  the border char
  */
-static void print_quoted_string(const string_t *const string)
+static void print_quoted_string(const string_t *const string, char border)
 {
-       fputc('"', out);
+       fputc(border, out);
        const char *end = string->begin + string->size;
        for (const char *c = string->begin; c != end; ++c) {
+               if (*c == border) {
+                       fputc('\\', out);
+               }
                switch(*c) {
-               case '\"':  fputs("\\\"", out); break;
                case '\\':  fputs("\\\\", out); break;
                case '\a':  fputs("\\a", out); break;
                case '\b':  fputs("\\b", out); break;
@@ -200,20 +221,34 @@ static void print_quoted_string(const string_t *const string)
                        break;
                }
        }
-       fputc('"', out);
+       fputc(border, out);
+}
+
+/**
+ * Print a constant character expression.
+ *
+ * @param cnst  the constant character expression
+ */
+static void print_char_const(const const_expression_t *cnst)
+{
+       print_quoted_string(&cnst->v.chars, '\'');
 }
 
 /**
  * Prints a string literal expression.
+ *
+ * @param string_literal  the string literal expression
  */
 static void print_string_literal(
                const string_literal_expression_t *string_literal)
 {
-       print_quoted_string(&string_literal->value);
+       print_quoted_string(&string_literal->value, '"');
 }
 
 /**
  * Prints a wide string literal expression.
+ *
+ * @param wstr  the wide string literal expression
  */
 static void print_wide_string_literal(
        const wide_string_literal_expression_t *const wstr)
@@ -262,6 +297,8 @@ static void print_wide_string_literal(
 
 /**
  * Prints a call expression.
+ *
+ * @param call  the call expression
  */
 static void print_call_expression(const call_expression_t *call)
 {
@@ -285,6 +322,8 @@ static void print_call_expression(const call_expression_t *call)
 
 /**
  * Prints a binary expression.
+ *
+ * @param binexpr   the binary expression
  */
 static void print_binary_expression(const binary_expression_t *binexpr)
 {
@@ -344,6 +383,8 @@ static void print_binary_expression(const binary_expression_t *binexpr)
 
 /**
  * Prints an unary expression.
+ *
+ * @param unexpr   the unary expression
  */
 static void print_unary_expression(const unary_expression_t *unexpr)
 {
@@ -394,6 +435,8 @@ static void print_unary_expression(const unary_expression_t *unexpr)
 
 /**
  * Prints a reference expression.
+ *
+ * @param ref   the reference expression
  */
 static void print_reference_expression(const reference_expression_t *ref)
 {
@@ -402,6 +445,8 @@ static void print_reference_expression(const reference_expression_t *ref)
 
 /**
  * Prints an array expression.
+ *
+ * @param expression   the array expression
  */
 static void print_array_expression(const array_access_expression_t *expression)
 {
@@ -420,7 +465,9 @@ static void print_array_expression(const array_access_expression_t *expression)
 }
 
 /**
- * Prints a typeproperty expression.
+ * Prints a typeproperty expression (sizeof or __alignof__).
+ *
+ * @param expression   the type property expression
  */
 static void print_typeprop_expression(const typeprop_expression_t *expression)
 {
@@ -443,7 +490,9 @@ static void print_typeprop_expression(const typeprop_expression_t *expression)
 }
 
 /**
- * Prints an builtin symbol
+ * Prints an builtin symbol.
+ *
+ * @param expression   the builtin symbol expression
  */
 static void print_builtin_symbol(const builtin_symbol_expression_t *expression)
 {
@@ -452,6 +501,8 @@ static void print_builtin_symbol(const builtin_symbol_expression_t *expression)
 
 /**
  * Prints a builtin constant expression.
+ *
+ * @param expression   the builtin constant expression
  */
 static void print_builtin_constant(const builtin_constant_expression_t *expression)
 {
@@ -462,6 +513,8 @@ static void print_builtin_constant(const builtin_constant_expression_t *expressi
 
 /**
  * Prints a builtin prefetch expression.
+ *
+ * @param expression   the builtin prefetch expression
  */
 static void print_builtin_prefetch(const builtin_prefetch_expression_t *expression)
 {
@@ -480,6 +533,8 @@ static void print_builtin_prefetch(const builtin_prefetch_expression_t *expressi
 
 /**
  * Prints a conditional expression.
+ *
+ * @param expression   the conditional expression
  */
 static void print_conditional(const conditional_expression_t *expression)
 {
@@ -495,6 +550,8 @@ static void print_conditional(const conditional_expression_t *expression)
 
 /**
  * Prints a va_start expression.
+ *
+ * @param expression   the va_start expression
  */
 static void print_va_start(const va_start_expression_t *const expression)
 {
@@ -507,6 +564,8 @@ static void print_va_start(const va_start_expression_t *const expression)
 
 /**
  * Prints a va_arg expression.
+ *
+ * @param expression   the va_arg expression
  */
 static void print_va_arg(const va_arg_expression_t *expression)
 {
@@ -518,7 +577,9 @@ static void print_va_arg(const va_arg_expression_t *expression)
 }
 
 /**
- * Prints a select expression.
+ * Prints a select expression (. or ->).
+ *
+ * @param expression   the select expression
  */
 static void print_select(const select_expression_t *expression)
 {
@@ -535,6 +596,8 @@ static void print_select(const select_expression_t *expression)
 
 /**
  * Prints a type classify expression.
+ *
+ * @param expr   the type classify expression
  */
 static void print_classify_type_expression(
        const classify_type_expression_t *const expr)
@@ -544,6 +607,11 @@ static void print_classify_type_expression(
        fputc(')', out);
 }
 
+/**
+ * Prints a designator.
+ *
+ * @param designator  the designator
+ */
 static void print_designator(const designator_t *designator)
 {
        fputs(designator->symbol->string, out);
@@ -560,7 +628,9 @@ static void print_designator(const designator_t *designator)
 }
 
 /**
- * Prints an offsetof classify expression.
+ * Prints an offsetof expression.
+ *
+ * @param expression   the offset expression
  */
 static void print_offsetof_expression(const offsetof_expression_t *expression)
 {
@@ -574,6 +644,8 @@ static void print_offsetof_expression(const offsetof_expression_t *expression)
 
 /**
  * Prints a statement expression.
+ *
+ * @param expression   the statement expression
  */
 static void print_statement_expression(const statement_expression_t *expression)
 {
@@ -582,9 +654,17 @@ static void print_statement_expression(const statement_expression_t *expression)
        fputc(')', out);
 }
 
+/**
+ * Prints an expression with parenthesis if needed.
+ *
+ * @param expression  the expression to print
+ * @param top_prec    the precedence of the user of this expression.
+ */
 static void print_expression_prec(const expression_t *expression, unsigned top_prec)
 {
        unsigned prec = get_expression_precedence(expression->base.kind);
+       if (print_parenthesis && top_prec != PREC_BOTTOM)
+               top_prec = PREC_TOP;
        if (top_prec > prec)
                fputc('(', out);
        switch(expression->kind) {
@@ -592,6 +672,9 @@ static void print_expression_prec(const expression_t *expression, unsigned top_p
        case EXPR_INVALID:
                fprintf(out, "*invalid expression*");
                break;
+       case EXPR_CHAR_CONST:
+               print_char_const(&expression->conste);
+               break;
        case EXPR_CONST:
                print_const(&expression->conste);
                break;
@@ -662,6 +745,11 @@ static void print_expression_prec(const expression_t *expression, unsigned top_p
                fputc(')', out);
 }
 
+/**
+ * Print an compound statement.
+ *
+ * @param block  the compound statement
+ */
 static void print_compound_statement(const compound_statement_t *block)
 {
        fputs("{\n", out);
@@ -681,20 +769,35 @@ static void print_compound_statement(const compound_statement_t *block)
        fputs("}\n", out);
 }
 
+/**
+ * Print a return statement.
+ *
+ * @param statement  the return statement
+ */
 static void print_return_statement(const return_statement_t *statement)
 {
        fprintf(out, "return ");
        if(statement->value != NULL)
-               print_expression_prec(statement->value, PREC_BAD);
+               print_expression(statement->value);
        fputs(";\n", out);
 }
 
+/**
+ * Print an expression statement.
+ *
+ * @param statement  the expression statement
+ */
 static void print_expression_statement(const expression_statement_t *statement)
 {
        print_expression(statement->expression);
        fputs(";\n", out);
 }
 
+/**
+ * Print a goto statement.
+ *
+ * @param statement  the goto statement
+ */
 static void print_goto_statement(const goto_statement_t *statement)
 {
        fprintf(out, "goto ");
@@ -703,6 +806,11 @@ static void print_goto_statement(const goto_statement_t *statement)
        fputs(";\n", out);
 }
 
+/**
+ * Print a label statement.
+ *
+ * @param statement  the label statement
+ */
 static void print_label_statement(const label_statement_t *statement)
 {
        fprintf(stderr, "(%p)", (void*) statement->label);
@@ -712,6 +820,11 @@ static void print_label_statement(const label_statement_t *statement)
        }
 }
 
+/**
+ * Print an if statement.
+ *
+ * @param statement  the if statement
+ */
 static void print_if_statement(const if_statement_t *statement)
 {
        fputs("if(", out);
@@ -728,6 +841,11 @@ static void print_if_statement(const if_statement_t *statement)
        }
 }
 
+/**
+ * Print a switch statement.
+ *
+ * @param statement  the switch statement
+ */
 static void print_switch_statement(const switch_statement_t *statement)
 {
        fputs("switch(", out);
@@ -736,6 +854,11 @@ static void print_switch_statement(const switch_statement_t *statement)
        print_statement(statement->body);
 }
 
+/**
+ * Print a case label (including the default label).
+ *
+ * @param statement  the case label statement
+ */
 static void print_case_label(const case_label_statement_t *statement)
 {
        if(statement->expression == NULL) {
@@ -743,6 +866,10 @@ static void print_case_label(const case_label_statement_t *statement)
        } else {
                fputs("case ", out);
                print_expression(statement->expression);
+               if (statement->end_range != NULL) {
+                       fputs(" ... ", out);
+                       print_expression(statement->end_range);
+               }
                fputs(":\n", out);
        }
        ++indent;
@@ -755,6 +882,11 @@ static void print_case_label(const case_label_statement_t *statement)
        }
 }
 
+/**
+ * Print a declaration statement.
+ *
+ * @param statement   the statement
+ */
 static void print_declaration_statement(
                const declaration_statement_t *statement)
 {
@@ -772,6 +904,11 @@ static void print_declaration_statement(
        }
 }
 
+/**
+ * Print a while statement.
+ *
+ * @param statement   the statement
+ */
 static void print_while_statement(const while_statement_t *statement)
 {
        fputs("while(", out);
@@ -780,6 +917,11 @@ static void print_while_statement(const while_statement_t *statement)
        print_statement(statement->body);
 }
 
+/**
+ * Print a do-while statement.
+ *
+ * @param statement   the statement
+ */
 static void print_do_while_statement(const do_while_statement_t *statement)
 {
        fputs("do ", out);
@@ -790,6 +932,11 @@ static void print_do_while_statement(const do_while_statement_t *statement)
        fputs(");\n", out);
 }
 
+/**
+ * Print a for statement.
+ *
+ * @param statement   the statement
+ */
 static void print_for_statement(const for_statement_t *statement)
 {
        fputs("for(", out);
@@ -817,6 +964,11 @@ static void print_for_statement(const for_statement_t *statement)
        print_statement(statement->body);
 }
 
+/**
+ * Print assembler constraints.
+ *
+ * @param constraints   the constraints
+ */
 static void print_asm_constraints(asm_constraint_t *constraints)
 {
        asm_constraint_t *constraint = constraints;
@@ -827,13 +979,18 @@ static void print_asm_constraints(asm_constraint_t *constraints)
                if(constraint->symbol) {
                        fprintf(out, "[%s] ", constraint->symbol->string);
                }
-               print_quoted_string(&constraint->constraints);
+               print_quoted_string(&constraint->constraints, '"');
                fputs(" (", out);
                print_expression(constraint->expression);
                fputs(")", out);
        }
 }
 
+/**
+ * Print assembler clobbers.
+ *
+ * @param clobbers   the clobbers
+ */
 static void print_asm_clobbers(asm_clobber_t *clobbers)
 {
        asm_clobber_t *clobber = clobbers;
@@ -841,10 +998,15 @@ static void print_asm_clobbers(asm_clobber_t *clobbers)
                if(clobber != clobbers)
                        fputs(", ", out);
 
-               print_quoted_string(&clobber->clobber);
+               print_quoted_string(&clobber->clobber, '"');
        }
 }
 
+/**
+ * Print an assembler statement.
+ *
+ * @param statement   the statement
+ */
 static void print_asm_statement(const asm_statement_t *statement)
 {
        fputs("asm ", out);
@@ -852,7 +1014,7 @@ static void print_asm_statement(const asm_statement_t *statement)
                fputs("volatile ", out);
        }
        fputs("(", out);
-       print_quoted_string(&statement->asm_text);
+       print_quoted_string(&statement->asm_text, '"');
        if(statement->inputs == NULL && statement->outputs == NULL
                        && statement->clobbers == NULL)
                goto end_of_print_asm_statement;
@@ -874,6 +1036,11 @@ end_of_print_asm_statement:
        fputs(");\n", out);
 }
 
+/**
+ * Print a statement.
+ *
+ * @param statement   the statement
+ */
 void print_statement(const statement_t *statement)
 {
        switch(statement->kind) {
@@ -928,6 +1095,11 @@ void print_statement(const statement_t *statement)
        }
 }
 
+/**
+ * Print a storage class.
+ *
+ * @param storage_class   the storage class
+ */
 static void print_storage_class(unsigned storage_class)
 {
        switch((storage_class_tag_t) storage_class) {
@@ -945,6 +1117,11 @@ static void print_storage_class(unsigned storage_class)
        }
 }
 
+/**
+ * Print an initializer.
+ *
+ * @param initializer  the initializer
+ */
 void print_initializer(const initializer_t *initializer)
 {
        if(initializer->kind == INITIALIZER_VALUE) {
@@ -966,6 +1143,11 @@ void print_initializer(const initializer_t *initializer)
        fputs("}", out);
 }
 
+/**
+ * Print a declaration in the NORMAL namespace.
+ *
+ * @param declaration  the declaration
+ */
 static void print_normal_declaration(const declaration_t *declaration)
 {
        print_storage_class(declaration->storage_class);
@@ -993,11 +1175,18 @@ static void print_normal_declaration(const declaration_t *declaration)
 
 /**
  * Prints an expression.
+ *
+ * @param expression  the expression
  */
 void print_expression(const expression_t *expression) {
-       print_expression_prec(expression, PREC_BAD);
+       print_expression_prec(expression, PREC_BOTTOM);
 }
 
+/**
+ * Print a declaration.
+ *
+ * @param declaration  the declaration
+ */
 void print_declaration(const declaration_t *declaration)
 {
        if(declaration->namespc != NAMESPACE_NORMAL &&
@@ -1032,6 +1221,11 @@ void print_declaration(const declaration_t *declaration)
        }
 }
 
+/**
+ * Print the AST of a translation unit.
+ *
+ * @param unit   the translation unit
+ */
 void print_ast(const translation_unit_t *unit)
 {
        inc_type_visited();
@@ -1050,11 +1244,18 @@ void print_ast(const translation_unit_t *unit)
        }
 }
 
+/**
+ * Returns true if a given expression is a compile time
+ * constant.
+ *
+ * @param expression  the expression to check
+ */
 bool is_constant_expression(const expression_t *expression)
 {
        switch(expression->kind) {
 
        case EXPR_CONST:
+       case EXPR_CHAR_CONST:
        case EXPR_STRING_LITERAL:
        case EXPR_WIDE_STRING_LITERAL:
        case EXPR_SIZEOF:
@@ -1158,24 +1359,41 @@ bool is_constant_expression(const expression_t *expression)
        panic("invalid expression found (is constant expression)");
 }
 
-
+/**
+ * Initialize the AST construction.
+ */
 void init_ast(void)
 {
        obstack_init(&ast_obstack);
 }
 
+/**
+ * Free the AST.
+ */
 void exit_ast(void)
 {
        obstack_free(&ast_obstack, NULL);
 }
 
+/**
+ * Set the output stream for the AST printer.
+ *
+ * @param stream  the output stream
+ */
 void ast_set_output(FILE *stream)
 {
        out = stream;
        type_set_output(stream);
 }
 
-void* (allocate_ast) (size_t size)
+/**
+ * Allocate an AST object of the given size.
+ *
+ * @param size  the size of the object to allocate
+ *
+ * @return  A new allocated object in the AST memeory space.
+ */
+void *(allocate_ast)(size_t size)
 {
        return _allocate_ast(size);
 }