Last minute cleanups.
[gnupg.git] / g10 / filter.h
index 4423da2..923cfda 100644 (file)
@@ -1,11 +1,12 @@
 /* filter.h
- *     Copyright (C) 1998 Free Software Foundation, Inc.
+ * Copyright (C) 1998, 1999, 2000, 2001, 2003,
+ *               2005 Free Software Foundation, Inc.
  *
  * This file is part of GnuPG.
  *
  * 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 +15,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 G10_FILTER_H
 #define G10_FILTER_H
 #include "cipher.h"
 
 typedef struct {
-    MD_HANDLE md;      /* catch all */
+    gcry_md_hd_t md;      /* catch all */
+    gcry_md_hd_t md2;     /* if we want to calculate an alternate hash */
     size_t maxbuf_size;
 } md_filter_context_t;
 
 typedef struct {
+    int  refcount;          /* Initialized to 1.  */
+
     /* these fields may be initialized */
     int what;              /* what kind of armor headers to write */
     int only_keyblocks;     /* skip all headers but ".... key block" */
     const char *hdrlines;   /* write these headerlines */
 
+    /* these fields must be initialized to zero */
+    int no_openpgp_data;    /* output flag: "No valid OpenPGP data found" */
+
     /* the following fields must be initialized to zero */
     int inp_checked;       /* set if the input has been checked */
     int inp_bypass;        /* set if the input is not armored */
@@ -43,6 +49,11 @@ typedef struct {
     int faked;             /* we are faking a literal data packet */
     int truncated;         /* number of truncated lines */
     int qp_detected;
+    int pgp2mode;
+    byte eol[3];            /* The end of line characters as a
+                              zero-terminated string.  Defaults
+                              (eol[0]=='\0') to whatever the local
+                              platform uses. */
 
     byte *buffer;          /* malloced buffer */
     unsigned buffer_size;   /* and size of this buffer */
@@ -54,12 +65,16 @@ typedef struct {
     u32 crc;
 
     int status;            /* an internal state flag */
+    int cancel;
     int any_data;          /* any valid armored data seen */
     int pending_lf;        /* used together with faked */
 } armor_filter_context_t;
 
+struct unarmor_pump_s;
+typedef struct unarmor_pump_s *UnarmorPump;
 
-typedef struct {
+
+struct compress_filter_context_s {
     int status;
     void *opaque;   /* (used for z_stream) */
     byte *inbuf;
@@ -68,14 +83,20 @@ typedef struct {
     unsigned outbufsize;
     int algo;   /* compress algo */
     int algo1hack;
-} compress_filter_context_t;
+    int new_ctb;
+    void (*release)(struct compress_filter_context_s*);
+};
+typedef struct compress_filter_context_s compress_filter_context_t;
 
 
 typedef struct {
     DEK *dek;
     u32 datalen;
-    CIPHER_HANDLE cipher_hd;
+    gcry_cipher_hd_t cipher_hd;
     int header;
+    gcry_md_hd_t mdc_hash;
+    byte enchash[20];
+    int create_mdc; /* flag will be set by the cipher filter */
 } cipher_filter_context_t;
 
 
@@ -86,38 +107,57 @@ typedef struct {
     unsigned buffer_len;    /* used length of the buffer */
     unsigned buffer_pos;    /* read position */
     int truncated;         /* number of truncated lines */
-    int clearsign;
     int not_dash_escaped;
     int escape_from;
-    MD_HANDLE md;
+    gcry_md_hd_t md;
     int pending_lf;
     int pending_esc;
 } text_filter_context_t;
 
 
+typedef struct {
+    char *what;                        /* description */
+    u32 last_time;             /* last time reported */
+    unsigned long last;                /* last amount reported */
+    unsigned long offset;      /* current amount */
+    unsigned long total;       /* total amount */
+    int  refcount;              
+} progress_filter_context_t;
+
 /* encrypt_filter_context_t defined in main.h */
 
 /*-- mdfilter.c --*/
-int md_filter( void *opaque, int control, IOBUF a, byte *buf, size_t *ret_len);
+int md_filter( void *opaque, int control, iobuf_t a, byte *buf, size_t *ret_len);
 void free_md_filter_context( md_filter_context_t *mfx );
 
 /*-- armor.c --*/
-int use_armor_filter( IOBUF a );
-int armor_filter( void *opaque, int control,
-                 IOBUF chain, byte *buf, size_t *ret_len);
+armor_filter_context_t *new_armor_context (void);
+void release_armor_context (armor_filter_context_t *afx);
+int push_armor_filter (armor_filter_context_t *afx, iobuf_t iobuf);
+int use_armor_filter( iobuf_t a );
+UnarmorPump unarmor_pump_new (void);
+void        unarmor_pump_release (UnarmorPump x);
+int         unarmor_pump (UnarmorPump x, int c);
 
 /*-- compress.c --*/
-int compress_filter( void *opaque, int control,
-                    IOBUF chain, byte *buf, size_t *ret_len);
+void push_compress_filter(iobuf_t out,compress_filter_context_t *zfx,int algo);
+void push_compress_filter2(iobuf_t out,compress_filter_context_t *zfx,
+                          int algo,int rel);
 
 /*-- cipher.c --*/
 int cipher_filter( void *opaque, int control,
-                  IOBUF chain, byte *buf, size_t *ret_len);
+                  iobuf_t chain, byte *buf, size_t *ret_len);
 
 /*-- textfilter.c --*/
 int text_filter( void *opaque, int control,
-                IOBUF chain, byte *buf, size_t *ret_len);
-
-
+                iobuf_t chain, byte *buf, size_t *ret_len);
+int copy_clearsig_text (iobuf_t out, iobuf_t inp, gcry_md_hd_t md,
+                        int escape_dash, int escape_from, int pgp2mode);
+
+/*-- progress.c --*/
+progress_filter_context_t *new_progress_context (void);
+void release_progress_context (progress_filter_context_t *pfx);
+void handle_progress (progress_filter_context_t *pfx,
+                     iobuf_t inp, const char *name);
 
 #endif /*G10_FILTER_H*/