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
27 * Something that can append strings and chars to something.
29 typedef struct _appender_t {
30 void (*append_char)(void *object, size_t n, char ch);
31 void (*append_str)(void *object, size_t n, const char *str);
35 * A callback function type to add something to an appender.
37 * @param app The appender.
38 * @param object The object for the appender.
39 * @param limit The limit for the appender.
40 * @param arg The thing to append.
42 typedef void (ir_printf_cb_t)(const appender_t *app, void *object, size_t limit, const void *arg);
45 * A string formatting routine for ir objects.
46 * This function rudimentarily implements a kind of printf(3) for ir
47 * nodes. Following conversion specifiers. No length, special or field
48 * width specifiers are accepted.
52 * - @%e An entity name.
53 * - @%E An entity ld_name.
54 * - @%n A full description of a node.
55 * - @%o The opcode name of an ir node.
56 * - @%m The mode name of an ir mode.
57 * - @%N The node number of an ir node.
58 * - @%b The block node number of the nodes block.
61 * Each of these can be prepended by a '+' which means, that the given
62 * pointer is a collection of items specified by the format. In this
63 * case you also have to pass an iterator interface to ir_printf()
64 * suitable for the instance of the collection. So, imagine you have a
65 * @c pset of ir_nodes and want to dump it, you write:
69 * ir_printf("Some nodes: %+n\n", it_pset, nodes);
71 * The @c it_pset is an iterator interface (of type
72 * @c iterator_t that allows the dumper to traverse the set.
74 * As special case when working with collections, you can also give a
75 * callback function which will be invoked on each element in the
76 * collection. It gets the appender (the thing where the textual
77 * representation of the element is written to) and its parameters
78 * passed by the dumping function. Suppose you have your own datatype
79 * @c xyz_t and want to dump a pset of it, you have:
81 * void xyz_dump(const appender_t *app, void *object, size_t limit,
84 * const xyz_t *xyz = arg;
85 * app->append_str(object, limit, xyz->name);
90 * ir_printf("A set of xyz\'s: %+C\n", it_pset, xyzs, xyz_dump);
93 * @param fmt The format string.
95 void ir_printf(const char *fmt, ...);
100 void ir_fprintf(FILE *f, const char *fmt, ...);
105 void ir_snprintf(char *buf, size_t n, const char *fmt, ...);