X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=gio%2Fginputstream.c;h=a1ba73608e6ee2c650e431bd0538b21a6eb7bf98;hb=356a3987cee7ceddcb3fe623edf0bd2881895add;hp=44ddc48f85fbca38c7232209981551af675806b4;hpb=761424465aaad736916b029383483b6ac419d831;p=platform%2Fupstream%2Fglib.git diff --git a/gio/ginputstream.c b/gio/ginputstream.c index 44ddc48..a1ba736 100644 --- a/gio/ginputstream.c +++ b/gio/ginputstream.c @@ -13,9 +13,7 @@ * 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: Alexander Larsson */ @@ -25,28 +23,36 @@ #include "glibintl.h" #include "ginputstream.h" +#include "gioprivate.h" #include "gseekable.h" -#include "gsimpleasyncresult.h" - -#include "gioalias.h" +#include "gcancellable.h" +#include "gasyncresult.h" +#include "gioerror.h" +#include "gpollableinputstream.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); - struct _GInputStreamPrivate { guint closed : 1; guint pending : 1; GAsyncReadyCallback outstanding_callback; }; +G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GInputStream, g_input_stream, G_TYPE_OBJECT) + static gssize g_input_stream_real_skip (GInputStream *stream, gsize count, GCancellable *cancellable, @@ -80,19 +86,6 @@ static gboolean g_input_stream_real_close_finish (GInputStream *stream, GError **error); 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); - - G_OBJECT_CLASS (g_input_stream_parent_class)->finalize (object); -} - -static void g_input_stream_dispose (GObject *object) { GInputStream *stream; @@ -111,9 +104,6 @@ g_input_stream_class_init (GInputStreamClass *klass) { GObjectClass *gobject_class = G_OBJECT_CLASS (klass); - g_type_class_add_private (klass, sizeof (GInputStreamPrivate)); - - gobject_class->finalize = g_input_stream_finalize; gobject_class->dispose = g_input_stream_dispose; klass->skip = g_input_stream_real_skip; @@ -128,18 +118,17 @@ g_input_stream_class_init (GInputStreamClass *klass) static void g_input_stream_init (GInputStream *stream) { - stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (stream, - G_TYPE_INPUT_STREAM, - GInputStreamPrivate); + stream->priv = g_input_stream_get_instance_private (stream); } /** * g_input_stream_read: * @stream: a #GInputStream. - * @buffer: a buffer to read data into (which should be at least count bytes long). + * @buffer: (array length=count) (element-type guint8): 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. @@ -152,15 +141,18 @@ g_input_stream_init (GInputStream *stream) * can happen e.g. near the end of a file. Zero is returned on end of file * (or if @count is zero), but never otherwise. * - * If @cancellable is not NULL, then the operation can be cancelled by + * The returned @buffer is not a nul-terminated string, it can contain nul bytes + * at any position, and this function doesn't nul-terminate the @buffer. + * + * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error G_IO_ERROR_CANCELLED will be returned. If an + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an * operation was partially finished when the operation was cancelled the * partial result will be returned, without an error. * * On error -1 is returned and @error is set accordingly. * - * Return value: Number of bytes read, or -1 on error + * Returns: Number of bytes read, or -1 on error, or 0 on end of file. **/ gssize g_input_stream_read (GInputStream *stream, @@ -213,11 +205,12 @@ g_input_stream_read (GInputStream *stream, /** * g_input_stream_read_all: * @stream: a #GInputStream. - * @buffer: a buffer to read data into (which should be at least count bytes long). + * @buffer: (array length=count) (element-type guint8): 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. @@ -230,10 +223,16 @@ g_input_stream_read (GInputStream *stream, * read into @buffer. * * 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 occurred. + * is set to indicate the error status. * - * Return value: %TRUE on success, %FALSE if there was an error + * As a special exception to the normal conventions for functions that + * use #GError, if this function returns %FALSE (and sets @error) then + * @bytes_read will be set to the number of bytes that were successfully + * read before the error was encountered. This functionality is only + * available from C. If you need it from another language then you must + * write your own loop around g_input_stream_read(). + * + * Returns: %TRUE on success, %FALSE if there was an error **/ gboolean g_input_stream_read_all (GInputStream *stream, @@ -273,11 +272,72 @@ g_input_stream_read_all (GInputStream *stream, } /** + * g_input_stream_read_bytes: + * @stream: a #GInputStream. + * @count: maximum number of bytes that will be read from the stream. Common + * values include 4096 and 8192. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @error: location to store the error occurring, or %NULL to ignore + * + * Like g_input_stream_read(), this tries to read @count bytes from + * the stream in a blocking fashion. However, rather than reading into + * a user-supplied buffer, this will create a new #GBytes containing + * the data that was read. This may be easier to use from language + * bindings. + * + * If count is zero, returns a zero-length #GBytes and does nothing. A + * value of @count larger than %G_MAXSSIZE will cause a + * %G_IO_ERROR_INVALID_ARGUMENT error. + * + * On success, a new #GBytes is returned. It is not an error if the + * size of this object is not the same as the requested size, as it + * can happen e.g. near the end of a file. A zero-length #GBytes is + * returned on end of file (or if @count is zero), but never + * otherwise. + * + * If @cancellable is not %NULL, then the operation can be cancelled by + * triggering the cancellable object from another thread. If the operation + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an + * operation was partially finished when the operation was cancelled the + * partial result will be returned, without an error. + * + * On error %NULL is returned and @error is set accordingly. + * + * Returns: a new #GBytes, or %NULL on error + * + * Since: 2.34 + **/ +GBytes * +g_input_stream_read_bytes (GInputStream *stream, + gsize count, + GCancellable *cancellable, + GError **error) +{ + guchar *buf; + gssize nread; + + buf = g_malloc (count); + nread = g_input_stream_read (stream, buf, count, cancellable, error); + if (nread == -1) + { + g_free (buf); + return NULL; + } + else if (nread == 0) + { + g_free (buf); + return g_bytes_new_static ("", 0); + } + else + return g_bytes_new_take (buf, nread); +} + +/** * 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. * @@ -294,7 +354,7 @@ g_input_stream_read_all (GInputStream *stream, * operation was partially finished when the operation was cancelled the * partial result will be returned, without an error. * - * Return value: Number of bytes skipped, or -1 on error + * Returns: Number of bytes skipped, or -1 on error **/ gssize g_input_stream_skip (GInputStream *stream, @@ -346,8 +406,6 @@ g_input_stream_real_skip (GInputStream *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), @@ -361,14 +419,14 @@ g_input_stream_real_skip (GInputStream *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 && @@ -378,24 +436,24 @@ g_input_stream_real_skip (GInputStream *stream, 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. * @@ -415,13 +473,13 @@ g_input_stream_real_skip (GInputStream *stream, * 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 + * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * Cancelling a close will still leave the stream closed, but some streams * can use a faster close that doesn't block to e.g. check errors. * - * Return value: %TRUE on success, %FALSE on failure + * Returns: %TRUE on success, %FALSE on failure **/ gboolean g_input_stream_close (GInputStream *stream, @@ -489,20 +547,21 @@ async_ready_close_callback_wrapper (GObject *source_object, /** * g_input_stream_read_async: * @stream: A #GInputStream. - * @buffer: a buffer to read data into (which should be at least count bytes long). + * @buffer: (array length=count) (element-type guint8): 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 - * @io_priority: the I/O priority + * @io_priority: the [I/O priority][io-priority] * 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. * 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. @@ -531,7 +590,6 @@ g_input_stream_read_async (GInputStream *stream, gpointer user_data) { GInputStreamClass *class; - GSimpleAsyncResult *simple; GError *error = NULL; g_return_if_fail (G_IS_INPUT_STREAM (stream)); @@ -539,33 +597,30 @@ g_input_stream_read_async (GInputStream *stream, if (count == 0) { - simple = g_simple_async_result_new (G_OBJECT (stream), - callback, - user_data, - g_input_stream_read_async); - g_simple_async_result_complete_in_idle (simple); - g_object_unref (simple); + GTask *task; + + task = g_task_new (stream, cancellable, callback, user_data); + g_task_set_source_tag (task, g_input_stream_read_async); + g_task_return_int (task, 0); + g_object_unref (task); return; } if (((gssize) count) < 0) { - g_simple_async_report_error_in_idle (G_OBJECT (stream), - callback, - user_data, - G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT, - _("Too large count value passed to %s"), - G_STRFUNC); + g_task_report_new_error (stream, callback, user_data, + g_input_stream_read_async, + G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT, + _("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), - callback, - user_data, - error); - g_error_free (error); + g_task_report_error (stream, callback, user_data, + g_input_stream_read_async, + error); return; } @@ -580,72 +635,351 @@ g_input_stream_read_async (GInputStream *stream, * 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. * - * Returns: number of bytes read in, or -1 on error. + * Returns: number of bytes read in, or -1 on error, or 0 on end of file. **/ gssize g_input_stream_read_finish (GInputStream *stream, GAsyncResult *result, GError **error) { - GSimpleAsyncResult *simple; GInputStreamClass *class; g_return_val_if_fail (G_IS_INPUT_STREAM (stream), -1); g_return_val_if_fail (G_IS_ASYNC_RESULT (result), -1); - if (G_IS_SIMPLE_ASYNC_RESULT (result)) + if (g_async_result_legacy_propagate_error (result, error)) + return -1; + else if (g_async_result_is_tagged (result, g_input_stream_read_async)) + return g_task_propagate_int (G_TASK (result), error); + + class = G_INPUT_STREAM_GET_CLASS (stream); + return class->read_finish (stream, result, error); +} + +typedef struct +{ + gchar *buffer; + gsize to_read; + gsize bytes_read; +} AsyncReadAll; + +static void +free_async_read_all (gpointer data) +{ + g_slice_free (AsyncReadAll, data); +} + +static void +read_all_callback (GObject *stream, + GAsyncResult *result, + gpointer user_data) +{ + GTask *task = user_data; + AsyncReadAll *data = g_task_get_task_data (task); + gboolean got_eof = FALSE; + + if (result) { - simple = G_SIMPLE_ASYNC_RESULT (result); - if (g_simple_async_result_propagate_error (simple, error)) - return -1; + GError *error = NULL; + gssize nread; + + nread = g_input_stream_read_finish (G_INPUT_STREAM (stream), result, &error); + + if (nread == -1) + { + g_task_return_error (task, error); + g_object_unref (task); + return; + } + + g_assert_cmpint (nread, <=, data->to_read); + data->to_read -= nread; + data->bytes_read += nread; + got_eof = (nread == 0); + } - /* Special case read of 0 bytes */ - if (g_simple_async_result_get_source_tag (simple) == g_input_stream_read_async) - return 0; + if (got_eof || data->to_read == 0) + { + g_task_return_boolean (task, TRUE); + g_object_unref (task); } - class = G_INPUT_STREAM_GET_CLASS (stream); - return class->read_finish (stream, result, error); + else + g_input_stream_read_async (G_INPUT_STREAM (stream), + data->buffer + data->bytes_read, + data->to_read, + g_task_get_priority (task), + g_task_get_cancellable (task), + read_all_callback, task); +} + + +static void +read_all_async_thread (GTask *task, + gpointer source_object, + gpointer task_data, + GCancellable *cancellable) +{ + GInputStream *stream = source_object; + AsyncReadAll *data = task_data; + GError *error = NULL; + + if (g_input_stream_read_all (stream, data->buffer, data->to_read, &data->bytes_read, + g_task_get_cancellable (task), &error)) + g_task_return_boolean (task, TRUE); + else + g_task_return_error (task, error); +} + +/** + * g_input_stream_read_all_async: + * @stream: A #GInputStream + * @buffer: (array length=count) (element-type guint8): 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 + * @io_priority: the [I/O priority][io-priority] 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 read of @count bytes from the stream into the + * buffer starting at @buffer. + * + * This is the asynchronous equivalent of g_input_stream_read_all(). + * + * Call g_input_stream_read_all_finish() to collect the result. + * + * 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. + * + * Since: 2.44 + **/ +void +g_input_stream_read_all_async (GInputStream *stream, + void *buffer, + gsize count, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) +{ + AsyncReadAll *data; + GTask *task; + + g_return_if_fail (G_IS_INPUT_STREAM (stream)); + g_return_if_fail (buffer != NULL || count == 0); + + task = g_task_new (stream, cancellable, callback, user_data); + data = g_slice_new0 (AsyncReadAll); + data->buffer = buffer; + data->to_read = count; + + g_task_set_task_data (task, data, free_async_read_all); + g_task_set_priority (task, io_priority); + + /* If async reads are going to be handled via the threadpool anyway + * then we may as well do it with a single dispatch instead of + * bouncing in and out. + */ + if (g_input_stream_async_read_is_via_threads (stream)) + { + g_task_run_in_thread (task, read_all_async_thread); + g_object_unref (task); + } + else + read_all_callback (G_OBJECT (stream), NULL, task); +} + +/** + * g_input_stream_read_all_finish: + * @stream: a #GInputStream + * @result: a #GAsyncResult + * @bytes_read: (out): location to store the number of bytes that was read from the stream + * @error: a #GError location to store the error occurring, or %NULL to ignore + * + * Finishes an asynchronous stream read operation started with + * g_input_stream_read_all_async(). + * + * As a special exception to the normal conventions for functions that + * use #GError, if this function returns %FALSE (and sets @error) then + * @bytes_read will be set to the number of bytes that were successfully + * read before the error was encountered. This functionality is only + * available from C. If you need it from another language then you must + * write your own loop around g_input_stream_read_async(). + * + * Returns: %TRUE on success, %FALSE if there was an error + * + * Since: 2.44 + **/ +gboolean +g_input_stream_read_all_finish (GInputStream *stream, + GAsyncResult *result, + gsize *bytes_read, + GError **error) +{ + GTask *task; + + g_return_val_if_fail (G_IS_INPUT_STREAM (stream), FALSE); + g_return_val_if_fail (g_task_is_valid (result, stream), FALSE); + + task = G_TASK (result); + + if (bytes_read) + { + AsyncReadAll *data = g_task_get_task_data (task); + + *bytes_read = data->bytes_read; + } + + return g_task_propagate_boolean (task, error); +} + +static void +read_bytes_callback (GObject *stream, + GAsyncResult *result, + gpointer user_data) +{ + GTask *task = user_data; + guchar *buf = g_task_get_task_data (task); + GError *error = NULL; + gssize nread; + GBytes *bytes = NULL; + + nread = g_input_stream_read_finish (G_INPUT_STREAM (stream), + result, &error); + if (nread == -1) + { + g_free (buf); + g_task_return_error (task, error); + } + else if (nread == 0) + { + g_free (buf); + bytes = g_bytes_new_static ("", 0); + } + else + bytes = g_bytes_new_take (buf, nread); + + if (bytes) + g_task_return_pointer (task, bytes, (GDestroyNotify)g_bytes_unref); + + g_object_unref (task); +} + +/** + * g_input_stream_read_bytes_async: + * @stream: A #GInputStream. + * @count: the number of bytes that will be read from the stream + * @io_priority: the [I/O priority][io-priority] 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 read of @count bytes from the stream into a + * new #GBytes. When the operation is finished @callback will be + * called. You can then call g_input_stream_read_bytes_finish() to get the + * result of the operation. + * + * 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. + * + * On success, the new #GBytes will be passed to the callback. It is + * not an error if this is smaller than the requested size, as it can + * happen e.g. near the end of a file, but generally we try to read 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. + * + * Since: 2.34 + **/ +void +g_input_stream_read_bytes_async (GInputStream *stream, + gsize count, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) +{ + GTask *task; + guchar *buf; + + task = g_task_new (stream, cancellable, callback, user_data); + buf = g_malloc (count); + g_task_set_task_data (task, buf, NULL); + + g_input_stream_read_async (stream, buf, count, + io_priority, cancellable, + read_bytes_callback, task); +} + +/** + * g_input_stream_read_bytes_finish: + * @stream: a #GInputStream. + * @result: a #GAsyncResult. + * @error: a #GError location to store the error occurring, or %NULL to + * ignore. + * + * Finishes an asynchronous stream read-into-#GBytes operation. + * + * Returns: the newly-allocated #GBytes, or %NULL on error + * + * Since: 2.34 + **/ +GBytes * +g_input_stream_read_bytes_finish (GInputStream *stream, + GAsyncResult *result, + GError **error) +{ + g_return_val_if_fail (G_IS_INPUT_STREAM (stream), NULL); + g_return_val_if_fail (g_task_is_valid (result, stream), NULL); + + return g_task_propagate_pointer (G_TASK (result), error); } /** * g_input_stream_skip_async: * @stream: A #GInputStream. * @count: the number of bytes that will be skipped from the stream - * @io_priority: the I/O priority - * 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 [I/O priority][io-priority] 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. - * You can then call g_input_stream_skip_finish() to get the result of the - * operation. + * 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, @@ -656,41 +990,36 @@ g_input_stream_skip_async (GInputStream *stream, gpointer user_data) { GInputStreamClass *class; - GSimpleAsyncResult *simple; GError *error = NULL; g_return_if_fail (G_IS_INPUT_STREAM (stream)); if (count == 0) { - simple = g_simple_async_result_new (G_OBJECT (stream), - callback, - user_data, - g_input_stream_skip_async); + GTask *task; - g_simple_async_result_complete_in_idle (simple); - g_object_unref (simple); + task = g_task_new (stream, cancellable, callback, user_data); + g_task_set_source_tag (task, g_input_stream_skip_async); + g_task_return_int (task, 0); + g_object_unref (task); return; } if (((gssize) count) < 0) { - g_simple_async_report_error_in_idle (G_OBJECT (stream), - callback, - user_data, - G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT, - _("Too large count value passed to %s"), - G_STRFUNC); + g_task_report_new_error (stream, callback, user_data, + g_input_stream_skip_async, + G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT, + _("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), - callback, - user_data, - error); - g_error_free (error); + g_task_report_error (stream, callback, user_data, + g_input_stream_skip_async, + error); return; } @@ -705,7 +1034,7 @@ g_input_stream_skip_async (GInputStream *stream, * 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. @@ -717,22 +1046,15 @@ g_input_stream_skip_finish (GInputStream *stream, GAsyncResult *result, GError **error) { - GSimpleAsyncResult *simple; GInputStreamClass *class; g_return_val_if_fail (G_IS_INPUT_STREAM (stream), -1); g_return_val_if_fail (G_IS_ASYNC_RESULT (result), -1); - if (G_IS_SIMPLE_ASYNC_RESULT (result)) - { - simple = G_SIMPLE_ASYNC_RESULT (result); - if (g_simple_async_result_propagate_error (simple, error)) - return -1; - - /* Special case skip of 0 bytes */ - if (g_simple_async_result_get_source_tag (simple) == g_input_stream_skip_async) - return 0; - } + if (g_async_result_legacy_propagate_error (result, error)) + return -1; + else if (g_async_result_is_tagged (result, g_input_stream_skip_async)) + return g_task_propagate_int (G_TASK (result), error); class = G_INPUT_STREAM_GET_CLASS (stream); return class->skip_finish (stream, result, error); @@ -741,11 +1063,10 @@ g_input_stream_skip_finish (GInputStream *stream, /** * g_input_stream_close_async: * @stream: A #GInputStream. - * @io_priority: the I/O priority - * 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 + * @io_priority: the [I/O priority][io-priority] of the request + * @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. @@ -766,30 +1087,26 @@ g_input_stream_close_async (GInputStream *stream, gpointer user_data) { GInputStreamClass *class; - GSimpleAsyncResult *simple; GError *error = NULL; g_return_if_fail (G_IS_INPUT_STREAM (stream)); if (stream->priv->closed) { - simple = g_simple_async_result_new (G_OBJECT (stream), - callback, - user_data, - g_input_stream_close_async); + GTask *task; - g_simple_async_result_complete_in_idle (simple); - g_object_unref (simple); + task = g_task_new (stream, cancellable, callback, user_data); + g_task_set_source_tag (task, g_input_stream_close_async); + g_task_return_boolean (task, TRUE); + g_object_unref (task); return; } if (!g_input_stream_set_pending (stream, &error)) { - g_simple_async_report_gerror_in_idle (G_OBJECT (stream), - callback, - user_data, - error); - g_error_free (error); + g_task_report_error (stream, callback, user_data, + g_input_stream_close_async, + error); return; } @@ -804,7 +1121,7 @@ g_input_stream_close_async (GInputStream *stream, * 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(). @@ -816,22 +1133,15 @@ g_input_stream_close_finish (GInputStream *stream, GAsyncResult *result, GError **error) { - GSimpleAsyncResult *simple; GInputStreamClass *class; g_return_val_if_fail (G_IS_INPUT_STREAM (stream), FALSE); g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE); - if (G_IS_SIMPLE_ASYNC_RESULT (result)) - { - simple = G_SIMPLE_ASYNC_RESULT (result); - if (g_simple_async_result_propagate_error (simple, error)) - return FALSE; - - /* Special case already closed */ - if (g_simple_async_result_get_source_tag (simple) == g_input_stream_close_async) - return TRUE; - } + if (g_async_result_legacy_propagate_error (result, error)) + return FALSE; + else if (g_async_result_is_tagged (result, g_input_stream_close_async)) + return g_task_propagate_boolean (G_TASK (result), error); class = G_INPUT_STREAM_GET_CLASS (stream); return class->close_finish (stream, result, error); @@ -872,14 +1182,14 @@ g_input_stream_has_pending (GInputStream *stream) /** * 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 * already set or @stream is closed, it will return %FALSE and set * @error. * - * Return value: %TRUE if pending was previously unset and is now set. + * Returns: %TRUE if pending was previously unset and is now set. **/ gboolean g_input_stream_set_pending (GInputStream *stream, GError **error) @@ -921,39 +1231,116 @@ g_input_stream_clear_pending (GInputStream *stream) stream->priv->pending = FALSE; } +/** + * g_input_stream_async_read_is_via_threads: + * @stream: input stream + * + * Checks if an input stream's read_async function uses threads. + * + * Returns: %TRUE if @stream's read_async function uses threads. + **/ +gboolean +g_input_stream_async_read_is_via_threads (GInputStream *stream) +{ + GInputStreamClass *class; + + g_return_val_if_fail (G_IS_INPUT_STREAM (stream), FALSE); + + class = G_INPUT_STREAM_GET_CLASS (stream); + + return (class->read_async == g_input_stream_real_read_async && + !(G_IS_POLLABLE_INPUT_STREAM (stream) && + g_pollable_input_stream_can_poll (G_POLLABLE_INPUT_STREAM (stream)))); +} + /******************************************** * Default implementation of async ops * ********************************************/ typedef struct { - void *buffer; - gsize count_requested; - gssize count_read; + void *buffer; + gsize count; } ReadData; static void -read_async_thread (GSimpleAsyncResult *res, - GObject *object, - GCancellable *cancellable) +free_read_data (ReadData *op) { - ReadData *op; + g_slice_free (ReadData, op); +} + +static void +read_async_thread (GTask *task, + gpointer source_object, + gpointer task_data, + GCancellable *cancellable) +{ + GInputStream *stream = source_object; + ReadData *op = task_data; GInputStreamClass *class; GError *error = NULL; + gssize nread; - op = g_simple_async_result_get_op_res_gpointer (res); + class = G_INPUT_STREAM_GET_CLASS (stream); + + nread = class->read_fn (stream, + op->buffer, op->count, + g_task_get_cancellable (task), + &error); + if (nread == -1) + g_task_return_error (task, error); + else + g_task_return_int (task, nread); +} - class = G_INPUT_STREAM_GET_CLASS (object); +static void read_async_pollable (GPollableInputStream *stream, + GTask *task); - op->count_read = class->read_fn (G_INPUT_STREAM (object), - op->buffer, op->count_requested, - cancellable, &error); - if (op->count_read == -1) +static gboolean +read_async_pollable_ready (GPollableInputStream *stream, + gpointer user_data) +{ + GTask *task = user_data; + + read_async_pollable (stream, task); + return FALSE; +} + +static void +read_async_pollable (GPollableInputStream *stream, + GTask *task) +{ + ReadData *op = g_task_get_task_data (task); + GError *error = NULL; + gssize nread; + + if (g_task_return_error_if_cancelled (task)) + return; + + nread = G_POLLABLE_INPUT_STREAM_GET_INTERFACE (stream)-> + read_nonblocking (stream, op->buffer, op->count, &error); + + if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_WOULD_BLOCK)) { - g_simple_async_result_set_from_error (res, error); + GSource *source; + g_error_free (error); + + source = g_pollable_input_stream_create_source (stream, + g_task_get_cancellable (task)); + g_task_attach_source (task, source, + (GSourceFunc) read_async_pollable_ready); + g_source_unref (source); + return; } + + if (nread == -1) + g_task_return_error (task, error); + else + g_task_return_int (task, nread); + /* g_input_stream_real_read_async() unrefs task */ } + static void g_input_stream_real_read_async (GInputStream *stream, void *buffer, @@ -963,17 +1350,21 @@ g_input_stream_real_read_async (GInputStream *stream, GAsyncReadyCallback callback, gpointer user_data) { - GSimpleAsyncResult *res; + GTask *task; ReadData *op; - op = g_new (ReadData, 1); - res = g_simple_async_result_new (G_OBJECT (stream), callback, user_data, g_input_stream_real_read_async); - g_simple_async_result_set_op_res_gpointer (res, op, g_free); + op = g_slice_new0 (ReadData); + task = g_task_new (stream, cancellable, callback, user_data); + g_task_set_task_data (task, op, (GDestroyNotify) free_read_data); + g_task_set_priority (task, io_priority); op->buffer = buffer; - op->count_requested = count; - - g_simple_async_result_run_in_thread (res, read_async_thread, io_priority, cancellable); - g_object_unref (res); + op->count = count; + + if (!g_input_stream_async_read_is_via_threads (stream)) + read_async_pollable (G_POLLABLE_INPUT_STREAM (stream), task); + else + g_task_run_in_thread (task, read_async_thread); + g_object_unref (task); } static gssize @@ -981,52 +1372,38 @@ g_input_stream_real_read_finish (GInputStream *stream, GAsyncResult *result, GError **error) { - GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result); - ReadData *op; - - 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); + g_return_val_if_fail (g_task_is_valid (result, stream), -1); - return op->count_read; + return g_task_propagate_int (G_TASK (result), error); } -typedef struct { - gsize count_requested; - gssize count_skipped; -} SkipData; - static void -skip_async_thread (GSimpleAsyncResult *res, - GObject *object, - GCancellable *cancellable) +skip_async_thread (GTask *task, + gpointer source_object, + gpointer task_data, + GCancellable *cancellable) { - SkipData *op; + GInputStream *stream = source_object; + gsize count = GPOINTER_TO_SIZE (task_data); GInputStreamClass *class; GError *error = NULL; - - class = G_INPUT_STREAM_GET_CLASS (object); - op = g_simple_async_result_get_op_res_gpointer (res); - op->count_skipped = class->skip (G_INPUT_STREAM (object), - op->count_requested, - cancellable, &error); - if (op->count_skipped == -1) - { - g_simple_async_result_set_from_error (res, error); - g_error_free (error); - } + gssize ret; + + class = G_INPUT_STREAM_GET_CLASS (stream); + ret = class->skip (stream, count, + g_task_get_cancellable (task), + &error); + if (ret == -1) + g_task_return_error (task, error); + else + g_task_return_int (task, ret); } typedef struct { char buffer[8192]; gsize count; gsize count_skipped; - int io_prio; - GCancellable *cancellable; - gpointer user_data; - GAsyncReadyCallback callback; } SkipFallbackAsyncData; static void @@ -1035,9 +1412,8 @@ skip_callback_wrapper (GObject *source_object, gpointer user_data) { GInputStreamClass *class; - SkipFallbackAsyncData *data = user_data; - SkipData *op; - GSimpleAsyncResult *simple; + GTask *task = user_data; + SkipFallbackAsyncData *data = g_task_get_task_data (task); GError *error = NULL; gssize ret; @@ -1051,36 +1427,28 @@ skip_callback_wrapper (GObject *source_object, if (data->count > 0) { class = G_INPUT_STREAM_GET_CLASS (source_object); - class->read_async (G_INPUT_STREAM (source_object), data->buffer, MIN (8192, data->count), data->io_prio, data->cancellable, - skip_callback_wrapper, data); + class->read_async (G_INPUT_STREAM (source_object), + data->buffer, MIN (8192, data->count), + g_task_get_priority (task), + g_task_get_cancellable (task), + skip_callback_wrapper, task); return; } } - op = g_new0 (SkipData, 1); - op->count_skipped = data->count_skipped; - simple = g_simple_async_result_new (source_object, - data->callback, data->user_data, - g_input_stream_real_skip_async); - - g_simple_async_result_set_op_res_gpointer (simple, op, g_free); - - if (ret == -1) + if (ret == -1 && + g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED) && + data->count_skipped) { - if (data->count_skipped && - error->domain == G_IO_ERROR && - error->code == G_IO_ERROR_CANCELLED) - { /* No error, return partial read */ } - else - g_simple_async_result_set_from_error (simple, error); - g_error_free (error); + /* No error, return partial read */ + g_clear_error (&error); } - /* Complete immediately, not in idle, since we're already in a mainloop callout */ - g_simple_async_result_complete (simple); - g_object_unref (simple); - - g_free (data); + if (error) + g_task_return_error (task, error); + else + g_task_return_int (task, data->count_skipped); + g_object_unref (task); } static void @@ -1092,28 +1460,23 @@ g_input_stream_real_skip_async (GInputStream *stream, gpointer user_data) { GInputStreamClass *class; - SkipData *op; SkipFallbackAsyncData *data; - GSimpleAsyncResult *res; + GTask *task; class = G_INPUT_STREAM_GET_CLASS (stream); - if (class->read_async == g_input_stream_real_read_async) + task = g_task_new (stream, cancellable, callback, user_data); + g_task_set_priority (task, io_priority); + + if (g_input_stream_async_read_is_via_threads (stream)) { /* Read is thread-using async fallback. * Make skip use threads too, so that we can use a possible sync skip * implementation. */ - op = g_new0 (SkipData, 1); - - res = g_simple_async_result_new (G_OBJECT (stream), callback, user_data, - g_input_stream_real_skip_async); - - g_simple_async_result_set_op_res_gpointer (res, op, g_free); + g_task_set_task_data (task, GSIZE_TO_POINTER (count), NULL); - op->count_requested = count; - - g_simple_async_result_run_in_thread (res, skip_async_thread, io_priority, cancellable); - g_object_unref (res); + g_task_run_in_thread (task, skip_async_thread); + g_object_unref (task); } else { @@ -1123,12 +1486,10 @@ g_input_stream_real_skip_async (GInputStream *stream, data = g_new (SkipFallbackAsyncData, 1); data->count = count; data->count_skipped = 0; - data->io_prio = io_priority; - data->cancellable = cancellable; - data->callback = callback; - data->user_data = user_data; + g_task_set_task_data (task, data, g_free); + g_task_set_check_cancellable (task, FALSE); class->read_async (stream, data->buffer, MIN (8192, count), io_priority, cancellable, - skip_callback_wrapper, data); + skip_callback_wrapper, task); } } @@ -1138,35 +1499,36 @@ g_input_stream_real_skip_finish (GInputStream *stream, GAsyncResult *result, GError **error) { - GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result); - SkipData *op; + g_return_val_if_fail (g_task_is_valid (result, stream), -1); - 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; + return g_task_propagate_int (G_TASK (result), error); } static void -close_async_thread (GSimpleAsyncResult *res, - GObject *object, - GCancellable *cancellable) +close_async_thread (GTask *task, + gpointer source_object, + gpointer task_data, + GCancellable *cancellable) { + GInputStream *stream = source_object; GInputStreamClass *class; GError *error = NULL; gboolean result; - /* Auto handling of cancelation disabled, and ignore - 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) + class = G_INPUT_STREAM_GET_CLASS (stream); + if (class->close_fn) { - g_simple_async_result_set_from_error (res, error); - g_error_free (error); + result = class->close_fn (stream, + g_task_get_cancellable (task), + &error); + if (!result) + { + g_task_return_error (task, error); + return; + } } + + g_task_return_boolean (task, TRUE); } static void @@ -1176,20 +1538,14 @@ g_input_stream_real_close_async (GInputStream *stream, GAsyncReadyCallback callback, gpointer user_data) { - GSimpleAsyncResult *res; - - res = g_simple_async_result_new (G_OBJECT (stream), - callback, - user_data, - g_input_stream_real_close_async); + GTask *task; - g_simple_async_result_set_handle_cancellation (res, FALSE); + task = g_task_new (stream, cancellable, callback, user_data); + g_task_set_check_cancellable (task, FALSE); + g_task_set_priority (task, io_priority); - g_simple_async_result_run_in_thread (res, - close_async_thread, - io_priority, - cancellable); - g_object_unref (res); + g_task_run_in_thread (task, close_async_thread); + g_object_unref (task); } static gboolean @@ -1197,10 +1553,7 @@ g_input_stream_real_close_finish (GInputStream *stream, GAsyncResult *result, GError **error) { - GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result); - g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_input_stream_real_close_async); - return TRUE; -} + g_return_val_if_fail (g_task_is_valid (result, stream), FALSE); -#define __G_INPUT_STREAM_C__ -#include "gioaliasdef.c" + return g_task_propagate_boolean (G_TASK (result), error); +}