X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=gio%2Fgmemoryoutputstream.c;h=a89701d6010dc1d0c5aa2b2541a01216743ed61d;hb=2e5bd8cf47f9e1559ccc44823a2f321b8ff8c1ea;hp=a1c581141dbb30ca382750ff601f277925859250;hpb=0debd52858ffb4f468e55cd2f3c7e4dec5455b94;p=platform%2Fupstream%2Fglib.git
diff --git a/gio/gmemoryoutputstream.c b/gio/gmemoryoutputstream.c
index a1c5811..a89701d 100644
--- a/gio/gmemoryoutputstream.c
+++ b/gio/gmemoryoutputstream.c
@@ -13,61 +13,69 @@
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
- * Public License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Public License along with this library; if not, see .
*
- * Author: Christian Kellner
+ * Authors:
+ * Christian Kellner
+ * Krzysztof KosiÅski
*/
-#include
+#include "config.h"
#include "gmemoryoutputstream.h"
#include "goutputstream.h"
+#include "gpollableoutputstream.h"
#include "gseekable.h"
-#include "gsimpleasyncresult.h"
+#include "gtask.h"
+#include "gioerror.h"
#include "string.h"
#include "glibintl.h"
-#include "gioalias.h"
/**
* SECTION:gmemoryoutputstream
* @short_description: Streaming output operations on memory chunks
- * @include: gio.h
+ * @include: gio/gio.h
* @see_also: #GMemoryInputStream
*
* #GMemoryOutputStream is a class for using arbitrary
* memory chunks as output for GIO streaming output operations.
*
+ * As of GLib 2.34, #GMemoryOutputStream trivially implements
+ * #GPollableOutputStream: it always polls as ready.
*/
-struct _GMemoryOutputStreamPrivate {
-
- GByteArray *data;
- goffset pos;
-
- guint max_size;
- guint free_data : 1;
-};
+#define MIN_ARRAY_SIZE 16
enum {
PROP_0,
PROP_DATA,
- PROP_FREE_ARRAY,
- PROP_SIZE_LIMIT
+ PROP_SIZE,
+ PROP_DATA_SIZE,
+ PROP_REALLOC_FUNCTION,
+ PROP_DESTROY_FUNCTION
};
-static void g_memory_output_stream_finalize (GObject *object);
+struct _GMemoryOutputStreamPrivate
+{
+ gpointer data; /* Write buffer */
+ gsize len; /* Current length of the data buffer. Can change with resizing. */
+ gsize valid_len; /* The part of data that has been written to */
+ gsize pos; /* Current position in the stream. Distinct from valid_len,
+ because the stream is seekable. */
+
+ GReallocFunc realloc_fn;
+ GDestroyNotify destroy;
+};
static void g_memory_output_stream_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec);
-
-static void g_memory_output_stream_get_property (GObject *object,
- guint prop_id,
- GValue *value,
- GParamSpec *pspec);
+static void g_memory_output_stream_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec);
+static void g_memory_output_stream_finalize (GObject *object);
static gssize g_memory_output_stream_write (GOutputStream *stream,
const void *buffer,
@@ -79,16 +87,6 @@ static gboolean g_memory_output_stream_close (GOutputStream *stream,
GCancellable *cancellable,
GError **error);
-static void g_memory_output_stream_write_async (GOutputStream *stream,
- const void *buffer,
- gsize count,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer data);
-static gssize g_memory_output_stream_write_finish (GOutputStream *stream,
- GAsyncResult *result,
- GError **error);
static void g_memory_output_stream_close_async (GOutputStream *stream,
int io_priority,
GCancellable *cancellable,
@@ -112,9 +110,18 @@ static gboolean g_memory_output_stream_truncate (GSeekable *see
GCancellable *cancellable,
GError **error);
+static gboolean g_memory_output_stream_is_writable (GPollableOutputStream *stream);
+static GSource *g_memory_output_stream_create_source (GPollableOutputStream *stream,
+ GCancellable *cancellable);
+
+static void g_memory_output_stream_pollable_iface_init (GPollableOutputStreamInterface *iface);
+
G_DEFINE_TYPE_WITH_CODE (GMemoryOutputStream, g_memory_output_stream, G_TYPE_OUTPUT_STREAM,
+ G_ADD_PRIVATE (GMemoryOutputStream)
G_IMPLEMENT_INTERFACE (G_TYPE_SEEKABLE,
- g_memory_output_stream_seekable_iface_init))
+ g_memory_output_stream_seekable_iface_init);
+ G_IMPLEMENT_INTERFACE (G_TYPE_POLLABLE_OUTPUT_STREAM,
+ g_memory_output_stream_pollable_iface_init))
static void
@@ -123,64 +130,183 @@ g_memory_output_stream_class_init (GMemoryOutputStreamClass *klass)
GOutputStreamClass *ostream_class;
GObjectClass *gobject_class;
- g_type_class_add_private (klass, sizeof (GMemoryOutputStreamPrivate));
-
gobject_class = G_OBJECT_CLASS (klass);
- gobject_class->finalize = g_memory_output_stream_finalize;
- gobject_class->get_property = g_memory_output_stream_get_property;
gobject_class->set_property = g_memory_output_stream_set_property;
+ gobject_class->get_property = g_memory_output_stream_get_property;
+ gobject_class->finalize = g_memory_output_stream_finalize;
ostream_class = G_OUTPUT_STREAM_CLASS (klass);
ostream_class->write_fn = g_memory_output_stream_write;
ostream_class->close_fn = g_memory_output_stream_close;
- ostream_class->write_async = g_memory_output_stream_write_async;
- ostream_class->write_finish = g_memory_output_stream_write_finish;
ostream_class->close_async = g_memory_output_stream_close_async;
ostream_class->close_finish = g_memory_output_stream_close_finish;
+ /**
+ * GMemoryOutputStream:data:
+ *
+ * Pointer to buffer where data will be written.
+ *
+ * Since: 2.24
+ **/
g_object_class_install_property (gobject_class,
PROP_DATA,
g_param_spec_pointer ("data",
- P_("Data byte array"),
- P_("The byte array used as internal storage."),
- G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
- G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
-
+ P_("Data Buffer"),
+ P_("Pointer to buffer where data will be written."),
+ G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
+ G_PARAM_STATIC_STRINGS));
+
+ /**
+ * GMemoryOutputStream:size:
+ *
+ * Current size of the data buffer.
+ *
+ * Since: 2.24
+ **/
+ g_object_class_install_property (gobject_class,
+ PROP_SIZE,
+ g_param_spec_ulong ("size",
+ P_("Data Buffer Size"),
+ P_("Current size of the data buffer."),
+ 0, G_MAXULONG, 0,
+ G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
+ G_PARAM_STATIC_STRINGS));
+
+ /**
+ * GMemoryOutputStream:data-size:
+ *
+ * Size of data written to the buffer.
+ *
+ * Since: 2.24
+ **/
+ g_object_class_install_property (gobject_class,
+ PROP_DATA_SIZE,
+ g_param_spec_ulong ("data-size",
+ P_("Data Size"),
+ P_("Size of data written to the buffer."),
+ 0, G_MAXULONG, 0,
+ G_PARAM_READABLE |
+ G_PARAM_STATIC_STRINGS));
+
+ /**
+ * GMemoryOutputStream:realloc-function: (skip)
+ *
+ * Function with realloc semantics called to enlarge the buffer.
+ *
+ * Since: 2.24
+ **/
g_object_class_install_property (gobject_class,
- PROP_FREE_ARRAY,
- g_param_spec_boolean ("free-array",
- P_("Free array data"),
- P_("Wether or not the interal array should be free on close."),
- FALSE,
- G_PARAM_READWRITE |
- G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
+ PROP_REALLOC_FUNCTION,
+ g_param_spec_pointer ("realloc-function",
+ P_("Memory Reallocation Function"),
+ P_("Function with realloc semantics called to enlarge the buffer."),
+ G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
+ G_PARAM_STATIC_STRINGS));
+
+ /**
+ * GMemoryOutputStream:destroy-function: (skip)
+ *
+ * Function called with the buffer as argument when the stream is destroyed.
+ *
+ * Since: 2.24
+ **/
g_object_class_install_property (gobject_class,
- PROP_SIZE_LIMIT,
- g_param_spec_uint ("size-limit",
- P_("Limit"),
- P_("Maximum amount of bytes that can be written to the stream."),
- 0,
- G_MAXUINT,
- 0,
- G_PARAM_READWRITE |
- G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
+ PROP_DESTROY_FUNCTION,
+ g_param_spec_pointer ("destroy-function",
+ P_("Destroy Notification Function"),
+ P_("Function called with the buffer as argument when the stream is destroyed."),
+ G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
+ G_PARAM_STATIC_STRINGS));
+}
+static void
+g_memory_output_stream_pollable_iface_init (GPollableOutputStreamInterface *iface)
+{
+ iface->is_writable = g_memory_output_stream_is_writable;
+ iface->create_source = g_memory_output_stream_create_source;
+}
+static void
+g_memory_output_stream_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec)
+{
+ GMemoryOutputStream *stream;
+ GMemoryOutputStreamPrivate *priv;
+
+ stream = G_MEMORY_OUTPUT_STREAM (object);
+ priv = stream->priv;
+
+ switch (prop_id)
+ {
+ case PROP_DATA:
+ priv->data = g_value_get_pointer (value);
+ break;
+ case PROP_SIZE:
+ priv->len = g_value_get_ulong (value);
+ break;
+ case PROP_REALLOC_FUNCTION:
+ priv->realloc_fn = g_value_get_pointer (value);
+ break;
+ case PROP_DESTROY_FUNCTION:
+ priv->destroy = g_value_get_pointer (value);
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
+}
+
+static void
+g_memory_output_stream_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec)
+{
+ GMemoryOutputStream *stream;
+ GMemoryOutputStreamPrivate *priv;
+
+ stream = G_MEMORY_OUTPUT_STREAM (object);
+ priv = stream->priv;
+
+ switch (prop_id)
+ {
+ case PROP_DATA:
+ g_value_set_pointer (value, priv->data);
+ break;
+ case PROP_SIZE:
+ g_value_set_ulong (value, priv->len);
+ break;
+ case PROP_DATA_SIZE:
+ g_value_set_ulong (value, priv->valid_len);
+ break;
+ case PROP_REALLOC_FUNCTION:
+ g_value_set_pointer (value, priv->realloc_fn);
+ break;
+ case PROP_DESTROY_FUNCTION:
+ g_value_set_pointer (value, priv->destroy);
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
}
static void
g_memory_output_stream_finalize (GObject *object)
{
GMemoryOutputStream *stream;
+ GMemoryOutputStreamPrivate *priv;
stream = G_MEMORY_OUTPUT_STREAM (object);
+ priv = stream->priv;
- if (stream->priv->free_data)
- g_byte_array_free (stream->priv->data, TRUE);
-
- if (G_OBJECT_CLASS (g_memory_output_stream_parent_class)->finalize)
- (*G_OBJECT_CLASS (g_memory_output_stream_parent_class)->finalize) (object);
+ if (priv->destroy)
+ priv->destroy (priv->data);
+
+ G_OBJECT_CLASS (g_memory_output_stream_parent_class)->finalize (object);
}
static void
@@ -190,257 +316,293 @@ g_memory_output_stream_seekable_iface_init (GSeekableIface *iface)
iface->can_seek = g_memory_output_stream_can_seek;
iface->seek = g_memory_output_stream_seek;
iface->can_truncate = g_memory_output_stream_can_truncate;
- iface->truncate_fn = g_memory_output_stream_truncate;
+ iface->truncate_fn = g_memory_output_stream_truncate;
}
static void
g_memory_output_stream_init (GMemoryOutputStream *stream)
{
- GMemoryOutputStreamPrivate *priv;
-
- stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (stream,
- G_TYPE_MEMORY_OUTPUT_STREAM,
- GMemoryOutputStreamPrivate);
-
- priv = stream->priv;
- priv->data = NULL;
+ stream->priv = g_memory_output_stream_get_instance_private (stream);
+ stream->priv->pos = 0;
+ stream->priv->valid_len = 0;
}
/**
- * g_memory_output_stream_new:
- * @data: a #GByteArray.
+ * g_memory_output_stream_new: (skip)
+ * @data: (allow-none): pointer to a chunk of memory to use, or %NULL
+ * @size: the size of @data
+ * @realloc_function: (allow-none): a function with realloc() semantics (like g_realloc())
+ * to be called when @data needs to be grown, or %NULL
+ * @destroy_function: (allow-none): a function to be called on @data when the stream is
+ * finalized, or %NULL
+ *
+ * Creates a new #GMemoryOutputStream.
+ *
+ * In most cases this is not the function you want. See
+ * g_memory_output_stream_new_resizable() instead.
+ *
+ * If @data is non-%NULL, the stream will use that for its internal storage.
*
- * Creates a new #GMemoryOutputStream. If @data is non-%NULL it will use
- * that for its internal storage otherwise it will create a new #GByteArray.
- * In both cases the internal #GByteArray can later be accessed through the
- * "data" property, or with g_memory_output_stream_get_data().
+ * If @realloc_fn is non-%NULL, it will be used for resizing the internal
+ * storage when necessary and the stream will be considered resizable.
+ * In that case, the stream will start out being (conceptually) empty.
+ * @size is used only as a hint for how big @data is. Specifically,
+ * seeking to the end of a newly-created stream will seek to zero, not
+ * @size. Seeking past the end of the stream and then writing will
+ * introduce a zero-filled gap.
*
- * Note: The new stream will not take ownership of the supplied
- * @data so you have to free it yourself after use or explicitly
- * ask for it be freed on close by setting the "free-array"
- * property to %TRUE.
+ * If @realloc_fn is %NULL then the stream is fixed-sized. Seeking to
+ * the end will seek to @size exactly. Writing past the end will give
+ * an 'out of space' error. Attempting to seek past the end will fail.
+ * Unlike the resizable case, seeking to an offset within the stream and
+ * writing will preserve the bytes passed in as @data before that point
+ * and will return them as part of g_memory_output_stream_steal_data().
+ * If you intend to seek you should probably therefore ensure that @data
+ * is properly initialised.
*
- * Return value: A newly created #GMemoryOutputStream object.
+ * It is probably only meaningful to provide @data and @size in the case
+ * that you want a fixed-sized stream. Put another way: if @realloc_fn
+ * is non-%NULL then it makes most sense to give @data as %NULL and
+ * @size as 0 (allowing #GMemoryOutputStream to do the initial
+ * allocation for itself).
+ *
+ * |[
+ * // a stream that can grow
+ * stream = g_memory_output_stream_new (NULL, 0, realloc, free);
+ *
+ * // another stream that can grow
+ * stream2 = g_memory_output_stream_new (NULL, 0, g_realloc, g_free);
+ *
+ * // a fixed-size stream
+ * data = malloc (200);
+ * stream3 = g_memory_output_stream_new (data, 200, NULL, free);
+ * ]|
+ *
+ * Returns: A newly created #GMemoryOutputStream object.
**/
GOutputStream *
-g_memory_output_stream_new (GByteArray *data)
+g_memory_output_stream_new (gpointer data,
+ gsize size,
+ GReallocFunc realloc_function,
+ GDestroyNotify destroy_function)
{
GOutputStream *stream;
- if (data == NULL)
- stream = g_object_new (G_TYPE_MEMORY_OUTPUT_STREAM, NULL);
- else
- stream = g_object_new (G_TYPE_MEMORY_OUTPUT_STREAM,
- "data", data,
- NULL);
+ stream = g_object_new (G_TYPE_MEMORY_OUTPUT_STREAM,
+ "data", data,
+ "size", size,
+ "realloc-function", realloc_function,
+ "destroy-function", destroy_function,
+ NULL);
return stream;
}
/**
- * g_memory_output_stream_set_free_data:
- * @ostream: a #GMemoryOutputStream.
- * @free_data: a #gboolean. If %TRUE, frees the data within @stream.
- *
- * Sets if the data within the @stream should be freed when the stream
- * is freed.
- **/
-void
-g_memory_output_stream_set_free_data (GMemoryOutputStream *ostream,
- gboolean free_data)
+ * g_memory_output_stream_new_resizable:
+ *
+ * Creates a new #GMemoryOutputStream, using g_realloc() and g_free()
+ * for memory allocation.
+ *
+ * Since: 2.36
+ */
+GOutputStream *
+g_memory_output_stream_new_resizable (void)
{
- GMemoryOutputStreamPrivate *priv;
-
- g_return_if_fail (G_IS_MEMORY_OUTPUT_STREAM (ostream));
-
- priv = ostream->priv;
-
- priv->free_data = free_data;
+ return g_memory_output_stream_new (NULL, 0, g_realloc, g_free);
}
/**
- * g_memory_output_stream_set_max_size:
- * @ostream: a #GMemoryOutputStream.
- * @max_size: a #guint to set as the maximum stream size.
+ * g_memory_output_stream_get_data:
+ * @ostream: a #GMemoryOutputStream
*
- * Sets a size limit on the data contained within the output stream.
+ * Gets any loaded data from the @ostream.
+ *
+ * Note that the returned pointer may become invalid on the next
+ * write or truncate operation on the stream.
+ *
+ * Returns: (transfer none): pointer to the stream's data
**/
-void
-g_memory_output_stream_set_max_size (GMemoryOutputStream *ostream,
- guint max_size)
+gpointer
+g_memory_output_stream_get_data (GMemoryOutputStream *ostream)
{
- GMemoryOutputStreamPrivate *priv;
-
- g_return_if_fail (G_IS_MEMORY_OUTPUT_STREAM (ostream));
-
- priv = ostream->priv;
-
- priv->max_size = max_size;
-
- if (priv->max_size > 0 &&
- priv->max_size < priv->data->len)
- {
-
- g_byte_array_set_size (priv->data, priv->max_size);
-
- if (priv->pos > priv->max_size)
- priv->pos = priv->max_size;
- }
+ g_return_val_if_fail (G_IS_MEMORY_OUTPUT_STREAM (ostream), NULL);
- g_object_notify (G_OBJECT (ostream), "size-limit");
+ return ostream->priv->data;
}
-static void
-g_memory_output_stream_set_property (GObject *object,
- guint prop_id,
- const GValue *value,
- GParamSpec *pspec)
+/**
+ * g_memory_output_stream_get_size:
+ * @ostream: a #GMemoryOutputStream
+ *
+ * Gets the size of the currently allocated data area (available from
+ * g_memory_output_stream_get_data()).
+ *
+ * You probably don't want to use this function on resizable streams.
+ * See g_memory_output_stream_get_data_size() instead. For resizable
+ * streams the size returned by this function is an implementation
+ * detail and may be change at any time in response to operations on the
+ * stream.
+ *
+ * If the stream is fixed-sized (ie: no realloc was passed to
+ * g_memory_output_stream_new()) then this is the maximum size of the
+ * stream and further writes will return %G_IO_ERROR_NO_SPACE.
+ *
+ * In any case, if you want the number of bytes currently written to the
+ * stream, use g_memory_output_stream_get_data_size().
+ *
+ * Returns: the number of bytes allocated for the data buffer
+ */
+gsize
+g_memory_output_stream_get_size (GMemoryOutputStream *ostream)
{
- GMemoryOutputStream *ostream;
- GMemoryOutputStreamPrivate *priv;
- GByteArray *data;
- guint max_size;
-
- ostream = G_MEMORY_OUTPUT_STREAM (object);
- priv = ostream->priv;
+ g_return_val_if_fail (G_IS_MEMORY_OUTPUT_STREAM (ostream), 0);
- switch (prop_id)
- {
- case PROP_DATA:
-
- if (priv->data && priv->free_data)
- g_byte_array_free (priv->data, TRUE);
-
- data = g_value_get_pointer (value);
-
- if (data == NULL)
- {
- data = g_byte_array_new ();
- priv->free_data = TRUE;
- }
- else
- priv->free_data = FALSE;
-
- priv->data = data;
- priv->pos = 0;
- g_object_notify (G_OBJECT (ostream), "data");
- break;
-
- case PROP_FREE_ARRAY:
- priv->free_data = g_value_get_boolean (value);
- break;
-
- case PROP_SIZE_LIMIT:
- max_size = g_value_get_uint (value);
- g_memory_output_stream_set_max_size (ostream, max_size);
- break;
-
- default:
- G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
- break;
- }
+ return ostream->priv->len;
}
-static void
-g_memory_output_stream_get_property (GObject *object,
- guint prop_id,
- GValue *value,
- GParamSpec *pspec)
+/**
+ * g_memory_output_stream_get_data_size:
+ * @ostream: a #GMemoryOutputStream
+ *
+ * Returns the number of bytes from the start up to including the last
+ * byte written in the stream that has not been truncated away.
+ *
+ * Returns: the number of bytes written to the stream
+ *
+ * Since: 2.18
+ */
+gsize
+g_memory_output_stream_get_data_size (GMemoryOutputStream *ostream)
{
- GMemoryOutputStream *ostream;
- GMemoryOutputStreamPrivate *priv;
+ g_return_val_if_fail (G_IS_MEMORY_OUTPUT_STREAM (ostream), 0);
- ostream = G_MEMORY_OUTPUT_STREAM (object);
- priv = ostream->priv;
+ return ostream->priv->valid_len;
+}
- switch (prop_id)
- {
- case PROP_DATA:
- g_value_set_pointer (value, priv->data);
- break;
+/**
+ * g_memory_output_stream_steal_data:
+ * @ostream: a #GMemoryOutputStream
+ *
+ * Gets any loaded data from the @ostream. Ownership of the data
+ * is transferred to the caller; when no longer needed it must be
+ * freed using the free function set in @ostream's
+ * #GMemoryOutputStream:destroy-function property.
+ *
+ * @ostream must be closed before calling this function.
+ *
+ * Returns: (transfer full): the stream's data
+ *
+ * Since: 2.26
+ **/
+gpointer
+g_memory_output_stream_steal_data (GMemoryOutputStream *ostream)
+{
+ gpointer data;
- case PROP_FREE_ARRAY:
- g_value_set_boolean (value, priv->free_data);
- break;
+ g_return_val_if_fail (G_IS_MEMORY_OUTPUT_STREAM (ostream), NULL);
+ g_return_val_if_fail (g_output_stream_is_closed (G_OUTPUT_STREAM (ostream)), NULL);
- case PROP_SIZE_LIMIT:
- g_value_set_uint (value, priv->max_size);
- break;
+ data = ostream->priv->data;
+ ostream->priv->data = NULL;
- default:
- G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
- break;
- }
+ return data;
}
/**
- * g_memory_output_stream_get_data:
+ * g_memory_output_stream_steal_as_bytes:
* @ostream: a #GMemoryOutputStream
*
- * Gets any loaded data from the @ostream.
- *
- * Returns: #GByteArray of the stream's data.
+ * Returns data from the @ostream as a #GBytes. @ostream must be
+ * closed before calling this function.
+ *
+ * Returns: (transfer full): the stream's data
+ *
+ * Since: 2.34
**/
-GByteArray *
-g_memory_output_stream_get_data (GMemoryOutputStream *ostream)
+GBytes *
+g_memory_output_stream_steal_as_bytes (GMemoryOutputStream *ostream)
{
+ GBytes *result;
+
g_return_val_if_fail (G_IS_MEMORY_OUTPUT_STREAM (ostream), NULL);
+ g_return_val_if_fail (g_output_stream_is_closed (G_OUTPUT_STREAM (ostream)), NULL);
- return ostream->priv->data;
-}
+ result = g_bytes_new_with_free_func (ostream->priv->data,
+ ostream->priv->valid_len,
+ ostream->priv->destroy,
+ ostream->priv->data);
+ ostream->priv->data = NULL;
+ return result;
+}
static gboolean
-array_check_boundary (GMemoryOutputStream *stream,
- goffset size,
- GError **error)
+array_resize (GMemoryOutputStream *ostream,
+ gsize size,
+ gboolean allow_partial,
+ GError **error)
{
GMemoryOutputStreamPrivate *priv;
+ gpointer data;
+ gsize len;
- priv = stream->priv;
+ priv = ostream->priv;
- if (!priv->max_size)
+ if (priv->len == size)
return TRUE;
- if (priv->max_size < size || size > G_MAXUINT)
+ if (!priv->realloc_fn)
{
- g_set_error (error,
- G_IO_ERROR,
- G_IO_ERROR_FAILED,
- "Reached maximum data array limit");
-
+ if (allow_partial &&
+ priv->pos < priv->len)
+ return TRUE; /* Short write */
+
+ g_set_error_literal (error,
+ G_IO_ERROR,
+ G_IO_ERROR_NO_SPACE,
+ _("Memory output stream not resizable"));
return FALSE;
}
- return TRUE;
-}
+ len = priv->len;
+ data = priv->realloc_fn (priv->data, size);
-static gssize
-array_resize (GMemoryOutputStream *stream,
- goffset size,
- GError **error)
-{
- GMemoryOutputStreamPrivate *priv;
- guint old_len;
+ if (size > 0 && !data)
+ {
+ if (allow_partial &&
+ priv->pos < priv->len)
+ return TRUE; /* Short write */
+
+ g_set_error_literal (error,
+ G_IO_ERROR,
+ G_IO_ERROR_NO_SPACE,
+ _("Failed to resize memory output stream"));
+ return FALSE;
+ }
- priv = stream->priv;
+ if (size > len)
+ memset ((guint8 *)data + len, 0, size - len);
- if (! array_check_boundary (stream, size, error))
- return -1;
-
+ priv->data = data;
+ priv->len = size;
- if (priv->data->len == size)
- return priv->data->len - priv->pos;
-
+ if (priv->len < priv->valid_len)
+ priv->valid_len = priv->len;
- old_len = priv->data->len;
- g_byte_array_set_size (priv->data, size);
+ return TRUE;
+}
- if (size > old_len && priv->pos > old_len)
- memset (priv->data->data + priv->pos, 0, size - old_len);
+static gsize
+g_nearest_pow (gsize num)
+{
+ gsize n = 1;
+
+ while (n < num && n > 0)
+ n <<= 1;
- return priv->data->len - priv->pos;
+ return n;
}
static gssize
@@ -452,43 +614,63 @@ g_memory_output_stream_write (GOutputStream *stream,
{
GMemoryOutputStream *ostream;
GMemoryOutputStreamPrivate *priv;
- gsize new_size;
- gssize n;
guint8 *dest;
+ gsize new_size;
ostream = G_MEMORY_OUTPUT_STREAM (stream);
priv = ostream->priv;
- /* count < 0 is ensured by GOutputStream */
+ if (count == 0)
+ return 0;
- n = MIN (count, priv->data->len - priv->pos);
+ /* Check for address space overflow, but only if the buffer is resizable.
+ Otherwise we just do a short write and don't worry. */
+ if (priv->realloc_fn && priv->pos + count < priv->pos)
+ goto overflow;
- if (n < 1)
+ if (priv->pos + count > priv->len)
{
- new_size = priv->pos + count;
+ /* At least enough to fit the write, rounded up for greater than
+ * linear growth.
+ *
+ * Assuming that we're using something like realloc(), the kernel
+ * will overcommit memory to us, so doubling the size each time
+ * will keep the number of realloc calls low without wasting too
+ * much memory.
+ */
+ new_size = g_nearest_pow (priv->pos + count);
+ /* Check for overflow again. We have checked if
+ pos + count > G_MAXSIZE, but now check if g_nearest_pow () has
+ overflowed */
+ if (new_size == 0)
+ goto overflow;
+
+ new_size = MAX (new_size, MIN_ARRAY_SIZE);
+ if (!array_resize (ostream, new_size, TRUE, error))
+ return -1;
+ }
- if (priv->max_size > 0)
- new_size = MIN (new_size, priv->max_size);
+ /* Make sure we handle short writes if the array_resize
+ only added part of the required memory */
+ count = MIN (count, priv->len - priv->pos);
- n = array_resize (ostream, new_size, error);
+ dest = (guint8 *)priv->data + priv->pos;
+ memcpy (dest, buffer, count);
+ priv->pos += count;
- if (n == 0)
- {
- g_set_error (error,
- G_IO_ERROR,
- G_IO_ERROR_FAILED,
- "Reached maximum data array limit");
- return -1;
- }
- else if (n < 0)
- return -1;
- }
+ if (priv->pos > priv->valid_len)
+ priv->valid_len = priv->pos;
- dest = priv->data->data + priv->pos;
- memcpy (dest, buffer, n);
- priv->pos += n;
+ return count;
- return n;
+ overflow:
+ /* Overflow: buffer size would need to be bigger than G_MAXSIZE. */
+ g_set_error_literal (error,
+ G_IO_ERROR,
+ G_IO_ERROR_NO_SPACE,
+ _("Amount of memory required to process the write is "
+ "larger than available address space"));
+ return -1;
}
static gboolean
@@ -496,81 +678,25 @@ g_memory_output_stream_close (GOutputStream *stream,
GCancellable *cancellable,
GError **error)
{
- GMemoryOutputStream *ostream;
- GMemoryOutputStreamPrivate *priv;
-
- ostream = G_MEMORY_OUTPUT_STREAM (stream);
- priv = ostream->priv;
-
return TRUE;
}
static void
-g_memory_output_stream_write_async (GOutputStream *stream,
- const void *buffer,
- gsize count,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer data)
+g_memory_output_stream_close_async (GOutputStream *stream,
+ int io_priority,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer data)
{
- GSimpleAsyncResult *simple;
- gssize nwritten;
-
- nwritten = g_memory_output_stream_write (stream,
- buffer,
- count,
- cancellable,
- NULL);
-
-
- simple = g_simple_async_result_new (G_OBJECT (stream),
- callback,
- data,
- g_memory_output_stream_write_async);
-
- g_simple_async_result_set_op_res_gssize (simple, nwritten);
- g_simple_async_result_complete_in_idle (simple);
- g_object_unref (simple);
-}
-
-static gssize
-g_memory_output_stream_write_finish (GOutputStream *stream,
- GAsyncResult *result,
- GError **error)
-{
- GSimpleAsyncResult *simple;
- gssize nwritten;
-
- simple = G_SIMPLE_ASYNC_RESULT (result);
-
- g_warn_if_fail (g_simple_async_result_get_source_tag (simple) ==
- g_memory_output_stream_write_async);
-
- nwritten = g_simple_async_result_get_op_res_gssize (simple);
- return nwritten;
-}
-
-static void
-g_memory_output_stream_close_async (GOutputStream *stream,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer data)
-{
- GSimpleAsyncResult *simple;
-
- simple = g_simple_async_result_new (G_OBJECT (stream),
- callback,
- data,
- g_memory_output_stream_close_async);
+ GTask *task;
+ task = g_task_new (stream, cancellable, callback, data);
/* will always return TRUE */
g_memory_output_stream_close (stream, cancellable, NULL);
-
- g_simple_async_result_complete_in_idle (simple);
- g_object_unref (simple);
+
+ g_task_return_boolean (task, TRUE);
+ g_object_unref (task);
}
static gboolean
@@ -578,14 +704,9 @@ g_memory_output_stream_close_finish (GOutputStream *stream,
GAsyncResult *result,
GError **error)
{
- GSimpleAsyncResult *simple;
-
- simple = G_SIMPLE_ASYNC_RESULT (result);
+ g_return_val_if_fail (g_task_is_valid (result, stream), FALSE);
- g_warn_if_fail (g_simple_async_result_get_source_tag (simple) ==
- g_memory_output_stream_close_async);
-
- return TRUE;
+ return g_task_propagate_boolean (G_TASK (result), error);
}
static goffset
@@ -608,10 +729,10 @@ g_memory_output_stream_can_seek (GSeekable *seekable)
static gboolean
g_memory_output_stream_seek (GSeekable *seekable,
- goffset offset,
- GSeekType type,
- GCancellable *cancellable,
- GError **error)
+ goffset offset,
+ GSeekType type,
+ GCancellable *cancellable,
+ GError **error)
{
GMemoryOutputStream *stream;
GMemoryOutputStreamPrivate *priv;
@@ -620,7 +741,7 @@ g_memory_output_stream_seek (GSeekable *seekable,
stream = G_MEMORY_OUTPUT_STREAM (seekable);
priv = stream->priv;
- switch (type)
+ switch (type)
{
case G_SEEK_CUR:
absolute = priv->pos + offset;
@@ -631,29 +752,48 @@ g_memory_output_stream_seek (GSeekable *seekable,
break;
case G_SEEK_END:
- absolute = priv->data->len + offset;
+ /* For resizable streams, we consider the end to be the data
+ * length. For fixed-sized streams, we consider the end to be the
+ * size of the buffer.
+ */
+ if (priv->realloc_fn)
+ absolute = priv->valid_len + offset;
+ else
+ absolute = priv->len + offset;
break;
-
+
default:
- g_set_error (error,
- G_IO_ERROR,
- G_IO_ERROR_INVALID_ARGUMENT,
- "Invalid GSeekType supplied");
+ g_set_error_literal (error,
+ G_IO_ERROR,
+ G_IO_ERROR_INVALID_ARGUMENT,
+ _("Invalid GSeekType supplied"));
return FALSE;
}
- if (absolute < 0)
+ if (absolute < 0)
{
- g_set_error (error,
- G_IO_ERROR,
- G_IO_ERROR_INVALID_ARGUMENT,
- "Invalid seek request");
+ g_set_error_literal (error,
+ G_IO_ERROR,
+ G_IO_ERROR_INVALID_ARGUMENT,
+ _("Requested seek before the beginning of the stream"));
return FALSE;
}
- if (!array_check_boundary (stream, absolute, error))
- return FALSE;
+ /* Can't seek past the end of a fixed-size stream.
+ *
+ * Note: seeking to the non-existent byte at the end of a fixed-sized
+ * stream is valid (eg: a 1-byte fixed sized stream can have position
+ * 0 or 1). Therefore '>' is what we want.
+ * */
+ if (priv->realloc_fn == NULL && absolute > priv->len)
+ {
+ g_set_error_literal (error,
+ G_IO_ERROR,
+ G_IO_ERROR_INVALID_ARGUMENT,
+ _("Requested seek beyond the end of the stream"));
+ return FALSE;
+ }
priv->pos = absolute;
@@ -663,7 +803,14 @@ g_memory_output_stream_seek (GSeekable *seekable,
static gboolean
g_memory_output_stream_can_truncate (GSeekable *seekable)
{
- return TRUE;
+ GMemoryOutputStream *ostream;
+ GMemoryOutputStreamPrivate *priv;
+
+ ostream = G_MEMORY_OUTPUT_STREAM (seekable);
+ priv = ostream->priv;
+
+ /* We do not allow truncation of fixed-sized streams */
+ return priv->realloc_fn != NULL;
}
static gboolean
@@ -672,17 +819,31 @@ g_memory_output_stream_truncate (GSeekable *seekable,
GCancellable *cancellable,
GError **error)
{
- GMemoryOutputStream *ostream;
- GMemoryOutputStreamPrivate *priv;
+ GMemoryOutputStream *ostream = G_MEMORY_OUTPUT_STREAM (seekable);
- ostream = G_MEMORY_OUTPUT_STREAM (seekable);
- priv = ostream->priv;
-
- if (array_resize (ostream, offset, error) < 0)
+ if (!array_resize (ostream, offset, FALSE, error))
return FALSE;
+ ostream->priv->valid_len = offset;
+
+ return TRUE;
+}
+
+static gboolean
+g_memory_output_stream_is_writable (GPollableOutputStream *stream)
+{
return TRUE;
}
-#define __G_MEMORY_OUTPUT_STREAM_C__
-#include "gioaliasdef.c"
+static GSource *
+g_memory_output_stream_create_source (GPollableOutputStream *stream,
+ GCancellable *cancellable)
+{
+ GSource *base_source, *pollable_source;
+
+ base_source = g_timeout_source_new (0);
+ pollable_source = g_pollable_source_new_full (stream, base_source, cancellable);
+ g_source_unref (base_source);
+
+ return pollable_source;
+}