* 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 "gcancellable.h"
+#include "gioerror.h"
#include "glibintl.h"
+
/**
* SECTION:gfileoutputstream
- * @short_description: file output streaming operations
- * @see_also: #GOutputStream, #GDataOutputStream, #GSeekable.
- *
+ * @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,
iface->can_seek = g_file_output_stream_seekable_can_seek;
iface->seek = g_file_output_stream_seekable_seek;
iface->can_truncate = g_file_output_stream_seekable_can_truncate;
- iface->truncate = g_file_output_stream_seekable_truncate;
+ iface->truncate_fn = g_file_output_stream_seekable_truncate;
}
static void
* 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)
{
output_stream = G_OUTPUT_STREAM (stream);
- if (g_output_stream_is_closed (output_stream))
- {
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
- _("Stream is already closed"));
- return NULL;
- }
-
- if (g_output_stream_has_pending (output_stream))
- {
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_PENDING,
- _("Stream has outstanding operation"));
- return NULL;
- }
+ if (!g_output_stream_set_pending (output_stream, error))
+ return NULL;
info = NULL;
- g_output_stream_set_pending (output_stream, TRUE);
-
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_set_pending (output_stream, FALSE);
+ g_output_stream_clear_pending (output_stream);
return info;
}
{
GFileOutputStream *stream = G_FILE_OUTPUT_STREAM (source_object);
- g_output_stream_set_pending (G_OUTPUT_STREAM (stream), FALSE);
+ g_output_stream_clear_pending (G_OUTPUT_STREAM (stream));
if (stream->priv->outstanding_callback)
(*stream->priv->outstanding_callback) (source_object, res, user_data);
g_object_unref (stream);
* g_file_output_stream_query_info_async:
* @stream: a #GFileOutputStream.
* @attributes: a file attribute query string.
- * @io_priority: the io priority of the request.
+ * @io_priority: the <link linkend="gio-GIOScheduler">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
**/
void
g_file_output_stream_query_info_async (GFileOutputStream *stream,
- char *attributes,
+ const char *attributes,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
{
GFileOutputStreamClass *klass;
GOutputStream *output_stream;
+ GError *error = NULL;
g_return_if_fail (G_IS_FILE_OUTPUT_STREAM (stream));
output_stream = G_OUTPUT_STREAM (stream);
- if (g_output_stream_is_closed (output_stream))
- {
- g_simple_async_report_error_in_idle (G_OBJECT (stream),
- callback,
- user_data,
- G_IO_ERROR, G_IO_ERROR_CLOSED,
- _("Stream is already closed"));
- return;
- }
-
- if (g_output_stream_has_pending (output_stream))
+ if (!g_output_stream_set_pending (output_stream, &error))
{
- g_simple_async_report_error_in_idle (G_OBJECT (stream),
- callback,
- user_data,
- G_IO_ERROR, G_IO_ERROR_PENDING,
- _("Stream has outstanding operation"));
+ g_simple_async_report_take_gerror_in_idle (G_OBJECT (stream),
+ callback,
+ user_data,
+ error);
return;
}
klass = G_FILE_OUTPUT_STREAM_GET_CLASS (stream);
- g_output_stream_set_pending (output_stream, TRUE);
stream->priv->outstanding_callback = callback;
g_object_ref (stream);
klass->query_info_async (stream, attributes, io_priority, cancellable,
* 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,
* g_file_output_stream_get_etag:
* @stream: a #GFileOutputStream.
*
- * Gets the entity tag for the file output stream.
+ * 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.
*
* 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,
output_stream = G_OUTPUT_STREAM (stream);
class = G_FILE_OUTPUT_STREAM_GET_CLASS (stream);
- if (g_output_stream_is_closed (output_stream))
- {
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
- _("Stream is already closed"));
- return FALSE;
- }
-
- if (g_output_stream_has_pending (output_stream))
- {
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_PENDING,
- _("Stream has outstanding operation"));
- return FALSE;
- }
-
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;
}
- g_output_stream_set_pending (output_stream, TRUE);
+ if (!g_output_stream_set_pending (output_stream, error))
+ 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_set_pending (output_stream, FALSE);
+ g_output_stream_clear_pending (output_stream);
return res;
}
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;
class = G_FILE_OUTPUT_STREAM_GET_CLASS (stream);
can_truncate = FALSE;
- if (class->truncate)
+ if (class->truncate_fn)
{
can_truncate = TRUE;
if (class->can_truncate)
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,
output_stream = G_OUTPUT_STREAM (stream);
class = G_FILE_OUTPUT_STREAM_GET_CLASS (stream);
- if (g_output_stream_is_closed (output_stream))
+ if (!class->truncate_fn)
{
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
- _("Stream is already closed"));
- return FALSE;
- }
-
- if (g_output_stream_has_pending (output_stream))
- {
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_PENDING,
- _("Stream has outstanding operation"));
- return FALSE;
- }
-
- if (!class->truncate)
- {
- 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;
}
- g_output_stream_set_pending (output_stream, TRUE);
+ if (!g_output_stream_set_pending (output_stream, error))
+ return FALSE;
if (cancellable)
- g_push_current_cancellable (cancellable);
+ g_cancellable_push_current (cancellable);
- res = class->truncate (stream, size, cancellable, error);
+ res = class->truncate_fn (stream, size, cancellable, error);
if (cancellable)
- g_pop_current_cancellable (cancellable);
+ g_cancellable_pop_current (cancellable);
- g_output_stream_set_pending (output_stream, FALSE);
+ g_output_stream_clear_pending (output_stream);
return res;
}
if (class->query_info)
info = class->query_info (G_FILE_OUTPUT_STREAM (object), data->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_simple_async_result_take_error (res, error);
else
data->info = info;
}
static void
g_file_output_stream_real_query_info_async (GFileOutputStream *stream,
- char *attributes,
+ const char *attributes,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
QueryInfoAsyncData *data;
- g_assert (g_simple_async_result_get_source_tag (simple) == g_file_output_stream_real_query_info_async);
+ g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_output_stream_real_query_info_async);
data = g_simple_async_result_get_op_res_gpointer (simple);
if (data->info)
projects / platform / upstream / glib.git / blobdiff