gio/gfilterinputstream.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   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
   7  * License as published by the Free Software Foundation; either
   8  * version 2 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
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Christian Kellner <gicmo@gnome.org>
  21  */
  22
  23 #ifndef __G_FILTER_INPUT_STREAM_H__
  24 #define __G_FILTER_INPUT_STREAM_H__
  25
  26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  29
  30 #include <gio/ginputstream.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define G_TYPE_FILTER_INPUT_STREAM         (g_filter_input_stream_get_type ())
  35 #define G_FILTER_INPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILTER_INPUT_STREAM, GFilterInputStream))
  36 #define G_FILTER_INPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILTER_INPUT_STREAM, GFilterInputStreamClass))
  37 #define G_IS_FILTER_INPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILTER_INPUT_STREAM))
  38 #define G_IS_FILTER_INPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILTER_INPUT_STREAM))
  39 #define G_FILTER_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILTER_INPUT_STREAM, GFilterInputStreamClass))
  40
  41 /**
  42  * GFilterInputStream:
  43  *
  44  * A base class for all input streams that work on an underlying stream.
  45  **/
  46 typedef struct _GFilterInputStreamClass    GFilterInputStreamClass;
  47
  48 struct _GFilterInputStream
  49 {
  50   GInputStream parent_instance;
  51
  52   /*<protected >*/
  53   GInputStream *base_stream;
  54 };
  55
  56 struct _GFilterInputStreamClass
  57 {
  58   GInputStreamClass parent_class;
  59
  60   /*< private >*/
  61   /* Padding for future expansion */
  62   void (*_g_reserved1) (void);
  63   void (*_g_reserved2) (void);
  64   void (*_g_reserved3) (void);
  65 };
  66
  67
  68 GLIB_AVAILABLE_IN_ALL
  69 GType          g_filter_input_stream_get_type              (void) G_GNUC_CONST;
  70 GLIB_AVAILABLE_IN_ALL
  71 GInputStream * g_filter_input_stream_get_base_stream       (GFilterInputStream *stream);
  72 GLIB_AVAILABLE_IN_ALL
  73 gboolean       g_filter_input_stream_get_close_base_stream (GFilterInputStream *stream);
  74 GLIB_AVAILABLE_IN_ALL
  75 void           g_filter_input_stream_set_close_base_stream (GFilterInputStream *stream,
  76                                                             gboolean            close_base);
  77
  78 G_END_DECLS
  79
  80 #endif /* __G_FILTER_INPUT_STREAM_H__ */