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

   1 /*
   2  * Copyright (C) 1995-2011 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    A little printf understanding some firm types.
  23  * @author   Sebastian Hack
  24  * @date     29.11.2004
  25  * @version  $Id$
  26  */
  27 #ifndef FIRM_IR_IRPRINTF_H
  28 #define FIRM_IR_IRPRINTF_H
  29
  30 #include <stddef.h>
  31 #include <stdarg.h>
  32 #include <stdio.h>
  33 #include "begin.h"
  34
  35 /* forward definition */
  36 struct obstack;
  37
  38 /**
  39  * A string formatting routine for ir objects.
  40  *
  41  * @param fmt  The format string.
  42  *
  43  * This function rudimentary implements a kind of printf(3) for ir
  44  * nodes and adds the following additional conversion specifiers.
  45  * - @%t A type name.
  46  * - @%e An entity name.
  47  * - @%E An entity ld name.
  48  * - @%T A tarval.
  49  * - @%n A full description of a node.
  50  * - @%O The opcode name of an ir node.
  51  * - @%N The node number of an ir node.
  52  * - @%m The mode name of an ir mode.
  53  * - @%B The block node number of the nodes block.
  54  * - @%P A compound graph path.
  55  * - @%I An ident.
  56  * - @%D Print as many white spaces as given in the parameter.
  57  * - @%G A debug info (if available) from the given ir node.
  58  * - @%B A bitset.
  59  * - @%F A Firm object (automatically detected).
  60  *
  61  * Note that some of the standard format capabilities are not available
  62  * due to this new conversion specifiers, use lc_printf() if needed.
  63  */
  64 FIRM_API void ir_printf(const char *fmt, ...);
  65
  66 /**
  67  * @see ir_printf.
  68  */
  69 FIRM_API void ir_fprintf(FILE *f, const char *fmt, ...);
  70
  71 /**
  72  * @see ir_printf.
  73  */
  74 FIRM_API void ir_snprintf(char *buf, size_t n, const char *fmt, ...);
  75
  76 /**
  77  * @see ir_printf.
  78  */
  79 FIRM_API void ir_vprintf(const char *fmt, va_list args);
  80
  81 /**
  82  * @see ir_printf.
  83  */
  84 FIRM_API void ir_vfprintf(FILE *f, const char *fmt, va_list args);
  85
  86 /**
  87  * @see ir_printf.
  88  */
  89 FIRM_API void ir_vsnprintf(char *buf, size_t len, const char *fmt,
  90                            va_list args);
  91
  92 /**
  93  * @see ir_printf.
  94  */
  95 FIRM_API void ir_obst_vprintf(struct obstack *obst, const char *fmt,
  96                               va_list args);
  97
  98 #include "end.h"
  99
 100 #endif