* gpg.sgml: Document delsig. Clarify that --refresh-keys arguments are
[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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
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
26
27 #define DBG_IOBUF   iobuf_debug_mode
28
29
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 typedef struct iobuf_struct *iobuf_t;
39
40 /* fixme: we should hide most of this stuff */
41 struct iobuf_struct
42 {
43   int use;                      /* 1 input , 2 output, 3 temp */
44   off_t nlimit;
45   off_t nbytes;                 /* used together with nlimit */
46   off_t ntotal;                 /* total bytes read (position of stream) */
47   int nofast;                   /* used by the iobuf_get() */
48   void *directfp;
49   struct
50   {
51     size_t size;                /* allocated size */
52     size_t start;               /* number of invalid bytes at the begin of the buffer */
53     size_t len;                 /* currently filled to this size */
54     byte *buf;
55   }
56   d;
57   int filter_eof;
58   int error;
59   int (*filter) (void *opaque, int control,
60                  iobuf_t chain, byte * buf, size_t * len);
61   void *filter_ov;              /* value for opaque */
62   int filter_ov_owner;
63   char *real_fname;
64   iobuf_t chain;                        /* next iobuf used for i/o if any
65                                    (passed to filter) */
66   int no, subno;
67   const char *desc;
68   void *opaque;                 /* can be used to hold any information
69                                    this value is copied to all
70                                    instances */
71   struct
72   {
73     size_t size;                /* allocated size */
74     size_t start;               /* number of invalid bytes at the
75                                    begin of the buffer */
76     size_t len;                 /* currently filled to this size */
77     byte *buf;
78   }
79   unget;
80 };
81
82 #ifndef EXTERN_UNLESS_MAIN_MODULE
83 #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
84 #define EXTERN_UNLESS_MAIN_MODULE extern
85 #else
86 #define EXTERN_UNLESS_MAIN_MODULE
87 #endif
88 #endif
89 EXTERN_UNLESS_MAIN_MODULE int iobuf_debug_mode;
90
91 void iobuf_enable_special_filenames (int yes);
92 iobuf_t iobuf_alloc (int use, size_t bufsize);
93 iobuf_t iobuf_temp (void);
94 iobuf_t iobuf_temp_with_content (const char *buffer, size_t length);
95 iobuf_t iobuf_open (const char *fname);
96 iobuf_t iobuf_fdopen (int fd, const char *mode);
97 iobuf_t iobuf_sockopen (int fd, const char *mode);
98 iobuf_t iobuf_create (const char *fname);
99 iobuf_t iobuf_append (const char *fname);
100 iobuf_t iobuf_openrw (const char *fname);
101 int iobuf_ioctl (iobuf_t a, int cmd, int intval, void *ptrval);
102 int iobuf_close (iobuf_t iobuf);
103 int iobuf_cancel (iobuf_t iobuf);
104
105 int iobuf_push_filter (iobuf_t a, int (*f) (void *opaque, int control,
106                                           iobuf_t chain, byte * buf,
107                                           size_t * len), void *ov);
108 int iobuf_push_filter2 (iobuf_t a,
109                         int (*f) (void *opaque, int control, iobuf_t chain,
110                                   byte * buf, size_t * len), void *ov,
111                         int rel_ov);
112 int iobuf_flush (iobuf_t a);
113 void iobuf_clear_eof (iobuf_t a);
114 #define iobuf_set_error(a)    do { (a)->error = 1; } while(0)
115 #define iobuf_error(a)        ((a)->error)
116
117 void iobuf_set_limit (iobuf_t a, off_t nlimit);
118
119 off_t iobuf_tell (iobuf_t a);
120 int iobuf_seek (iobuf_t a, off_t newpos);
121
122 int iobuf_readbyte (iobuf_t a);
123 int iobuf_read (iobuf_t a, byte * buf, unsigned buflen);
124 unsigned iobuf_read_line (iobuf_t a, byte ** addr_of_buffer,
125                           unsigned *length_of_buffer, unsigned *max_length);
126 int iobuf_peek (iobuf_t a, byte * buf, unsigned buflen);
127 int iobuf_writebyte (iobuf_t a, unsigned c);
128 int iobuf_write (iobuf_t a, byte * buf, unsigned buflen);
129 int iobuf_writestr (iobuf_t a, const char *buf);
130
131 void iobuf_flush_temp (iobuf_t temp);
132 int iobuf_write_temp (iobuf_t a, iobuf_t temp);
133 size_t iobuf_temp_to_buffer (iobuf_t a, byte * buffer, size_t buflen);
134 void iobuf_unget_and_close_temp (iobuf_t a, iobuf_t temp);
135
136 off_t iobuf_get_filelength (iobuf_t a);
137 #define IOBUF_FILELENGTH_LIMIT 0xffffffff
138 const char *iobuf_get_real_fname (iobuf_t a);
139 const char *iobuf_get_fname (iobuf_t a);
140
141 void iobuf_set_block_mode (iobuf_t a, size_t n);
142 void iobuf_set_partial_block_mode (iobuf_t a, size_t len);
143 int iobuf_in_block_mode (iobuf_t a);
144
145 int iobuf_translate_file_handle (int fd, int for_write);
146
147
148 /* get a byte form the iobuf; must check for eof prior to this function
149  * this function returns values in the range 0 .. 255 or -1 to indicate EOF
150  * iobuf_get_noeof() does not return -1 to indicate EOF, but masks the
151  * returned value to be in the range 0 ..255.
152  */
153 #define iobuf_get(a)  \
154      (  ((a)->nofast || (a)->d.start >= (a)->d.len )?  \
155         iobuf_readbyte((a)) : ( (a)->nbytes++, (a)->d.buf[(a)->d.start++] ) )
156 #define iobuf_get_noeof(a)    (iobuf_get((a))&0xff)
157
158 /* write a byte to the iobuf and return true on write error
159  * This macro does only write the low order byte
160  */
161 #define iobuf_put(a,c)  iobuf_writebyte(a,c)
162
163 #define iobuf_where(a)  "[don't know]"
164 #define iobuf_id(a)     ((a)->no)
165
166 #define iobuf_get_temp_buffer(a) ( (a)->d.buf )
167 #define iobuf_get_temp_length(a) ( (a)->d.len )
168 #define iobuf_is_temp(a)         ( (a)->use == 3 )
169
170 #endif /*GNUPG_COMMON_IOBUF_H*/