e381445a5697bf39d63ef736add0149a5afc5508
[gnupg.git] / include / iobuf.h
1 /* iobuf.h - I/O buffer
2  *      Copyright (c) 1997 by Werner Koch (dd9jn)
3  *
4  * This file is part of G10.
5  *
6  * G10 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  * G10 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 G10_IOBUF_H
22 #define G10_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_USER      16
36
37 typedef struct iobuf_struct *IOBUF;
38
39 struct iobuf_struct {
40     int usage;           /* 1 input , 2 output, 3 temp */
41     unsigned long nlimit;
42     unsigned long nbytes; /* used together with nlimit */
43     unsigned long ntotal; /* total bytes read (position of stream) */
44     struct {
45         size_t size;   /* allocated size */
46         size_t start;  /* number of invalid bytes at the begin of the buffer */
47         size_t len;    /* currently filled to this size */
48         byte *buf;
49     } d;
50     int filter_eof;
51     int (*filter)( void *opaque, int control,
52                    IOBUF chain, byte *buf, size_t *len);
53     void *filter_ov;    /* value for opaque */
54     IOBUF chain;        /* next iobuf used for i/o if any (passed to filter) */
55     int no, subno;
56     const char *desc;
57     void *opaque;      /* can be used to old any information    */
58                        /* this value is copied to all instances */
59 };
60
61 int iobuf_debug_mode;
62
63 IOBUF iobuf_alloc(int usage, size_t bufsize);
64 IOBUF iobuf_temp(void);
65 IOBUF iobuf_open( const char *fname );
66 IOBUF iobuf_create( const char *fname );
67 IOBUF iobuf_append( const char *fname );
68 IOBUF iobuf_openrw( const char *fname );
69 int   iobuf_close( IOBUF iobuf );
70 int   iobuf_cancel( IOBUF iobuf );
71
72 int iobuf_push_filter( IOBUF a, int (*f)(void *opaque, int control,
73                        IOBUF chain, byte *buf, size_t *len), void *ov );
74 int iobuf_pop_filter( IOBUF a, int (*f)(void *opaque, int control,
75                       IOBUF chain, byte *buf, size_t *len), void *ov );
76 int iobuf_flush(IOBUF a);
77 void iobuf_clear_eof(IOBUF a);
78
79 void iobuf_set_limit( IOBUF a, unsigned long nlimit );
80
81 ulong iobuf_tell( IOBUF a );
82 int   iobuf_seek( IOBUF a, ulong newpos );
83
84 int  iobuf_readbyte(IOBUF a);
85 int  iobuf_writebyte(IOBUF a, unsigned c);
86 int  iobuf_write(IOBUF a, byte *buf, unsigned buflen );
87 int  iobuf_writestr(IOBUF a, const char *buf );
88
89 int  iobuf_write_temp( IOBUF a, IOBUF temp );
90 size_t iobuf_temp_to_buffer( IOBUF a, byte *buffer, size_t buflen );
91
92 u32 iobuf_get_filelength( IOBUF a );
93 const char *iobuf_get_fname( IOBUF a );
94
95 void iobuf_set_block_mode( IOBUF a, size_t n );
96 void iobuf_set_partial_block_mode( IOBUF a, size_t len );
97 int  iobuf_in_block_mode( IOBUF a );
98
99 /* get a byte form the iobuf; must check for eof prior to this function
100  * this function returns values in the range 0 .. 255 or -1 to indicate EOF
101  * iobuf_get_noeof() does not return -1 to indicate EOF, but masks the
102  * returned value to be in the range 0 ..255.
103  */
104 #define iobuf_get(a)  \
105      (  ((a)->nlimit || (a)->d.start >= (a)->d.len )?  \
106         iobuf_readbyte((a)) : ( (a)->nbytes++, (a)->d.buf[(a)->d.start++] ) )
107 #define iobuf_get_noeof(a)    (iobuf_get((a))&0xff)
108
109
110 /* write a byte to the iobuf and return true on write error
111  * This macro does only write the low order byte
112  */
113 #define iobuf_put(a,c)  iobuf_writebyte(a,c)
114
115 #define iobuf_where(a)  "[don't know]"
116 #define iobuf_id(a)     ((a)->no)
117
118 #define iobuf_get_temp_length(a) ( (a)->d.len )
119 #define iobuf_is_temp(a)         ( (a)->usage == 3 )
120
121 #endif /*G10_IOBUF_H*/