Switched to GPLv3.
[gnupg.git] / include / iobuf.h
1 /* iobuf.h - I/O buffer
2  * Copyright (C) 1998, 1999, 2000, 2001, 2004 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 3 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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef G10_IOBUF_H
21 #define G10_IOBUF_H
22
23 #include "types.h"
24
25
26 #define DBG_IOBUF   iobuf_debug_mode
27
28 #define IOBUFCTRL_INIT      1
29 #define IOBUFCTRL_FREE      2
30 #define IOBUFCTRL_UNDERFLOW 3
31 #define IOBUFCTRL_FLUSH     4
32 #define IOBUFCTRL_DESC      5
33 #define IOBUFCTRL_CANCEL    6
34 #define IOBUFCTRL_USER      16
35
36 typedef struct iobuf_struct *IOBUF;
37 typedef struct iobuf_struct *iobuf_t;
38
39 /* fixme: we should hide most of this stuff */
40 struct iobuf_struct {
41     int use;           /* 1 input , 2 output, 3 temp */
42     off_t nlimit;
43     off_t nbytes;      /* used together with nlimit */
44     off_t ntotal;      /* total bytes read (position of stream) */
45     int nofast;         /* used by the iobuf_get() */
46     void *directfp;
47     struct {
48         size_t size;   /* allocated size */
49         size_t start;  /* number of invalid bytes at the begin of the buffer */
50         size_t len;    /* currently filled to this size */
51         byte *buf;
52     } d;
53     int filter_eof;
54     int error;
55     int (*filter)( void *opaque, int control,
56                    IOBUF chain, byte *buf, size_t *len);
57     void *filter_ov;    /* value for opaque */
58     int filter_ov_owner;
59     char *real_fname;
60     IOBUF chain;        /* next iobuf used for i/o if any (passed to filter) */
61     int no, subno;
62     const char *desc;
63     void *opaque;      /* can be used to hold any information    */
64                        /* this value is copied to all instances */
65     struct {
66         size_t size;   /* allocated size */
67         size_t start;  /* number of invalid bytes at the begin of the buffer */
68         size_t len;    /* currently filled to this size */
69         byte *buf;
70     } unget;
71 };
72
73 #ifndef EXTERN_UNLESS_MAIN_MODULE
74 #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
75 #define EXTERN_UNLESS_MAIN_MODULE extern
76 #else
77 #define EXTERN_UNLESS_MAIN_MODULE 
78 #endif
79 #endif
80 EXTERN_UNLESS_MAIN_MODULE int iobuf_debug_mode;
81
82 void  iobuf_enable_special_filenames ( int yes );
83 int   iobuf_is_pipe_filename (const char *fname);
84 IOBUF iobuf_alloc(int use, size_t bufsize);
85 IOBUF iobuf_temp(void);
86 IOBUF iobuf_temp_with_content( const char *buffer, size_t length );
87 IOBUF iobuf_open( const char *fname );
88 IOBUF iobuf_fdopen( int fd, const char *mode );
89 IOBUF iobuf_sockopen( int fd, const char *mode );
90 IOBUF iobuf_create( const char *fname );
91 IOBUF iobuf_append( const char *fname );
92 IOBUF iobuf_openrw( const char *fname );
93 int   iobuf_ioctl ( IOBUF a, int cmd, int intval, void *ptrval );
94 int   iobuf_close( IOBUF iobuf );
95 int   iobuf_cancel( IOBUF iobuf );
96
97 int iobuf_push_filter( IOBUF a, int (*f)(void *opaque, int control,
98                        IOBUF chain, byte *buf, size_t *len), void *ov );
99 int iobuf_push_filter2( IOBUF a,
100                     int (*f)(void *opaque, int control,
101                     IOBUF chain, byte *buf, size_t *len),
102                     void *ov, int rel_ov );
103 int iobuf_flush(IOBUF a);
104 void iobuf_clear_eof(IOBUF a);
105 #define iobuf_set_error(a)    do { (a)->error = 1; } while(0)
106 #define iobuf_error(a)        ((a)->error)
107
108 void iobuf_set_limit( IOBUF a, off_t nlimit );
109
110 off_t iobuf_tell( IOBUF a );
111 int   iobuf_seek( IOBUF a, off_t newpos );
112
113 int  iobuf_readbyte(IOBUF a);
114 int  iobuf_read(IOBUF a, byte *buf, unsigned buflen );
115 unsigned iobuf_read_line( IOBUF a, byte **addr_of_buffer,
116                           unsigned *length_of_buffer, unsigned *max_length );
117 int  iobuf_peek(IOBUF a, byte *buf, unsigned buflen );
118 int  iobuf_writebyte(IOBUF a, unsigned c);
119 int  iobuf_write(IOBUF a, byte *buf, unsigned buflen );
120 int  iobuf_writestr(IOBUF a, const char *buf );
121
122 void iobuf_flush_temp( IOBUF temp );
123 int  iobuf_write_temp( IOBUF a, IOBUF temp );
124 size_t iobuf_temp_to_buffer( IOBUF a, byte *buffer, size_t buflen );
125 void iobuf_unget_and_close_temp( IOBUF a, IOBUF temp );
126
127 int  iobuf_get_fd (IOBUF a);
128 off_t iobuf_get_filelength (IOBUF a, int *overflow);
129 #define IOBUF_FILELENGTH_LIMIT 0xffffffff
130 const char *iobuf_get_real_fname( IOBUF a );
131 const char *iobuf_get_fname( IOBUF a );
132
133 void iobuf_set_partial_block_mode( IOBUF a, size_t len );
134
135 int iobuf_translate_file_handle ( int fd, int for_write );
136
137 /* Get a byte form the iobuf; must check for eof prior to this function.
138  * This function returns values in the range 0 .. 255 or -1 to indicate EOF
139  * iobuf_get_noeof() does not return -1 to indicate EOF, but masks the
140  * returned value to be in the range 0..255.
141  */
142 #define iobuf_get(a)  \
143      (  ((a)->nofast || (a)->d.start >= (a)->d.len )?  \
144         iobuf_readbyte((a)) : ( (a)->nbytes++, (a)->d.buf[(a)->d.start++] ) )
145 #define iobuf_get_noeof(a)    (iobuf_get((a))&0xff)
146
147 /* write a byte to the iobuf and return true on write error
148  * This macro does only write the low order byte
149  */
150 #define iobuf_put(a,c)  iobuf_writebyte(a,c)
151
152 #define iobuf_where(a)  "[don't know]"
153 #define iobuf_id(a)     ((a)->no)
154
155 #define iobuf_get_temp_buffer(a) ( (a)->d.buf )
156 #define iobuf_get_temp_length(a) ( (a)->d.len )
157 #define iobuf_is_temp(a)         ( (a)->use == 3 )
158
159 void iobuf_skip_rest (IOBUF a, unsigned long n, int partial);
160
161 #endif /*G10_IOBUF_H*/