Turn __FUNCTION__ into an alias for __func__.
[cparser] / walk.c
1 /*
2  * This file is part of cparser.
3  * Copyright (C) 2007-2009 Matthias Braun <matze@braunis.de>
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
18  * 02111-1307, USA.
19  */
20 #include <config.h>
21
22 #include "adt/error.h"
23 #include "ast_t.h"
24 #include "entity_t.h"
25 #include "type_t.h"
26 #include "walk.h"
27 #include <libfirm/adt/pset.h>
28
29 typedef struct walk_env_t {
30         pset *visited_types;
31         declaration_callback declaration_func;
32         statement_callback   statement_func;
33         expression_callback  expression_func;
34         void *env;
35 } walk_env_t;
36
37 static void walk_expression(expression_t *expr, const walk_env_t *const env);
38 static void walk_statement(statement_t *stmt, const walk_env_t *env);
39 static void walk_entity(entity_t *entity, const walk_env_t *env);
40 static void walk_designator(const designator_t *, const walk_env_t *);
41 static void walk_initializer(const initializer_t  *, const walk_env_t *);
42 static void walk_scope(const scope_t *const scope, const walk_env_t *const env);
43
44 static void walk_type(type_t *const type, const walk_env_t *const env)
45 {
46         if (pset_find_ptr(env->visited_types, type) != NULL)
47                 return;
48         pset_insert_ptr(env->visited_types, type);
49
50         switch (type->kind) {
51         case TYPE_ATOMIC:
52         case TYPE_COMPLEX:
53         case TYPE_IMAGINARY:
54         case TYPE_REFERENCE:
55         case TYPE_ERROR:
56                 return;
57         case TYPE_POINTER:
58                 walk_type(type->pointer.points_to, env);
59                 return;
60         case TYPE_ARRAY:
61                 walk_type(type->array.element_type, env);
62                 if (type->array.size_expression != NULL)
63                         walk_expression(type->array.size_expression, env);
64                 return;
65         case TYPE_FUNCTION:
66                 for (function_parameter_t *parameter = type->function.parameters;
67                      parameter != NULL; parameter = parameter->next) {
68                         walk_type(parameter->type, env);
69                 }
70                 walk_type(type->function.return_type, env);
71                 return;
72         case TYPE_TYPEOF:
73                 walk_expression(type->typeoft.expression, env);
74                 return;
75         case TYPE_TYPEDEF:
76                 walk_entity((entity_t*)type->typedeft.typedefe, env);
77                 return;
78         case TYPE_COMPOUND_STRUCT:
79         case TYPE_COMPOUND_UNION:
80                 walk_entity((entity_t*)type->compound.compound, env);
81                 return;
82         case TYPE_ENUM:
83                 walk_entity((entity_t*)type->enumt.enume, env);
84                 return;
85         }
86         panic("invalid type found");
87 }
88
89 static void walk_expression(expression_t *const expr,
90                             const walk_env_t *const env)
91 {
92         env->expression_func(expr, env->env);
93
94         switch (expr->base.kind) {
95         case EXPR_STATEMENT:
96                 walk_statement(expr->statement.statement, env);
97                 return;
98
99         case EXPR_BINARY_CASES:
100                 walk_expression(expr->binary.left, env);
101                 walk_expression(expr->binary.right, env);
102                 return;
103
104         case EXPR_UNARY_CASES_OPTIONAL:
105                 if (expr->unary.value == NULL)
106                         return;
107                 /* FALLTHROUGH */
108         case EXPR_UNARY_CASES_MANDATORY:
109                 walk_expression(expr->unary.value, env);
110                 return;
111
112         case EXPR_CALL:
113                 for (call_argument_t *arg = expr->call.arguments; arg != NULL;
114                      arg = arg->next) {
115                         walk_expression(arg->expression, env);
116                 }
117                 return;
118
119         case EXPR_COMPOUND_LITERAL:
120                 walk_initializer(expr->compound_literal.initializer, env);
121                 return;
122
123         case EXPR_CONDITIONAL:
124                 walk_expression(expr->conditional.condition, env);
125                 /* may be NULL because of gnu extension */
126                 if (expr->conditional.true_expression != NULL)
127                         walk_expression(expr->conditional.true_expression, env);
128                 walk_expression(expr->conditional.false_expression, env);
129                 return;
130
131         case EXPR_BUILTIN_CONSTANT_P:
132                 walk_expression(expr->builtin_constant.value, env);
133                 return;
134
135         case EXPR_BUILTIN_TYPES_COMPATIBLE_P:
136                 walk_type(expr->builtin_types_compatible.left, env);
137                 walk_type(expr->builtin_types_compatible.right, env);
138                 return;
139
140         case EXPR_SELECT:
141                 walk_expression(expr->select.compound, env);
142                 return;
143
144         case EXPR_ARRAY_ACCESS:
145                 walk_expression(expr->array_access.array_ref, env);
146                 walk_expression(expr->array_access.index, env);
147                 return;
148
149         case EXPR_CLASSIFY_TYPE:
150                 walk_expression(expr->classify_type.type_expression, env);
151                 return;
152
153         case EXPR_SIZEOF:
154         case EXPR_ALIGNOF: {
155                 expression_t *tp_expression = expr->typeprop.tp_expression;
156                 if (tp_expression != NULL) {
157                         walk_expression(tp_expression, env);
158                 }
159                 return;
160         }
161
162         case EXPR_VA_START:
163                 walk_expression(expr->va_starte.ap, env);
164                 return;
165
166         case EXPR_VA_ARG:
167                 walk_expression(expr->va_arge.ap, env);
168                 return;
169
170         case EXPR_VA_COPY:
171                 walk_expression(expr->va_copye.src, env);
172                 walk_expression(expr->va_copye.dst, env);
173                 return;
174
175         case EXPR_OFFSETOF:
176                 walk_designator(expr->offsetofe.designator, env);
177                 return;
178
179         case EXPR_LITERAL_CASES:
180         case EXPR_REFERENCE:
181         case EXPR_ENUM_CONSTANT:
182         case EXPR_STRING_LITERAL:
183         case EXPR_FUNCNAME:
184         case EXPR_LABEL_ADDRESS:
185         case EXPR_ERROR:
186                 return;
187         }
188         panic("invalid expr kind");
189 }
190
191 static void walk_designator(const designator_t *designator,
192                             const walk_env_t *const env)
193 {
194         for ( ; designator != NULL; designator = designator->next) {
195                 if (designator->array_index != NULL)
196                         walk_expression(designator->array_index, env);
197         }
198 }
199
200 static void walk_initializer(const initializer_t  *initializer,
201                              const walk_env_t *const env)
202 {
203         switch(initializer->kind) {
204         case INITIALIZER_VALUE:
205                 walk_expression(initializer->value.value, env);
206                 return;
207         case INITIALIZER_LIST: {
208                 for (size_t i = 0; i < initializer->list.len; ++i) {
209                         walk_initializer(initializer->list.initializers[i], env);
210                 }
211                 return;
212         }
213         case INITIALIZER_DESIGNATOR:
214                 walk_designator(initializer->designator.designator, env);
215                 return;
216         case INITIALIZER_STRING:
217         case INITIALIZER_WIDE_STRING:
218                 return;
219         }
220 }
221
222 static void walk_entity(entity_t *entity, const walk_env_t *const env)
223 {
224         env->declaration_func(entity, env->env);
225
226         switch (entity->kind) {
227         case ENTITY_VARIABLE: {
228                 const variable_t    *variable    = &entity->variable;
229                 const initializer_t *initializer = variable->initializer;
230                 walk_type(entity->declaration.type, env);
231                 if (initializer != NULL) {
232                         walk_initializer(initializer, env);
233                 }
234                 return;
235         }
236         case ENTITY_ENUM_VALUE:
237                 if (entity->enum_value.value != NULL)
238                         walk_expression(entity->enum_value.value, env);
239                 return;
240         case ENTITY_TYPEDEF:
241                 walk_type(entity->typedefe.type, env);
242                 return;
243         case ENTITY_FUNCTION:
244                 walk_type(entity->declaration.type, env);
245                 if (entity->function.statement != NULL)
246                         walk_statement(entity->function.statement, env);
247                 return;
248         case ENTITY_COMPOUND_MEMBER:
249         case ENTITY_PARAMETER:
250                 walk_type(entity->declaration.type, env);
251                 return;
252         case ENTITY_CLASS:
253         case ENTITY_STRUCT:
254         case ENTITY_UNION:
255                 walk_scope(&entity->compound.members, env);
256                 return;
257         case ENTITY_NAMESPACE:
258                 walk_scope(&entity->namespacee.members, env);
259                 return;
260         case ENTITY_ENUM:
261                 for (entity = entity->base.next;
262                      entity != NULL && entity->kind == ENTITY_ENUM_VALUE;
263                          entity = entity->base.next) {
264                         walk_entity(entity, env);
265                 }
266                 return;
267         case ENTITY_LABEL:
268         case ENTITY_LOCAL_LABEL:
269                 return;
270         }
271         panic("invalid entity found");
272 }
273
274 static void walk_declarations(entity_t*            entity,
275                               entity_t*      const last,
276                                                           const walk_env_t    *const env)
277 {
278         entity_t const *const end = last != NULL ? last->base.next : NULL;
279         for (; entity != end; entity = entity->base.next) {
280                 walk_entity(entity, env);
281         }
282 }
283
284 static void walk_scope(const scope_t *const scope, const walk_env_t *const env)
285 {
286         walk_declarations(scope->entities, NULL, env);
287 }
288
289 static void walk_statement(statement_t *const stmt, const walk_env_t *const env)
290 {
291         env->statement_func(stmt, env->env);
292
293         switch (stmt->kind) {
294         case STATEMENT_COMPOUND:
295                 for (statement_t *s = stmt->compound.statements; s != NULL;
296                      s = s->base.next) {
297                         walk_statement(s, env);
298                 }
299                 return;
300
301         case STATEMENT_FOR:
302                 walk_declarations(stmt->fors.scope.entities, NULL, env);
303                 if (stmt->fors.initialisation != NULL)
304                         walk_expression(stmt->fors.initialisation, env);
305                 if (stmt->fors.condition != NULL)
306                         walk_expression(stmt->fors.condition, env);
307                 if (stmt->fors.step != NULL)
308                         walk_expression(stmt->fors.step, env);
309                 walk_statement(stmt->fors.body, env);
310                 return;
311
312         case STATEMENT_IF:
313                 walk_expression(stmt->ifs.condition, env);
314                 walk_statement(stmt->ifs.true_statement, env);
315                 if (stmt->ifs.false_statement != NULL)
316                         walk_statement(stmt->ifs.false_statement, env);
317                 return;
318
319         case STATEMENT_SWITCH:
320                 walk_expression(stmt->switchs.expression, env);
321                 walk_statement(stmt->switchs.body, env);
322                 return;
323
324         case STATEMENT_LABEL:
325                 walk_statement(stmt->label.statement, env);
326                 return;
327
328         case STATEMENT_CASE_LABEL:
329                 if (stmt->case_label.expression) {
330                         walk_expression(stmt->case_label.expression, env);
331                         if (stmt->case_label.end_range)
332                                 walk_expression(stmt->case_label.end_range, env);
333                 }
334                 walk_statement(stmt->case_label.statement, env);
335                 return;
336
337         case STATEMENT_WHILE:
338                 walk_expression(stmt->whiles.condition, env);
339                 walk_statement(stmt->whiles.body, env);
340                 return;
341
342         case STATEMENT_DO_WHILE:
343                 walk_statement(stmt->do_while.body, env);
344                 walk_expression(stmt->do_while.condition, env);
345                 return;
346
347         case STATEMENT_EXPRESSION:
348                 walk_expression(stmt->expression.expression, env);
349                 return;
350
351         case STATEMENT_RETURN:
352                 if (stmt->returns.value != NULL)
353                         walk_expression(stmt->returns.value, env);
354                 return;
355
356         case STATEMENT_DECLARATION:
357                 walk_declarations(stmt->declaration.declarations_begin,
358                                 stmt->declaration.declarations_end, env);
359                 return;
360
361         case STATEMENT_MS_TRY:
362                 walk_statement(stmt->ms_try.try_statement, env);
363                 walk_statement(stmt->ms_try.final_statement, env);
364                 return;
365
366         case STATEMENT_COMPUTED_GOTO:
367                 walk_expression(stmt->computed_goto.expression, env);
368                 return;
369
370         case STATEMENT_ERROR:
371         case STATEMENT_EMPTY:
372         case STATEMENT_CONTINUE:
373         case STATEMENT_BREAK:
374         case STATEMENT_ASM:
375         case STATEMENT_GOTO:
376         case STATEMENT_LEAVE:
377                 return;
378         }
379
380         panic("unhandled statement");
381 }
382
383 static void null_declaration_func(entity_t *entity, void *env)
384 {
385         (void) entity;
386         (void) env;
387 }
388
389 static void null_statement_func(statement_t *statement, void *env)
390 {
391         (void) statement;
392         (void) env;
393 }
394
395 static void null_expression_func(expression_t *expression, void *env)
396 {
397         (void) expression;
398         (void) env;
399 }
400
401 void walk_translation_unit(translation_unit_t *unit,
402                            declaration_callback declaration_func,
403                                                    statement_callback statement_func,
404                                                    expression_callback expression_func, void *env)
405 {
406         walk_env_t walk_env = {
407                 pset_new_ptr_default(),
408                 declaration_func != NULL ? declaration_func : null_declaration_func,
409                 statement_func != NULL ? statement_func : null_statement_func,
410                 expression_func != NULL ? expression_func : null_expression_func,
411                 env
412         };
413         walk_scope(&unit->scope, &walk_env);
414         del_pset(walk_env.visited_types);
415 }
416
417 void walk_statements(statement_t *statement, statement_callback func, void *env)
418 {
419         walk_env_t walk_env
420                 = { pset_new_ptr_default(),
421                     null_declaration_func, func, null_expression_func, env };
422         walk_statement(statement, &walk_env);
423         del_pset(walk_env.visited_types);
424 }