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