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