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