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