no need for firm_config.h anymore
[libfirm] / ir / ir / irargs.c
1 /*
2  * Copyright (C) 1995-2008 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 #ifdef HAVE_CONFIG_H
27 # include "config.h"
28 #endif
29
30 #include "bitset.h"
31
32 #include <ctype.h>
33
34 #include "lc_printf.h"
35 #include "firm_common.h"
36 #include "irnode_t.h"
37 #include "entity_t.h"
38 #include "irloop_t.h"
39 #include "tv_t.h"
40 #include "dbginfo_t.h"
41
42 /**
43  * identify a firm object type
44  */
45 static int firm_get_arg_type(const lc_arg_occ_t *occ) {
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         (void) occ;
53         return lc_arg_type_int;
54 }
55
56
57 static int bitset_get_arg_type(const lc_arg_occ_t *occ) {
58         (void) occ;
59         return lc_arg_type_ptr;
60 }
61
62 static int bitset_emit(lc_appendable_t *app,
63     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
64 {
65         int res = 2;
66         bitset_t *b = arg->v_ptr;
67         bitset_pos_t p;
68         char buf[32];
69         const char *prefix = "";
70
71         lc_arg_append(app, occ, "[", 1);
72         bitset_foreach(b, p) {
73                 int n;
74
75                 n = snprintf(buf, sizeof(buf), "%s%d", prefix, (int) p);
76                 lc_arg_append(app, occ, buf, n);
77                 prefix = ", ";
78                 res += n;
79         }
80         lc_arg_append(app, occ, "]", 1);
81
82         return res;
83 }
84
85 /**
86  * emit an opaque Firm dbg_info object
87  */
88 static int firm_emit_dbg(lc_appendable_t *app,
89     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
90 {
91         char buf[1024];
92         ir_node *irn = arg->v_ptr;
93         dbg_info *dbg = get_irn_dbg_info(irn);
94
95         buf[0] = '\0';
96         if (dbg && __dbg_info_snprint) {
97                 if (__dbg_info_snprint(buf, sizeof(buf), dbg) <= 0)
98                         buf[0] = '\0';
99         }
100         return lc_arg_append(app, occ, buf, strlen(buf));
101 }
102
103 /**
104  * Beware: do not set the entity ld_name
105  */
106 static const char *get_entity_ld_name_ex(ir_entity *ent) {
107         if (ent->ld_name)
108                 return get_entity_ld_name(ent);
109         return get_entity_name(ent);
110 }
111
112 /**
113  * emit a Firm object
114  */
115 static int firm_emit(lc_appendable_t *app,
116     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
117 {
118 #define A(s)    occ->flag_hash ? s " ": ""
119
120         void *X = arg->v_ptr;
121         firm_kind *obj = X;
122         int i, n;
123         ir_node *block;
124         char add[64];
125         char buf[256];
126         char tv_buf[256];
127         ir_entity *ent;
128
129         buf[0] = '\0';
130         add[0] = '\0';
131
132         if (! X)
133                 strncpy(buf, "(null)", sizeof(buf));
134         else {
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                 snprintf(buf, sizeof(buf), "%s%s", A("ent"),
142                         isupper(occ->conversion) ? get_entity_ld_name_ex(X): get_entity_name(X));
143                 snprintf(add, sizeof(add), "[%ld]", get_entity_nr(X));
144                 break;
145         case k_type:
146                 snprintf(buf, sizeof(buf), "%s%s:%s", A("type"), get_type_tpop_name(X), get_type_name(X));
147                 snprintf(add, sizeof(add), "[%ld]", get_type_nr(X));
148                 break;
149         case k_ir_graph:
150                 if (X == get_const_code_irg())
151                         snprintf(buf, sizeof(buf), "%s<ConstCodeIrg>", A("irg"));
152                 else
153                         snprintf(buf, sizeof(buf), "%s%s", A("irg"), get_entity_name(get_irg_entity(X)));
154                 snprintf(add, sizeof(add), "[%ld]", get_irg_graph_nr(X));
155                 break;
156         case k_ir_node:
157                 switch (occ->conversion) {
158                 case 'B':
159                         block = is_no_Block(X) ? get_nodes_block(X) : X;
160                         snprintf(buf, sizeof(buf), "%s%s%s", A("irn"), get_irn_opname(block),
161                                 get_mode_name(get_irn_mode(block)));
162                         snprintf(add, sizeof(add), "[%ld]", get_irn_node_nr(block));
163                         break;
164                 case 'N':
165                         snprintf(buf, sizeof(buf), "%ld", get_irn_node_nr(X));
166                         break;
167                 default:
168                         if (is_Const(X)) {
169                                 tarval *tv = get_Const_tarval(X);
170                                 if (tv)
171                                         tarval_snprintf(tv_buf, sizeof(tv_buf), tv);
172                                 else
173                                         strncpy(tv_buf, "(NULL)", sizeof(tv_buf));
174                                 snprintf(buf, sizeof(buf), "%s%s%s<%s>", A("irn"), get_irn_opname(X),
175                                         get_mode_name(get_irn_mode(X)), tv_buf);
176                         }
177                         else
178                                 snprintf(buf, sizeof(buf), "%s%s%s", A("irn"), get_irn_opname(X),
179                                 get_mode_name(get_irn_mode(X)));
180                         snprintf(add, sizeof(add), "[%ld:%d]", get_irn_node_nr(X), get_irn_idx(X));
181                         }
182                         break;
183         case k_ir_mode:
184                 snprintf(buf, sizeof(buf), "%s%s", A("mode"), get_mode_name(X));
185                 break;
186         case k_tarval:
187                 tarval_snprintf(tv_buf, sizeof(tv_buf), X);
188                 snprintf(buf, sizeof(buf), "%s%s", A("tv"), tv_buf);
189                 break;
190         case k_ir_loop:
191                 snprintf(buf, sizeof(buf), "loop[%d:%d]", get_loop_loop_nr(X), get_loop_depth(X));
192                 break;
193         case k_ir_op:
194                 snprintf(buf, sizeof(buf), "%s%s", A("op"), get_op_name(X));
195                 break;
196         case k_ir_compound_graph_path:
197                 n = get_compound_graph_path_length(X);
198
199                 for (i = 0; i < n; ++i) {
200                         ent = get_compound_graph_path_node(X, i);
201
202                         strncat(buf, ".", sizeof(buf));
203                         strncat(buf, get_entity_name(ent), sizeof(buf));
204                         if (is_Array_type(get_entity_owner(ent))) {
205                                 snprintf(add, sizeof(add), "[%d]",
206                                         get_compound_graph_path_array_index(X, i));
207                                 strncat(buf, add, sizeof(buf));
208                         }
209                 }
210                 add[0] = '\0';
211                 break;
212         case k_ir_extblk:
213                 snprintf(buf, sizeof(buf), "ExtBlock");
214                 snprintf(add, sizeof(add), "[%ld]", get_irn_node_nr(get_extbb_leader(X)));
215                 break;
216
217         default:
218                 snprintf(buf, sizeof(buf), "UNKWN");
219                 snprintf(add, sizeof(add), "[%p]", X);
220                 }
221         }
222
223         if (occ->flag_plus)
224                 strncat(buf, add, sizeof(buf));
225
226         return lc_arg_append(app, occ, buf, strlen(buf));
227
228 #undef A
229 }
230
231 /**
232  * emit an ident
233  */
234 static int firm_emit_ident(lc_appendable_t *app,
235     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
236 {
237         ident *id = (ident *)arg->v_ptr;
238         const char *p = id ? get_id_str(id) : "(null)";
239
240         return lc_arg_append(app, occ, p, strlen(p));
241 }
242
243 /**
244  * Emit indent.
245  */
246 static int firm_emit_indent(lc_appendable_t *app,
247     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
248 {
249         int i;
250         int width  = occ->width > 0 ? occ->width : 1;
251         int amount = arg->v_int * width;
252
253         for (i = 0; i < amount; ++i)
254                 lc_appendable_chadd(app, (i % width) == 0 ? '|' : ' ');
255
256         return amount;
257 }
258
259 /**
260  * Emit pnc.
261  */
262 static int firm_emit_pnc(lc_appendable_t *app,
263     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
264 {
265         int value = arg->v_int;
266         const char *p = get_pnc_string(value);
267
268         return lc_arg_append(app, occ, p, strlen(p));
269 }
270
271 lc_arg_env_t *firm_get_arg_env(void)
272 {
273
274         static lc_arg_env_t *env = NULL;
275
276         static lc_arg_handler_t firm_handler   = { firm_get_arg_type, firm_emit };
277         static lc_arg_handler_t ident_handler  = { firm_get_arg_type, firm_emit_ident };
278         static lc_arg_handler_t indent_handler = { firm_get_arg_type_int, firm_emit_indent };
279         static lc_arg_handler_t pnc_handler    = { firm_get_arg_type_int, firm_emit_pnc };
280         static lc_arg_handler_t bitset_handler = { bitset_get_arg_type, bitset_emit };
281         static lc_arg_handler_t debug_handler  = { firm_get_arg_type, firm_emit_dbg };
282
283         static struct {
284                 const char *name;
285                 char letter;
286         } args[] = {
287 #define X(name, letter) {"firm:" name, letter}
288                 X("type",      't'),
289                 X("entity",    'e'),
290                 X("entity_ld", 'E'),
291                 X("tarval",    'T'),
292                 X("irn",       'n'),
293                 X("op",        'O'),
294                 X("irn_nr",    'N'),
295                 X("mode",      'm'),
296                 X("block",     'B'),
297                 X("cg_path",   'P'),
298 #undef X
299         };
300
301         size_t i;
302
303         if (env == NULL) {
304                 env = lc_arg_new_env();
305                 lc_arg_add_std(env);
306
307                 lc_arg_register(env, "firm", 'F', &firm_handler);
308                 for (i = 0; i < sizeof(args)/sizeof(args[0]); ++i)
309                         lc_arg_register(env, args[i].name, args[i].letter, &firm_handler);
310
311                 lc_arg_register(env, "firm:ident",    'I', &ident_handler);
312                 lc_arg_register(env, "firm:indent",   'D', &indent_handler);
313                 lc_arg_register(env, "firm:dbg_info", 'G', &debug_handler);
314                 lc_arg_register(env, "firm:bitset",   'B', &bitset_handler);
315                 lc_arg_register(env, "firm:pnc",      '=', &pnc_handler);
316         }
317
318         return env;
319 }