Removed C99 feature, adapt to Firm coding conventions.
[libfirm] / ir / ir / irargs.c
1 /*
2  * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief    Support for libcore IR object output.
23  * @author   Sebastian Hack
24  * @version  $Id$
25  */
26 #include "config.h"
27
28 #include "irargs_t.h"
29
30 #include <ctype.h>
31
32 #include "bitset.h"
33 #include "lc_printf.h"
34 #include "firm_common.h"
35 #include "irnode_t.h"
36 #include "entity_t.h"
37 #include "irloop_t.h"
38 #include "tv_t.h"
39 #include "dbginfo_t.h"
40
41 /**
42  * identify a firm object type
43  */
44 static int firm_get_arg_type(const lc_arg_occ_t *occ)
45 {
46         (void) occ;
47         /* Firm objects are always pointer */
48         return lc_arg_type_ptr;
49 }
50
51 static int firm_get_arg_type_int(const lc_arg_occ_t *occ)
52 {
53         (void) occ;
54         return lc_arg_type_int;
55 }
56
57
58 static int bitset_get_arg_type(const lc_arg_occ_t *occ)
59 {
60         (void) occ;
61         return lc_arg_type_ptr;
62 }
63
64 static int bitset_emit(lc_appendable_t *app,
65     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
66 {
67         int res = 2;
68         bitset_t *b = (bitset_t*)arg->v_ptr;
69         size_t  p;
70         char buf[32];
71         const char *prefix = "";
72
73         lc_arg_append(app, occ, "[", 1);
74         bitset_foreach(b, p) {
75                 int n;
76
77                 n = snprintf(buf, sizeof(buf), "%s%d", prefix, (int) p);
78                 lc_arg_append(app, occ, buf, n);
79                 prefix = ", ";
80                 res += n;
81         }
82         lc_arg_append(app, occ, "]", 1);
83
84         return res;
85 }
86
87 /**
88  * emit an opaque Firm dbg_info object
89  */
90 static int firm_emit_dbg(lc_appendable_t *app,
91     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
92 {
93         char buf[1024];
94         ir_node *irn = (ir_node*)arg->v_ptr;
95         dbg_info *dbg = get_irn_dbg_info(irn);
96
97         ir_dbg_info_snprint(buf, sizeof(buf), dbg);
98         return lc_arg_append(app, occ, buf, strlen(buf));
99 }
100
101 /**
102  * Beware: do not set the entity ld_name
103  */
104 static const char *get_entity_ld_name_ex(ir_entity *ent)
105 {
106         if (ent->ld_name)
107                 return get_entity_ld_name(ent);
108         return get_entity_name(ent);
109 }
110
111 /**
112  * emit a Firm object
113  */
114 static int firm_emit(lc_appendable_t *app,
115     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
116 {
117 #define A(s)    occ->flag_hash ? s " ": ""
118
119         void *X = (void*)arg->v_ptr;
120         firm_kind *obj = (firm_kind*)X;
121         size_t i, n;
122         ir_node *block;
123         char add[64];
124         char buf[256];
125         char tv_buf[256];
126         ir_entity *ent;
127
128         buf[0] = '\0';
129         add[0] = '\0';
130
131         if (X == NULL) {
132                 return lc_arg_append(app, occ, "(null)", 6);
133         }
134
135         switch (*obj) {
136         case k_BAD:
137                 snprintf(buf, sizeof(buf), "BAD");
138                 snprintf(add, sizeof(add), "[%p]", X);
139                 break;
140         case k_entity: {
141                 ir_entity *entity = (ir_entity*)X;
142                 snprintf(buf, sizeof(buf), "%s%s", A("ent"),
143                         isupper(occ->conversion) ? get_entity_ld_name_ex(entity): get_entity_name(entity));
144                 snprintf(add, sizeof(add), "[%ld]", get_entity_nr(entity));
145                 break;
146         }
147         case k_type: {
148                 ir_type *type = (ir_type*)X;
149                 char type_name[256];
150                 ir_print_type(type_name, sizeof(type_name), type);
151                 snprintf(buf, sizeof(buf), "%s%s:%s", A("type"),
152                          get_type_tpop_name(type), type_name);
153                 snprintf(add, sizeof(add), "[%ld]", get_type_nr(type));
154                 break;
155         }
156         case k_ir_graph: {
157                 ir_graph *irg = (ir_graph*)X;
158                 if (irg == get_const_code_irg())
159                         snprintf(buf, sizeof(buf), "%s<ConstCodeIrg>", A("irg"));
160                 else
161                         snprintf(buf, sizeof(buf), "%s%s", A("irg"), get_entity_name(get_irg_entity(irg)));
162                 snprintf(add, sizeof(add), "[%ld]", get_irg_graph_nr(irg));
163                 break;
164         }
165         case k_ir_node: {
166                 ir_node *node = (ir_node*)X;
167                 switch (occ->conversion) {
168                 case 'B':
169                         block = !is_Block(node) ? get_nodes_block(node) : node;
170                         snprintf(buf, sizeof(buf), "%s%s %s", A("irn"),
171                                  get_irn_opname(block), get_mode_name(get_irn_mode(block)));
172                         snprintf(add, sizeof(add), "[%ld]", get_irn_node_nr(block));
173                         break;
174                 case 'N':
175                         snprintf(buf, sizeof(buf), "%ld", get_irn_node_nr(node));
176                         break;
177                 default:
178                         if (is_Const(node)) {
179                                 ir_tarval *tv = get_Const_tarval(node);
180                                 if (tv)
181                                         tarval_snprintf(tv_buf, sizeof(tv_buf), tv);
182                                 else
183                                         strncpy(tv_buf, "(NULL)", sizeof(tv_buf));
184                                 snprintf(buf, sizeof(buf), "%s%s %s<%s>", A("irn"), get_irn_opname(node),
185                                         get_mode_name(get_irn_mode(node)), tv_buf);
186                         } else if (is_SymConst_addr_ent(node)) {
187                                 snprintf(buf, sizeof(buf), "%s%s %s[%s]", A("irn"), get_irn_opname(node),
188                                 get_mode_name(get_irn_mode(node)), get_entity_name(get_SymConst_entity(node)));
189                         } else if (is_Sel(node)) {
190                                 snprintf(buf, sizeof(buf), "%s%s %s[%s]", A("irn"), get_irn_opname(node),
191                                 get_mode_name(get_irn_mode(node)), get_entity_name(get_Sel_entity(node)));
192                         } else {
193                                 snprintf(buf, sizeof(buf), "%s%s %s", A("irn"), get_irn_opname(node),
194                                 get_mode_name(get_irn_mode(node)));
195                         }
196                         snprintf(add, sizeof(add), "[%ld:%u]", get_irn_node_nr(node), get_irn_idx(node));
197                 }
198                 break;
199         }
200         case k_ir_mode: {
201                 ir_mode *mode = (ir_mode*)X;
202                 snprintf(buf, sizeof(buf), "%s%s", A("mode"), get_mode_name(mode));
203                 break;
204         }
205         case k_tarval: {
206                 ir_tarval *tarval = (ir_tarval*)X;
207                 tarval_snprintf(tv_buf, sizeof(tv_buf), tarval);
208                 snprintf(buf, sizeof(buf), "%s%s", A("tv"), tv_buf);
209                 break;
210         }
211         case k_ir_loop: {
212                 ir_loop *loop = (ir_loop*)X;
213                 snprintf(buf, sizeof(buf), "loop[%ld:%u]", get_loop_loop_nr(loop), get_loop_depth(loop));
214                 break;
215         }
216         case k_ir_op: {
217                 ir_op *op = (ir_op*)X;
218                 snprintf(buf, sizeof(buf), "%s%s", A("op"), get_op_name(op));
219                 break;
220         }
221         case k_ir_compound_graph_path: {
222                 compound_graph_path *path = (compound_graph_path*)X;
223                 n = get_compound_graph_path_length(path);
224
225                 for (i = 0; i < n; ++i) {
226                         ent = get_compound_graph_path_node(path, i);
227
228                         strncat(buf, ".", sizeof(buf)-1);
229                         strncat(buf, get_entity_name(ent), sizeof(buf)-1);
230                         if (is_Array_type(get_entity_owner(ent))) {
231                                 snprintf(add, sizeof(add), "[%ld]",
232                                         get_compound_graph_path_array_index(path, i));
233                                 strncat(buf, add, sizeof(buf)-1);
234                         }
235                 }
236                 add[0] = '\0';
237                 break;
238         }
239         case k_ir_extblk: {
240                 ir_extblk *extblk = (ir_extblk*)X;
241                 snprintf(buf, sizeof(buf), "ExtBlock");
242                 snprintf(add, sizeof(add), "[%ld]", get_irn_node_nr(get_extbb_leader(extblk)));
243                 break;
244         }
245
246         default:
247                 snprintf(buf, sizeof(buf), "UNKWN");
248                 snprintf(add, sizeof(add), "[%p]", X);
249         }
250
251         if (occ->flag_plus)
252                 strncat(buf, add, sizeof(buf)-1);
253
254         return lc_arg_append(app, occ, buf, strlen(buf));
255 #undef A
256 }
257
258 /**
259  * emit an ident
260  */
261 static int firm_emit_ident(lc_appendable_t *app,
262     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
263 {
264         ident *id = (ident *)arg->v_ptr;
265         const char *p = id ? get_id_str(id) : "(null)";
266
267         return lc_arg_append(app, occ, p, strlen(p));
268 }
269
270 /**
271  * Emit indent.
272  */
273 static int firm_emit_indent(lc_appendable_t *app,
274     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
275 {
276         int i;
277         int width  = occ->width > 0 ? occ->width : 1;
278         int amount = arg->v_int * width;
279
280         for (i = 0; i < amount; ++i)
281                 lc_appendable_chadd(app, (i % width) == 0 ? '|' : ' ');
282
283         return amount;
284 }
285
286 /**
287  * Emit pnc.
288  */
289 static int firm_emit_pnc(lc_appendable_t *app,
290     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
291 {
292         int value = arg->v_int;
293         const char *p = get_pnc_string(value);
294
295         return lc_arg_append(app, occ, p, strlen(p));
296 }
297
298 lc_arg_env_t *firm_get_arg_env(void)
299 {
300
301         static lc_arg_env_t *env = NULL;
302
303         static lc_arg_handler_t firm_handler   = { firm_get_arg_type, firm_emit };
304         static lc_arg_handler_t ident_handler  = { firm_get_arg_type, firm_emit_ident };
305         static lc_arg_handler_t indent_handler = { firm_get_arg_type_int, firm_emit_indent };
306         static lc_arg_handler_t pnc_handler    = { firm_get_arg_type_int, firm_emit_pnc };
307         static lc_arg_handler_t bitset_handler = { bitset_get_arg_type, bitset_emit };
308         static lc_arg_handler_t debug_handler  = { firm_get_arg_type, firm_emit_dbg };
309
310         static struct {
311                 const char *name;
312                 char letter;
313         } args[] = {
314                 {"firm:type",      't'},
315                 {"firm:entity",    'e'},
316                 {"firm:entity_ld", 'E'},
317                 {"firm:tarval",    'T'},
318                 {"firm:irn",       'n'},
319                 {"firm:op",        'O'},
320                 {"firm:irn_nr",    'N'},
321                 {"firm:mode",      'm'},
322                 {"firm:block",     'B'},
323                 {"firm:cg_path",   'P'},
324         };
325
326         size_t i;
327
328         if (env == NULL) {
329                 env = lc_arg_new_env();
330                 lc_arg_add_std(env);
331
332                 lc_arg_register(env, "firm", 'F', &firm_handler);
333                 for (i = 0; i < sizeof(args)/sizeof(args[0]); ++i)
334                         lc_arg_register(env, args[i].name, args[i].letter, &firm_handler);
335
336                 lc_arg_register(env, "firm:ident",    'I', &ident_handler);
337                 lc_arg_register(env, "firm:indent",   'D', &indent_handler);
338                 lc_arg_register(env, "firm:dbg_info", 'G', &debug_handler);
339                 lc_arg_register(env, "firm:bitset",   'B', &bitset_handler);
340                 lc_arg_register(env, "firm:pnc",      '=', &pnc_handler);
341         }
342
343         return env;
344 }