See ChangeLog: Wed Jan 20 18:59:49 CET 1999 Werner Koch
[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 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     int nofast;         /* used by the iobuf_get() */
45     void *directfp;
46     struct {
47         size_t size;   /* allocated size */
48         size_t start;  /* number of invalid bytes at the begin of the buffer */
49         size_t len;    /* currently filled to this size */
50         byte *buf;
51     } d;
52     int filter_eof;
53     int error;
54     int (*filter)( void *opaque, int control,
55                    IOBUF chain, byte *buf, size_t *len);
56     void *filter_ov;    /* value for opaque */
57     IOBUF chain;        /* next iobuf used for i/o if any (passed to filter) */
58     int no, subno;
59     const char *desc;
60     void *opaque;      /* can be used to hold any information    */
61                        /* this value is copied to all instances */
62     struct {
63         size_t size;   /* allocated size */
64         size_t start;  /* number of invalid bytes at the begin of the buffer */
65         size_t len;    /* currently filled to this size */
66         byte *buf;
67     } unget;
68 };
69
70 int iobuf_debug_mode;
71
72 IOBUF iobuf_alloc(int usage, size_t bufsize);
73 IOBUF iobuf_temp(void);
74 IOBUF iobuf_temp_with_content( const char *buffer, size_t length );
75 IOBUF iobuf_open( const char *fname );
76 IOBUF iobuf_fdopen( int fd, const char *mode );
77 IOBUF iobuf_fopen( const char *fname, const char *mode );
78 IOBUF iobuf_create( const char *fname );
79 IOBUF iobuf_append( const char *fname );
80 IOBUF iobuf_openrw( const char *fname );
81 int   iobuf_close( IOBUF iobuf );
82 int   iobuf_cancel( IOBUF iobuf );
83
84 int iobuf_push_filter( IOBUF a, int (*f)(void *opaque, int control,
85                        IOBUF chain, byte *buf, size_t *len), void *ov );
86 int iobuf_pop_filter( IOBUF a, int (*f)(void *opaque, int control,
87                       IOBUF chain, byte *buf, size_t *len), void *ov );
88 int iobuf_flush(IOBUF a);
89 void iobuf_clear_eof(IOBUF a);
90 #define iobuf_set_error(a)    do { (a)->error = 1; } while(0)
91 #define iobuf_error(a)        ((a)->error)
92
93 void iobuf_set_limit( IOBUF a, unsigned long nlimit );
94
95 ulong iobuf_tell( IOBUF a );
96 int   iobuf_seek( IOBUF a, ulong newpos );
97
98 int  iobuf_readbyte(IOBUF a);
99 int  iobuf_read(IOBUF a, byte *buf, unsigned buflen );
100 unsigned iobuf_read_line( IOBUF a, byte **addr_of_buffer,
101                           unsigned *length_of_buffer, unsigned *max_length );
102 int  iobuf_peek(IOBUF a, byte *buf, unsigned buflen );
103 int  iobuf_writebyte(IOBUF a, unsigned c);
104 int  iobuf_write(IOBUF a, byte *buf, unsigned buflen );
105 int  iobuf_writestr(IOBUF a, const char *buf );
106
107 void iobuf_flush_temp( IOBUF temp );
108 int  iobuf_write_temp( IOBUF a, IOBUF temp );
109 size_t iobuf_temp_to_buffer( IOBUF a, byte *buffer, size_t buflen );
110 void iobuf_unget_and_close_temp( IOBUF a, IOBUF temp );
111
112 u32 iobuf_get_filelength( IOBUF a );
113 const char *iobuf_get_fname( IOBUF a );
114
115 void iobuf_set_block_mode( IOBUF a, size_t n );
116 void iobuf_set_partial_block_mode( IOBUF a, size_t len );
117 int  iobuf_in_block_mode( IOBUF a );
118
119 /* get a byte form the iobuf; must check for eof prior to this function
120  * this function returns values in the range 0 .. 255 or -1 to indicate EOF
121  * iobuf_get_noeof() does not return -1 to indicate EOF, but masks the
122  * returned value to be in the range 0 ..255.
123  */
124 #define iobuf_get(a)  \
125      (  ((a)->nofast || (a)->d.start >= (a)->d.len )?  \
126         iobuf_readbyte((a)) : ( (a)->nbytes++, (a)->d.buf[(a)->d.start++] ) )
127 #define iobuf_get_noeof(a)    (iobuf_get((a))&0xff)
128
129 /* write a byte to the iobuf and return true on write error
130  * This macro does only write the low order byte
131  */
132 #define iobuf_put(a,c)  iobuf_writebyte(a,c)
133
134 #define iobuf_where(a)  "[don't know]"
135 #define iobuf_id(a)     ((a)->no)
136
137 #define iobuf_get_temp_buffer(a) ( (a)->d.buf )
138 #define iobuf_get_temp_length(a) ( (a)->d.len )
139 #define iobuf_is_temp(a)         ( (a)->usage == 3 )
140
141 #endif /*G10_IOBUF_H*/