1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD 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
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module gio.MemoryOutputStream;
26 
27 private import gio.OutputStream;
28 private import gio.PollableOutputStreamIF;
29 private import gio.PollableOutputStreamT;
30 private import gio.SeekableIF;
31 private import gio.SeekableT;
32 private import gio.c.functions;
33 public  import gio.c.types;
34 private import glib.Bytes;
35 private import glib.ConstructionException;
36 private import gobject.ObjectG;
37 public  import gtkc.giotypes;
38 
39 
40 /**
41  * #GMemoryOutputStream is a class for using arbitrary
42  * memory chunks as output for GIO streaming output operations.
43  * 
44  * As of GLib 2.34, #GMemoryOutputStream trivially implements
45  * #GPollableOutputStream: it always polls as ready.
46  */
47 public class MemoryOutputStream : OutputStream, PollableOutputStreamIF, SeekableIF
48 {
49 	/** the main Gtk struct */
50 	protected GMemoryOutputStream* gMemoryOutputStream;
51 
52 	/** Get the main Gtk struct */
53 	public GMemoryOutputStream* getMemoryOutputStreamStruct(bool transferOwnership = false)
54 	{
55 		if (transferOwnership)
56 			ownedRef = false;
57 		return gMemoryOutputStream;
58 	}
59 
60 	/** the main Gtk struct as a void* */
61 	protected override void* getStruct()
62 	{
63 		return cast(void*)gMemoryOutputStream;
64 	}
65 
66 	/**
67 	 * Sets our main struct and passes it to the parent class.
68 	 */
69 	public this (GMemoryOutputStream* gMemoryOutputStream, bool ownedRef = false)
70 	{
71 		this.gMemoryOutputStream = gMemoryOutputStream;
72 		super(cast(GOutputStream*)gMemoryOutputStream, ownedRef);
73 	}
74 
75 	// add the PollableOutputStream capabilities
76 	mixin PollableOutputStreamT!(GMemoryOutputStream);
77 
78 	// add the Seekable capabilities
79 	mixin SeekableT!(GMemoryOutputStream);
80 
81 
82 	/** */
83 	public static GType getType()
84 	{
85 		return g_memory_output_stream_get_type();
86 	}
87 
88 	/**
89 	 * Creates a new #GMemoryOutputStream.
90 	 *
91 	 * In most cases this is not the function you want.  See
92 	 * g_memory_output_stream_new_resizable() instead.
93 	 *
94 	 * If @data is non-%NULL, the stream will use that for its internal storage.
95 	 *
96 	 * If @realloc_fn is non-%NULL, it will be used for resizing the internal
97 	 * storage when necessary and the stream will be considered resizable.
98 	 * In that case, the stream will start out being (conceptually) empty.
99 	 * @size is used only as a hint for how big @data is.  Specifically,
100 	 * seeking to the end of a newly-created stream will seek to zero, not
101 	 * @size.  Seeking past the end of the stream and then writing will
102 	 * introduce a zero-filled gap.
103 	 *
104 	 * If @realloc_fn is %NULL then the stream is fixed-sized.  Seeking to
105 	 * the end will seek to @size exactly.  Writing past the end will give
106 	 * an 'out of space' error.  Attempting to seek past the end will fail.
107 	 * Unlike the resizable case, seeking to an offset within the stream and
108 	 * writing will preserve the bytes passed in as @data before that point
109 	 * and will return them as part of g_memory_output_stream_steal_data().
110 	 * If you intend to seek you should probably therefore ensure that @data
111 	 * is properly initialised.
112 	 *
113 	 * It is probably only meaningful to provide @data and @size in the case
114 	 * that you want a fixed-sized stream.  Put another way: if @realloc_fn
115 	 * is non-%NULL then it makes most sense to give @data as %NULL and
116 	 * @size as 0 (allowing #GMemoryOutputStream to do the initial
117 	 * allocation for itself).
118 	 *
119 	 * |[<!-- language="C" -->
120 	 * // a stream that can grow
121 	 * stream = g_memory_output_stream_new (NULL, 0, realloc, free);
122 	 *
123 	 * // another stream that can grow
124 	 * stream2 = g_memory_output_stream_new (NULL, 0, g_realloc, g_free);
125 	 *
126 	 * // a fixed-size stream
127 	 * data = malloc (200);
128 	 * stream3 = g_memory_output_stream_new (data, 200, NULL, free);
129 	 * ]|
130 	 *
131 	 * Params:
132 	 *     data = pointer to a chunk of memory to use, or %NULL
133 	 *     size = the size of @data
134 	 *     reallocFunction = a function with realloc() semantics (like g_realloc())
135 	 *         to be called when @data needs to be grown, or %NULL
136 	 *     destroyFunction = a function to be called on @data when the stream is
137 	 *         finalized, or %NULL
138 	 *
139 	 * Returns: A newly created #GMemoryOutputStream object.
140 	 *
141 	 * Throws: ConstructionException GTK+ fails to create the object.
142 	 */
143 	public this(void* data, size_t size, GReallocFunc reallocFunction, GDestroyNotify destroyFunction)
144 	{
145 		auto p = g_memory_output_stream_new(data, size, reallocFunction, destroyFunction);
146 
147 		if(p is null)
148 		{
149 			throw new ConstructionException("null returned by new");
150 		}
151 
152 		this(cast(GMemoryOutputStream*) p, true);
153 	}
154 
155 	/**
156 	 * Creates a new #GMemoryOutputStream, using g_realloc() and g_free()
157 	 * for memory allocation.
158 	 *
159 	 * Since: 2.36
160 	 *
161 	 * Throws: ConstructionException GTK+ fails to create the object.
162 	 */
163 	public this()
164 	{
165 		auto p = g_memory_output_stream_new_resizable();
166 
167 		if(p is null)
168 		{
169 			throw new ConstructionException("null returned by new_resizable");
170 		}
171 
172 		this(cast(GMemoryOutputStream*) p, true);
173 	}
174 
175 	/**
176 	 * Gets any loaded data from the @ostream.
177 	 *
178 	 * Note that the returned pointer may become invalid on the next
179 	 * write or truncate operation on the stream.
180 	 *
181 	 * Returns: pointer to the stream's data, or %NULL if the data
182 	 *     has been stolen
183 	 */
184 	public void* getData()
185 	{
186 		return g_memory_output_stream_get_data(gMemoryOutputStream);
187 	}
188 
189 	/**
190 	 * Returns the number of bytes from the start up to including the last
191 	 * byte written in the stream that has not been truncated away.
192 	 *
193 	 * Returns: the number of bytes written to the stream
194 	 *
195 	 * Since: 2.18
196 	 */
197 	public size_t getDataSize()
198 	{
199 		return g_memory_output_stream_get_data_size(gMemoryOutputStream);
200 	}
201 
202 	/**
203 	 * Gets the size of the currently allocated data area (available from
204 	 * g_memory_output_stream_get_data()).
205 	 *
206 	 * You probably don't want to use this function on resizable streams.
207 	 * See g_memory_output_stream_get_data_size() instead.  For resizable
208 	 * streams the size returned by this function is an implementation
209 	 * detail and may be change at any time in response to operations on the
210 	 * stream.
211 	 *
212 	 * If the stream is fixed-sized (ie: no realloc was passed to
213 	 * g_memory_output_stream_new()) then this is the maximum size of the
214 	 * stream and further writes will return %G_IO_ERROR_NO_SPACE.
215 	 *
216 	 * In any case, if you want the number of bytes currently written to the
217 	 * stream, use g_memory_output_stream_get_data_size().
218 	 *
219 	 * Returns: the number of bytes allocated for the data buffer
220 	 */
221 	public size_t getSize()
222 	{
223 		return g_memory_output_stream_get_size(gMemoryOutputStream);
224 	}
225 
226 	/**
227 	 * Returns data from the @ostream as a #GBytes. @ostream must be
228 	 * closed before calling this function.
229 	 *
230 	 * Returns: the stream's data
231 	 *
232 	 * Since: 2.34
233 	 */
234 	public Bytes stealAsBytes()
235 	{
236 		auto p = g_memory_output_stream_steal_as_bytes(gMemoryOutputStream);
237 
238 		if(p is null)
239 		{
240 			return null;
241 		}
242 
243 		return new Bytes(cast(GBytes*) p, true);
244 	}
245 
246 	/**
247 	 * Gets any loaded data from the @ostream. Ownership of the data
248 	 * is transferred to the caller; when no longer needed it must be
249 	 * freed using the free function set in @ostream's
250 	 * #GMemoryOutputStream:destroy-function property.
251 	 *
252 	 * @ostream must be closed before calling this function.
253 	 *
254 	 * Returns: the stream's data, or %NULL if it has previously
255 	 *     been stolen
256 	 *
257 	 * Since: 2.26
258 	 */
259 	public void* stealData()
260 	{
261 		return g_memory_output_stream_steal_data(gMemoryOutputStream);
262 	}
263 }