glib/gio/gmemoryinputstream.c
A. Walton ab69ee2945 More documentation cleanup and filling in missing information, bringing
2007-12-09  A. Walton  <awalton@svn.gnome.org>

	* gdesktopappinfo.c:
	* gdrive.c:
	* gdrive.h:
	* gfile.c:
	* gfile.h:
	* gfileattribute.c:
	* gfileenumerator.c:
	* gioerror.c:
	* gioscheduler.c:
	* gioscheduler.h:
	* gloadableicon.c:
	* gmemoryinputstream.c:
	* gmemoryoutputstream.c:
	* goutputstream.h:
	* gsimpleasyncresult.c:
	More documentation cleanup and filling in missing information, 
bringing
	GIO to 99% symbol coverage.

svn path=/trunk/; revision=6077
2007-12-09 15:51:12 +00:00

482 lines
15 KiB
C

/* GIO - GLib Input, Output and Streaming Library
*
* Copyright (C) 2006-2007 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* 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.
*
* Author: Christian Kellner <gicmo@gnome.org>
*/
#include <config.h>
#include "gmemoryinputstream.h"
#include "ginputstream.h"
#include "gseekable.h"
#include "string.h"
#include "gsimpleasyncresult.h"
#include "glibintl.h"
#include "gioalias.h"
/**
* SECTION:gmemoryinputstream
* @short_description: Streaming input operations on memory chunks
* @see_also: #GMemoryOutputStream
*
* #GMemoryInputStream is a class for using arbitrary
* memory chunks as input for GIO streaming input operations.
*
*/
struct _GMemoryInputStreamPrivate {
guint8 *buffer;
gsize pos;
gsize len;
gboolean free_data;
};
static gssize g_memory_input_stream_read (GInputStream *stream,
void *buffer,
gsize count,
GCancellable *cancellable,
GError **error);
static gssize g_memory_input_stream_skip (GInputStream *stream,
gsize count,
GCancellable *cancellable,
GError **error);
static gboolean g_memory_input_stream_close (GInputStream *stream,
GCancellable *cancellable,
GError **error);
static void g_memory_input_stream_read_async (GInputStream *stream,
void *buffer,
gsize count,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
static gssize g_memory_input_stream_read_finish (GInputStream *stream,
GAsyncResult *result,
GError **error);
static void g_memory_input_stream_skip_async (GInputStream *stream,
gsize count,
int io_priority,
GCancellable *cancellabl,
GAsyncReadyCallback callback,
gpointer datae);
static gssize g_memory_input_stream_skip_finish (GInputStream *stream,
GAsyncResult *result,
GError **error);
static void g_memory_input_stream_close_async (GInputStream *stream,
int io_priority,
GCancellable *cancellabl,
GAsyncReadyCallback callback,
gpointer data);
static gboolean g_memory_input_stream_close_finish (GInputStream *stream,
GAsyncResult *result,
GError **error);
static void g_memory_input_stream_seekable_iface_init (GSeekableIface *iface);
static goffset g_memory_input_stream_tell (GSeekable *seekable);
static gboolean g_memory_input_stream_can_seek (GSeekable *seekable);
static gboolean g_memory_input_stream_seek (GSeekable *seekable,
goffset offset,
GSeekType type,
GCancellable *cancellable,
GError **error);
static gboolean g_memory_input_stream_can_truncate (GSeekable *seekable);
static gboolean g_memory_input_stream_truncate (GSeekable *seekable,
goffset offset,
GCancellable *cancellable,
GError **error);
static void g_memory_input_stream_finalize (GObject *object);
G_DEFINE_TYPE_WITH_CODE (GMemoryInputStream, g_memory_input_stream, G_TYPE_INPUT_STREAM,
G_IMPLEMENT_INTERFACE (G_TYPE_SEEKABLE,
g_memory_input_stream_seekable_iface_init))
static void
g_memory_input_stream_class_init (GMemoryInputStreamClass *klass)
{
GObjectClass *object_class;
GInputStreamClass *istream_class;
g_type_class_add_private (klass, sizeof (GMemoryInputStreamPrivate));
object_class = G_OBJECT_CLASS (klass);
object_class->finalize = g_memory_input_stream_finalize;
istream_class = G_INPUT_STREAM_CLASS (klass);
istream_class->read_fn = g_memory_input_stream_read;
istream_class->skip = g_memory_input_stream_skip;
istream_class->close_fn = g_memory_input_stream_close;
istream_class->read_async = g_memory_input_stream_read_async;
istream_class->read_finish = g_memory_input_stream_read_finish;
istream_class->skip_async = g_memory_input_stream_skip_async;
istream_class->skip_finish = g_memory_input_stream_skip_finish;
istream_class->close_async = g_memory_input_stream_close_async;
istream_class->close_finish = g_memory_input_stream_close_finish;
}
static void
g_memory_input_stream_finalize (GObject *object)
{
GMemoryInputStream *stream;
stream = G_MEMORY_INPUT_STREAM (object);
if (stream->priv->free_data)
g_free (stream->priv->buffer);
if (G_OBJECT_CLASS (g_memory_input_stream_parent_class)->finalize)
(*G_OBJECT_CLASS (g_memory_input_stream_parent_class)->finalize) (object);
}
static void
g_memory_input_stream_seekable_iface_init (GSeekableIface *iface)
{
iface->tell = g_memory_input_stream_tell;
iface->can_seek = g_memory_input_stream_can_seek;
iface->seek = g_memory_input_stream_seek;
iface->can_truncate = g_memory_input_stream_can_truncate;
iface->truncate_fn = g_memory_input_stream_truncate;
}
static void
g_memory_input_stream_init (GMemoryInputStream *stream)
{
stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (stream,
G_TYPE_MEMORY_INPUT_STREAM,
GMemoryInputStreamPrivate);
}
/**
* g_memory_input_stream_set_free_data:
* @stream: a #GMemoryInputStream.
* @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_input_stream_set_free_data (GMemoryInputStream *stream,
gboolean free_data)
{
g_return_if_fail (G_IS_MEMORY_INPUT_STREAM (stream));
stream->priv->free_data = free_data;
}
/**
* g_memory_input_stream_from_data:
* @data: input data.
* @len: length of the data.
*
* Creates a new #GMemoryInputStream with data in memory of a given size.
*
* Returns: new #GInputStream read from @data of @len bytes.
**/
GInputStream *
g_memory_input_stream_from_data (const void *data,
gssize len)
{
GInputStream *stream;
GMemoryInputStream *memory_stream;
g_return_val_if_fail (data != NULL, NULL);
stream = g_object_new (G_TYPE_MEMORY_INPUT_STREAM, NULL);
memory_stream = G_MEMORY_INPUT_STREAM (stream);
if (len == -1)
len = strlen (data);
memory_stream->priv->buffer = (guint8 *)data;
memory_stream->priv->len = len;
return stream;
}
static gssize
g_memory_input_stream_read (GInputStream *stream,
void *buffer,
gsize count,
GCancellable *cancellable,
GError **error)
{
GMemoryInputStream *memory_stream;
GMemoryInputStreamPrivate * priv;
memory_stream = G_MEMORY_INPUT_STREAM (stream);
priv = memory_stream->priv;
count = MIN (count, priv->len - priv->pos);
memcpy (buffer, priv->buffer + priv->pos, count);
priv->pos += count;
return count;
}
/**
* g_memory_input_stream_get_data:
* @stream: a #GMemoryInputStream
*
* Gets a pointer to the data within the #GMemoryInputStream.
*
* Returns: a pointer to the memory in the @stream.
**/
const void *
g_memory_input_stream_get_data (GMemoryInputStream *stream)
{
g_return_val_if_fail (G_IS_MEMORY_INPUT_STREAM (stream), NULL);
return stream->priv->buffer;
}
/**
* g_memory_input_stream_get_data_size:
* @stream: a #GMemoryInputStream
*
* Gets the size of the data within the #GMemoryInputStream.
*
* Returns: a gsize with the size of the data in @stream, or -1
* on error.
**/
gsize
g_memory_input_stream_get_data_size (GMemoryInputStream *stream)
{
g_return_val_if_fail (G_IS_MEMORY_INPUT_STREAM (stream), -1);
return stream->priv->len;
}
static gssize
g_memory_input_stream_skip (GInputStream *stream,
gsize count,
GCancellable *cancellable,
GError **error)
{
GMemoryInputStream *memory_stream;
GMemoryInputStreamPrivate *priv;
memory_stream = G_MEMORY_INPUT_STREAM (stream);
priv = memory_stream->priv;
count = MIN (count, priv->len - priv->pos);
priv->pos += count;
return count;
}
static gboolean
g_memory_input_stream_close (GInputStream *stream,
GCancellable *cancellable,
GError **error)
{
return TRUE;
}
static void
g_memory_input_stream_read_async (GInputStream *stream,
void *buffer,
gsize count,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
GSimpleAsyncResult *simple;
gssize nread;
nread = g_memory_input_stream_read (stream, buffer, count, cancellable, NULL);
simple = g_simple_async_result_new (G_OBJECT (stream),
callback,
user_data,
g_memory_input_stream_read_async);
g_simple_async_result_set_op_res_gssize (simple, nread);
g_simple_async_result_complete_in_idle (simple);
g_object_unref (simple);
}
static gssize
g_memory_input_stream_read_finish (GInputStream *stream,
GAsyncResult *result,
GError **error)
{
GSimpleAsyncResult *simple;
gssize nread;
simple = G_SIMPLE_ASYNC_RESULT (result);
g_assert (g_simple_async_result_get_source_tag (simple) == g_memory_input_stream_read_async);
nread = g_simple_async_result_get_op_res_gssize (simple);
return nread;
}
static void
g_memory_input_stream_skip_async (GInputStream *stream,
gsize count,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
GSimpleAsyncResult *simple;
gssize nskipped;
nskipped = g_memory_input_stream_skip (stream, count, cancellable, NULL);
simple = g_simple_async_result_new (G_OBJECT (stream),
callback,
user_data,
g_memory_input_stream_skip_async);
g_simple_async_result_set_op_res_gssize (simple, nskipped);
g_simple_async_result_complete_in_idle (simple);
g_object_unref (simple);
}
static gssize
g_memory_input_stream_skip_finish (GInputStream *stream,
GAsyncResult *result,
GError **error)
{
GSimpleAsyncResult *simple;
gssize nskipped;
simple = G_SIMPLE_ASYNC_RESULT (result);
g_assert (g_simple_async_result_get_source_tag (simple) == g_memory_input_stream_skip_async);
nskipped = g_simple_async_result_get_op_res_gssize (simple);
return nskipped;
}
static void
g_memory_input_stream_close_async (GInputStream *stream,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
GSimpleAsyncResult *simple;
simple = g_simple_async_result_new (G_OBJECT (stream),
callback,
user_data,
g_memory_input_stream_close_async);
g_simple_async_result_complete_in_idle (simple);
g_object_unref (simple);
}
static gboolean
g_memory_input_stream_close_finish (GInputStream *stream,
GAsyncResult *result,
GError **error)
{
return TRUE;
}
static goffset
g_memory_input_stream_tell (GSeekable *seekable)
{
GMemoryInputStream *memory_stream;
GMemoryInputStreamPrivate * priv;
memory_stream = G_MEMORY_INPUT_STREAM (seekable);
priv = memory_stream->priv;
return priv->pos;
}
static
gboolean g_memory_input_stream_can_seek (GSeekable *seekable)
{
return TRUE;
}
static gboolean
g_memory_input_stream_seek (GSeekable *seekable,
goffset offset,
GSeekType type,
GCancellable *cancellable,
GError **error)
{
GMemoryInputStream *memory_stream;
GMemoryInputStreamPrivate * priv;
goffset absolute;
memory_stream = G_MEMORY_INPUT_STREAM (seekable);
priv = memory_stream->priv;
switch (type)
{
case G_SEEK_CUR:
absolute = priv->pos + offset;
break;
case G_SEEK_SET:
absolute = offset;
break;
case G_SEEK_END:
absolute = priv->len + offset;
break;
default:
g_set_error (error,
G_IO_ERROR,
G_IO_ERROR_INVALID_ARGUMENT,
"Invalid GSeekType supplied");
return FALSE;
}
if (absolute < 0 || absolute > priv->len)
{
g_set_error (error,
G_IO_ERROR,
G_IO_ERROR_INVALID_ARGUMENT,
"Invalid seek request");
return FALSE;
}
priv->pos = absolute;
return TRUE;
}
static gboolean
g_memory_input_stream_can_truncate (GSeekable *seekable)
{
return FALSE;
}
static gboolean
g_memory_input_stream_truncate (GSeekable *seekable,
goffset offset,
GCancellable *cancellable,
GError **error)
{
g_set_error (error,
G_IO_ERROR,
G_IO_ERROR_NOT_SUPPORTED,
"Cannot seek on GMemoryInputStream");
return FALSE;
}
#define __G_MEMORY_INPUT_STREAM_C__
#include "gioaliasdef.c"