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