gmime/gmime-filter.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*  GMime
   3  *  Copyright (C) 2000-2012 Jeffrey Stedfast
   4  *
   5  *  This library is free software; you can redistribute it and/or
   6  *  modify it under the terms of the GNU Lesser General Public License
   7  *  as published by the Free Software Foundation; either version 2.1
   8  *  of the License, or (at your option) any later version.
   9  *
  10  *  This library is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  *  Lesser General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU Lesser General Public
  16  *  License along with this library; if not, write to the Free
  17  *  Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
  18  *  02110-1301, USA.
  19  */
  20
  21
  22 #ifndef __GMIME_FILTER_H__
  23 #define __GMIME_FILTER_H__
  24
  25 #include <glib.h>
  26 #include <glib-object.h>
  27 #include <sys/types.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define GMIME_TYPE_FILTER            (g_mime_filter_get_type ())
  32 #define GMIME_FILTER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GMIME_TYPE_FILTER, GMimeFilter))
  33 #define GMIME_FILTER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GMIME_TYPE_FILTER, GMimeFilterClass))
  34 #define GMIME_IS_FILTER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GMIME_TYPE_FILTER))
  35 #define GMIME_IS_FILTER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GMIME_TYPE_FILTER))
  36 #define GMIME_FILTER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GMIME_TYPE_FILTER, GMimeFilterClass))
  37
  38 typedef struct _GMimeFilter GMimeFilter;
  39 typedef struct _GMimeFilterClass GMimeFilterClass;
  40
  41 /**
  42  * GMimeFilter:
  43  * @parent_object: parent #GObject
  44  * @priv: private state data
  45  * @outreal: real malloc'd buffer
  46  * @outbuf: first writable position allowed (outreal + outpre)
  47  * @outptr: current writale position
  48  * @outsize: current bytes in @outbuf
  49  * @outpre: current prespace of @outbuf
  50  * @backbuf: backup buffer
  51  * @backsize: backup buffer size
  52  * @backlen: number of bytes backed-up in @backbuf
  53  *
  54  * Base class for filters used by #GMimeStreamFilter.
  55  **/
  56 struct _GMimeFilter {
  57         GObject parent_object;
  58
  59         struct _GMimeFilterPrivate *priv;
  60
  61         /* <protected> */
  62         char *outreal;          /* real malloc'd buffer */
  63         char *outbuf;           /* first 'writable' position allowed (outreal + outpre) */
  64         char *outptr;
  65         size_t outsize;
  66         size_t outpre;          /* prespace of this buffer */
  67
  68         char *backbuf;
  69         size_t backsize;
  70         size_t backlen;         /* significant data there */
  71 };
  72
  73 struct _GMimeFilterClass {
  74         GObjectClass parent_class;
  75
  76         /* virtual functions */
  77         GMimeFilter * (* copy) (GMimeFilter *filter);
  78
  79         void (* filter)   (GMimeFilter *filter, char *inbuf, size_t inlen, size_t prespace,
  80                            char **outbuf, size_t *outlen, size_t *outprespace);
  81
  82         void (* complete) (GMimeFilter *filter, char *inbuf, size_t inlen, size_t prespace,
  83                            char **outbuf, size_t *outlen, size_t *outprespace);
  84
  85         void (* reset)    (GMimeFilter *filter);
  86 };
  87
  88
  89 GType g_mime_filter_get_type (void);
  90
  91
  92 GMimeFilter *g_mime_filter_copy (GMimeFilter *filter);
  93
  94 void g_mime_filter_filter (GMimeFilter *filter,
  95                            char *inbuf, size_t inlen, size_t prespace,
  96                            char **outbuf, size_t *outlen, size_t *outprespace);
  97
  98 void g_mime_filter_complete (GMimeFilter *filter,
  99                              char *inbuf, size_t inlen, size_t prespace,
 100                              char **outbuf, size_t *outlen, size_t *outprespace);
 101
 102 void g_mime_filter_reset (GMimeFilter *filter);
 103
 104
 105 /* sets/returns number of bytes backed up on the input */
 106 void g_mime_filter_backup (GMimeFilter *filter, const char *data, size_t length);
 107
 108 /* ensure this much size available for filter output */
 109 void g_mime_filter_set_size (GMimeFilter *filter, size_t size, gboolean keep);
 110
 111 G_END_DECLS
 112
 113 #endif /* __GMIME_FILTER_H__ */