1 /* GIO - GLib Input, Output and Streaming Library 2 * 3 * Copyright (C) 2006-2007 Red Hat, Inc. 4 * 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.1 of the License, or (at your option) any later version. 9 * 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. 14 * 15 * You should have received a copy of the GNU Lesser General 16 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>. 17 * 18 * Author: Alexander Larsson <alexl@redhat.com> 19 */ 20 21 #ifndef __G_FILE_INPUT_STREAM_H__ 22 #define __G_FILE_INPUT_STREAM_H__ 23 24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION) 25 #error "Only <gio/gio.h> can be included directly." 26 #endif 27 28 #include <gio/ginputstream.h> 29 30 G_BEGIN_DECLS 31 32 #define G_TYPE_FILE_INPUT_STREAM (g_file_input_stream_get_type ()) 33 #define G_FILE_INPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_INPUT_STREAM, GFileInputStream)) 34 #define G_FILE_INPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_INPUT_STREAM, GFileInputStreamClass)) 35 #define G_IS_FILE_INPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_INPUT_STREAM)) 36 #define G_IS_FILE_INPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_INPUT_STREAM)) 37 #define G_FILE_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_INPUT_STREAM, GFileInputStreamClass)) 38 39 /** 40 * GFileInputStream: 41 * 42 * A subclass of GInputStream for opened files. This adds 43 * a few file-specific operations and seeking. 44 * 45 * #GFileInputStream implements #GSeekable. 46 **/ 47 typedef struct _GFileInputStreamClass GFileInputStreamClass; 48 typedef struct _GFileInputStreamPrivate GFileInputStreamPrivate; 49 50 struct _GFileInputStream 51 { 52 GInputStream parent_instance; 53 54 /*< private >*/ 55 GFileInputStreamPrivate *priv; 56 }; 57 58 struct _GFileInputStreamClass 59 { 60 GInputStreamClass parent_class; 61 62 goffset (* tell) (GFileInputStream *stream); 63 gboolean (* can_seek) (GFileInputStream *stream); 64 gboolean (* seek) (GFileInputStream *stream, 65 goffset offset, 66 GSeekType type, 67 GCancellable *cancellable, 68 GError **error); 69 GFileInfo * (* query_info) (GFileInputStream *stream, 70 const char *attributes, 71 GCancellable *cancellable, 72 GError **error); 73 void (* query_info_async) (GFileInputStream *stream, 74 const char *attributes, 75 int io_priority, 76 GCancellable *cancellable, 77 GAsyncReadyCallback callback, 78 gpointer user_data); 79 GFileInfo * (* query_info_finish) (GFileInputStream *stream, 80 GAsyncResult *result, 81 GError **error); 82 83 /*< private >*/ 84 /* Padding for future expansion */ 85 void (*_g_reserved1) (void); 86 void (*_g_reserved2) (void); 87 void (*_g_reserved3) (void); 88 void (*_g_reserved4) (void); 89 void (*_g_reserved5) (void); 90 }; 91 92 GLIB_AVAILABLE_IN_ALL 93 GType g_file_input_stream_get_type (void) G_GNUC_CONST; 94 95 GLIB_AVAILABLE_IN_ALL 96 GFileInfo *g_file_input_stream_query_info (GFileInputStream *stream, 97 const char *attributes, 98 GCancellable *cancellable, 99 GError **error); 100 GLIB_AVAILABLE_IN_ALL 101 void g_file_input_stream_query_info_async (GFileInputStream *stream, 102 const char *attributes, 103 int io_priority, 104 GCancellable *cancellable, 105 GAsyncReadyCallback callback, 106 gpointer user_data); 107 GLIB_AVAILABLE_IN_ALL 108 GFileInfo *g_file_input_stream_query_info_finish (GFileInputStream *stream, 109 GAsyncResult *result, 110 GError **error); 111 112 G_END_DECLS 113 114 #endif /* __G_FILE_FILE_INPUT_STREAM_H__ */ 115