nsz Git - libfirm/blob - ir/libcore/lc_printf.h

   1 /*
   2   libcore: library for basic data structures and algorithms.
   3   Copyright (C) 2005  IPD Goos, Universit"at Karlsruhe, Germany
   4
   5   This library is free software; you can redistribute it and/or
   6   modify it under the terms of the GNU Lesser General Public
   7   License as published by the Free Software Foundation; either
   8   version 2.1 of the License, or (at your option) any later version.
   9
  10   This library is distributed in the hope that it will be useful,
  11   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13   Lesser General Public License for more details.
  14
  15   You should have received a copy of the GNU Lesser General Public
  16   License along with this library; if not, write to the Free Software
  17   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18 */
  19
  20
  21
  22 /**
  23  * Flexible printf().
  24  * @author Sebastian Hack
  25  * @date 3.1.2005
  26  */
  27
  28 #ifndef _LIBCORE_LC_PRINTF_H
  29 #define _LIBCORE_LC_PRINTF_H
  30
  31 #include <stddef.h>
  32 #include <stdarg.h>
  33 #include <stdio.h>
  34 #include <stdint.h>
  35
  36 #include <obstack.h>
  37
  38 #include "lc_config.h"
  39 #include "lc_appendable.h"
  40
  41 typedef struct lc_arg_occ_t {
  42         int width;                 /**< The width, or 0 if not given. */
  43         int precision;             /**< The precision, or 0 if not given */
  44
  45         const char *modifier;      /**< A string of of modifiers preceding the
  46                                         conversion specifier. Attention: This string
  47                                         is not zero terminated. Use
  48                                         @c modifier_length to get the number of
  49                                         valid chars in it. */
  50         size_t modifier_length;    /**< The number of valid chars in @c modifier. */
  51         char conversion;           /**< The conversion specifier. */
  52         int lc_arg_type;           /**< The type of the argument as determined by
  53                                         the @c get_lc_arg_type member function of
  54                                         the handler. */
  55
  56         unsigned flag_hash : 1;    /**< @c # flag was seen. */
  57         unsigned flag_zero : 1;    /**< @c 0 flag was seen. */
  58         unsigned flag_minus : 1;   /**< @c - flag was seen. */
  59         unsigned flag_plus : 1;    /**< @c + flag was seen. */
  60         unsigned flag_space : 1;   /**< A space flag was seen. */
  61 } lc_arg_occ_t;
  62
  63 /**
  64  * A value from the ... arguments of the printf function.
  65  * Look at the file 'xprintf_lc_arg_types.def'. The second argument of the
  66  * @c ARG_TYPE macro is the name of the union member preceded by $c v_
  67  */
  68 typedef union {
  69 #define LC_ARG_TYPE(type,name,va_type) type v_ ## name;
  70 #include "lc_printf_arg_types.def"
  71 #undef LC_ARG_TYPE
  72 } lc_arg_value_t;
  73
  74 enum {
  75 #define LC_ARG_TYPE(type,name,va_type) lc_arg_type_ ## name,
  76 #include "lc_printf_arg_types.def"
  77 #undef LC_ARG_TYPE
  78   lc_arg_type_last
  79 };
  80
  81 typedef struct lc_arg_handler {
  82         int (*get_lc_arg_type)(const lc_arg_occ_t *occ);
  83         int (*emit)(lc_appendable_t *app, const lc_arg_occ_t *occ, const lc_arg_value_t *arg);
  84 } lc_arg_handler_t;
  85
  86 typedef struct lc_arg_env_t lc_arg_env_t;
  87
  88 lc_arg_env_t *lc_arg_new_env(void);
  89 void lc_arg_free_env(lc_arg_env_t *env);
  90 lc_arg_env_t *lc_arg_get_default_env(void);
  91
  92 int lc_arg_register(lc_arg_env_t *env, const char *name, char letter, const lc_arg_handler_t *handler);
  93 void lc_arg_unregister(lc_arg_env_t *env, const char *name);
  94
  95 lc_arg_env_t *lc_arg_add_std(lc_arg_env_t *env);
  96
  97 int lc_arg_append(lc_appendable_t *app, const lc_arg_occ_t *occ, const char *str, size_t len);
  98
  99 int lc_epprintf(const lc_arg_env_t *env, lc_appendable_t *app, const char *fmt, ...);
 100 int lc_evpprintf(const lc_arg_env_t *env, lc_appendable_t *app, const char *fmt, va_list args);
 101 int lc_pprintf(lc_appendable_t *app, const char *fmt, ...);
 102 int lc_vpprintf(lc_appendable_t *app, const char *fmt, va_list args);
 103
 104 int lc_eprintf(const lc_arg_env_t *env, const char *fmt, ...);
 105 int lc_esnprintf(const lc_arg_env_t *env, char *buf, size_t len, const char *fmt, ...);
 106 int lc_efprintf(const lc_arg_env_t *env, FILE *file, const char *fmt, ...);
 107 int lc_eoprintf(const lc_arg_env_t *env, struct obstack *obst, const char *fmt, ...);
 108
 109 int lc_evprintf(const lc_arg_env_t *env, const char *fmt, va_list args);
 110 int lc_evsnprintf(const lc_arg_env_t *env, char *buf, size_t len, const char *fmt, va_list args);
 111 int lc_evfprintf(const lc_arg_env_t *env, FILE *f, const char *fmt, va_list args);
 112 int lc_evoprintf(const lc_arg_env_t *env, struct obstack *obst, const char *fmt, va_list args);
 113
 114 int lc_printf(const char *fmt, ...) LC_PRINTF(1);
 115 int lc_snprintf(char *buf, size_t len, const char *fmt, ...) LC_PRINTF(3);
 116 int lc_fprintf(FILE *f, const char *fmt, ...) LC_PRINTF(2);
 117 int lc_oprintf(struct obstack *obst, const char *fmt, ...) LC_PRINTF(2);
 118
 119 int lc_vprintf(const char *fmt, va_list args);
 120 int lc_vsnprintf(char *buf, size_t len, const char *fmt, va_list args);
 121 int lc_vfprintf(FILE *f, const char *fmt, va_list args);
 122 int lc_voprintf(struct obstack *obst, const char *fmt, va_list args);
 123
 124 #endif