2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief A little printf understanding some firm types.
23 * @author Sebastian Hack
27 #ifndef FIRM_IR_IRPRINTF_H
28 #define FIRM_IR_IRPRINTF_H
35 /* forward definition */
39 * A string formatting routine for ir objects.
41 * @param fmt The format string.
43 * This function rudimentary implements a kind of printf(3) for ir
44 * nodes. Following conversion specifiers. No length, special or field
45 * width specifiers are accepted.
46 * - @%% Print a '%' character.
47 * - @%> Print as many white spaces as given in the parameter.
48 * - @%c Print a character
51 * - @%d A decimal integer.
52 * - @%x A hexadecimal integer.
53 * - @%o An octal integer.
56 * - @%e An entity name.
57 * - @%E An entity ld name.
59 * - @%n A full description of a node.
60 * - @%O The opcode name of an ir node.
61 * - @%N The node number of an ir node.
62 * - @%m The mode name of an ir mode.
63 * - @%B The block node number of the nodes block.
66 * - @%G A debug info (if available)
67 * - @%P A compound graph path
69 * Each of these can be prepend by a '+' which means, that the given
70 * pointer is a collection of items specified by the format. In this
71 * case you also have to pass an iterator interface to ir_printf()
72 * suitable for the instance of the collection. So, imagine you have a
73 * @c pset of ir_nodes and want to dump it, you write:
77 * ir_printf("Some nodes: %*n\n", it_pset, nodes);
79 * The @c it_pset is an iterator interface (of type
80 * @c iterator_t that allows the dumper to traverse the set.
82 FIRM_API void ir_printf(const char *fmt, ...);
87 FIRM_API void ir_fprintf(FILE *f, const char *fmt, ...);
92 FIRM_API void ir_snprintf(char *buf, size_t n, const char *fmt, ...);
97 FIRM_API void ir_vprintf(const char *fmt, va_list args);
102 FIRM_API void ir_vfprintf(FILE *f, const char *fmt, va_list args);
107 FIRM_API void ir_vsnprintf(char *buf, size_t len, const char *fmt,
113 FIRM_API void ir_obst_vprintf(struct obstack *obst, const char *fmt,