3 * File name: ir/ir/irprintf.h
4 * Purpose: A little printf understanding some firm types.
5 * Author: Sebastian Hack
8 * Copyright: (c) 1998-2004 Universität Karlsruhe
9 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
15 * A little printf understanding some firm types.
16 * @author Sebastian Hack
23 #include "firm_config.h"
29 /* forward definition */
33 * Something that can append strings and chars to something.
35 typedef struct _appender_t {
36 void (*init)(void *object, size_t n);
37 void (*append_char)(void *object, size_t n, char ch);
38 void (*append_str)(void *object, size_t n, const char *str);
42 * A callback function type to add something to an appender.
44 * @param app The appender.
45 * @param object The object for the appender.
46 * @param limit The limit for the appender.
47 * @param arg The thing to append.
49 typedef void (ir_printf_cb_t)(const appender_t *app, void *object, size_t limit, const void *arg);
52 * A string formatting routine for ir objects.
53 * This function rudimentary implements a kind of printf(3) for ir
54 * nodes. Following conversion specifiers. No length, special or field
55 * width specifiers are accepted.
56 * - @%% Print a '%' character.
57 * - @%> Print as many white spaces as given in the parameter.
58 * - @%c Print a character
61 * - @%d A decimal integer.
62 * - @%x A hexadecimal integer.
63 * - @%o An octal integer.
66 * - @%e An entity name.
67 * - @%E An entity ld name.
69 * - @%n A full description of a node.
70 * - @%O The opcode name of an ir node.
71 * - @%N The node number of an ir node.
72 * - @%m The mode name of an ir mode.
73 * - @%B The block node number of the nodes block.
77 * Each of these can be prepend by a '+' which means, that the given
78 * pointer is a collection of items specified by the format. In this
79 * case you also have to pass an iterator interface to ir_printf()
80 * suitable for the instance of the collection. So, imagine you have a
81 * @c pset of ir_nodes and want to dump it, you write:
85 * ir_printf("Some nodes: %*n\n", it_pset, nodes);
87 * The @c it_pset is an iterator interface (of type
88 * @c iterator_t that allows the dumper to traverse the set.
90 * As special case when working with collections, you can also give a
91 * callback function which will be invoked on each element in the
92 * collection. It gets the appender (the thing where the textual
93 * representation of the element is written to) and its parameters
94 * passed by the dumping function. Suppose you have your own data type
95 * @c xyz_t and want to dump a pset of it, you have:
97 * void xyz_dump(const appender_t *app, void *object, size_t limit,
100 * const xyz_t *xyz = arg;
101 * app->append_str(object, limit, xyz->name);
106 * ir_printf("A set of xyz\'s: %*C\n", it_pset, xyzs, xyz_dump);
109 * @param fmt The format string.
111 void ir_printf(const char *fmt, ...);
116 void ir_fprintf(FILE *f, const char *fmt, ...);
121 void ir_snprintf(char *buf, size_t n, const char *fmt, ...);
126 void ir_vprintf(const char *fmt, va_list args);
131 void ir_vfprintf(FILE *f, const char *fmt, va_list args);
136 void ir_vsnprintf(char *buf, size_t len, const char *fmt, va_list args);
141 void ir_obst_vprintf(struct obstack *obst, const char *fmt, va_list args);
144 #include <libcore/xprintf.h>
145 #endif /* WITH_LIBCORE */
147 #endif /* _IRPRINTF_H */