0e4549680bdf698394b5a21a92dda7e04ec792de
[gnupg.git] / common / estream-printf.h
1 /* estream-printf.h - Versatile C-99 compliant printf formatting.
2  * Copyright (C) 2007 g10 Code GmbH
3  *
4  * This file is part of Libestream.
5  *
6  * Libestream is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published
8  * by the Free Software Foundation; either version 3 of the License,
9  * or (at your option) any later version.
10  *
11  * Libestream is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Libestream; if not, see <http://www.gnu.org/licenses/>.
18  *
19  * $Id: estream-printf.h 56 2007-05-15 18:38:43Z wk $
20  */
21
22 #ifndef ESTREAM_PRINTF_H
23 #define ESTREAM_PRINTF_H
24
25 #include <stdarg.h>
26 #include <stdio.h>
27
28 /* To use this file with libraries the following macro is useful:
29
30      #define _ESTREAM_EXT_SYM_PREFIX _foo_
31    
32        This prefixes all external symbols with "_foo_".
33
34    For the implementation of the code (estream-printf.c) the following
35    macros may be used to tune the implementation for certain systems:
36
37      #define _ESTREAM_PRINTF_MALLOC foo_malloc
38      #define _ESTREAM_PRINTF_FREE   foo_free
39
40        Make estream_asprintf and estream_vasprintf use foo_malloc and
41        foo_free instead of the standard malloc and free functions to
42        allocate the memory returned to the caller.
43
44      #define  _ESTREAM_PRINTF_EXTRA_INCLUDE "foo.h"
45
46        This includes the file "foo.h" which may provide prototypes for
47        the custom memory allocation functions.
48  */
49
50
51 #ifdef _ESTREAM_EXT_SYM_PREFIX
52 #ifndef _ESTREAM_PREFIX
53 #define _ESTREAM_PREFIX1(x,y)  x ## y
54 #define _ESTREAM_PREFIX2(x,y) _ESTREAM_PREFIX1(x,y)
55 #define _ESTREAM_PREFIX(x)    _ESTREAM_PREFIX2(_ESTREAM_EXT_SYM_PREFIX,x)
56 #endif /*_ESTREAM_PREFIX*/
57 #define estream_printf_out_t  _ESTREAM_PREFIX(estream_printf_out_t)
58 #define estream_format        _ESTREAM_PREFIX(estream_format)
59 #define estream_printf        _ESTREAM_PREFIX(estream_printf)
60 #define estream_fprintf       _ESTREAM_PREFIX(estream_fprintf)
61 #define estream_vfprintf      _ESTREAM_PREFIX(estream_vfprintf)
62 #define estream_snprintf      _ESTREAM_PREFIX(estream_snprintf)
63 #define estream_vsnprintf     _ESTREAM_PREFIX(estream_vsnprintf)
64 #define estream_asprintf      _ESTREAM_PREFIX(estream_asprintf)
65 #define estream_vasprintf     _ESTREAM_PREFIX(estream_vasprintf)
66 #endif /*_ESTREAM_EXT_SYM_PREFIX*/
67
68 #ifndef _ESTREAM_GCC_A_PRINTF
69 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
70 # define _ESTREAM_GCC_A_PRINTF( f, a )  __attribute__ ((format (printf,f,a)))
71 #else
72 # define _ESTREAM_GCC_A_PRINTF( f, a )
73 #endif
74 #endif /*_ESTREAM_GCC_A_PRINTF*/
75
76
77 #ifdef __cplusplus
78 extern "C"
79 {
80 #if 0
81 }
82 #endif
83 #endif
84
85
86 typedef int (*estream_printf_out_t)
87      (void *outfncarg,  const char *buf, size_t buflen);
88
89 int estream_format (estream_printf_out_t outfnc, void *outfncarg,
90                     const char *format, va_list vaargs) 
91      _ESTREAM_GCC_A_PRINTF(3,0);
92 int estream_printf (const char *format, ...) 
93      _ESTREAM_GCC_A_PRINTF(1,2);
94 int estream_fprintf (FILE *fp, const char *format, ... )
95      _ESTREAM_GCC_A_PRINTF(2,3);
96 int estream_vfprintf (FILE *fp, const char *format, va_list arg_ptr)
97      _ESTREAM_GCC_A_PRINTF(2,0);
98 int estream_snprintf (char *buf, size_t bufsize, const char *format, ...)
99      _ESTREAM_GCC_A_PRINTF(3,4);
100 int estream_vsnprintf (char *buf,size_t bufsize, 
101                        const char *format, va_list arg_ptr) 
102      _ESTREAM_GCC_A_PRINTF(3,0);
103 int estream_asprintf (char **bufp, const char *format, ...)
104      _ESTREAM_GCC_A_PRINTF(2,3);
105 int estream_vasprintf (char **bufp, const char *format, va_list arg_ptr)
106      _ESTREAM_GCC_A_PRINTF(2,0);
107
108
109 #ifdef __cplusplus
110 }
111 #endif
112 #endif /*ESTREAM_PRINTF_H*/