Re-indent code and use test macros for betetr readability
[gnupg.git] / common / iobuf.h
index b991717..8a3671e 100644 (file)
@@ -5,7 +5,7 @@
  *
  * GNUPG is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * GNUPG is distributed in the hope that it will be useful,
@@ -14,8 +14,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef GNUPG_COMMON_IOBUF_H
 #define IOBUFCTRL_USER     16
 
 typedef struct iobuf_struct *iobuf_t;
+typedef struct iobuf_struct *IOBUF;  /* Compatibility with gpg 1.4. */
 
 /* fixme: we should hide most of this stuff */
 struct iobuf_struct
 {
   int use;                     /* 1 input , 2 output, 3 temp */
   off_t nlimit;
-  off_t nbytes;                        /* used together with nlimit */
-  off_t ntotal;                        /* total bytes read (position of stream) */
-  int nofast;                  /* used by the iobuf_get() */
+  off_t nbytes;                        /* Used together with nlimit. */
+  off_t ntotal;                        /* Total bytes read (position of stream). */
+  int nofast;                  /* Used by the iobuf_get (). */
   void *directfp;
   struct
   {
-    size_t size;               /* allocated size */
-    size_t start;              /* number of invalid bytes at the begin of the buffer */
-    size_t len;                        /* currently filled to this size */
+    size_t size;               /* Allocated size */
+    size_t start;              /* Number of invalid bytes at the
+                                   begin of the buffer */
+    size_t len;                        /* Currently filled to this size */
     byte *buf;
-  }
-  d;
+  } d;
+
   int filter_eof;
   int error;
   int (*filter) (void *opaque, int control,
                 iobuf_t chain, byte * buf, size_t * len);
-  void *filter_ov;             /* value for opaque */
+  void *filter_ov;             /* Value for opaque */
   int filter_ov_owner;
   char *real_fname;
-  iobuf_t chain;                       /* next iobuf used for i/o if any
+  iobuf_t chain;               /* Next iobuf used for i/o if any
                                    (passed to filter) */
   int no, subno;
   const char *desc;
-  void *opaque;                        /* can be used to hold any information
+  void *opaque;                        /* Can be used to hold any information
                                    this value is copied to all
                                    instances */
-  struct
-  {
-    size_t size;               /* allocated size */
-    size_t start;              /* number of invalid bytes at the
-                                   begin of the buffer */
-    size_t len;                        /* currently filled to this size */
-    byte *buf;
-  }
-  unget;
 };
 
 #ifndef EXTERN_UNLESS_MAIN_MODULE
@@ -89,6 +81,7 @@ struct iobuf_struct
 EXTERN_UNLESS_MAIN_MODULE int iobuf_debug_mode;
 
 void iobuf_enable_special_filenames (int yes);
+int  iobuf_is_pipe_filename (const char *fname);
 iobuf_t iobuf_alloc (int use, size_t bufsize);
 iobuf_t iobuf_temp (void);
 iobuf_t iobuf_temp_with_content (const char *buffer, size_t length);
@@ -121,6 +114,7 @@ int iobuf_seek (iobuf_t a, off_t newpos);
 
 int iobuf_readbyte (iobuf_t a);
 int iobuf_read (iobuf_t a, void *buf, unsigned buflen);
+void iobuf_unread (iobuf_t a, const unsigned char *buf, unsigned int buflen);
 unsigned iobuf_read_line (iobuf_t a, byte ** addr_of_buffer,
                          unsigned *length_of_buffer, unsigned *max_length);
 int iobuf_peek (iobuf_t a, byte * buf, unsigned buflen);
@@ -131,18 +125,16 @@ int iobuf_writestr (iobuf_t a, const char *buf);
 void iobuf_flush_temp (iobuf_t temp);
 int iobuf_write_temp (iobuf_t a, iobuf_t temp);
 size_t iobuf_temp_to_buffer (iobuf_t a, byte * buffer, size_t buflen);
-void iobuf_unget_and_close_temp (iobuf_t a, iobuf_t temp);
 
-off_t iobuf_get_filelength (iobuf_t a);
+off_t iobuf_get_filelength (iobuf_t a, int *overflow);
 #define IOBUF_FILELENGTH_LIMIT 0xffffffff
+int  iobuf_get_fd (iobuf_t a);
 const char *iobuf_get_real_fname (iobuf_t a);
 const char *iobuf_get_fname (iobuf_t a);
 
-void iobuf_set_block_mode (iobuf_t a, size_t n);
 void iobuf_set_partial_block_mode (iobuf_t a, size_t len);
-int iobuf_in_block_mode (iobuf_t a);
 
-int iobuf_translate_file_handle (int fd, int for_write);
+void iobuf_skip_rest (iobuf_t a, unsigned long n, int partial);
 
 
 /* get a byte form the iobuf; must check for eof prior to this function