* 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 <gfileoutputstream.h>
#include <gseekable.h>
-#include "gsimpleasyncresult.h"
+#include "gasyncresult.h"
+#include "gtask.h"
+#include "gcancellable.h"
+#include "gioerror.h"
#include "glibintl.h"
-#include "gioalias.h"
/**
* SECTION:gfileoutputstream
* @short_description: File output streaming operations
+ * @include: gio/gio.h
* @see_also: #GOutputStream, #GDataOutputStream, #GSeekable
*
- *
+ * GFileOutputStream provides output streams that write their
+ * content to a file.
+ *
+ * GFileOutputStream implements #GSeekable, which allows the output
+ * stream to jump to arbitrary positions in the file and to truncate
+ * the file, provided the filesystem of the file supports these
+ * operations.
*
+ * To find the position of a file output stream, use g_seekable_tell().
+ * To find out if a file output stream supports seeking, use
+ * g_seekable_can_seek().To position a file output stream, use
+ * g_seekable_seek(). To find out if a file output stream supports
+ * truncating, use g_seekable_can_truncate(). To truncate a file output
+ * stream, use g_seekable_truncate().
**/
static void g_file_output_stream_seekable_iface_init (GSeekableIface *iface);
GCancellable *cancellable,
GError **error);
static void g_file_output_stream_real_query_info_async (GFileOutputStream *stream,
- char *attributes,
+ const char *attributes,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
GAsyncResult *result,
GError **error);
-G_DEFINE_TYPE_WITH_CODE (GFileOutputStream, g_file_output_stream, G_TYPE_OUTPUT_STREAM,
- G_IMPLEMENT_INTERFACE (G_TYPE_SEEKABLE,
- g_file_output_stream_seekable_iface_init));
-
struct _GFileOutputStreamPrivate {
GAsyncReadyCallback outstanding_callback;
};
+G_DEFINE_TYPE_WITH_CODE (GFileOutputStream, g_file_output_stream, G_TYPE_OUTPUT_STREAM,
+ G_ADD_PRIVATE (GFileOutputStream)
+ G_IMPLEMENT_INTERFACE (G_TYPE_SEEKABLE,
+ g_file_output_stream_seekable_iface_init));
+
static void
g_file_output_stream_class_init (GFileOutputStreamClass *klass)
{
- g_type_class_add_private (klass, sizeof (GFileOutputStreamPrivate));
-
klass->query_info_async = g_file_output_stream_real_query_info_async;
klass->query_info_finish = g_file_output_stream_real_query_info_finish;
}
static void
g_file_output_stream_init (GFileOutputStream *stream)
{
- stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (stream,
- G_TYPE_FILE_OUTPUT_STREAM,
- GFileOutputStreamPrivate);
+ stream->priv = g_file_output_stream_get_instance_private (stream);
}
/**
* was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will
* be returned.
*
- * Returns: a #GFileInfo for the @stream, or %NULL on error.
+ * Returns: (transfer full): a #GFileInfo for the @stream, or %NULL on error.
**/
GFileInfo *
g_file_output_stream_query_info (GFileOutputStream *stream,
- char *attributes,
+ const char *attributes,
GCancellable *cancellable,
GError **error)
{
info = NULL;
if (cancellable)
- g_push_current_cancellable (cancellable);
+ g_cancellable_push_current (cancellable);
class = G_FILE_OUTPUT_STREAM_GET_CLASS (stream);
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_pop_current_cancellable (cancellable);
+ g_cancellable_pop_current (cancellable);
g_output_stream_clear_pending (output_stream);
* g_file_output_stream_query_info_async:
* @stream: a #GFileOutputStream.
* @attributes: a file attribute query string.
- * @io_priority: the <link linkend="gio-GIOScheduler">I/O priority</link>
- * of the request.
+ * @io_priority: the [I/O priority][gio-GIOScheduler] 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
**/
void
g_file_output_stream_query_info_async (GFileOutputStream *stream,
- char *attributes,
+ const char *attributes,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
if (!g_output_stream_set_pending (output_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_output_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);
}
/**
* Finalizes the asynchronous query started
* by g_file_output_stream_query_info_async().
*
- * Returns: A #GFileInfo for the finished query.
+ * Returns: (transfer full): A #GFileInfo for the finished query.
**/
GFileInfo *
g_file_output_stream_query_info_finish (GFileOutputStream *stream,
GAsyncResult *result,
GError **error)
{
- GSimpleAsyncResult *simple;
GFileOutputStreamClass *class;
g_return_val_if_fail (G_IS_FILE_OUTPUT_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_output_stream_query_info_async))
+ return g_task_propagate_pointer (G_TASK (result), error);
class = G_FILE_OUTPUT_STREAM_GET_CLASS (stream);
return class->query_info_finish (stream, result, error);
* g_file_output_stream_get_etag:
* @stream: a #GFileOutputStream.
*
- * Gets the entity tag for the file when its been written.
+ * Gets the entity tag for the file when it has been written.
* This must be called after the stream has been written
- * and closed. As the etag can change while writing.
+ * and closed, as the etag can change while writing.
*
* Returns: the entity tag for the stream.
**/
return etag;
}
-/**
- * g_file_output_stream_tell:
- * @stream: a #GFileOutputStream.
- *
- * Gets the current location within the stream.
- *
- * Returns: a #goffset of the location within the stream.
- **/
-goffset
+static goffset
g_file_output_stream_tell (GFileOutputStream *stream)
{
GFileOutputStreamClass *class;
return g_file_output_stream_tell (G_FILE_OUTPUT_STREAM (seekable));
}
-/**
- * g_file_output_stream_can_seek:
- * @stream: a #GFileOutputStream.
- *
- * Checks if the stream can be seeked.
- *
- * Returns: %TRUE if seeking is supported by the stream.
- **/
-gboolean
+static gboolean
g_file_output_stream_can_seek (GFileOutputStream *stream)
{
GFileOutputStreamClass *class;
return g_file_output_stream_can_seek (G_FILE_OUTPUT_STREAM (seekable));
}
-/**
- * g_file_output_stream_seek:
- * @stream: a #GFileOutputStream.
- * @offset: a #goffset to seek.
- * @type: a #GSeekType.
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError, %NULL to ignore.
- *
- * Seeks to a location in a file output stream.
- *
- * Returns: %TRUE if the seek was successful. %FALSE otherwise.
- **/
-gboolean
+static gboolean
g_file_output_stream_seek (GFileOutputStream *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;
}
return FALSE;
if (cancellable)
- g_push_current_cancellable (cancellable);
+ g_cancellable_push_current (cancellable);
res = class->seek (stream, offset, type, cancellable, error);
if (cancellable)
- g_pop_current_cancellable (cancellable);
+ g_cancellable_pop_current (cancellable);
g_output_stream_clear_pending (output_stream);
offset, type, cancellable, error);
}
-/**
- * g_file_output_stream_can_truncate:
- * @stream: a #GFileOutputStream.
- *
- * Checks if the stream can be truncated.
- *
- * Returns: %TRUE if stream can be truncated.
- **/
-gboolean
+static gboolean
g_file_output_stream_can_truncate (GFileOutputStream *stream)
{
GFileOutputStreamClass *class;
return g_file_output_stream_can_truncate (G_FILE_OUTPUT_STREAM (seekable));
}
-/**
- * g_file_output_stream_truncate:
- * @stream: a #GFileOutputStream.
- * @size: a #goffset to truncate the stream at.
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError, %NULL to ignore.
- *
- * Truncates a file output stream.
- *
- * Returns: %TRUE if @stream is truncated successfully.
- **/
-gboolean
+static gboolean
g_file_output_stream_truncate (GFileOutputStream *stream,
goffset size,
GCancellable *cancellable,
if (!class->truncate_fn)
{
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
- _("Truncate not supported on stream"));
+ g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
+ _("Truncate not supported on stream"));
return FALSE;
}
return FALSE;
if (cancellable)
- g_push_current_cancellable (cancellable);
+ g_cancellable_push_current (cancellable);
res = class->truncate_fn (stream, size, cancellable, error);
if (cancellable)
- g_pop_current_cancellable (cancellable);
+ g_cancellable_pop_current (cancellable);
g_output_stream_clear_pending (output_stream);
* 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)
{
+ GFileOutputStream *stream = source_object;
+ const char *attributes = task_data;
GFileOutputStreamClass *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_OUTPUT_STREAM_GET_CLASS (object);
+ class = G_FILE_OUTPUT_STREAM_GET_CLASS (stream);
if (class->query_info)
- info = class->query_info (G_FILE_OUTPUT_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_output_stream_real_query_info_async (GFileOutputStream *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);
+ 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);
- res = g_simple_async_result_new (G_OBJECT (stream), callback, user_data, g_file_output_stream_real_query_info_async);
- g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_info_data_free);
-
- 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 *
g_file_output_stream_real_query_info_finish (GFileOutputStream *stream,
- GAsyncResult *res,
- GError **error)
+ 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_output_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_OUTPUT_STREAM_C__
-#include "gioaliasdef.c"
projects / platform / upstream / glib.git / blobdiff