More chnages to use estream. Add a way to replace the standard
[gnupg.git] / common / estream.h
1 /* estream.h - Extended stream I/O Library
2  * Copyright (C) 2004, 2005, 2006, 2007, 2010 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_H
55 #define ESTREAM_H
56
57 #include <sys/types.h>
58 #include <stdarg.h>
59 #include <stdio.h>
60
61 /* To use this file with libraries the following macro is useful:
62
63      #define _ESTREAM_EXT_SYM_PREFIX _foo_
64
65        This prefixes all external symbols with "_foo_".
66
67  */
68
69
70 #ifdef _ESTREAM_EXT_SYM_PREFIX
71 #ifndef _ESTREAM_PREFIX
72 #define _ESTREAM_PREFIX1(x,y)  x ## y
73 #define _ESTREAM_PREFIX2(x,y) _ESTREAM_PREFIX1(x,y)
74 #define _ESTREAM_PREFIX(x)    _ESTREAM_PREFIX2(_ESTREAM_EXT_SYM_PREFIX,x)
75 #endif /*_ESTREAM_PREFIX*/
76 #define es_fopen              _ESTREAM_PREFIX(es_fopen)
77 #define es_mopen              _ESTREAM_PREFIX(es_mopen)
78 #define es_fopenmem           _ESTREAM_PREFIX(es_fopenmem)
79 #define es_fdopen             _ESTREAM_PREFIX(es_fdopen)
80 #define es_fdopen_nc          _ESTREAM_PREFIX(es_fdopen_nc)
81 #define es_fpopen             _ESTREAM_PREFIX(es_fpopen)
82 #define es_fpopen_nc          _ESTREAM_PREFIX(es_fpopen_nc)
83 #define _es_set_std_fd        _ESTREAM_PREFIX(_es_set_std_fd)
84 #define _es_get_std_stream    _ESTREAM_PREFIX(_es_get_std_stream)
85 #define es_freopen            _ESTREAM_PREFIX(es_freopen)
86 #define es_fopencookie        _ESTREAM_PREFIX(es_fopencookie)
87 #define es_fclose             _ESTREAM_PREFIX(es_fclose)
88 #define es_fileno             _ESTREAM_PREFIX(es_fileno)
89 #define es_fileno_unlocked    _ESTREAM_PREFIX(es_fileno_unlocked)
90 #define es_flockfile          _ESTREAM_PREFIX(es_flockfile)
91 #define es_ftrylockfile       _ESTREAM_PREFIX(es_ftrylockfile)
92 #define es_funlockfile        _ESTREAM_PREFIX(es_funlockfile)
93 #define es_feof               _ESTREAM_PREFIX(es_feof)
94 #define es_feof_unlocked      _ESTREAM_PREFIX(es_feof_unlocked)
95 #define es_ferror             _ESTREAM_PREFIX(es_ferror)
96 #define es_ferror_unlocked    _ESTREAM_PREFIX(es_ferror_unlocked)
97 #define es_clearerr           _ESTREAM_PREFIX(es_clearerr)
98 #define es_clearerr_unlocked  _ESTREAM_PREFIX(es_clearerr_unlocked)
99 #define es_fflush             _ESTREAM_PREFIX(es_fflush)
100 #define es_fseek              _ESTREAM_PREFIX(es_fseek)
101 #define es_fseeko             _ESTREAM_PREFIX(es_fseeko)
102 #define es_ftell              _ESTREAM_PREFIX(es_ftell)
103 #define es_ftello             _ESTREAM_PREFIX(es_ftello)
104 #define es_rewind             _ESTREAM_PREFIX(es_rewind)
105 #define es_fgetc              _ESTREAM_PREFIX(es_fgetc)
106 #define es_fputc              _ESTREAM_PREFIX(es_fputc)
107 #define _es_getc_underflow    _ESTREAM_PREFIX(_es_getc_underflow)
108 #define _es_putc_overflow     _ESTREAM_PREFIX(_es_putc_overflow)
109 #define es_ungetc             _ESTREAM_PREFIX(es_ungetc)
110 #define es_read               _ESTREAM_PREFIX(es_read)
111 #define es_write              _ESTREAM_PREFIX(es_write)
112 #define es_write_sanitized    _ESTREAM_PREFIX(es_write_sanitized)
113 #define es_write_hexstring    _ESTREAM_PREFIX(es_write_hexstring)
114 #define es_fread              _ESTREAM_PREFIX(es_fread)
115 #define es_fwrite             _ESTREAM_PREFIX(es_fwrite)
116 #define es_fgets              _ESTREAM_PREFIX(es_fgets)
117 #define es_fputs              _ESTREAM_PREFIX(es_fputs)
118 #define es_fputs_unlocked     _ESTREAM_PREFIX(es_fputs_unlocked)
119 #define es_getline            _ESTREAM_PREFIX(es_getline)
120 #define es_read_line          _ESTREAM_PREFIX(es_read_line)
121 #define es_free               _ESTREAM_PREFIX(es_free)
122 #define es_fprintf            _ESTREAM_PREFIX(es_fprintf)
123 #define es_fprintf_unlocked   _ESTREAM_PREFIX(es_fprintf_unlocked)
124 #define es_vfprintf           _ESTREAM_PREFIX(es_vfprint)
125 #define es_vfprintf_unlocked  _ESTREAM_PREFIX(es_vfprint_unlocked)
126 #define es_setvbuf            _ESTREAM_PREFIX(es_setvbuf)
127 #define es_setbuf             _ESTREAM_PREFIX(es_setbuf)
128 #define es_tmpfile            _ESTREAM_PREFIX(es_tmpfile)
129 #define es_opaque_set         _ESTREAM_PREFIX(es_opaque_set)
130 #define es_opaque_get         _ESTREAM_PREFIX(es_opaque_get)
131 #define es_write_sanitized_utf8_buffer  \
132               _ESTREAM_PREFIX(es_write_sanitized_utf8_buffer)
133 #endif /*_ESTREAM_EXT_SYM_PREFIX*/
134
135
136 #ifdef __cplusplus
137 extern "C"
138 {
139 #if 0
140 }
141 #endif
142 #endif
143
144
145 /* Forward declaration for the (opaque) internal type.  */
146 struct estream_internal;
147
148 /* The definition of this struct is entirely private.  You must not
149    use it for anything.  It is only here so some functions can be
150    implemented as macros.  */
151 struct es__stream
152 {
153   /* The layout of this struct must never change.  It may be grown,
154      but only if all functions which access the new members are
155      versioned.  */
156
157   /* A pointer to the stream buffer.  */
158   unsigned char *buffer;
159
160   /* The size of the buffer in bytes.  */
161   size_t buffer_size;
162
163   /* The length of the usable data in the buffer, only valid when in
164      read mode (see flags).  */
165   size_t data_len;
166
167   /* The current position of the offset pointer, valid in read and
168      write mode.  */
169   size_t data_offset;
170
171   size_t data_flushed;
172   unsigned char *unread_buffer;
173   size_t unread_buffer_size;
174
175   /* The number of unread bytes.  */
176   size_t unread_data_len;
177
178   /* Various flags.  */
179   struct {
180     unsigned int writing: 1;
181     unsigned int reserved: 7;
182   } flags;
183
184   /* A pointer to our internal data for this stream.  */
185   struct estream_internal *intern;
186 };
187
188 /* The opaque type for an estream.  */
189 typedef struct es__stream *estream_t;
190
191 \f
192 typedef ssize_t (*es_cookie_read_function_t) (void *cookie,
193                                               void *buffer, size_t size);
194 typedef ssize_t (*es_cookie_write_function_t) (void *cookie,
195                                                const void *buffer,
196                                                size_t size);
197 typedef int (*es_cookie_seek_function_t) (void *cookie,
198                                           off_t *pos, int whence);
199 typedef int (*es_cookie_close_function_t) (void *cookie);
200
201 typedef struct es_cookie_io_functions
202 {
203   es_cookie_read_function_t func_read;
204   es_cookie_write_function_t func_write;
205   es_cookie_seek_function_t func_seek;
206   es_cookie_close_function_t func_close;
207 } es_cookie_io_functions_t;
208
209 \f
210 #ifndef _ESTREAM_GCC_A_PRINTF
211 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
212 # define _ESTREAM_GCC_A_PRINTF( f, a )  __attribute__ ((format (printf,f,a)))
213 #else
214 # define _ESTREAM_GCC_A_PRINTF( f, a )
215 #endif
216 #endif /*_ESTREAM_GCC_A_PRINTF*/
217
218
219 #ifndef ES__RESTRICT
220 #  if defined __GNUC__ && defined __GNUC_MINOR__
221 #    if  (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 92))
222 #      define ES__RESTRICT __restrict__
223 #    endif
224 #  endif
225 #endif
226 #ifndef ES__RESTRICT
227 #  define ES__RESTRICT
228 #endif
229
230 int es_init (void);
231
232 estream_t es_fopen (const char *ES__RESTRICT path,
233                     const char *ES__RESTRICT mode);
234 estream_t es_mopen (unsigned char *ES__RESTRICT data,
235                     size_t data_n, size_t data_len,
236                     unsigned int grow,
237                     void *(*func_realloc) (void *mem, size_t size),
238                     void (*func_free) (void *mem),
239                     const char *ES__RESTRICT mode);
240 estream_t es_fopenmem (size_t memlimit, const char *ES__RESTRICT mode);
241 estream_t es_fdopen (int filedes, const char *mode);
242 estream_t es_fdopen_nc (int filedes, const char *mode);
243 estream_t es_fpopen (FILE *fp, const char *mode);
244 estream_t es_fpopen_nc (FILE *fp, const char *mode);
245 estream_t es_freopen (const char *ES__RESTRICT path,
246                       const char *ES__RESTRICT mode,
247                       estream_t ES__RESTRICT stream);
248 estream_t es_fopencookie (void *ES__RESTRICT cookie,
249                           const char *ES__RESTRICT mode,
250                           es_cookie_io_functions_t functions);
251 int es_fclose (estream_t stream);
252 int es_fileno (estream_t stream);
253 int es_fileno_unlocked (estream_t stream);
254
255 void _es_set_std_fd (int no, int fd);
256 estream_t _es_get_std_stream (int fd);
257
258 #define es_stdin  _es_get_std_stream (0)
259 #define es_stdout _es_get_std_stream (1)
260 #define es_stderr _es_get_std_stream (2)
261
262
263 void es_flockfile (estream_t stream);
264 int es_ftrylockfile (estream_t stream);
265 void es_funlockfile (estream_t stream);
266
267 int es_feof (estream_t stream);
268 int es_feof_unlocked (estream_t stream);
269 int es_ferror (estream_t stream);
270 int es_ferror_unlocked (estream_t stream);
271 void es_clearerr (estream_t stream);
272 void es_clearerr_unlocked (estream_t stream);
273
274 int es_fflush (estream_t stream);
275 int es_fseek (estream_t stream, long int offset, int whence);
276 int es_fseeko (estream_t stream, off_t offset, int whence);
277 long int es_ftell (estream_t stream);
278 off_t es_ftello (estream_t stream);
279 void es_rewind (estream_t stream);
280
281 int es_fgetc (estream_t stream);
282 int es_fputc (int c, estream_t stream);
283
284 int _es_getc_underflow (estream_t stream);
285 int _es_putc_overflow (int c, estream_t stream);
286
287 #define es_getc_unlocked(stream)                                \
288   (((!(stream)->flags.writing)                                  \
289     && ((stream)->data_offset < (stream)->data_len)             \
290     && (! (stream)->unread_data_len))                           \
291   ? ((int) (stream)->buffer[((stream)->data_offset)++])         \
292   : _es_getc_underflow ((stream)))
293
294 #define es_putc_unlocked(c, stream)                             \
295   (((stream)->flags.writing                                     \
296     && ((stream)->data_offset < (stream)->buffer_size)          \
297     && (c != '\n'))                                             \
298   ? ((int) ((stream)->buffer[((stream)->data_offset)++] = (c))) \
299   : _es_putc_overflow ((c), (stream)))
300
301 #define es_getc(stream)    es_fgetc (stream)
302 #define es_putc(c, stream) es_fputc (c, stream)
303
304 int es_ungetc (int c, estream_t stream);
305
306 int es_read (estream_t ES__RESTRICT stream,
307              void *ES__RESTRICT buffer, size_t bytes_to_read,
308              size_t *ES__RESTRICT bytes_read);
309 int es_write (estream_t ES__RESTRICT stream,
310               const void *ES__RESTRICT buffer, size_t bytes_to_write,
311               size_t *ES__RESTRICT bytes_written);
312 int es_write_sanitized (estream_t ES__RESTRICT stream,
313                         const void *ES__RESTRICT buffer, size_t length,
314                         const char *delimiters,
315                         size_t *ES__RESTRICT bytes_written);
316 int es_write_hexstring (estream_t ES__RESTRICT stream,
317                         const void *ES__RESTRICT buffer, size_t length,
318                         int reserved, size_t *ES__RESTRICT bytes_written);
319
320 size_t es_fread (void *ES__RESTRICT ptr, size_t size, size_t nitems,
321                  estream_t ES__RESTRICT stream);
322 size_t es_fwrite (const void *ES__RESTRICT ptr, size_t size, size_t memb,
323                   estream_t ES__RESTRICT stream);
324
325 char *es_fgets (char *ES__RESTRICT s, int n, estream_t ES__RESTRICT stream);
326 int es_fputs (const char *ES__RESTRICT s, estream_t ES__RESTRICT stream);
327 int es_fputs_unlocked (const char *ES__RESTRICT s,
328                        estream_t ES__RESTRICT stream);
329
330 ssize_t es_getline (char *ES__RESTRICT *ES__RESTRICT lineptr,
331                     size_t *ES__RESTRICT n,
332                     estream_t stream);
333 ssize_t es_read_line (estream_t stream,
334                       char **addr_of_buffer, size_t *length_of_buffer,
335                       size_t *max_length);
336 void es_free (void *a);
337
338 int es_fprintf (estream_t ES__RESTRICT stream,
339                 const char *ES__RESTRICT format, ...)
340      _ESTREAM_GCC_A_PRINTF(2,3);
341 int es_fprintf_unlocked (estream_t ES__RESTRICT stream,
342                          const char *ES__RESTRICT format, ...)
343      _ESTREAM_GCC_A_PRINTF(2,3);
344
345 int es_vfprintf (estream_t ES__RESTRICT stream,
346                  const char *ES__RESTRICT format, va_list ap)
347      _ESTREAM_GCC_A_PRINTF(2,0);
348 int es_vfprintf_unlocked (estream_t ES__RESTRICT stream,
349                           const char *ES__RESTRICT format, va_list ap)
350      _ESTREAM_GCC_A_PRINTF(2,0);
351
352 int es_setvbuf (estream_t ES__RESTRICT stream,
353                 char *ES__RESTRICT buf, int mode, size_t size);
354 void es_setbuf (estream_t ES__RESTRICT stream, char *ES__RESTRICT buf);
355
356 estream_t es_tmpfile (void);
357
358 void es_opaque_set (estream_t ES__RESTRICT stream, void *ES__RESTRICT opaque);
359 void *es_opaque_get (estream_t stream);
360
361
362 #ifdef GNUPG_MAJOR_VERSION
363 int es_write_sanitized_utf8_buffer (estream_t stream,
364                                     const void *buffer, size_t length,
365                                     const char *delimiters,
366                                     size_t *bytes_written);
367 #endif /*GNUPG_MAJOR_VERSION*/
368
369 #ifdef __cplusplus
370 }
371 #endif
372 #endif /*ESTREAM_H*/