W32CE fix.
[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
27 #define DBG_IOBUF   iobuf_debug_mode
28
29 /* Filter control modes.  */
30 #define IOBUFCTRL_INIT      1
31 #define IOBUFCTRL_FREE      2
32 #define IOBUFCTRL_UNDERFLOW 3
33 #define IOBUFCTRL_FLUSH     4
34 #define IOBUFCTRL_DESC      5
35 #define IOBUFCTRL_CANCEL    6
36 #define IOBUFCTRL_USER      16
37
38
39 /* Command codes for iobuf_ioctl.  */
40 typedef enum 
41   {
42     IOBUF_IOCTL_KEEP_OPEN        = 1, /* Uses intval.  */
43     IOBUF_IOCTL_INVALIDATE_CACHE = 2, /* Uses ptrval.  */
44     IOBUF_IOCTL_NO_CACHE         = 3, /* Uses intval.  */
45     IOBUF_IOCTL_FSYNC            = 4  /* Uses ptrval.  */
46   } iobuf_ioctl_t;
47
48
49 typedef struct iobuf_struct *iobuf_t;
50 typedef struct iobuf_struct *IOBUF;  /* Compatibility with gpg 1.4. */
51
52 /* fixme: we should hide most of this stuff */
53 struct iobuf_struct
54 {
55   int use;                      /* 1 input , 2 output, 3 temp */
56   off_t nlimit;
57   off_t nbytes;                 /* Used together with nlimit. */
58   off_t ntotal;                 /* Total bytes read (position of stream). */
59   int nofast;                   /* Used by the iobuf_get (). */
60   void *directfp;
61   struct
62   {
63     size_t size;                /* Allocated size */
64     size_t start;               /* Number of invalid bytes at the
65                                    begin of the buffer */
66     size_t len;                 /* Currently filled to this size */
67     byte *buf;
68   } d;
69
70   int filter_eof;
71   int error;
72   int (*filter) (void *opaque, int control,
73                  iobuf_t chain, byte * buf, size_t * len);
74   void *filter_ov;              /* Value for opaque */
75   int filter_ov_owner;
76   char *real_fname;
77   iobuf_t chain;                /* Next iobuf used for i/o if any
78                                    (passed to filter) */
79   int no, subno;
80   const char *desc;
81   void *opaque;                 /* Can be used to hold any information
82                                    this value is copied to all
83                                    instances */
84 };
85
86 #ifndef EXTERN_UNLESS_MAIN_MODULE
87 #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
88 #define EXTERN_UNLESS_MAIN_MODULE extern
89 #else
90 #define EXTERN_UNLESS_MAIN_MODULE
91 #endif
92 #endif
93 EXTERN_UNLESS_MAIN_MODULE int iobuf_debug_mode;
94
95 void iobuf_enable_special_filenames (int yes);
96 int  iobuf_is_pipe_filename (const char *fname);
97 iobuf_t iobuf_alloc (int use, size_t bufsize);
98 iobuf_t iobuf_temp (void);
99 iobuf_t iobuf_temp_with_content (const char *buffer, size_t length);
100 iobuf_t iobuf_open_fd_or_name (gnupg_fd_t fd, const char *fname,
101                                const char *mode);
102 iobuf_t iobuf_open (const char *fname);
103 iobuf_t iobuf_fdopen (int fd, const char *mode);
104 iobuf_t iobuf_fdopen_nc (int fd, const char *mode);
105 iobuf_t iobuf_sockopen (int fd, const char *mode);
106 iobuf_t iobuf_create (const char *fname);
107 iobuf_t iobuf_append (const char *fname);
108 iobuf_t iobuf_openrw (const char *fname);
109 int iobuf_ioctl (iobuf_t a, iobuf_ioctl_t cmd, int intval, void *ptrval);
110 int iobuf_close (iobuf_t iobuf);
111 int iobuf_cancel (iobuf_t iobuf);
112
113 int iobuf_push_filter (iobuf_t a, int (*f) (void *opaque, int control,
114                                           iobuf_t chain, byte * buf,
115                                           size_t * len), void *ov);
116 int iobuf_push_filter2 (iobuf_t a,
117                         int (*f) (void *opaque, int control, iobuf_t chain,
118                                   byte * buf, size_t * len), void *ov,
119                         int rel_ov);
120 int iobuf_flush (iobuf_t a);
121 void iobuf_clear_eof (iobuf_t a);
122 #define iobuf_set_error(a)    do { (a)->error = 1; } while(0)
123 #define iobuf_error(a)        ((a)->error)
124
125 void iobuf_set_limit (iobuf_t a, off_t nlimit);
126
127 off_t iobuf_tell (iobuf_t a);
128 int iobuf_seek (iobuf_t a, off_t newpos);
129
130 int iobuf_readbyte (iobuf_t a);
131 int iobuf_read (iobuf_t a, void *buf, unsigned buflen);
132 void iobuf_unread (iobuf_t a, const unsigned char *buf, unsigned int buflen);
133 unsigned iobuf_read_line (iobuf_t a, byte ** addr_of_buffer,
134                           unsigned *length_of_buffer, unsigned *max_length);
135 int iobuf_peek (iobuf_t a, byte * buf, unsigned buflen);
136 int iobuf_writebyte (iobuf_t a, unsigned c);
137 int iobuf_write (iobuf_t a, const void *buf, unsigned buflen);
138 int iobuf_writestr (iobuf_t a, const char *buf);
139
140 void iobuf_flush_temp (iobuf_t temp);
141 int iobuf_write_temp (iobuf_t a, iobuf_t temp);
142 size_t iobuf_temp_to_buffer (iobuf_t a, byte * buffer, size_t buflen);
143
144 off_t iobuf_get_filelength (iobuf_t a, int *overflow);
145 #define IOBUF_FILELENGTH_LIMIT 0xffffffff
146 int  iobuf_get_fd (iobuf_t a);
147 const char *iobuf_get_real_fname (iobuf_t a);
148 const char *iobuf_get_fname (iobuf_t a);
149 const char *iobuf_get_fname_nonnull (iobuf_t a);
150
151 void iobuf_set_partial_block_mode (iobuf_t a, size_t len);
152
153 void iobuf_skip_rest (iobuf_t a, unsigned long n, int partial);
154
155
156 /* Get a byte from the iobuf; must check for eof prior to this
157  * function.  This function returns values in the range 0 .. 255 or -1
158  * to indicate EOF.  iobuf_get_noeof() does not return -1 to indicate
159  * EOF, but masks the returned value to be in the range 0 .. 255.
160  */
161 #define iobuf_get(a)  \
162      (  ((a)->nofast || (a)->d.start >= (a)->d.len )?  \
163         iobuf_readbyte((a)) : ( (a)->nbytes++, (a)->d.buf[(a)->d.start++] ) )
164 #define iobuf_get_noeof(a)    (iobuf_get((a))&0xff)
165
166 /* write a byte to the iobuf and return true on write error
167  * This macro does only write the low order byte
168  */
169 #define iobuf_put(a,c)  iobuf_writebyte(a,c)
170
171 #define iobuf_where(a)  "[don't know]"
172 #define iobuf_id(a)     ((a)->no)
173
174 #define iobuf_get_temp_buffer(a) ( (a)->d.buf )
175 #define iobuf_get_temp_length(a) ( (a)->d.len )
176 #define iobuf_is_temp(a)         ( (a)->use == 3 )
177
178 #endif /*GNUPG_COMMON_IOBUF_H*/