b5694370eb62ae395e583af225f7e2ab1b2ed30f
[gnupg.git] / common / estream.h
1 /* estream.h - Extended stream I/O/ Library
2  * Copyright (C) 2004, 2005, 2006, 2007 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  * Lesser 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #ifndef ESTREAM_H
23 #define ESTREAM_H
24
25 #include <sys/types.h>
26 #include <stdarg.h>
27 #include <stdio.h>
28
29 /* To use this file with libraries the following macro is useful:
30
31      #define _ESTREAM_EXT_SYM_PREFIX _foo_
32
33        This prefixes all external symbols with "_foo_".
34
35  */
36
37
38 #ifdef _ESTREAM_EXT_SYM_PREFIX
39 #ifndef _ESTREAM_PREFIX
40 #define _ESTREAM_PREFIX1(x,y)  x ## y
41 #define _ESTREAM_PREFIX2(x,y) _ESTREAM_PREFIX1(x,y)
42 #define _ESTREAM_PREFIX(x)    _ESTREAM_PREFIX2(_ESTREAM_EXT_SYM_PREFIX,x)
43 #endif /*_ESTREAM_PREFIX*/
44 #define es_fopen              _ESTREAM_PREFIX(es_fopen)
45 #define es_mopen              _ESTREAM_PREFIX(es_mopen)
46 #define es_open_memstream     _ESTREAM_PREFIX(es_open_memstream)
47 #define es_fdopen             _ESTREAM_PREFIX(es_fdopen)
48 #define es_freopen            _ESTREAM_PREFIX(es_freopen)
49 #define es_fopencookie        _ESTREAM_PREFIX(es_fopencookie)
50 #define es_fclose             _ESTREAM_PREFIX(es_fclose)
51 #define es_fileno             _ESTREAM_PREFIX(es_fileno)
52 #define es_fileno_unlocked    _ESTREAM_PREFIX(es_fileno_unlocked)
53 #define es_flockfile          _ESTREAM_PREFIX(es_flockfile)
54 #define es_ftrylockfile       _ESTREAM_PREFIX(es_ftrylockfile)
55 #define es_funlockfile        _ESTREAM_PREFIX(es_funlockfile)
56 #define es_feof               _ESTREAM_PREFIX(es_feof)
57 #define es_feof_unlocked      _ESTREAM_PREFIX(es_feof_unlocked)
58 #define es_ferror             _ESTREAM_PREFIX(es_ferror)
59 #define es_ferror_unlocked    _ESTREAM_PREFIX(es_ferror_unlocked)
60 #define es_clearerr           _ESTREAM_PREFIX(es_clearerr)
61 #define es_clearerr_unlocked  _ESTREAM_PREFIX(es_clearerr_unlocked)
62 #define es_fflush             _ESTREAM_PREFIX(es_fflush)
63 #define es_fseek              _ESTREAM_PREFIX(es_fseek)
64 #define es_fseeko             _ESTREAM_PREFIX(es_fseeko)
65 #define es_ftell              _ESTREAM_PREFIX(es_ftell)
66 #define es_ftello             _ESTREAM_PREFIX(es_ftello)
67 #define es_rewind             _ESTREAM_PREFIX(es_rewind)
68 #define es_fgetc              _ESTREAM_PREFIX(es_fgetc)
69 #define es_fputc              _ESTREAM_PREFIX(es_fputc)
70 #define _es_getc_underflow    _ESTREAM_PREFIX(_es_getc_underflow)
71 #define _es_putc_overflow     _ESTREAM_PREFIX(_es_putc_overflow)
72 #define es_ungetc             _ESTREAM_PREFIX(es_ungetc)
73 #define es_read               _ESTREAM_PREFIX(es_read)
74 #define es_write              _ESTREAM_PREFIX(es_write)
75 #define es_write_sanitized    _ESTREAM_PREFIX(es_write_sanitized)
76 #define es_write_hexstring    _ESTREAM_PREFIX(es_write_hexstring)
77 #define es_fread              _ESTREAM_PREFIX(es_fread)
78 #define es_fwrite             _ESTREAM_PREFIX(es_fwrite)
79 #define es_fgets              _ESTREAM_PREFIX(es_fgets)
80 #define es_fputs              _ESTREAM_PREFIX(es_fputs)
81 #define es_getline            _ESTREAM_PREFIX(es_getline)
82 #define es_read_line          _ESTREAM_PREFIX(es_read_line)
83 #define es_free               _ESTREAM_PREFIX(es_free)
84 #define es_fprf               _ESTREAM_PREFIX(es_fprf)
85 #define es_vfprf              _ESTREAM_PREFIX(es_vfprf)
86 #define es_setvbuf            _ESTREAM_PREFIX(es_setvbuf)
87 #define es_setbuf             _ESTREAM_PREFIX(es_setbuf)
88 #define es_tmpfile            _ESTREAM_PREFIX(es_tmpfile)
89 #define es_opaque_set         _ESTREAM_PREFIX(es_opaque_set)
90 #define es_opaque_get         _ESTREAM_PREFIX(es_opaque_get)
91 #define es_write_sanitized_utf8_buffer  \
92               _ESTREAM_PREFIX(es_write_sanitized_utf8_buffer)
93 #endif /*_ESTREAM_EXT_SYM_PREFIX*/
94
95
96 #ifdef __cplusplus
97 extern "C"
98 {
99 #if 0
100 }
101 #endif
102 #endif
103
104
105 /* Forward declaration for the (opaque) internal type.  */
106 struct estream_internal;
107
108 /* The definition of this struct is entirely private.  You must not
109    use it for anything.  It is only here so some functions can be
110    implemented as macros.  */
111 struct es__stream
112 {
113   /* The layout of this struct must never change.  It may be grown,
114      but only if all functions which access the new members are
115      versioned.  */
116
117   /* A pointer to the stream buffer.  */
118   unsigned char *buffer;
119
120   /* The size of the buffer in bytes.  */
121   size_t buffer_size;
122
123   /* The length of the usable data in the buffer, only valid when in
124      read mode (see flags).  */
125   size_t data_len;
126
127   /* The current position of the offset pointer, valid in read and
128      write mode.  */
129   size_t data_offset;
130
131   size_t data_flushed;
132   unsigned char *unread_buffer;
133   size_t unread_buffer_size;
134
135   /* The number of unread bytes.  */
136   size_t unread_data_len;
137
138   /* Various flags.  */
139 #define ES__FLAG_WRITING        (1 << 0)
140   unsigned int flags;
141
142   /* A pointer to our internal data for this stream.  */
143   struct estream_internal *intern;
144 };
145
146 /* The opaque type for an estream.  */
147 typedef struct es__stream *estream_t;
148
149 \f
150 typedef ssize_t (*es_cookie_read_function_t) (void *cookie,
151                                               void *buffer, size_t size);
152 typedef ssize_t (*es_cookie_write_function_t) (void *cookie,
153                                                const void *buffer,
154                                                size_t size);
155 typedef int (*es_cookie_seek_function_t) (void *cookie,
156                                           off_t *pos, int whence);
157 typedef int (*es_cookie_close_function_t) (void *cookie);
158
159 typedef struct es_cookie_io_functions
160 {
161   es_cookie_read_function_t func_read;
162   es_cookie_write_function_t func_write;
163   es_cookie_seek_function_t func_seek;
164   es_cookie_close_function_t func_close;
165 } es_cookie_io_functions_t;
166
167 \f
168 #ifndef _ESTREAM_GCC_A_PRINTF
169 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
170 # define _ESTREAM_GCC_A_PRINTF( f, a )  __attribute__ ((format (printf,f,a)))
171 #else
172 # define _ESTREAM_GCC_A_PRINTF( f, a )
173 #endif
174 #endif /*_ESTREAM_GCC_A_PRINTF*/
175
176
177 #ifndef ES__RESTRICT
178 #  if defined __GNUC__ && defined __GNUC_MINOR__
179 #    if  (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 92))
180 #      define ES__RESTRICT __restrict__
181 #    endif
182 #  endif
183 #endif
184 #ifndef ES__RESTRICT
185 #  define ES__RESTRICT
186 #endif
187
188 int es_init (void);
189
190 estream_t es_fopen (const char *ES__RESTRICT path,
191                     const char *ES__RESTRICT mode);
192 estream_t es_mopen (unsigned char *ES__RESTRICT data,
193                     size_t data_n, size_t data_len,
194                     unsigned int grow,
195                     void *(*func_realloc) (void *mem, size_t size),
196                     void (*func_free) (void *mem),
197                     const char *ES__RESTRICT mode);
198 estream_t es_open_memstream (char **ptr, size_t *size);
199 estream_t es_fdopen (int filedes, const char *mode);
200 estream_t es_freopen (const char *ES__RESTRICT path,
201                       const char *ES__RESTRICT mode,
202                       estream_t ES__RESTRICT stream);
203 estream_t es_fopencookie (void *ES__RESTRICT cookie,
204                           const char *ES__RESTRICT mode,
205                           es_cookie_io_functions_t functions);
206 int es_fclose (estream_t stream);
207 int es_fileno (estream_t stream);
208 int es_fileno_unlocked (estream_t stream);
209
210 void es_flockfile (estream_t stream);
211 int es_ftrylockfile (estream_t stream);
212 void es_funlockfile (estream_t stream);
213
214 int es_feof (estream_t stream);
215 int es_feof_unlocked (estream_t stream);
216 int es_ferror (estream_t stream);
217 int es_ferror_unlocked (estream_t stream);
218 void es_clearerr (estream_t stream);
219 void es_clearerr_unlocked (estream_t stream);
220
221 int es_fflush (estream_t stream);
222 int es_fseek (estream_t stream, long int offset, int whence);
223 int es_fseeko (estream_t stream, off_t offset, int whence);
224 long int es_ftell (estream_t stream);
225 off_t es_ftello (estream_t stream);
226 void es_rewind (estream_t stream);
227
228 int es_fgetc (estream_t stream);
229 int es_fputc (int c, estream_t stream);
230
231 int _es_getc_underflow (estream_t stream);
232 int _es_putc_overflow (int c, estream_t stream);
233
234 #define es_getc_unlocked(stream)                                \
235   (((! ((stream)->flags & 1))                                   \
236     && ((stream)->data_offset < (stream)->data_len)             \
237     && (! (stream)->unread_data_len))                           \
238   ? ((int) (stream)->buffer[((stream)->data_offset)++])         \
239   : _es_getc_underflow ((stream)))
240
241 #define es_putc_unlocked(c, stream)                             \
242   ((((stream)->flags & 1)                                       \
243     && ((stream)->data_offset < (stream)->buffer_size)          \
244     && (c != '\n'))                                             \
245   ? ((int) ((stream)->buffer[((stream)->data_offset)++] = (c))) \
246   : _es_putc_overflow ((c), (stream)))
247
248 #define es_getc(stream)    es_fgetc (stream)
249 #define es_putc(c, stream) es_fputc (c, stream)
250
251 int es_ungetc (int c, estream_t stream);
252
253 int es_read (estream_t ES__RESTRICT stream,
254              void *ES__RESTRICT buffer, size_t bytes_to_read,
255              size_t *ES__RESTRICT bytes_read);
256 int es_write (estream_t ES__RESTRICT stream,
257               const void *ES__RESTRICT buffer, size_t bytes_to_write,
258               size_t *ES__RESTRICT bytes_written);
259 int es_write_sanitized (estream_t ES__RESTRICT stream,
260                         const void *ES__RESTRICT buffer, size_t length,
261                         const char *delimiters,
262                         size_t *ES__RESTRICT bytes_written);
263 int es_write_hexstring (estream_t ES__RESTRICT stream,
264                         const void *ES__RESTRICT buffer, size_t length,
265                         int reserved, size_t *ES__RESTRICT bytes_written);
266
267 size_t es_fread (void *ES__RESTRICT ptr, size_t size, size_t nitems,
268                  estream_t ES__RESTRICT stream);
269 size_t es_fwrite (const void *ES__RESTRICT ptr, size_t size, size_t memb,
270                   estream_t ES__RESTRICT stream);
271
272 char *es_fgets (char *ES__RESTRICT s, int n, estream_t ES__RESTRICT stream);
273 int es_fputs (const char *ES__RESTRICT s, estream_t ES__RESTRICT stream);
274
275 ssize_t es_getline (char *ES__RESTRICT *ES__RESTRICT lineptr,
276                     size_t *ES__RESTRICT n,
277                     estream_t stream);
278 ssize_t es_read_line (estream_t stream,
279                       char **addr_of_buffer, size_t *length_of_buffer,
280                       size_t *max_length);
281 void es_free (void *a);
282
283 int es_fprintf (estream_t ES__RESTRICT stream,
284                 const char *ES__RESTRICT format, ...)
285      _ESTREAM_GCC_A_PRINTF(2,3);
286 int es_vfprintf (estream_t ES__RESTRICT stream,
287                  const char *ES__RESTRICT format, va_list ap)
288      _ESTREAM_GCC_A_PRINTF(2,0);
289 int es_setvbuf (estream_t ES__RESTRICT stream,
290                 char *ES__RESTRICT buf, int mode, size_t size);
291 void es_setbuf (estream_t ES__RESTRICT stream, char *ES__RESTRICT buf);
292
293 estream_t es_tmpfile (void);
294
295 void es_opaque_set (estream_t ES__RESTRICT stream, void *ES__RESTRICT opaque);
296 void *es_opaque_get (estream_t stream);
297
298
299 #ifdef GNUPG_MAJOR_VERSION
300 int es_write_sanitized_utf8_buffer (estream_t stream,
301                                     const void *buffer, size_t length,
302                                     const char *delimiters,
303                                     size_t *bytes_written);
304 #endif /*GNUPG_MAJOR_VERSION*/
305
306
307 #ifdef __cplusplus
308 }
309 #endif
310 #endif /*ESTREAM_H*/