* 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 <http://www.gnu.org/licenses/>.
*
* Author: Alexander Larsson <alexl@redhat.com>
*/
-#include <config.h>
+#include "config.h"
#include <glib.h>
#include <gfileinputstream.h>
#include <gseekable.h>
-#include "gsimpleasyncresult.h"
+#include "gcancellable.h"
+#include "gasyncresult.h"
+#include "gtask.h"
+#include "gioerror.h"
#include "glibintl.h"
-#include "gioalias.h"
/**
* SECTION:gfileinputstream
* @short_description: File input streaming operations
+ * @include: gio/gio.h
* @see_also: #GInputStream, #GDataInputStream, #GSeekable
- *
- *
*
+ * GFileInputStream provides input streams that take their
+ * content from a file.
+ *
+ * GFileInputStream implements #GSeekable, which allows the input
+ * stream to jump to arbitrary positions in the file, provided the
+ * filesystem of the file allows it. To find the position of a file
+ * input stream, use g_seekable_tell(). To find out if a file input
+ * stream supports seeking, use g_seekable_can_seek().
+ * To position a file input stream, use g_seekable_seek().
**/
static void g_file_input_stream_seekable_iface_init (GSeekableIface *iface);
GCancellable *cancellable,
GError **error);
static void g_file_input_stream_real_query_info_async (GFileInputStream *stream,
- char *attributes,
+ const char *attributes,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
GError **error);
-G_DEFINE_TYPE_WITH_CODE (GFileInputStream, g_file_input_stream, G_TYPE_INPUT_STREAM,
- G_IMPLEMENT_INTERFACE (G_TYPE_SEEKABLE,
- g_file_input_stream_seekable_iface_init))
-
struct _GFileInputStreamPrivate {
GAsyncReadyCallback outstanding_callback;
};
+G_DEFINE_TYPE_WITH_CODE (GFileInputStream, g_file_input_stream, G_TYPE_INPUT_STREAM,
+ G_ADD_PRIVATE (GFileInputStream)
+ G_IMPLEMENT_INTERFACE (G_TYPE_SEEKABLE,
+ g_file_input_stream_seekable_iface_init))
+
static void
g_file_input_stream_class_init (GFileInputStreamClass *klass)
{
- g_type_class_add_private (klass, sizeof (GFileInputStreamPrivate));
-
klass->query_info_async = g_file_input_stream_real_query_info_async;
klass->query_info_finish = g_file_input_stream_real_query_info_finish;
}
static void
g_file_input_stream_init (GFileInputStream *stream)
{
- stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (stream,
- G_TYPE_FILE_INPUT_STREAM,
- GFileInputStreamPrivate);
+ stream->priv = g_file_input_stream_get_instance_private (stream);
}
/**
* g_file_input_stream_query_info:
* @stream: a #GFileInputStream.
* @attributes: a file attribute query string.
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError location to store the error occuring, or %NULL to
+ * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
+ * @error: a #GError location to store the error occurring, or %NULL to
* ignore.
*
- * Queries a file input stream the given @attributes.his function blocks
+ * Queries a file input stream the given @attributes. This function blocks
* while querying the stream. For the asynchronous (non-blocking) version
* of this function, see g_file_input_stream_query_info_async(). While the
* stream is blocked, the stream will set the pending flag internally, and
* any other operations on the stream will fail with %G_IO_ERROR_PENDING.
*
- * Returns: a #GFileInfo, or %NULL on error.
+ * Returns: (transfer full): a #GFileInfo, or %NULL on error.
**/
GFileInfo *
g_file_input_stream_query_info (GFileInputStream *stream,
- char *attributes,
+ const char *attributes,
GCancellable *cancellable,
GError **error)
{
if (class->query_info)
info = class->query_info (stream, attributes, cancellable, error);
else
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
- _("Stream doesn't support query_info"));
+ g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
+ _("Stream doesn't support query_info"));
if (cancellable)
g_cancellable_pop_current (cancellable);
* g_file_input_stream_query_info_async:
* @stream: a #GFileInputStream.
* @attributes: a file attribute query string.
- * @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 [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
*
- * Queries the stream information asynchronously. For the synchronous
- * version of this function, see g_file_input_stream_query_info().
+ * Queries the stream information asynchronously.
+ * When the operation is finished @callback will be called.
+ * You can then call g_file_input_stream_query_info_finish()
+ * to get the result of the operation.
+ *
+ * For the synchronous version of this function,
+ * see g_file_input_stream_query_info().
*
* If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
**/
void
g_file_input_stream_query_info_async (GFileInputStream *stream,
- char *attributes,
+ const char *attributes,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
if (!g_input_stream_set_pending (input_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_file_input_stream_query_info_async,
+ error);
return;
}
stream->priv->outstanding_callback = callback;
g_object_ref (stream);
klass->query_info_async (stream, attributes, io_priority, cancellable,
- async_ready_callback_wrapper, user_data);
+ async_ready_callback_wrapper, user_data);
}
/**
* g_file_input_stream_query_info_finish:
* @stream: a #GFileInputStream.
* @result: a #GAsyncResult.
- * @error: a #GError location to store the error occuring,
+ * @error: a #GError location to store the error occurring,
* or %NULL to ignore.
*
* Finishes an asynchronous info query operation.
*
- * Returns: #GFileInfo.
+ * Returns: (transfer full): #GFileInfo.
**/
GFileInfo *
g_file_input_stream_query_info_finish (GFileInputStream *stream,
GAsyncResult *result,
GError **error)
{
- GSimpleAsyncResult *simple;
GFileInputStreamClass *class;
g_return_val_if_fail (G_IS_FILE_INPUT_STREAM (stream), NULL);
g_return_val_if_fail (G_IS_ASYNC_RESULT (result), NULL);
- if (G_IS_SIMPLE_ASYNC_RESULT (result))
- {
- simple = G_SIMPLE_ASYNC_RESULT (result);
- if (g_simple_async_result_propagate_error (simple, error))
- return NULL;
- }
+ if (g_async_result_legacy_propagate_error (result, error))
+ return NULL;
+ else if (g_async_result_is_tagged (result, g_file_input_stream_query_info_async))
+ return g_task_propagate_pointer (G_TASK (result), error);
class = G_FILE_INPUT_STREAM_GET_CLASS (stream);
return class->query_info_finish (stream, result, error);
}
-/**
- * g_file_input_stream_tell:
- * @stream: a #GFileInputStream.
- *
- * Gets the current position in the stream.
- *
- * Returns: a #goffset with the position in the stream.
- **/
-goffset
+static goffset
g_file_input_stream_tell (GFileInputStream *stream)
{
GFileInputStreamClass *class;
return g_file_input_stream_tell (G_FILE_INPUT_STREAM (seekable));
}
-/**
- * g_file_input_stream_can_seek:
- * @stream: a #GFileInputStream.
- *
- * Checks if a file input stream can be seeked.
- *
- * Returns: %TRUE if stream can be seeked. %FALSE otherwise.
- **/
-gboolean
+static gboolean
g_file_input_stream_can_seek (GFileInputStream *stream)
{
GFileInputStreamClass *class;
return g_file_input_stream_can_seek (G_FILE_INPUT_STREAM (seekable));
}
-/**
- * g_file_input_stream_seek:
- * @stream: a #GFileInputStream.
- * @offset: a #goffset to seek.
- * @type: a #GSeekType.
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError location to store the error occuring, or
- * %NULL to ignore.
- *
- * Seeks in the file input stream.
- *
- * 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 set.
- *
- * Returns: %TRUE if the stream was successfully seeked to the position.
- * %FALSE on error.
- **/
-gboolean
+static gboolean
g_file_input_stream_seek (GFileInputStream *stream,
goffset offset,
GSeekType type,
if (!class->seek)
{
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
- _("Seek not supported on stream"));
+ g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
+ _("Seek not supported on stream"));
return FALSE;
}
GCancellable *cancellable,
GError **error)
{
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
- _("Truncate not allowed on input stream"));
+ g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
+ _("Truncate not allowed on input stream"));
return FALSE;
}
* Default implementation of async ops *
********************************************/
-typedef struct {
- char *attributes;
- GFileInfo *info;
-} QueryInfoAsyncData;
-
static void
-query_info_data_free (QueryInfoAsyncData *data)
-{
- if (data->info)
- g_object_unref (data->info);
- g_free (data->attributes);
- g_free (data);
-}
-
-static void
-query_info_async_thread (GSimpleAsyncResult *res,
- GObject *object,
- GCancellable *cancellable)
+query_info_async_thread (GTask *task,
+ gpointer source_object,
+ gpointer task_data,
+ GCancellable *cancellable)
{
+ GFileInputStream *stream = source_object;
+ const char *attributes = task_data;
GFileInputStreamClass *class;
GError *error = NULL;
- QueryInfoAsyncData *data;
- GFileInfo *info;
-
- data = g_simple_async_result_get_op_res_gpointer (res);
+ GFileInfo *info = NULL;
- info = NULL;
-
- class = G_FILE_INPUT_STREAM_GET_CLASS (object);
+ class = G_FILE_INPUT_STREAM_GET_CLASS (stream);
if (class->query_info)
- info = class->query_info (G_FILE_INPUT_STREAM (object), data->attributes, cancellable, &error);
+ info = class->query_info (stream, attributes, cancellable, &error);
else
- g_set_error (&error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
- _("Stream doesn't support query_info"));
+ g_set_error_literal (&error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
+ _("Stream doesn't support query_info"));
if (info == NULL)
- {
- g_simple_async_result_set_from_error (res, error);
- g_error_free (error);
- }
+ g_task_return_error (task, error);
else
- data->info = info;
+ g_task_return_pointer (task, info, g_object_unref);
}
static void
g_file_input_stream_real_query_info_async (GFileInputStream *stream,
- char *attributes,
+ const char *attributes,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
- GSimpleAsyncResult *res;
- QueryInfoAsyncData *data;
+ GTask *task;
- data = g_new0 (QueryInfoAsyncData, 1);
- data->attributes = g_strdup (attributes);
-
- res = g_simple_async_result_new (G_OBJECT (stream), callback, user_data, g_file_input_stream_real_query_info_async);
- g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_info_data_free);
+ task = g_task_new (stream, cancellable, callback, user_data);
+ g_task_set_task_data (task, g_strdup (attributes), g_free);
+ g_task_set_priority (task, io_priority);
- g_simple_async_result_run_in_thread (res, query_info_async_thread, io_priority, cancellable);
- g_object_unref (res);
+ g_task_run_in_thread (task, query_info_async_thread);
+ g_object_unref (task);
}
static GFileInfo *
GAsyncResult *res,
GError **error)
{
- GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
- QueryInfoAsyncData *data;
-
- g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_input_stream_real_query_info_async);
+ g_return_val_if_fail (g_task_is_valid (res, stream), NULL);
- data = g_simple_async_result_get_op_res_gpointer (simple);
- if (data->info)
- return g_object_ref (data->info);
-
- return NULL;
+ return g_task_propagate_pointer (G_TASK (res), error);
}
-
-#define __G_FILE_INPUT_STREAM_C__
-#include "gioaliasdef.c"
-
projects / platform / upstream / glib.git / blobdiff