2002-02-01 Marcus Brinkmann <marcus@g10code.de>
[gnupg.git] / include / iobuf.h
1 /* iobuf.h - I/O buffer
2  *      Copyright (C) 1998 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 GPG_IOBUF_H
22 #define GPG_IOBUF_H
23
24 #include "types.h"
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;
39
40 /* fixme: we should hide most of this stuff */
41 struct iobuf_struct {
42     int use;           /* 1 input , 2 output, 3 temp */
43     unsigned long nlimit;
44     unsigned long nbytes; /* used together with nlimit */
45     unsigned long ntotal; /* total bytes read (position of stream) */
46     int nofast;         /* used by the iobuf_get() */
47     void *directfp;
48     struct {
49         size_t size;   /* allocated size */
50         size_t start;  /* number of invalid bytes at the begin of the buffer */
51         size_t len;    /* currently filled to this size */
52         byte *buf;
53     } d;
54     int filter_eof;
55     int error;
56     int (*filter)( void *opaque, int control,
57                    IOBUF chain, byte *buf, size_t *len);
58     void *filter_ov;    /* value for opaque */
59     int filter_ov_owner;
60     char *real_fname;
61     IOBUF chain;        /* next iobuf used for i/o if any (passed to filter) */
62     int no, subno;
63     const char *desc;
64     void *opaque;      /* can be used to hold any information    */
65                        /* this value is copied to all instances */
66     struct {
67         size_t size;   /* allocated size */
68         size_t start;  /* number of invalid bytes at the begin of the buffer */
69         size_t len;    /* currently filled to this size */
70         byte *buf;
71     } unget;
72 };
73
74 int iobuf_debug_mode;
75
76 IOBUF iobuf_alloc(int use, size_t bufsize);
77 IOBUF iobuf_temp(void);
78 IOBUF iobuf_temp_with_content( const char *buffer, size_t length );
79 IOBUF iobuf_open( const char *fname );
80 IOBUF iobuf_fdopen( int fd, const char *mode );
81 IOBUF iobuf_fopen( const char *fname, const char *mode );
82 IOBUF iobuf_create( const char *fname );
83 IOBUF iobuf_append( const char *fname );
84 IOBUF iobuf_openrw( const char *fname );
85 int   iobuf_close( IOBUF iobuf );
86 int   iobuf_cancel( IOBUF iobuf );
87
88 int iobuf_push_filter( IOBUF a, int (*f)(void *opaque, int control,
89                        IOBUF chain, byte *buf, size_t *len), void *ov );
90 int iobuf_push_filter2( IOBUF a,
91                     int (*f)(void *opaque, int control,
92                     IOBUF chain, byte *buf, size_t *len),
93                     void *ov, int rel_ov );
94 int iobuf_flush(IOBUF a);
95 void iobuf_clear_eof(IOBUF a);
96 #define iobuf_set_error(a)    do { (a)->error = 1; } while(0)
97 #define iobuf_error(a)        ((a)->error)
98
99 void iobuf_set_limit( IOBUF a, unsigned long nlimit );
100
101 ulong iobuf_tell( IOBUF a );
102 int   iobuf_seek( IOBUF a, ulong newpos );
103
104 int  iobuf_readbyte(IOBUF a);
105 int  iobuf_read(IOBUF a, byte *buf, unsigned buflen );
106 unsigned iobuf_read_line( IOBUF a, byte **addr_of_buffer,
107                           unsigned *length_of_buffer, unsigned *max_length );
108 int  iobuf_peek(IOBUF a, byte *buf, unsigned buflen );
109 int  iobuf_writebyte(IOBUF a, unsigned c);
110 int  iobuf_write(IOBUF a, byte *buf, unsigned buflen );
111 int  iobuf_writestr(IOBUF a, const char *buf );
112
113 void iobuf_flush_temp( IOBUF temp );
114 int  iobuf_write_temp( IOBUF a, IOBUF temp );
115 size_t iobuf_temp_to_buffer( IOBUF a, byte *buffer, size_t buflen );
116 void iobuf_unget_and_close_temp( IOBUF a, IOBUF temp );
117
118 u32 iobuf_get_filelength( IOBUF a );
119 #define IOBUF_FILELENGTH_LIMIT 0xffffffff
120 const char *iobuf_get_real_fname( IOBUF a );
121 const char *iobuf_get_fname( IOBUF a );
122
123 void iobuf_set_block_mode( IOBUF a, size_t n );
124 void iobuf_set_partial_block_mode( IOBUF a, size_t len );
125 int  iobuf_in_block_mode( IOBUF a );
126
127 /* get a byte form the iobuf; must check for eof prior to this function
128  * this function returns values in the range 0 .. 255 or -1 to indicate EOF
129  * iobuf_get_noeof() does not return -1 to indicate EOF, but masks the
130  * returned value to be in the range 0 ..255.
131  */
132 #define iobuf_get(a)  \
133      (  ((a)->nofast || (a)->d.start >= (a)->d.len )?  \
134         iobuf_readbyte((a)) : ( (a)->nbytes++, (a)->d.buf[(a)->d.start++] ) )
135 #define iobuf_get_noeof(a)    (iobuf_get((a))&0xff)
136
137 /* write a byte to the iobuf and return true on write error
138  * This macro does only write the low order byte
139  */
140 #define iobuf_put(a,c)  iobuf_writebyte(a,c)
141
142 #define iobuf_where(a)  "[don't know]"
143 #define iobuf_id(a)     ((a)->no)
144
145 #define iobuf_get_temp_buffer(a) ( (a)->d.buf )
146 #define iobuf_get_temp_length(a) ( (a)->d.len )
147 #define iobuf_is_temp(a)         ( (a)->use == 3 )
148
149 #endif /*GPG_IOBUF_H*/