Adjusted symbols for printf and updated to latest version.
[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 2 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  *
21  * $Id: estream-printf.h 56 2007-05-15 18:38:43Z wk $
22  */
23
24 #ifndef ESTREAM_PRINTF_H
25 #define ESTREAM_PRINTF_H
26
27 #include <stdarg.h>
28 #include <stdio.h>
29
30 /* To use this file with libraries the following macro is useful:
31
32      #define _ESTREAM_EXT_SYM_PREFIX _foo_
33    
34        This prefixes all external symbols with "_foo_".
35
36    For the implementation of the code (estream-printf.c) the following
37    macros may be used to tune the implementation for certain systems:
38
39      #define _ESTREAM_PRINTF_MALLOC foo_malloc
40      #define _ESTREAM_PRINTF_FREE   foo_free
41
42        Make estream_asprintf and estream_vasprintf use foo_malloc and
43        foo_free instead of the standard malloc and free functions to
44        allocate the memory returned to the caller.
45
46      #define  _ESTREAM_PRINTF_EXTRA_INCLUDE "foo.h"
47
48        This includes the file "foo.h" which may provide prototypes for
49        the custom memory allocation functions.
50  */
51
52
53 #ifdef _ESTREAM_EXT_SYM_PREFIX
54 #ifndef _ESTREAM_PREFIX
55 #define _ESTREAM_PREFIX1(x,y)  x ## y
56 #define _ESTREAM_PREFIX2(x,y) _ESTREAM_PREFIX1(x,y)
57 #define _ESTREAM_PREFIX(x)    _ESTREAM_PREFIX2(_ESTREAM_EXT_SYM_PREFIX,x)
58 #endif /*_ESTREAM_PREFIX*/
59 #define estream_printf_out_t  _ESTREAM_PREFIX(estream_printf_out_t)
60 #define estream_format        _ESTREAM_PREFIX(estream_format)
61 #define estream_printf        _ESTREAM_PREFIX(estream_printf)
62 #define estream_fprintf       _ESTREAM_PREFIX(estream_fprintf)
63 #define estream_vfprintf      _ESTREAM_PREFIX(estream_vfprintf)
64 #define estream_snprintf      _ESTREAM_PREFIX(estream_snprintf)
65 #define estream_vsnprintf     _ESTREAM_PREFIX(estream_vsnprintf)
66 #define estream_asprintf      _ESTREAM_PREFIX(estream_asprintf)
67 #define estream_vasprintf     _ESTREAM_PREFIX(estream_vasprintf)
68 #endif /*_ESTREAM_EXT_SYM_PREFIX*/
69
70 #ifndef _ESTREAM_GCC_A_PRINTF
71 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
72 # define _ESTREAM_GCC_A_PRINTF( f, a )  __attribute__ ((format (printf,f,a)))
73 #else
74 # define _ESTREAM_GCC_A_PRINTF( f, a )
75 #endif
76 #endif /*_ESTREAM_GCC_A_PRINTF*/
77
78
79 #ifdef __cplusplus
80 extern "C"
81 {
82 #if 0
83 }
84 #endif
85 #endif
86
87
88 typedef int (*estream_printf_out_t)
89      (void *outfncarg,  const char *buf, size_t buflen);
90
91 int estream_format (estream_printf_out_t outfnc, void *outfncarg,
92                     const char *format, va_list vaargs) 
93      _ESTREAM_GCC_A_PRINTF(3,0);
94 int estream_printf (const char *format, ...) 
95      _ESTREAM_GCC_A_PRINTF(1,2);
96 int estream_fprintf (FILE *fp, const char *format, ... )
97      _ESTREAM_GCC_A_PRINTF(2,3);
98 int estream_vfprintf (FILE *fp, const char *format, va_list arg_ptr)
99      _ESTREAM_GCC_A_PRINTF(2,0);
100 int estream_snprintf (char *buf, size_t bufsize, const char *format, ...)
101      _ESTREAM_GCC_A_PRINTF(3,4);
102 int estream_vsnprintf (char *buf,size_t bufsize, 
103                        const char *format, va_list arg_ptr) 
104      _ESTREAM_GCC_A_PRINTF(3,0);
105 int estream_asprintf (char **bufp, const char *format, ...)
106      _ESTREAM_GCC_A_PRINTF(2,3);
107 int estream_vasprintf (char **bufp, const char *format, va_list arg_ptr)
108      _ESTREAM_GCC_A_PRINTF(2,0);
109
110
111 #ifdef __cplusplus
112 }
113 #endif
114 #endif /*ESTREAM_PRINTF_H*/