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