glib-2.0/gio/gmemoryoutputstream.h

0001 /* GIO - GLib Input, Output and Streaming Library
0002  *
0003  * Copyright (C) 2006-2007 Red Hat, Inc.
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General
0018  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  *
0020  * Author: Christian Kellner <gicmo@gnome.org>
0021  */
0022
0023 #ifndef __G_MEMORY_OUTPUT_STREAM_H__
0024 #define __G_MEMORY_OUTPUT_STREAM_H__
0025
0026 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
0027 #error "Only <gio/gio.h> can be included directly."
0028 #endif
0029
0030 #include <gio/goutputstream.h>
0031
0032 G_BEGIN_DECLS
0033
0034 #define G_TYPE_MEMORY_OUTPUT_STREAM         (g_memory_output_stream_get_type ())
0035 #define G_MEMORY_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_MEMORY_OUTPUT_STREAM, GMemoryOutputStream))
0036 #define G_MEMORY_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_MEMORY_OUTPUT_STREAM, GMemoryOutputStreamClass))
0037 #define G_IS_MEMORY_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_MEMORY_OUTPUT_STREAM))
0038 #define G_IS_MEMORY_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_MEMORY_OUTPUT_STREAM))
0039 #define G_MEMORY_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_MEMORY_OUTPUT_STREAM, GMemoryOutputStreamClass))
0040
0041 typedef struct _GMemoryOutputStreamClass    GMemoryOutputStreamClass;
0042 typedef struct _GMemoryOutputStreamPrivate  GMemoryOutputStreamPrivate;
0043
0044 struct _GMemoryOutputStream
0045 {
0046   GOutputStream parent_instance;
0047
0048   /*< private >*/
0049   GMemoryOutputStreamPrivate *priv;
0050 };
0051
0052 struct _GMemoryOutputStreamClass
0053 {
0054   GOutputStreamClass parent_class;
0055
0056   /*< private >*/
0057   /* Padding for future expansion */
0058   void (*_g_reserved1) (void);
0059   void (*_g_reserved2) (void);
0060   void (*_g_reserved3) (void);
0061   void (*_g_reserved4) (void);
0062   void (*_g_reserved5) (void);
0063 };
0064
0065 /**
0066  * GReallocFunc:
0067  * @data: memory block to reallocate
0068  * @size: size to reallocate @data to
0069  *
0070  * Changes the size of the memory block pointed to by @data to
0071  * @size bytes.
0072  *
0073  * The function should have the same semantics as realloc().
0074  *
0075  * Returns: a pointer to the reallocated memory
0076  */
0077 typedef gpointer (* GReallocFunc) (gpointer data,
0078                                    gsize    size);
0079
0080 GIO_AVAILABLE_IN_ALL
0081 GType          g_memory_output_stream_get_type      (void) G_GNUC_CONST;
0082
0083 GIO_AVAILABLE_IN_ALL
0084 GOutputStream *g_memory_output_stream_new           (gpointer             data,
0085                                                      gsize                size,
0086                                                      GReallocFunc         realloc_function,
0087                                                      GDestroyNotify       destroy_function);
0088 GIO_AVAILABLE_IN_2_36
0089 GOutputStream *g_memory_output_stream_new_resizable (void);
0090 GIO_AVAILABLE_IN_ALL
0091 gpointer       g_memory_output_stream_get_data      (GMemoryOutputStream *ostream);
0092 GIO_AVAILABLE_IN_ALL
0093 gsize          g_memory_output_stream_get_size      (GMemoryOutputStream *ostream);
0094 GIO_AVAILABLE_IN_ALL
0095 gsize          g_memory_output_stream_get_data_size (GMemoryOutputStream *ostream);
0096 GIO_AVAILABLE_IN_ALL
0097 gpointer       g_memory_output_stream_steal_data    (GMemoryOutputStream *ostream);
0098
0099 GIO_AVAILABLE_IN_2_34
0100 GBytes *       g_memory_output_stream_steal_as_bytes (GMemoryOutputStream *ostream);
0101
0102 G_END_DECLS
0103
0104 #endif /* __G_MEMORY_OUTPUT_STREAM_H__ */