nsz Git - libfirm/blob - ir/ir/irprintf.h

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/ir/irprintf.h
   4  * Purpose:     A little printf understanding some firm types.
   5  * Author:      Sebastian Hack
   6  * Created:     29.11.2004
   7  * CVS-ID:      $Id$
   8  * Copyright:   (c) 1998-2004 Universität Karlsruhe
   9  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  10  */
  11
  12 /**
  13  * @file irprintf.h
  14  *
  15  * A little printf understanding some firm types.
  16  * @author Sebastian Hack
  17  * @date 29.11.2004
  18  */
  19
  20 #ifndef _IRPRINTF_H
  21 #define _IRPRINTF_H
  22
  23 #include <stddef.h>
  24 #include <stdarg.h>
  25 #include <stdio.h>
  26
  27 /* forward definition */
  28 struct obstack;
  29
  30 /**
  31  * Something that can append strings and chars to something.
  32  */
  33 typedef struct _appender_t {
  34         void (*init)(void *object, size_t n);
  35         void (*append_char)(void *object, size_t n, char ch);
  36         void (*append_str)(void *object, size_t n, const char *str);
  37 } appender_t;
  38
  39 /**
  40  * A callback function type to add something to an appender.
  41  *
  42  * @param app    The appender.
  43  * @param object The object for the appender.
  44  * @param limit  The limit for the appender.
  45  * @param arg    The thing to append.
  46  */
  47 typedef void (ir_printf_cb_t)(const appender_t *app, void *object, size_t limit, const void *arg);
  48
  49 /**
  50  * A string formatting routine for ir objects.
  51  * This function rudimentarily implements a kind of printf(3) for ir
  52  * nodes. Following conversion specifiers. No length, special or field
  53  * width specifiers are accepted.
  54  * - @%> Print as many white spaces as given in the parameter.
  55  * - @%p A pointer.
  56  * - @%s A string.
  57  * - @%I An ident.
  58  * - @%t A type name.
  59  * - @%e An entity name.
  60  * - @%E An entity ld name.
  61  * - @%n A full description of a node.
  62  * - @%O The opcode name of an ir node.
  63  * - @%m The mode name of an ir mode.
  64  * - @%N The node number of an ir node.
  65  * - @%B The block node number of the nodes block.
  66  * - @%b A bitset.
  67  * - @%T A tarval.
  68  *
  69  * Each of these can be prepended 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:
  74  * @code
  75  *   pset *nodes;
  76  *   ...
  77  *   ir_printf("Some nodes: %*n\n", it_pset, nodes);
  78  * @endcode
  79  * The @c it_pset is an iterator interface (of type
  80  * @c iterator_t that allows the dumper to traverse the set.
  81  *
  82  * As special case when working with collections, you can also give a
  83  * callback function which will be invoked on each element in the
  84  * collection. It gets the appender (the thing where the textual
  85  * representation of the element is written to) and its parameters
  86  * passed by the dumping function. Suppose you have your own datatype
  87  * @c xyz_t and want to dump a pset of it, you have:
  88  * @code
  89  *   void xyz_dump(const appender_t *app, void *object, size_t limit,
  90  *       const void *arg)
  91  *   {
  92  *     const xyz_t *xyz = arg;
  93  *     app->append_str(object, limit, xyz->name);
  94  *   }
  95  *   ...
  96  *   pset *xyzs;
  97  *
  98  *   ir_printf("A set of xyz\'s: %*C\n", it_pset, xyzs, xyz_dump);
  99  * @endcode
 100  *
 101  * @param fmt The format string.
 102  */
 103 void ir_printf(const char *fmt, ...);
 104
 105 /**
 106  * @see irn_printf.
 107  */
 108 void ir_fprintf(FILE *f, const char *fmt, ...);
 109
 110 /**
 111  * @see irn_printf.
 112  */
 113 void ir_snprintf(char *buf, size_t n, const char *fmt, ...);
 114
 115 /**
 116  * @see irn_printf.
 117  */
 118 void ir_vprintf(const char *fmt, va_list args);
 119
 120 /**
 121  * @see irn_printf.
 122  */
 123 void ir_vfprintf(FILE *f, const char *fmt, va_list args);
 124
 125 /**
 126  * @see irn_printf.
 127  */
 128 void ir_vsnprintf(char *buf, size_t len, const char *fmt, va_list args);
 129
 130 /**
 131  * @see irn_printf.
 132  */
 133 void ir_obst_vprintf(struct obstack *obst, const char *fmt, va_list args);
 134
 135 #endif