1 /* GIO - GLib Input, IO and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
26 #include <gfileiostream.h>
27 #include <gseekable.h>
28 #include "gasyncresult.h"
30 #include "gcancellable.h"
32 #include "gfileoutputstream.h"
37 * SECTION:gfileiostream
38 * @short_description: File read and write streaming operations
40 * @see_also: #GIOStream, #GFileInputStream, #GFileOutputStream, #GSeekable
42 * GFileIOStream provides io streams that both read and write to the same
45 * GFileIOStream implements #GSeekable, which allows the io
46 * stream to jump to arbitrary positions in the file and to truncate
47 * the file, provided the filesystem of the file supports these
50 * To find the position of a file io stream, use
53 * To find out if a file io stream supports seeking, use g_seekable_can_seek().
54 * To position a file io stream, use g_seekable_seek().
55 * To find out if a file io stream supports truncating, use
56 * g_seekable_can_truncate(). To truncate a file io
57 * stream, use g_seekable_truncate().
59 * The default implementation of all the #GFileIOStream operations
60 * and the implementation of #GSeekable just call into the same operations
61 * on the output stream.
65 static void g_file_io_stream_seekable_iface_init (GSeekableIface
*iface
);
66 static goffset
g_file_io_stream_seekable_tell (GSeekable
*seekable
);
67 static gboolean
g_file_io_stream_seekable_can_seek (GSeekable
*seekable
);
68 static gboolean
g_file_io_stream_seekable_seek (GSeekable
*seekable
,
71 GCancellable
*cancellable
,
73 static gboolean
g_file_io_stream_seekable_can_truncate (GSeekable
*seekable
);
74 static gboolean
g_file_io_stream_seekable_truncate (GSeekable
*seekable
,
76 GCancellable
*cancellable
,
78 static void g_file_io_stream_real_query_info_async (GFileIOStream
*stream
,
79 const char *attributes
,
81 GCancellable
*cancellable
,
82 GAsyncReadyCallback callback
,
84 static GFileInfo
*g_file_io_stream_real_query_info_finish (GFileIOStream
*stream
,
88 G_DEFINE_TYPE_WITH_CODE (GFileIOStream
, g_file_io_stream
, G_TYPE_IO_STREAM
,
89 G_IMPLEMENT_INTERFACE (G_TYPE_SEEKABLE
,
90 g_file_io_stream_seekable_iface_init
));
92 struct _GFileIOStreamPrivate
{
93 GAsyncReadyCallback outstanding_callback
;
97 g_file_io_stream_seekable_iface_init (GSeekableIface
*iface
)
99 iface
->tell
= g_file_io_stream_seekable_tell
;
100 iface
->can_seek
= g_file_io_stream_seekable_can_seek
;
101 iface
->seek
= g_file_io_stream_seekable_seek
;
102 iface
->can_truncate
= g_file_io_stream_seekable_can_truncate
;
103 iface
->truncate_fn
= g_file_io_stream_seekable_truncate
;
107 g_file_io_stream_init (GFileIOStream
*stream
)
109 stream
->priv
= G_TYPE_INSTANCE_GET_PRIVATE (stream
,
110 G_TYPE_FILE_IO_STREAM
,
111 GFileIOStreamPrivate
);
115 * g_file_io_stream_query_info:
116 * @stream: a #GFileIOStream.
117 * @attributes: a file attribute query string.
118 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
119 * @error: a #GError, %NULL to ignore.
121 * Queries a file io stream for the given @attributes.
122 * This function blocks while querying the stream. For the asynchronous
123 * version of this function, see g_file_io_stream_query_info_async().
124 * While the stream is blocked, the stream will set the pending flag
125 * internally, and any other operations on the stream will fail with
126 * %G_IO_ERROR_PENDING.
128 * Can fail if the stream was already closed (with @error being set to
129 * %G_IO_ERROR_CLOSED), the stream has pending operations (with @error being
130 * set to %G_IO_ERROR_PENDING), or if querying info is not supported for
131 * the stream's interface (with @error being set to %G_IO_ERROR_NOT_SUPPORTED). I
132 * all cases of failure, %NULL will be returned.
134 * If @cancellable is not %NULL, then the operation can be cancelled by
135 * triggering the cancellable object from another thread. If the operation
136 * was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will
139 * Returns: (transfer full): a #GFileInfo for the @stream, or %NULL on error.
144 g_file_io_stream_query_info (GFileIOStream
*stream
,
145 const char *attributes
,
146 GCancellable
*cancellable
,
149 GFileIOStreamClass
*class;
150 GIOStream
*io_stream
;
153 g_return_val_if_fail (G_IS_FILE_IO_STREAM (stream
), NULL
);
155 io_stream
= G_IO_STREAM (stream
);
157 if (!g_io_stream_set_pending (io_stream
, error
))
163 g_cancellable_push_current (cancellable
);
165 class = G_FILE_IO_STREAM_GET_CLASS (stream
);
166 if (class->query_info
)
167 info
= class->query_info (stream
, attributes
, cancellable
, error
);
169 g_set_error_literal (error
, G_IO_ERROR
, G_IO_ERROR_NOT_SUPPORTED
,
170 _("Stream doesn't support query_info"));
173 g_cancellable_pop_current (cancellable
);
175 g_io_stream_clear_pending (io_stream
);
181 async_ready_callback_wrapper (GObject
*source_object
,
185 GFileIOStream
*stream
= G_FILE_IO_STREAM (source_object
);
187 g_io_stream_clear_pending (G_IO_STREAM (stream
));
188 if (stream
->priv
->outstanding_callback
)
189 (*stream
->priv
->outstanding_callback
) (source_object
, res
, user_data
);
190 g_object_unref (stream
);
194 * g_file_io_stream_query_info_async:
195 * @stream: a #GFileIOStream.
196 * @attributes: a file attribute query string.
197 * @io_priority: the <link linkend="gio-GIOScheduler">I/O priority</link>
199 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
200 * @callback: (scope async): callback to call when the request is satisfied
201 * @user_data: (closure): the data to pass to callback function
203 * Asynchronously queries the @stream for a #GFileInfo. When completed,
204 * @callback will be called with a #GAsyncResult which can be used to
205 * finish the operation with g_file_io_stream_query_info_finish().
207 * For the synchronous version of this function, see
208 * g_file_io_stream_query_info().
213 g_file_io_stream_query_info_async (GFileIOStream
*stream
,
214 const char *attributes
,
216 GCancellable
*cancellable
,
217 GAsyncReadyCallback callback
,
220 GFileIOStreamClass
*klass
;
221 GIOStream
*io_stream
;
222 GError
*error
= NULL
;
224 g_return_if_fail (G_IS_FILE_IO_STREAM (stream
));
226 io_stream
= G_IO_STREAM (stream
);
228 if (!g_io_stream_set_pending (io_stream
, &error
))
230 g_task_report_error (stream
, callback
, user_data
,
231 g_file_io_stream_query_info_async
,
236 klass
= G_FILE_IO_STREAM_GET_CLASS (stream
);
238 stream
->priv
->outstanding_callback
= callback
;
239 g_object_ref (stream
);
240 klass
->query_info_async (stream
, attributes
, io_priority
, cancellable
,
241 async_ready_callback_wrapper
, user_data
);
245 * g_file_io_stream_query_info_finish:
246 * @stream: a #GFileIOStream.
247 * @result: a #GAsyncResult.
248 * @error: a #GError, %NULL to ignore.
250 * Finalizes the asynchronous query started
251 * by g_file_io_stream_query_info_async().
253 * Returns: (transfer full): A #GFileInfo for the finished query.
258 g_file_io_stream_query_info_finish (GFileIOStream
*stream
,
259 GAsyncResult
*result
,
262 GFileIOStreamClass
*class;
264 g_return_val_if_fail (G_IS_FILE_IO_STREAM (stream
), NULL
);
265 g_return_val_if_fail (G_IS_ASYNC_RESULT (result
), NULL
);
267 if (g_async_result_legacy_propagate_error (result
, error
))
269 else if (g_async_result_is_tagged (result
, g_file_io_stream_query_info_async
))
270 return g_task_propagate_pointer (G_TASK (result
), error
);
272 class = G_FILE_IO_STREAM_GET_CLASS (stream
);
273 return class->query_info_finish (stream
, result
, error
);
277 * g_file_io_stream_get_etag:
278 * @stream: a #GFileIOStream.
280 * Gets the entity tag for the file when it has been written.
281 * This must be called after the stream has been written
282 * and closed, as the etag can change while writing.
284 * Returns: the entity tag for the stream.
289 g_file_io_stream_get_etag (GFileIOStream
*stream
)
291 GFileIOStreamClass
*class;
292 GIOStream
*io_stream
;
295 g_return_val_if_fail (G_IS_FILE_IO_STREAM (stream
), NULL
);
297 io_stream
= G_IO_STREAM (stream
);
299 if (!g_io_stream_is_closed (io_stream
))
301 g_warning ("stream is not closed yet, can't get etag");
307 class = G_FILE_IO_STREAM_GET_CLASS (stream
);
309 etag
= class->get_etag (stream
);
315 g_file_io_stream_tell (GFileIOStream
*stream
)
317 GFileIOStreamClass
*class;
320 g_return_val_if_fail (G_IS_FILE_IO_STREAM (stream
), 0);
322 class = G_FILE_IO_STREAM_GET_CLASS (stream
);
326 offset
= class->tell (stream
);
332 g_file_io_stream_seekable_tell (GSeekable
*seekable
)
334 return g_file_io_stream_tell (G_FILE_IO_STREAM (seekable
));
338 g_file_io_stream_can_seek (GFileIOStream
*stream
)
340 GFileIOStreamClass
*class;
343 g_return_val_if_fail (G_IS_FILE_IO_STREAM (stream
), FALSE
);
345 class = G_FILE_IO_STREAM_GET_CLASS (stream
);
352 can_seek
= class->can_seek (stream
);
359 g_file_io_stream_seekable_can_seek (GSeekable
*seekable
)
361 return g_file_io_stream_can_seek (G_FILE_IO_STREAM (seekable
));
365 g_file_io_stream_seek (GFileIOStream
*stream
,
368 GCancellable
*cancellable
,
371 GFileIOStreamClass
*class;
372 GIOStream
*io_stream
;
375 g_return_val_if_fail (G_IS_FILE_IO_STREAM (stream
), FALSE
);
377 io_stream
= G_IO_STREAM (stream
);
378 class = G_FILE_IO_STREAM_GET_CLASS (stream
);
382 g_set_error_literal (error
, G_IO_ERROR
, G_IO_ERROR_NOT_SUPPORTED
,
383 _("Seek not supported on stream"));
387 if (!g_io_stream_set_pending (io_stream
, error
))
391 g_cancellable_push_current (cancellable
);
393 res
= class->seek (stream
, offset
, type
, cancellable
, error
);
396 g_cancellable_pop_current (cancellable
);
398 g_io_stream_clear_pending (io_stream
);
404 g_file_io_stream_seekable_seek (GSeekable
*seekable
,
407 GCancellable
*cancellable
,
410 return g_file_io_stream_seek (G_FILE_IO_STREAM (seekable
),
411 offset
, type
, cancellable
, error
);
415 g_file_io_stream_can_truncate (GFileIOStream
*stream
)
417 GFileIOStreamClass
*class;
418 gboolean can_truncate
;
420 g_return_val_if_fail (G_IS_FILE_IO_STREAM (stream
), FALSE
);
422 class = G_FILE_IO_STREAM_GET_CLASS (stream
);
424 can_truncate
= FALSE
;
425 if (class->truncate_fn
)
428 if (class->can_truncate
)
429 can_truncate
= class->can_truncate (stream
);
436 g_file_io_stream_seekable_can_truncate (GSeekable
*seekable
)
438 return g_file_io_stream_can_truncate (G_FILE_IO_STREAM (seekable
));
442 g_file_io_stream_truncate (GFileIOStream
*stream
,
444 GCancellable
*cancellable
,
447 GFileIOStreamClass
*class;
448 GIOStream
*io_stream
;
451 g_return_val_if_fail (G_IS_FILE_IO_STREAM (stream
), FALSE
);
453 io_stream
= G_IO_STREAM (stream
);
454 class = G_FILE_IO_STREAM_GET_CLASS (stream
);
456 if (!class->truncate_fn
)
458 g_set_error_literal (error
, G_IO_ERROR
, G_IO_ERROR_NOT_SUPPORTED
,
459 _("Truncate not supported on stream"));
463 if (!g_io_stream_set_pending (io_stream
, error
))
467 g_cancellable_push_current (cancellable
);
469 res
= class->truncate_fn (stream
, size
, cancellable
, error
);
472 g_cancellable_pop_current (cancellable
);
474 g_io_stream_clear_pending (io_stream
);
480 g_file_io_stream_seekable_truncate (GSeekable
*seekable
,
482 GCancellable
*cancellable
,
485 return g_file_io_stream_truncate (G_FILE_IO_STREAM (seekable
),
486 size
, cancellable
, error
);
488 /*****************************************************
489 * Default implementations based on output stream *
490 *****************************************************/
493 g_file_io_stream_real_tell (GFileIOStream
*stream
)
498 out
= g_io_stream_get_output_stream (G_IO_STREAM (stream
));
499 seekable
= G_SEEKABLE (out
);
501 return g_seekable_tell (seekable
);
505 g_file_io_stream_real_can_seek (GFileIOStream
*stream
)
510 out
= g_io_stream_get_output_stream (G_IO_STREAM (stream
));
511 seekable
= G_SEEKABLE (out
);
513 return g_seekable_can_seek (seekable
);
517 g_file_io_stream_real_seek (GFileIOStream
*stream
,
520 GCancellable
*cancellable
,
526 out
= g_io_stream_get_output_stream (G_IO_STREAM (stream
));
527 seekable
= G_SEEKABLE (out
);
529 return g_seekable_seek (seekable
, offset
, type
, cancellable
, error
);
533 g_file_io_stream_real_can_truncate (GFileIOStream
*stream
)
538 out
= g_io_stream_get_output_stream (G_IO_STREAM (stream
));
539 seekable
= G_SEEKABLE (out
);
541 return g_seekable_can_truncate (seekable
);
545 g_file_io_stream_real_truncate_fn (GFileIOStream
*stream
,
547 GCancellable
*cancellable
,
553 out
= g_io_stream_get_output_stream (G_IO_STREAM (stream
));
554 seekable
= G_SEEKABLE (out
);
556 return g_seekable_truncate (seekable
, size
, cancellable
, error
);
560 g_file_io_stream_real_get_etag (GFileIOStream
*stream
)
563 GFileOutputStream
*file_out
;
565 out
= g_io_stream_get_output_stream (G_IO_STREAM (stream
));
566 file_out
= G_FILE_OUTPUT_STREAM (out
);
568 return g_file_output_stream_get_etag (file_out
);
572 g_file_io_stream_real_query_info (GFileIOStream
*stream
,
573 const char *attributes
,
574 GCancellable
*cancellable
,
578 GFileOutputStream
*file_out
;
580 out
= g_io_stream_get_output_stream (G_IO_STREAM (stream
));
581 file_out
= G_FILE_OUTPUT_STREAM (out
);
583 return g_file_output_stream_query_info (file_out
,
584 attributes
, cancellable
, error
);
589 GAsyncReadyCallback callback
;
593 static AsyncOpWrapper
*
594 async_op_wrapper_new (gpointer object
,
595 GAsyncReadyCallback callback
,
598 AsyncOpWrapper
*data
;
600 data
= g_new0 (AsyncOpWrapper
, 1);
601 data
->object
= g_object_ref (object
);
602 data
->callback
= callback
;
603 data
->user_data
= user_data
;
609 async_op_wrapper_callback (GObject
*source_object
,
613 AsyncOpWrapper
*data
= user_data
;
614 data
->callback (data
->object
, res
, data
->user_data
);
615 g_object_unref (data
->object
);
620 g_file_io_stream_real_query_info_async (GFileIOStream
*stream
,
621 const char *attributes
,
623 GCancellable
*cancellable
,
624 GAsyncReadyCallback callback
,
628 GFileOutputStream
*file_out
;
629 AsyncOpWrapper
*data
;
631 out
= g_io_stream_get_output_stream (G_IO_STREAM (stream
));
632 file_out
= G_FILE_OUTPUT_STREAM (out
);
634 data
= async_op_wrapper_new (stream
, callback
, user_data
);
635 g_file_output_stream_query_info_async (file_out
,
636 attributes
, io_priority
,
637 cancellable
, async_op_wrapper_callback
, data
);
641 g_file_io_stream_real_query_info_finish (GFileIOStream
*stream
,
646 GFileOutputStream
*file_out
;
648 out
= g_io_stream_get_output_stream (G_IO_STREAM (stream
));
649 file_out
= G_FILE_OUTPUT_STREAM (out
);
651 return g_file_output_stream_query_info_finish (file_out
, res
, error
);
655 g_file_io_stream_class_init (GFileIOStreamClass
*klass
)
657 g_type_class_add_private (klass
, sizeof (GFileIOStreamPrivate
));
659 klass
->tell
= g_file_io_stream_real_tell
;
660 klass
->can_seek
= g_file_io_stream_real_can_seek
;
661 klass
->seek
= g_file_io_stream_real_seek
;
662 klass
->can_truncate
= g_file_io_stream_real_can_truncate
;
663 klass
->truncate_fn
= g_file_io_stream_real_truncate_fn
;
664 klass
->query_info
= g_file_io_stream_real_query_info
;
665 klass
->query_info_async
= g_file_io_stream_real_query_info_async
;
666 klass
->query_info_finish
= g_file_io_stream_real_query_info_finish
;
667 klass
->get_etag
= g_file_io_stream_real_get_etag
;