* Author: Alexander Larsson <alexl@redhat.com>
*/
-#include <config.h>
+#include "config.h"
#include <glib.h>
#include "glibintl.h"
#include "ginputstream.h"
#include "gseekable.h"
+#include "gcancellable.h"
+#include "gasyncresult.h"
#include "gsimpleasyncresult.h"
+#include "gioerror.h"
-#include "gioalias.h"
/**
* SECTION:ginputstream
* @short_description: Base class for implementing streaming input
+ * @include: gio/gio.h
*
- *
- *
+ * GInputStream has functions to read from a stream (g_input_stream_read()),
+ * to close a stream (g_input_stream_close()) and to skip some content
+ * (g_input_stream_skip()).
+ *
+ * To copy the content of an input stream to an output stream without
+ * manually handling the reads and writes, use g_output_stream_splice().
+ *
+ * All of these functions have async variants too.
**/
-G_DEFINE_TYPE (GInputStream, g_input_stream, G_TYPE_OBJECT);
+G_DEFINE_ABSTRACT_TYPE (GInputStream, g_input_stream, G_TYPE_OBJECT);
struct _GInputStreamPrivate {
guint closed : 1;
static void
g_input_stream_finalize (GObject *object)
{
- GInputStream *stream;
-
- stream = G_INPUT_STREAM (object);
-
- if (!stream->priv->closed)
- g_input_stream_close (stream, NULL, NULL);
-
- if (G_OBJECT_CLASS (g_input_stream_parent_class)->finalize)
- (*G_OBJECT_CLASS (g_input_stream_parent_class)->finalize) (object);
+ G_OBJECT_CLASS (g_input_stream_parent_class)->finalize (object);
}
static void
if (!stream->priv->closed)
g_input_stream_close (stream, NULL, NULL);
-
- if (G_OBJECT_CLASS (g_input_stream_parent_class)->dispose)
- (*G_OBJECT_CLASS (g_input_stream_parent_class)->dispose) (object);
+
+ G_OBJECT_CLASS (g_input_stream_parent_class)->dispose (object);
}
* @stream: a #GInputStream.
* @buffer: a buffer to read data into (which should be at least count bytes long).
* @count: the number of bytes that will be read from the stream
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: location to store the error occuring, or %NULL to ignore
+ * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
+ * @error: location to store the error occurring, or %NULL to ignore
*
* Tries to read @count bytes from the stream into the buffer starting at
* @buffer. Will block during this read.
if (((gssize) count) < 0)
{
g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
- _("Too large count value passed to g_input_stream_read"));
+ _("Too large count value passed to %s"), G_STRFUNC);
return -1;
}
if (class->read_fn == NULL)
{
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
- _("Input stream doesn't implement read"));
+ g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
+ _("Input stream doesn't implement read"));
return -1;
}
return -1;
if (cancellable)
- g_push_current_cancellable (cancellable);
+ g_cancellable_push_current (cancellable);
res = class->read_fn (stream, buffer, count, cancellable, error);
if (cancellable)
- g_pop_current_cancellable (cancellable);
+ g_cancellable_pop_current (cancellable);
g_input_stream_clear_pending (stream);
* @stream: a #GInputStream.
* @buffer: a buffer to read data into (which should be at least count bytes long).
* @count: the number of bytes that will be read from the stream
- * @bytes_read: location to store the number of bytes that was read from the stream
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: location to store the error occuring, or %NULL to ignore
+ * @bytes_read: (out): location to store the number of bytes that was read from the stream
+ * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
+ * @error: location to store the error occurring, or %NULL to ignore
*
* Tries to read @count bytes from the stream into the buffer starting at
* @buffer. Will block during this read.
*
* If there is an error during the operation %FALSE is returned and @error
* is set to indicate the error status, @bytes_read is updated to contain
- * the number of bytes read into @buffer before the error occured.
+ * the number of bytes read into @buffer before the error occurred.
*
* Return value: %TRUE on success, %FALSE if there was an error
**/
* g_input_stream_skip:
* @stream: a #GInputStream.
* @count: the number of bytes that will be skipped from the stream
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: location to store the error occuring, or %NULL to ignore
+ * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
+ * @error: location to store the error occurring, or %NULL to ignore
*
* Tries to skip @count bytes from the stream. Will block during the operation.
*
if (((gssize) count) < 0)
{
g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
- _("Too large count value passed to g_input_stream_skip"));
+ _("Too large count value passed to %s"), G_STRFUNC);
return -1;
}
return -1;
if (cancellable)
- g_push_current_cancellable (cancellable);
+ g_cancellable_push_current (cancellable);
res = class->skip (stream, count, cancellable, error);
if (cancellable)
- g_pop_current_cancellable (cancellable);
+ g_cancellable_pop_current (cancellable);
g_input_stream_clear_pending (stream);
char buffer[8192];
GError *my_error;
- class = G_INPUT_STREAM_GET_CLASS (stream);
-
if (G_IS_SEEKABLE (stream) && g_seekable_can_seek (G_SEEKABLE (stream)))
{
if (g_seekable_seek (G_SEEKABLE (stream),
/* If not seekable, or seek failed, fall back to reading data: */
class = G_INPUT_STREAM_GET_CLASS (stream);
-
+
read_bytes = 0;
while (1)
{
my_error = NULL;
ret = class->read_fn (stream, buffer, MIN (sizeof (buffer), count),
- cancellable, &my_error);
+ cancellable, &my_error);
if (ret == -1)
{
if (read_bytes > 0 &&
g_error_free (my_error);
return read_bytes;
}
-
+
g_propagate_error (error, my_error);
return -1;
}
count -= ret;
read_bytes += ret;
-
+
if (ret == 0 || count == 0)
- return read_bytes;
+ return read_bytes;
}
}
/**
* g_input_stream_close:
* @stream: A #GInputStream.
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: location to store the error occuring, or %NULL to ignore
+ * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
+ * @error: location to store the error occurring, or %NULL to ignore
*
* Closes the stream, releasing resources related to it.
*
* Closing a stream multiple times will not return an error.
*
* Streams will be automatically closed when the last reference
- * is dropped, but you might want to call make sure resources
- * are released as early as possible.
+ * is dropped, but you might want to call this function to make sure
+ * resources are released as early as possible.
*
* Some streams might keep the backing store of the stream (e.g. a file descriptor)
* open after the stream is closed. See the documentation for the individual
*
* On failure the first error that happened will be reported, but the close
* operation will finish as much as possible. A stream that failed to
- * close will still return %G_IO_ERROR_CLOSED all operations. Still, it
+ * close will still return %G_IO_ERROR_CLOSED for all operations. Still, it
* is important to check and report the error to the user.
*
* If @cancellable is not NULL, then the operation can be cancelled by
return FALSE;
if (cancellable)
- g_push_current_cancellable (cancellable);
+ g_cancellable_push_current (cancellable);
if (class->close_fn)
res = class->close_fn (stream, cancellable, error);
if (cancellable)
- g_pop_current_cancellable (cancellable);
+ g_cancellable_pop_current (cancellable);
g_input_stream_clear_pending (stream);
* @count: the number of bytes that will be read from the stream
* @io_priority: the <link linkend="io-priority">I/O priority</link>
* of the request.
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @callback: callback to call when the request is satisfied
- * @user_data: the data to pass to callback function
+ * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
+ * @callback: (scope async): callback to call when the request is satisfied
+ * @user_data: (closure): the data to pass to callback function
*
* Request an asynchronous read of @count bytes from the stream into the buffer
- * starting at @buffer. When the operation is finished @callback will be called,
- * giving the results.
+ * starting at @buffer. When the operation is finished @callback will be called.
+ * You can then call g_input_stream_read_finish() to get the result of the
+ * operation.
*
- * During an async request no other sync and async calls are allowed, and will
+ * During an async request no other sync and async calls are allowed on @stream, and will
* result in %G_IO_ERROR_PENDING errors.
*
* A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
callback,
user_data,
G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
- _("Too large count value passed to g_input_stream_read_async"));
+ _("Too large count value passed to %s"),
+ G_STRFUNC);
return;
}
if (!g_input_stream_set_pending (stream, &error))
{
- g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
+ g_simple_async_report_take_gerror_in_idle (G_OBJECT (stream),
callback,
user_data,
error);
- g_error_free (error);
return;
}
* g_input_stream_read_finish:
* @stream: a #GInputStream.
* @result: a #GAsyncResult.
- * @error: a #GError location to store the error occuring, or %NULL to
+ * @error: a #GError location to store the error occurring, or %NULL to
* ignore.
*
* Finishes an asynchronous stream read operation.
* g_input_stream_skip_async:
* @stream: A #GInputStream.
* @count: the number of bytes that will be skipped from the stream
- * @io_priority: the <link linkend="io-priority">I/O priority</link>
- * of the request.
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @callback: callback to call when the request is satisfied
- * @user_data: the data to pass to callback function
+ * @io_priority: the <link linkend="io-priority">I/O priority</link>
+ * of the request.
+ * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
+ * @callback: (scope async): callback to call when the request is satisfied
+ * @user_data: (closure): the data to pass to callback function
*
- * Request an asynchronous skip of @count bytes from the stream into the buffer
- * starting at @buffer. When the operation is finished @callback will be called,
- * giving the results.
+ * Request an asynchronous skip of @count bytes from the stream.
+ * When the operation is finished @callback will be called.
+ * You can then call g_input_stream_skip_finish() to get the result
+ * of the operation.
*
- * During an async request no other sync and async calls are allowed, and will
- * result in %G_IO_ERROR_PENDING errors.
+ * During an async request no other sync and async calls are allowed,
+ * and will result in %G_IO_ERROR_PENDING errors.
*
* A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
*
- * On success, the number of bytes skipped will be passed to the
- * callback. It is not an error if this is not the same as the requested size, as it
+ * On success, the number of bytes skipped will be passed to the callback.
+ * It is not an error if this is not the same as the requested size, as it
* can happen e.g. near the end of a file, but generally we try to skip
* as many bytes as requested. Zero is returned on end of file
* (or if @count is zero), but never otherwise.
*
- * Any outstanding i/o request with higher priority (lower numerical value) will
- * be executed before an outstanding request with lower priority. Default
- * priority is %G_PRIORITY_DEFAULT.
+ * Any outstanding i/o request with higher priority (lower numerical value)
+ * will be executed before an outstanding request with lower priority.
+ * Default priority is %G_PRIORITY_DEFAULT.
*
- * The asyncronous methods have a default fallback that uses threads to implement
- * asynchronicity, so they are optional for inheriting classes. However, if you
- * override one you must override all.
+ * The asynchronous methods have a default fallback that uses threads to
+ * implement asynchronicity, so they are optional for inheriting classes.
+ * However, if you override one, you must override all.
**/
void
g_input_stream_skip_async (GInputStream *stream,
callback,
user_data,
G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
- _("Too large count value passed to g_input_stream_skip_async"));
+ _("Too large count value passed to %s"),
+ G_STRFUNC);
return;
}
if (!g_input_stream_set_pending (stream, &error))
{
- g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
+ g_simple_async_report_take_gerror_in_idle (G_OBJECT (stream),
callback,
user_data,
error);
- g_error_free (error);
return;
}
* g_input_stream_skip_finish:
* @stream: a #GInputStream.
* @result: a #GAsyncResult.
- * @error: a #GError location to store the error occuring, or %NULL to
+ * @error: a #GError location to store the error occurring, or %NULL to
* ignore.
*
* Finishes a stream skip operation.
* @stream: A #GInputStream.
* @io_priority: the <link linkend="io-priority">I/O priority</link>
* of the request.
- * @cancellable: optional cancellable object
- * @callback: callback to call when the request is satisfied
- * @user_data: the data to pass to callback function
+ * @cancellable: (allow-none): optional cancellable object
+ * @callback: (scope async): callback to call when the request is satisfied
+ * @user_data: (closure): the data to pass to callback function
*
* Requests an asynchronous closes of the stream, releasing resources related to it.
- * When the operation is finished @callback will be called, giving the results.
+ * When the operation is finished @callback will be called.
+ * You can then call g_input_stream_close_finish() to get the result of the
+ * operation.
*
* For behaviour details see g_input_stream_close().
*
if (!g_input_stream_set_pending (stream, &error))
{
- g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
+ g_simple_async_report_take_gerror_in_idle (G_OBJECT (stream),
callback,
user_data,
error);
- g_error_free (error);
return;
}
* g_input_stream_close_finish:
* @stream: a #GInputStream.
* @result: a #GAsyncResult.
- * @error: a #GError location to store the error occuring, or %NULL to
+ * @error: a #GError location to store the error occurring, or %NULL to
* ignore.
*
* Finishes closing a stream asynchronously, started from g_input_stream_close_async().
/**
* g_input_stream_set_pending:
* @stream: input stream
- * @error: a #GError location to store the error occuring, or %NULL to
+ * @error: a #GError location to store the error occurring, or %NULL to
* ignore.
*
* Sets @stream to have actions pending. If the pending flag is
if (stream->priv->closed)
{
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
- _("Stream is already closed"));
+ g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
+ _("Stream is already closed"));
return FALSE;
}
if (stream->priv->pending)
{
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_PENDING,
- _("Stream has outstanding operation"));
+ g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_PENDING,
+ /* Translators: This is an error you get if there is already an
+ * operation running against this stream when you try to start
+ * one */
+ _("Stream has outstanding operation"));
return FALSE;
}
op->buffer, op->count_requested,
cancellable, &error);
if (op->count_read == -1)
- {
- g_simple_async_result_set_from_error (res, error);
- g_error_free (error);
- }
+ g_simple_async_result_take_error (res, error);
}
static void
GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
ReadData *op;
- g_assert (g_simple_async_result_get_source_tag (simple) ==
+ g_warn_if_fail (g_simple_async_result_get_source_tag (simple) ==
g_input_stream_real_read_async);
op = g_simple_async_result_get_op_res_gpointer (simple);
op->count_requested,
cancellable, &error);
if (op->count_skipped == -1)
- {
- g_simple_async_result_set_from_error (res, error);
- g_error_free (error);
- }
+ g_simple_async_result_take_error (res, error);
}
typedef struct {
if (ret == -1)
{
- if (data->count_skipped &&
- error->domain == G_IO_ERROR &&
- error->code == G_IO_ERROR_CANCELLED)
- { /* No error, return partial read */ }
+ if (data->count_skipped &&
+ g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
+ /* No error, return partial read */
+ g_error_free (error);
else
- g_simple_async_result_set_from_error (simple, error);
- g_error_free (error);
+ g_simple_async_result_take_error (simple, error);
}
/* Complete immediately, not in idle, since we're already in a mainloop callout */
GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
SkipData *op;
- g_assert (g_simple_async_result_get_source_tag (simple) == g_input_stream_real_skip_async);
+ g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_input_stream_real_skip_async);
op = g_simple_async_result_get_op_res_gpointer (simple);
return op->count_skipped;
}
cancellation, since we want to close things anyway, although
possibly in a quick-n-dirty way. At least we never want to leak
open handles */
-
+
class = G_INPUT_STREAM_GET_CLASS (object);
- result = class->close_fn (G_INPUT_STREAM (object), cancellable, &error);
- if (!result)
+ if (class->close_fn)
{
- g_simple_async_result_set_from_error (res, error);
- g_error_free (error);
+ result = class->close_fn (G_INPUT_STREAM (object), cancellable, &error);
+ if (!result)
+ g_simple_async_result_take_error (res, error);
}
}
GError **error)
{
GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
- g_assert (g_simple_async_result_get_source_tag (simple) == g_input_stream_real_close_async);
+ g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_input_stream_real_close_async);
return TRUE;
}
-
-#define __G_INPUT_STREAM_C__
-#include "gioaliasdef.c"
projects / platform / upstream / glib.git / blobdiff