Require libgpg-error 1.10
[gnupg.git] / common / iobuf.h
1 /* iobuf.h - I/O buffer
2  * Copyright (C) 1998, 1999, 2000, 2001, 2003,
3  *               2010 Free Software Foundation, Inc.
4  *
5  * This file is part of GNUPG.
6  *
7  * GNUPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GNUPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #ifndef GNUPG_COMMON_IOBUF_H
22 #define GNUPG_COMMON_IOBUF_H
23
24 #include "../include/types.h" /* fixme: should be moved elsewhere. */
25 #include "../common/sysutils.h"
26 #include "../common/estream.h"
27
28 #define DBG_IOBUF   iobuf_debug_mode
29
30 /* Filter control modes.  */
31 #define IOBUFCTRL_INIT      1
32 #define IOBUFCTRL_FREE      2
33 #define IOBUFCTRL_UNDERFLOW 3
34 #define IOBUFCTRL_FLUSH     4
35 #define IOBUFCTRL_DESC      5
36 #define IOBUFCTRL_CANCEL    6
37 #define IOBUFCTRL_USER      16
38
39
40 /* Command codes for iobuf_ioctl.  */
41 typedef enum
42   {
43     IOBUF_IOCTL_KEEP_OPEN        = 1, /* Uses intval.  */
44     IOBUF_IOCTL_INVALIDATE_CACHE = 2, /* Uses ptrval.  */
45     IOBUF_IOCTL_NO_CACHE         = 3, /* Uses intval.  */
46     IOBUF_IOCTL_FSYNC            = 4  /* Uses ptrval.  */
47   } iobuf_ioctl_t;
48
49
50 typedef struct iobuf_struct *iobuf_t;
51 typedef struct iobuf_struct *IOBUF;  /* Compatibility with gpg 1.4. */
52
53 /* fixme: we should hide most of this stuff */
54 struct iobuf_struct
55 {
56   int use;                      /* 1 input , 2 output, 3 temp */
57   off_t nlimit;
58   off_t nbytes;                 /* Used together with nlimit. */
59   off_t ntotal;                 /* Total bytes read (position of stream). */
60   int nofast;                   /* Used by the iobuf_get (). */
61   void *directfp;
62   struct
63   {
64     size_t size;                /* Allocated size */
65     size_t start;               /* Number of invalid bytes at the
66                                    begin of the buffer */
67     size_t len;                 /* Currently filled to this size */
68     byte *buf;
69   } d;
70
71   int filter_eof;
72   int error;
73   int (*filter) (void *opaque, int control,
74                  iobuf_t chain, byte * buf, size_t * len);
75   void *filter_ov;              /* Value for opaque */
76   int filter_ov_owner;
77   char *real_fname;
78   iobuf_t chain;                /* Next iobuf used for i/o if any
79                                    (passed to filter) */
80   int no, subno;
81   const char *desc;
82   void *opaque;                 /* Can be used to hold any information
83                                    this value is copied to all
84                                    instances */
85 };
86
87 #ifndef EXTERN_UNLESS_MAIN_MODULE
88 #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
89 #define EXTERN_UNLESS_MAIN_MODULE extern
90 #else
91 #define EXTERN_UNLESS_MAIN_MODULE
92 #endif
93 #endif
94 EXTERN_UNLESS_MAIN_MODULE int iobuf_debug_mode;
95
96 void iobuf_enable_special_filenames (int yes);
97 int  iobuf_is_pipe_filename (const char *fname);
98 iobuf_t iobuf_alloc (int use, size_t bufsize);
99 iobuf_t iobuf_temp (void);
100 iobuf_t iobuf_temp_with_content (const char *buffer, size_t length);
101 iobuf_t iobuf_open_fd_or_name (gnupg_fd_t fd, const char *fname,
102                                const char *mode);
103 iobuf_t iobuf_open (const char *fname);
104 iobuf_t iobuf_fdopen (int fd, const char *mode);
105 iobuf_t iobuf_fdopen_nc (int fd, const char *mode);
106 iobuf_t iobuf_esopen (estream_t estream, const char *mode, int keep_open);
107 iobuf_t iobuf_sockopen (int fd, const char *mode);
108 iobuf_t iobuf_create (const char *fname);
109 iobuf_t iobuf_append (const char *fname);
110 iobuf_t iobuf_openrw (const char *fname);
111 int iobuf_ioctl (iobuf_t a, iobuf_ioctl_t cmd, int intval, void *ptrval);
112 int iobuf_close (iobuf_t iobuf);
113 int iobuf_cancel (iobuf_t iobuf);
114
115 int iobuf_push_filter (iobuf_t a, int (*f) (void *opaque, int control,
116                                           iobuf_t chain, byte * buf,
117                                           size_t * len), void *ov);
118 int iobuf_push_filter2 (iobuf_t a,
119                         int (*f) (void *opaque, int control, iobuf_t chain,
120                                   byte * buf, size_t * len), void *ov,
121                         int rel_ov);
122 int iobuf_flush (iobuf_t a);
123 void iobuf_clear_eof (iobuf_t a);
124 #define iobuf_set_error(a)    do { (a)->error = 1; } while(0)
125 #define iobuf_error(a)        ((a)->error)
126
127 void iobuf_set_limit (iobuf_t a, off_t nlimit);
128
129 off_t iobuf_tell (iobuf_t a);
130 int iobuf_seek (iobuf_t a, off_t newpos);
131
132 int iobuf_readbyte (iobuf_t a);
133 int iobuf_read (iobuf_t a, void *buf, unsigned buflen);
134 void iobuf_unread (iobuf_t a, const unsigned char *buf, unsigned int buflen);
135 unsigned iobuf_read_line (iobuf_t a, byte ** addr_of_buffer,
136                           unsigned *length_of_buffer, unsigned *max_length);
137 int iobuf_peek (iobuf_t a, byte * buf, unsigned buflen);
138 int iobuf_writebyte (iobuf_t a, unsigned c);
139 int iobuf_write (iobuf_t a, const void *buf, unsigned buflen);
140 int iobuf_writestr (iobuf_t a, const char *buf);
141
142 void iobuf_flush_temp (iobuf_t temp);
143 int iobuf_write_temp (iobuf_t a, iobuf_t temp);
144 size_t iobuf_temp_to_buffer (iobuf_t a, byte * buffer, size_t buflen);
145
146 off_t iobuf_get_filelength (iobuf_t a, int *overflow);
147 #define IOBUF_FILELENGTH_LIMIT 0xffffffff
148 int  iobuf_get_fd (iobuf_t a);
149 const char *iobuf_get_real_fname (iobuf_t a);
150 const char *iobuf_get_fname (iobuf_t a);
151 const char *iobuf_get_fname_nonnull (iobuf_t a);
152
153 void iobuf_set_partial_block_mode (iobuf_t a, size_t len);
154
155 void iobuf_skip_rest (iobuf_t a, unsigned long n, int partial);
156
157
158 /* Get a byte from the iobuf; must check for eof prior to this
159  * function.  This function returns values in the range 0 .. 255 or -1
160  * to indicate EOF.  iobuf_get_noeof() does not return -1 to indicate
161  * EOF, but masks the returned value to be in the range 0 .. 255.
162  */
163 #define iobuf_get(a)  \
164      (  ((a)->nofast || (a)->d.start >= (a)->d.len )?  \
165         iobuf_readbyte((a)) : ( (a)->nbytes++, (a)->d.buf[(a)->d.start++] ) )
166 #define iobuf_get_noeof(a)    (iobuf_get((a))&0xff)
167
168 /* write a byte to the iobuf and return true on write error
169  * This macro does only write the low order byte
170  */
171 #define iobuf_put(a,c)  iobuf_writebyte(a,c)
172
173 #define iobuf_where(a)  "[don't know]"
174 #define iobuf_id(a)     ((a)->no)
175
176 #define iobuf_get_temp_buffer(a) ( (a)->d.buf )
177 #define iobuf_get_temp_length(a) ( (a)->d.len )
178 #define iobuf_is_temp(a)         ( (a)->use == 3 )
179
180 #endif /*GNUPG_COMMON_IOBUF_H*/