Change all quotes in strings and comments to the new GNU standard.
[gnupg.git] / common / estream-printf.h
1 /* estream-printf.h - Versatile mostly C-99 compliant printf formatting.
2  * Copyright (C) 2007, 2010, 2012 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, see <http://www.gnu.org/licenses/>.
18  *
19  * ALTERNATIVELY, Libestream may be distributed under the terms of the
20  * following license, in which case the provisions of this license are
21  * required INSTEAD OF the GNU General Public License. If you wish to
22  * allow use of your version of this file only under the terms of the
23  * GNU General Public License, and not to allow others to use your
24  * version of this file under the terms of the following license,
25  * indicate your decision by deleting this paragraph and the license
26  * below.
27  *
28  * Redistribution and use in source and binary forms, with or without
29  * modification, are permitted provided that the following conditions
30  * are met:
31  * 1. Redistributions of source code must retain the above copyright
32  *    notice, and the entire permission notice in its entirety,
33  *    including the disclaimer of warranties.
34  * 2. Redistributions in binary form must reproduce the above copyright
35  *    notice, this list of conditions and the following disclaimer in the
36  *    documentation and/or other materials provided with the distribution.
37  * 3. The name of the author may not be used to endorse or promote
38  *    products derived from this software without specific prior
39  *    written permission.
40  *
41  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
42  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
45  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
46  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
47  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  */
53
54 #ifndef ESTREAM_PRINTF_H
55 #define ESTREAM_PRINTF_H
56
57 #include <stdarg.h>
58 #include <stdio.h>
59
60 /* To use this file with libraries the following macro is useful:
61
62      #define _ESTREAM_EXT_SYM_PREFIX _foo_
63
64        This prefixes all external symbols with "_foo_".
65
66    For the implementation of the code (estream-printf.c) the following
67    macros may be used to tune the implementation for certain systems:
68
69      #define _ESTREAM_PRINTF_REALLOC foo_realloc
70
71        Make estream_asprintf and estream_vasprintf use foo_realloc
72        instead of the standard realloc to allocate memory returned to
73        the caller.  Note that foo_realloc needs to be C-90 compliant:
74        foo_realloc (NULL,n) is the same as a call to malloc(n) and
75        foo_realloc (a, 0) is the same as a call to free (a).
76
77      #define  _ESTREAM_PRINTF_EXTRA_INCLUDE "foo.h"
78
79        This includes the file "foo.h" which may provide prototypes for
80        the custom memory allocation functions.
81  */
82
83
84 #ifdef _ESTREAM_EXT_SYM_PREFIX
85 #ifndef _ESTREAM_PREFIX
86 #define _ESTREAM_PREFIX1(x,y)  x ## y
87 #define _ESTREAM_PREFIX2(x,y) _ESTREAM_PREFIX1(x,y)
88 #define _ESTREAM_PREFIX(x)    _ESTREAM_PREFIX2(_ESTREAM_EXT_SYM_PREFIX,x)
89 #endif /*_ESTREAM_PREFIX*/
90 #define estream_printf_out_t  _ESTREAM_PREFIX(estream_printf_out_t)
91 #define estream_format        _ESTREAM_PREFIX(estream_format)
92 #define estream_printf        _ESTREAM_PREFIX(estream_printf)
93 #define estream_fprintf       _ESTREAM_PREFIX(estream_fprintf)
94 #define estream_vfprintf      _ESTREAM_PREFIX(estream_vfprintf)
95 #define estream_snprintf      _ESTREAM_PREFIX(estream_snprintf)
96 #define estream_vsnprintf     _ESTREAM_PREFIX(estream_vsnprintf)
97 #define estream_asprintf      _ESTREAM_PREFIX(estream_asprintf)
98 #define estream_vasprintf     _ESTREAM_PREFIX(estream_vasprintf)
99 #endif /*_ESTREAM_EXT_SYM_PREFIX*/
100
101 #ifndef _ESTREAM_GCC_A_PRINTF
102 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
103 # define _ESTREAM_GCC_A_PRINTF( f, a )  __attribute__ ((format (printf,f,a)))
104 #else
105 # define _ESTREAM_GCC_A_PRINTF( f, a )
106 #endif
107 #endif /*_ESTREAM_GCC_A_PRINTF*/
108
109
110 #ifdef __cplusplus
111 extern "C"
112 {
113 #if 0
114 }
115 #endif
116 #endif
117
118
119 typedef int (*estream_printf_out_t)
120      (void *outfncarg,  const char *buf, size_t buflen);
121
122 int estream_format (estream_printf_out_t outfnc, void *outfncarg,
123                     const char *format, va_list vaargs)
124      _ESTREAM_GCC_A_PRINTF(3,0);
125 int estream_printf (const char *format, ...)
126      _ESTREAM_GCC_A_PRINTF(1,2);
127 int estream_fprintf (FILE *fp, const char *format, ... )
128      _ESTREAM_GCC_A_PRINTF(2,3);
129 int estream_vfprintf (FILE *fp, const char *format, va_list arg_ptr)
130      _ESTREAM_GCC_A_PRINTF(2,0);
131 int estream_snprintf (char *buf, size_t bufsize, const char *format, ...)
132      _ESTREAM_GCC_A_PRINTF(3,4);
133 int estream_vsnprintf (char *buf,size_t bufsize,
134                        const char *format, va_list arg_ptr)
135      _ESTREAM_GCC_A_PRINTF(3,0);
136 int estream_asprintf (char **bufp, const char *format, ...)
137      _ESTREAM_GCC_A_PRINTF(2,3);
138 int estream_vasprintf (char **bufp, const char *format, va_list arg_ptr)
139      _ESTREAM_GCC_A_PRINTF(2,0);
140
141
142 #ifdef __cplusplus
143 }
144 #endif
145 #endif /*ESTREAM_PRINTF_H*/