.
[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_sysopen            _ESTREAM_PREFIX(es_sysopen)
82 #define es_sysopen_nc         _ESTREAM_PREFIX(es_sysopen_nc)
83 #define es_fpopen             _ESTREAM_PREFIX(es_fpopen)
84 #define es_fpopen_nc          _ESTREAM_PREFIX(es_fpopen_nc)
85 #define _es_set_std_fd        _ESTREAM_PREFIX(_es_set_std_fd)
86 #define _es_get_std_stream    _ESTREAM_PREFIX(_es_get_std_stream)
87 #define es_freopen            _ESTREAM_PREFIX(es_freopen)
88 #define es_fopencookie        _ESTREAM_PREFIX(es_fopencookie)
89 #define es_fclose             _ESTREAM_PREFIX(es_fclose)
90 #define es_onclose            _ESTREAM_PREFIX(es_onclose)
91 #define es_fileno             _ESTREAM_PREFIX(es_fileno)
92 #define es_fileno_unlocked    _ESTREAM_PREFIX(es_fileno_unlocked)
93 #define es_flockfile          _ESTREAM_PREFIX(es_flockfile)
94 #define es_ftrylockfile       _ESTREAM_PREFIX(es_ftrylockfile)
95 #define es_funlockfile        _ESTREAM_PREFIX(es_funlockfile)
96 #define es_feof               _ESTREAM_PREFIX(es_feof)
97 #define es_feof_unlocked      _ESTREAM_PREFIX(es_feof_unlocked)
98 #define es_ferror             _ESTREAM_PREFIX(es_ferror)
99 #define es_ferror_unlocked    _ESTREAM_PREFIX(es_ferror_unlocked)
100 #define es_clearerr           _ESTREAM_PREFIX(es_clearerr)
101 #define es_clearerr_unlocked  _ESTREAM_PREFIX(es_clearerr_unlocked)
102 #define es_fflush             _ESTREAM_PREFIX(es_fflush)
103 #define es_fseek              _ESTREAM_PREFIX(es_fseek)
104 #define es_fseeko             _ESTREAM_PREFIX(es_fseeko)
105 #define es_ftell              _ESTREAM_PREFIX(es_ftell)
106 #define es_ftello             _ESTREAM_PREFIX(es_ftello)
107 #define es_rewind             _ESTREAM_PREFIX(es_rewind)
108 #define es_fgetc              _ESTREAM_PREFIX(es_fgetc)
109 #define es_fputc              _ESTREAM_PREFIX(es_fputc)
110 #define _es_getc_underflow    _ESTREAM_PREFIX(_es_getc_underflow)
111 #define _es_putc_overflow     _ESTREAM_PREFIX(_es_putc_overflow)
112 #define es_ungetc             _ESTREAM_PREFIX(es_ungetc)
113 #define es_read               _ESTREAM_PREFIX(es_read)
114 #define es_write              _ESTREAM_PREFIX(es_write)
115 #define es_write_sanitized    _ESTREAM_PREFIX(es_write_sanitized)
116 #define es_write_hexstring    _ESTREAM_PREFIX(es_write_hexstring)
117 #define es_fread              _ESTREAM_PREFIX(es_fread)
118 #define es_fwrite             _ESTREAM_PREFIX(es_fwrite)
119 #define es_fgets              _ESTREAM_PREFIX(es_fgets)
120 #define es_fputs              _ESTREAM_PREFIX(es_fputs)
121 #define es_fputs_unlocked     _ESTREAM_PREFIX(es_fputs_unlocked)
122 #define es_getline            _ESTREAM_PREFIX(es_getline)
123 #define es_read_line          _ESTREAM_PREFIX(es_read_line)
124 #define es_free               _ESTREAM_PREFIX(es_free)
125 #define es_fprintf            _ESTREAM_PREFIX(es_fprintf)
126 #define es_fprintf_unlocked   _ESTREAM_PREFIX(es_fprintf_unlocked)
127 #define es_printf             _ESTREAM_PREFIX(es_printf)
128 #define es_printf_unlocked    _ESTREAM_PREFIX(es_printf_unlocked)
129 #define es_vfprintf           _ESTREAM_PREFIX(es_vfprint)
130 #define es_vfprintf_unlocked  _ESTREAM_PREFIX(es_vfprint_unlocked)
131 #define es_setvbuf            _ESTREAM_PREFIX(es_setvbuf)
132 #define es_setbuf             _ESTREAM_PREFIX(es_setbuf)
133 #define es_set_binary         _ESTREAM_PREFIX(es_set_binary)
134 #define es_tmpfile            _ESTREAM_PREFIX(es_tmpfile)
135 #define es_opaque_set         _ESTREAM_PREFIX(es_opaque_set)
136 #define es_opaque_get         _ESTREAM_PREFIX(es_opaque_get)
137 #define es_fname_set          _ESTREAM_PREFIX(es_fname_set)
138 #define es_fname_get          _ESTREAM_PREFIX(es_fname_get)
139 #define es_write_sanitized_utf8_buffer  \
140               _ESTREAM_PREFIX(es_write_sanitized_utf8_buffer)
141 #endif /*_ESTREAM_EXT_SYM_PREFIX*/
142
143
144 #ifdef __cplusplus
145 extern "C"
146 {
147 #if 0
148 }
149 #endif
150 #endif
151
152
153 /* Forward declaration for the (opaque) internal type.  */
154 struct estream_internal;
155
156 /* The definition of this struct is entirely private.  You must not
157    use it for anything.  It is only here so some functions can be
158    implemented as macros.  */
159 struct es__stream
160 {
161   /* The layout of this struct must never change.  It may be grown,
162      but only if all functions which access the new members are
163      versioned.  */
164
165   /* A pointer to the stream buffer.  */
166   unsigned char *buffer;
167
168   /* The size of the buffer in bytes.  */
169   size_t buffer_size;
170
171   /* The length of the usable data in the buffer, only valid when in
172      read mode (see flags).  */
173   size_t data_len;
174
175   /* The current position of the offset pointer, valid in read and
176      write mode.  */
177   size_t data_offset;
178
179   size_t data_flushed;
180   unsigned char *unread_buffer;
181   size_t unread_buffer_size;
182
183   /* The number of unread bytes.  */
184   size_t unread_data_len;
185
186   /* Various flags.  */
187   struct {
188     unsigned int writing: 1;
189     unsigned int reserved: 7;
190   } flags;
191
192   /* A pointer to our internal data for this stream.  */
193   struct estream_internal *intern;
194 };
195
196 /* The opaque type for an estream.  */
197 typedef struct es__stream *estream_t;
198
199 \f
200 typedef ssize_t (*es_cookie_read_function_t) (void *cookie,
201                                               void *buffer, size_t size);
202 typedef ssize_t (*es_cookie_write_function_t) (void *cookie,
203                                                const void *buffer,
204                                                size_t size);
205 typedef int (*es_cookie_seek_function_t) (void *cookie,
206                                           off_t *pos, int whence);
207 typedef int (*es_cookie_close_function_t) (void *cookie);
208
209 typedef struct es_cookie_io_functions
210 {
211   es_cookie_read_function_t func_read;
212   es_cookie_write_function_t func_write;
213   es_cookie_seek_function_t func_seek;
214   es_cookie_close_function_t func_close;
215 } es_cookie_io_functions_t;
216
217
218 enum es_syshd_types 
219   {
220     ES_SYSHD_NONE,  /* No system handle available.  */
221     ES_SYSHD_FD,    /* A file descriptor as returned by open().  */
222     ES_SYSHD_SOCK,  /* A socket as returned by socket().        */
223     ES_SYSHD_RVID,  /* A rendevous id (see libassuan's gpgcedev.c).  */
224     ES_SYSHD_HANDLE /* A HANDLE object (Windows).  */
225   };
226
227 typedef struct
228 {
229   enum es_syshd_types type;
230   union {
231     int fd;
232     int sock;
233     int rvid;
234     void *handle;
235   } u;
236 } es_syshd_t;
237
238
239
240 \f
241 #ifndef _ESTREAM_GCC_A_PRINTF
242 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
243 # define _ESTREAM_GCC_A_PRINTF( f, a )  __attribute__ ((format (printf,f,a)))
244 #else
245 # define _ESTREAM_GCC_A_PRINTF( f, a )
246 #endif
247 #endif /*_ESTREAM_GCC_A_PRINTF*/
248
249
250 #ifndef ES__RESTRICT
251 #  if defined __GNUC__ && defined __GNUC_MINOR__
252 #    if  (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 92))
253 #      define ES__RESTRICT __restrict__
254 #    endif
255 #  endif
256 #endif
257 #ifndef ES__RESTRICT
258 #  define ES__RESTRICT
259 #endif
260
261 int es_init (void);
262
263 estream_t es_fopen (const char *ES__RESTRICT path,
264                     const char *ES__RESTRICT mode);
265 estream_t es_mopen (unsigned char *ES__RESTRICT data,
266                     size_t data_n, size_t data_len,
267                     unsigned int grow,
268                     void *(*func_realloc) (void *mem, size_t size),
269                     void (*func_free) (void *mem),
270                     const char *ES__RESTRICT mode);
271 estream_t es_fopenmem (size_t memlimit, const char *ES__RESTRICT mode);
272 estream_t es_fdopen (int filedes, const char *mode);
273 estream_t es_fdopen_nc (int filedes, const char *mode);
274 estream_t es_sysopen (es_syshd_t *syshd, const char *mode);
275 estream_t es_sysopen_nc (es_syshd_t *syshd, const char *mode);
276 estream_t es_fpopen (FILE *fp, const char *mode);
277 estream_t es_fpopen_nc (FILE *fp, const char *mode);
278 estream_t es_freopen (const char *ES__RESTRICT path,
279                       const char *ES__RESTRICT mode,
280                       estream_t ES__RESTRICT stream);
281 estream_t es_fopencookie (void *ES__RESTRICT cookie,
282                           const char *ES__RESTRICT mode,
283                           es_cookie_io_functions_t functions);
284 int es_fclose (estream_t stream);
285 int es_onclose (estream_t stream, int mode,
286                 void (*fnc) (estream_t, void*), void *fnc_value);
287 int es_fileno (estream_t stream);
288 int es_fileno_unlocked (estream_t stream);
289 int es_syshd (estream_t stream, es_syshd_t *syshd);
290 int es_syshd_unlocked (estream_t stream, es_syshd_t *syshd);
291
292 void _es_set_std_fd (int no, int fd);
293 estream_t _es_get_std_stream (int fd);
294
295 #define es_stdin  _es_get_std_stream (0)
296 #define es_stdout _es_get_std_stream (1)
297 #define es_stderr _es_get_std_stream (2)
298
299
300 void es_flockfile (estream_t stream);
301 int es_ftrylockfile (estream_t stream);
302 void es_funlockfile (estream_t stream);
303
304 int es_feof (estream_t stream);
305 int es_feof_unlocked (estream_t stream);
306 int es_ferror (estream_t stream);
307 int es_ferror_unlocked (estream_t stream);
308 void es_clearerr (estream_t stream);
309 void es_clearerr_unlocked (estream_t stream);
310
311 int es_fflush (estream_t stream);
312 int es_fseek (estream_t stream, long int offset, int whence);
313 int es_fseeko (estream_t stream, off_t offset, int whence);
314 long int es_ftell (estream_t stream);
315 off_t es_ftello (estream_t stream);
316 void es_rewind (estream_t stream);
317
318 int es_fgetc (estream_t stream);
319 int es_fputc (int c, estream_t stream);
320
321 int _es_getc_underflow (estream_t stream);
322 int _es_putc_overflow (int c, estream_t stream);
323
324 #define es_getc_unlocked(stream)                                \
325   (((!(stream)->flags.writing)                                  \
326     && ((stream)->data_offset < (stream)->data_len)             \
327     && (! (stream)->unread_data_len))                           \
328   ? ((int) (stream)->buffer[((stream)->data_offset)++])         \
329   : _es_getc_underflow ((stream)))
330
331 #define es_putc_unlocked(c, stream)                             \
332   (((stream)->flags.writing                                     \
333     && ((stream)->data_offset < (stream)->buffer_size)          \
334     && (c != '\n'))                                             \
335   ? ((int) ((stream)->buffer[((stream)->data_offset)++] = (c))) \
336   : _es_putc_overflow ((c), (stream)))
337
338 #define es_getc(stream)    es_fgetc (stream)
339 #define es_putc(c, stream) es_fputc (c, stream)
340
341 int es_ungetc (int c, estream_t stream);
342
343 int es_read (estream_t ES__RESTRICT stream,
344              void *ES__RESTRICT buffer, size_t bytes_to_read,
345              size_t *ES__RESTRICT bytes_read);
346 int es_write (estream_t ES__RESTRICT stream,
347               const void *ES__RESTRICT buffer, size_t bytes_to_write,
348               size_t *ES__RESTRICT bytes_written);
349 int es_write_sanitized (estream_t ES__RESTRICT stream,
350                         const void *ES__RESTRICT buffer, size_t length,
351                         const char *delimiters,
352                         size_t *ES__RESTRICT bytes_written);
353 int es_write_hexstring (estream_t ES__RESTRICT stream,
354                         const void *ES__RESTRICT buffer, size_t length,
355                         int reserved, size_t *ES__RESTRICT bytes_written);
356
357 size_t es_fread (void *ES__RESTRICT ptr, size_t size, size_t nitems,
358                  estream_t ES__RESTRICT stream);
359 size_t es_fwrite (const void *ES__RESTRICT ptr, size_t size, size_t memb,
360                   estream_t ES__RESTRICT stream);
361
362 char *es_fgets (char *ES__RESTRICT s, int n, estream_t ES__RESTRICT stream);
363 int es_fputs (const char *ES__RESTRICT s, estream_t ES__RESTRICT stream);
364 int es_fputs_unlocked (const char *ES__RESTRICT s,
365                        estream_t ES__RESTRICT stream);
366
367 ssize_t es_getline (char *ES__RESTRICT *ES__RESTRICT lineptr,
368                     size_t *ES__RESTRICT n,
369                     estream_t stream);
370 ssize_t es_read_line (estream_t stream,
371                       char **addr_of_buffer, size_t *length_of_buffer,
372                       size_t *max_length);
373 void es_free (void *a);
374
375 int es_fprintf (estream_t ES__RESTRICT stream,
376                 const char *ES__RESTRICT format, ...)
377      _ESTREAM_GCC_A_PRINTF(2,3);
378 int es_fprintf_unlocked (estream_t ES__RESTRICT stream,
379                          const char *ES__RESTRICT format, ...)
380      _ESTREAM_GCC_A_PRINTF(2,3);
381
382 int es_printf (const char *ES__RESTRICT format, ...)
383      _ESTREAM_GCC_A_PRINTF(1,2);
384 int es_printf_unlocked (const char *ES__RESTRICT format, ...)
385      _ESTREAM_GCC_A_PRINTF(1,2);
386
387 int es_vfprintf (estream_t ES__RESTRICT stream,
388                  const char *ES__RESTRICT format, va_list ap)
389      _ESTREAM_GCC_A_PRINTF(2,0);
390 int es_vfprintf_unlocked (estream_t ES__RESTRICT stream,
391                           const char *ES__RESTRICT format, va_list ap)
392      _ESTREAM_GCC_A_PRINTF(2,0);
393
394 char *es_asprintf (const char *ES__RESTRICT format, ...)
395      _ESTREAM_GCC_A_PRINTF(1,2);
396 char *es_vasprintf (const char *ES__RESTRICT format, va_list ap)
397      _ESTREAM_GCC_A_PRINTF(1,0);
398
399 int es_setvbuf (estream_t ES__RESTRICT stream,
400                 char *ES__RESTRICT buf, int mode, size_t size);
401 void es_setbuf (estream_t ES__RESTRICT stream, char *ES__RESTRICT buf);
402
403 void es_set_binary (estream_t stream);
404
405
406 estream_t es_tmpfile (void);
407
408 void es_opaque_set (estream_t ES__RESTRICT stream, void *ES__RESTRICT opaque);
409 void *es_opaque_get (estream_t stream);
410
411 void es_fname_set (estream_t stream, const char *fname);
412 const char *es_fname_get (estream_t stream);
413
414
415 #ifdef GNUPG_MAJOR_VERSION
416 int es_write_sanitized_utf8_buffer (estream_t stream,
417                                     const void *buffer, size_t length,
418                                     const char *delimiters,
419                                     size_t *bytes_written);
420 #endif /*GNUPG_MAJOR_VERSION*/
421
422 #ifdef __cplusplus
423 }
424 #endif
425 #endif /*ESTREAM_H*/