nsz Git - cparser/blob - ast.h

   1 /*
   2  * This file is part of cparser.
   3  * Copyright (C) 2007-2009 Matthias Braun <matze@braunis.de>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  18  * 02111-1307, USA.
  19  */
  20 #ifndef AST_H
  21 #define AST_H
  22
  23 #include <stdio.h>
  24 #include <stdbool.h>
  25 #include "entity.h"
  26
  27 typedef struct expression_base_t                     expression_base_t;
  28 typedef struct literal_expression_t                  literal_expression_t;
  29 typedef struct string_literal_expression_t           string_literal_expression_t;
  30 typedef struct funcname_expression_t                 funcname_expression_t;
  31 typedef struct compound_literal_expression_t         compound_literal_expression_t;
  32 typedef struct reference_expression_t                reference_expression_t;
  33 typedef struct cast_expression_t                     cast_expression_t;
  34 typedef struct call_argument_t                       call_argument_t;
  35 typedef struct type_argument_t                       type_argument_t;
  36 typedef struct call_expression_t                     call_expression_t;
  37 typedef struct binary_expression_t                   binary_expression_t;
  38 typedef struct unary_expression_t                    unary_expression_t;
  39 typedef struct select_expression_t                   select_expression_t;
  40 typedef struct array_access_expression_t             array_access_expression_t;
  41 typedef struct typeprop_expression_t                 typeprop_expression_t;
  42 typedef struct conditional_expression_t              conditional_expression_t;
  43 typedef struct expression_list_element_t             expression_list_element_t;
  44 typedef struct comma_expression_t                    comma_expression_t;
  45 typedef struct statement_expression_t                statement_expression_t;
  46 typedef struct designator_t                          designator_t;
  47 typedef struct offsetof_expression_t                 offsetof_expression_t;
  48 typedef struct va_start_expression_t                 va_start_expression_t;
  49 typedef struct va_arg_expression_t                   va_arg_expression_t;
  50 typedef struct va_copy_expression_t                  va_copy_expression_t;
  51 typedef struct builtin_constant_expression_t         builtin_constant_expression_t;
  52 typedef struct builtin_types_compatible_expression_t builtin_types_compatible_expression_t;
  53 typedef struct classify_type_expression_t            classify_type_expression_t;
  54 typedef struct bitfield_extract_expression_t         bitfield_extract_expression_t;
  55 typedef struct label_address_expression_t            label_address_expression_t;
  56 typedef union  expression_t                          expression_t;
  57
  58 typedef struct initializer_base_t                    initializer_base_t;
  59 typedef struct initializer_list_t                    initializer_list_t;
  60 typedef struct initializer_value_t                   initializer_value_t;
  61 typedef struct initializer_string_t                  initializer_string_t;
  62 typedef struct initializer_wide_string_t             initializer_wide_string_t;
  63 typedef struct initializer_designator_t              initializer_designator_t;
  64 typedef union  initializer_t                         initializer_t;
  65
  66 typedef struct statement_base_t                      statement_base_t;
  67 typedef struct invalid_statement_t                   invalid_statement_t;
  68 typedef struct empty_statement_t                     empty_statement_t;
  69 typedef struct compound_statement_t                  compound_statement_t;
  70 typedef struct return_statement_t                    return_statement_t;
  71 typedef struct if_statement_t                        if_statement_t;
  72 typedef struct switch_statement_t                    switch_statement_t;
  73 typedef struct declaration_statement_t               declaration_statement_t;
  74 typedef struct expression_statement_t                expression_statement_t;
  75 typedef struct goto_statement_t                      goto_statement_t;
  76 typedef struct label_statement_t                     label_statement_t;
  77 typedef struct case_label_statement_t                case_label_statement_t;
  78 typedef struct while_statement_t                     while_statement_t;
  79 typedef struct do_while_statement_t                  do_while_statement_t;
  80 typedef struct for_statement_t                       for_statement_t;
  81 typedef struct asm_argument_t                        asm_argument_t;
  82 typedef struct asm_clobber_t                         asm_clobber_t;
  83 typedef struct asm_statement_t                       asm_statement_t;
  84 typedef struct ms_try_statement_t                    ms_try_statement_t;
  85 typedef struct leave_statement_t                     leave_statement_t;
  86 typedef union  statement_t                           statement_t;
  87
  88 typedef struct translation_unit_t                    translation_unit_t;
  89
  90 /**
  91  * Initialize the AST construction.
  92  */
  93 void init_ast(void);
  94
  95 /**
  96  * Free the AST.
  97  */
  98 void exit_ast(void);
  99
 100 void print_expression(const expression_t *expression);
 101 void print_initializer(const initializer_t *initializer);
 102 void print_ast(const translation_unit_t *unit);
 103 void print_indent(void);
 104 void print_declaration(const entity_t *entity);
 105 void print_entity(const entity_t *entity);
 106 void change_indent(int delta);
 107
 108 typedef enum expression_classification_t {
 109         EXPR_CLASS_VARIABLE,
 110         EXPR_CLASS_ERROR,
 111         EXPR_CLASS_CONSTANT
 112 } expression_classification_t;
 113
 114 /**
 115  * Returns true if a given expression is a compile time
 116  * constant. §6.6
 117  *
 118  * @param expression  the expression to check
 119  */
 120 expression_classification_t is_constant_initializer(const initializer_t *initializer);
 121
 122 /**
 123  * Returns true if a given expression is a compile time
 124  * constant.
 125  *
 126  * @param expression  the expression to check
 127  */
 128 expression_classification_t is_constant_expression(const expression_t *expression);
 129
 130 /**
 131  * Checks if an expression is a constant/known value to the linker. Examples:
 132  *  - all constant expression casted to a pointer type
 133  *  - "&x", with x being a global variable.
 134  *  - "array" or "a.array" in case array is an array and array and a,
 135  *  respectively is an object with link time constant address
 136  */
 137 expression_classification_t is_linker_constant(const expression_t *expression);
 138
 139 long fold_constant_to_int(const expression_t *expression);
 140 bool fold_constant_to_bool(const expression_t *expression);
 141 bool constant_is_negative(const expression_t *constant);
 142
 143 /**
 144  * the type of a literal is usually the biggest type that can hold the value.
 145  * Since this is backend dependent the parses needs this call exposed.
 146  * Works for EXPR_LITERAL_* expressions.
 147  */
 148 void determine_literal_type(literal_expression_t *literal);
 149
 150 #endif