gio/gmemoryoutputstream.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_MEMORY_OUTPUT_STREAM_H__
  24 #define __G_MEMORY_OUTPUT_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/goutputstream.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define G_TYPE_MEMORY_OUTPUT_STREAM         (g_memory_output_stream_get_type ())
  35 #define G_MEMORY_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_MEMORY_OUTPUT_STREAM, GMemoryOutputStream))
  36 #define G_MEMORY_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_MEMORY_OUTPUT_STREAM, GMemoryOutputStreamClass))
  37 #define G_IS_MEMORY_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_MEMORY_OUTPUT_STREAM))
  38 #define G_IS_MEMORY_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_MEMORY_OUTPUT_STREAM))
  39 #define G_MEMORY_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_MEMORY_OUTPUT_STREAM, GMemoryOutputStreamClass))
  40
  41 /**
  42  * GMemoryOutputStream:
  43  *
  44  * Implements #GOutputStream for arbitrary memory chunks.
  45  **/
  46 typedef struct _GMemoryOutputStreamClass    GMemoryOutputStreamClass;
  47 typedef struct _GMemoryOutputStreamPrivate  GMemoryOutputStreamPrivate;
  48
  49 struct _GMemoryOutputStream
  50 {
  51   GOutputStream parent_instance;
  52
  53   /*< private >*/
  54   GMemoryOutputStreamPrivate *priv;
  55 };
  56
  57 struct _GMemoryOutputStreamClass
  58 {
  59   GOutputStreamClass parent_class;
  60
  61   /*< private >*/
  62   /* Padding for future expansion */
  63   void (*_g_reserved1) (void);
  64   void (*_g_reserved2) (void);
  65   void (*_g_reserved3) (void);
  66   void (*_g_reserved4) (void);
  67   void (*_g_reserved5) (void);
  68 };
  69
  70 /**
  71  * GReallocFunc:
  72  * @data: memory block to reallocate
  73  * @size: size to reallocate @data to
  74  *
  75  * Changes the size of the memory block pointed to by @data to
  76  * @size bytes.
  77  *
  78  * The function should have the same semantics as realloc().
  79  *
  80  * Returns: a pointer to the reallocated memory
  81  */
  82 typedef gpointer (* GReallocFunc) (gpointer data,
  83                                    gsize    size);
  84
  85 GLIB_AVAILABLE_IN_ALL
  86 GType          g_memory_output_stream_get_type      (void) G_GNUC_CONST;
  87
  88 GLIB_AVAILABLE_IN_ALL
  89 GOutputStream *g_memory_output_stream_new           (gpointer             data,
  90                                                      gsize                size,
  91                                                      GReallocFunc         realloc_function,
  92                                                      GDestroyNotify       destroy_function);
  93 GLIB_AVAILABLE_IN_2_36
  94 GOutputStream *g_memory_output_stream_new_resizable (void);
  95 GLIB_AVAILABLE_IN_ALL
  96 gpointer       g_memory_output_stream_get_data      (GMemoryOutputStream *ostream);
  97 GLIB_AVAILABLE_IN_ALL
  98 gsize          g_memory_output_stream_get_size      (GMemoryOutputStream *ostream);
  99 GLIB_AVAILABLE_IN_ALL
 100 gsize          g_memory_output_stream_get_data_size (GMemoryOutputStream *ostream);
 101 GLIB_AVAILABLE_IN_ALL
 102 gpointer       g_memory_output_stream_steal_data    (GMemoryOutputStream *ostream);
 103
 104 GLIB_AVAILABLE_IN_2_34
 105 GBytes *       g_memory_output_stream_steal_as_bytes (GMemoryOutputStream *ostream);
 106
 107 G_END_DECLS
 108
 109 #endif /* __G_MEMORY_OUTPUT_STREAM_H__ */