cosmetics
[cparser] / ast.h
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 #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 const_expression_t                    const_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 wide_string_literal_expression_t      wide_string_literal_expression_t;
32 typedef struct compound_literal_expression_t         compound_literal_expression_t;
33 typedef struct reference_expression_t                reference_expression_t;
34 typedef struct cast_expression_t                     cast_expression_t;
35 typedef struct call_argument_t                       call_argument_t;
36 typedef struct type_argument_t                       type_argument_t;
37 typedef struct call_expression_t                     call_expression_t;
38 typedef struct binary_expression_t                   binary_expression_t;
39 typedef struct unary_expression_t                    unary_expression_t;
40 typedef struct select_expression_t                   select_expression_t;
41 typedef struct array_access_expression_t             array_access_expression_t;
42 typedef struct typeprop_expression_t                 typeprop_expression_t;
43 typedef struct conditional_expression_t              conditional_expression_t;
44 typedef struct expression_list_element_t             expression_list_element_t;
45 typedef struct comma_expression_t                    comma_expression_t;
46 typedef struct statement_expression_t                statement_expression_t;
47 typedef struct designator_t                          designator_t;
48 typedef struct offsetof_expression_t                 offsetof_expression_t;
49 typedef struct va_start_expression_t                 va_start_expression_t;
50 typedef struct va_arg_expression_t                   va_arg_expression_t;
51 typedef struct va_copy_expression_t                  va_copy_expression_t;
52 typedef struct builtin_constant_expression_t         builtin_constant_expression_t;
53 typedef struct builtin_types_compatible_expression_t builtin_types_compatible_expression_t;
54 typedef struct classify_type_expression_t            classify_type_expression_t;
55 typedef struct bitfield_extract_expression_t         bitfield_extract_expression_t;
56 typedef struct label_address_expression_t            label_address_expression_t;
57 typedef union  expression_t                          expression_t;
58
59 typedef struct initializer_base_t                    initializer_base_t;
60 typedef struct initializer_list_t                    initializer_list_t;
61 typedef struct initializer_value_t                   initializer_value_t;
62 typedef struct initializer_string_t                  initializer_string_t;
63 typedef struct initializer_wide_string_t             initializer_wide_string_t;
64 typedef struct initializer_designator_t              initializer_designator_t;
65 typedef union  initializer_t                         initializer_t;
66
67 typedef struct statement_base_t                      statement_base_t;
68 typedef struct invalid_statement_t                   invalid_statement_t;
69 typedef struct empty_statement_t                     empty_statement_t;
70 typedef struct compound_statement_t                  compound_statement_t;
71 typedef struct return_statement_t                    return_statement_t;
72 typedef struct if_statement_t                        if_statement_t;
73 typedef struct switch_statement_t                    switch_statement_t;
74 typedef struct declaration_statement_t               declaration_statement_t;
75 typedef struct expression_statement_t                expression_statement_t;
76 typedef struct goto_statement_t                      goto_statement_t;
77 typedef struct label_statement_t                     label_statement_t;
78 typedef struct case_label_statement_t                case_label_statement_t;
79 typedef struct while_statement_t                     while_statement_t;
80 typedef struct do_while_statement_t                  do_while_statement_t;
81 typedef struct for_statement_t                       for_statement_t;
82 typedef struct asm_argument_t                        asm_argument_t;
83 typedef struct asm_clobber_t                         asm_clobber_t;
84 typedef struct asm_statement_t                       asm_statement_t;
85 typedef struct ms_try_statement_t                    ms_try_statement_t;
86 typedef struct leave_statement_t                     leave_statement_t;
87 typedef union  statement_t                           statement_t;
88
89 typedef struct translation_unit_t                    translation_unit_t;
90
91 void  init_ast(void);
92 void  exit_ast(void);
93
94 void  ast_set_output(FILE *out);
95 void  print_expression(const expression_t *expression);
96 void  print_initializer(const initializer_t *initializer);
97 void  print_ast(const translation_unit_t *unit);
98 void  print_indent(void);
99 void  print_declaration(const entity_t *entity);
100 void  print_entity(const entity_t *entity);
101 void  change_indent(int delta);
102 void *allocate_ast(size_t size);
103
104 /**
105  * Returns true if a given expression is a compile time
106  * constant. ยง6.6
107  *
108  * @param expression  the expression to check
109  */
110 bool is_constant_initializer(const initializer_t *initializer);
111
112 /**
113  * Returns true if a given expression is a compile time
114  * constant.
115  *
116  * @param expression  the expression to check
117  */
118 bool is_constant_expression(const expression_t *expression);
119
120 bool is_address_constant(const expression_t *expression);
121
122 long fold_constant(const expression_t *expression);
123
124 #endif