summaryrefslogtreecommitdiff
path: root/gio/gfile.h
blob: 7eab52604ccb7fc3b2cdbf0201234476484265e6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
#ifndef __G_FILE_H__
#define __G_FILE_H__

#include <glib-object.h>
#include <gio/giotypes.h>
#include <gio/gfileinfo.h>
#include <gio/gfileenumerator.h>
#include <gio/gfileinputstream.h>
#include <gio/gfileoutputstream.h>
#include <gio/gmountoperation.h>

G_BEGIN_DECLS

#define G_TYPE_FILE            (g_file_get_type ())
#define G_FILE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_FILE, GFile))
#define G_IS_FILE(obj)	       (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_FILE))
#define G_FILE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_FILE, GFileIface))

typedef enum {
  G_FILE_GET_INFO_NOFOLLOW_SYMLINKS = (1<<0)
} GFileGetInfoFlags;

typedef enum {
  G_FILE_COPY_OVERWRITE = (1<<0),
  G_FILE_COPY_BACKUP = (1<<1)
} GFileCopyFlags;

typedef struct _GFile         		GFile; /* Dummy typedef */
typedef struct _GFileIface    		GFileIface;
typedef struct _GDirectoryMonitor       GDirectoryMonitor;
typedef struct _GFileMonitor            GFileMonitor;

typedef void (*GFileProgressCallback) (goffset current_num_bytes,
				       goffset total_num_bytes,
				       gpointer user_data);

struct _GFileIface
{
  GTypeInterface g_iface;

  /* Virtual Table */

  GFile *             (*dup)                (GFile                *file);
  guint               (*hash)               (GFile                *file);
  gboolean            (*equal)              (GFile                *file1,
					     GFile                *file2);
  gboolean            (*is_native)          (GFile                *file);
  char *              (*get_basename)       (GFile                *file);
  char *              (*get_path)           (GFile                *file);
  char *              (*get_uri)            (GFile                *file);
  char *              (*get_parse_name)     (GFile                *file);
  GFile *             (*get_parent)         (GFile                *file);
  GFile *             (*resolve_relative)   (GFile                *file,
					     const char           *relative_path);
  GFile *             (*get_child_for_display_name) (GFile        *file,
						     const char   *display_name,
						     GError      **error);
  GFileEnumerator *   (*enumerate_children) (GFile                *file,
					     const char           *attributes,
					     GFileGetInfoFlags     flags,
					     GCancellable         *cancellable,
					     GError              **error);
  GFileInfo *         (*get_info)           (GFile                *file,
					     const char           *attributes,
					     GFileGetInfoFlags     flags,
					     GCancellable         *cancellable,
					     GError              **error);
  /*                  (*get_info_async)     (GFile                *file.. */
  GFile *             (*set_display_name)   (GFile                *file,
					     const char           *display_name,
					     GCancellable         *cancellable,
					     GError              **error);
  gboolean            (*set_attribute)      (GFile                *file,
					     const char           *attribute,
					     GFileAttributeType    type,
					     gconstpointer         data,
					     GFileGetInfoFlags     flags,
					     GCancellable         *cancellable,
					     GError              **error);
  GFileInputStream *  (*read)               (GFile                *file,
					     GCancellable         *cancellable,
					     GError              **error);
  GFileOutputStream * (*append_to)          (GFile                *file,
					     GCancellable         *cancellable,
					     GError               **error);
  GFileOutputStream * (*create)             (GFile                *file,
					     GCancellable         *cancellable,
					     GError               **error);
  GFileOutputStream * (*replace)            (GFile                *file,
					     time_t                mtime,
					     gboolean              make_backup,
					     GCancellable         *cancellable,
					     GError              **error);
  gboolean            (*delete_file)        (GFile                *file,
					     GCancellable         *cancellable,
					     GError              **error);
  gboolean            (*make_directory)     (GFile                *file,
					     GCancellable         *cancellable,
					     GError              **error);
  gboolean            (*make_symbolic_link) (GFile                *file,
					     const char *symlink_value,
					     GCancellable         *cancellable,
					     GError              **error);
  gboolean            (*copy)               (GFile                *source,
					     GFile                *destination,
					     GFileCopyFlags        flags,
					     GCancellable         *cancellable,
					     GFileProgressCallback progress_callback,
					     gpointer              progress_callback_data,
					     GError              **error);
  gboolean            (*move)               (GFile                *source,
					     GFile                *destination,
					     GFileCopyFlags        flags,
					     GCancellable         *cancellable,
					     GFileProgressCallback progress_callback,
					     gpointer              progress_callback_data,
					     GError              **error);

  void                (*read_async)         (GFile                *file,
					     int                   io_priority,
					     GCancellable         *cancellable,
					     GAsyncReadyCallback   callback,
					     gpointer              user_data);
  GFileInputStream *  (*read_finish)        (GFile                *file,
					     GAsyncResult         *res,
					     GError              **error);

  void               (*mount_mountable)           (GFile               *file,
						   GMountOperation     *mount_operation,
						   GAsyncReadyCallback  callback,
						   gpointer             user_data);
  GFile *            (*mount_mountable_finish)    (GFile               *file,
						   GAsyncResult        *result,
						   GError             **error);
  void               (*unmount_mountable)         (GFile               *file,
						   GAsyncReadyCallback  callback,
						   gpointer             user_data);
  gboolean            (*unmount_mountable_finish) (GFile               *file,
						   GAsyncResult        *result,
						   GError             **error);
  void               (*eject_mountable)           (GFile               *file,
						   GAsyncReadyCallback  callback,
						   gpointer             user_data);
  gboolean            (*eject_mountable_finish)   (GFile               *file,
						   GAsyncResult        *result,
						   GError             **error);


  void     (*mount_for_location)        (GFile *location,
					 GMountOperation *mount_operation,
					 GAsyncReadyCallback callback,
					 gpointer user_data);
  gboolean (*mount_for_location_finish) (GFile *location,
					 GAsyncResult *result,
					 GError **error);
  
  GDirectoryMonitor* (*monitor_dir)         (GFile                  *file);

  GFileMonitor*      (*monitor_file)        (GFile                  *file);
};

GType g_file_get_type (void) G_GNUC_CONST;

GFile *            g_file_get_for_path               (const char             *path);
GFile *            g_file_get_for_uri                (const char             *uri);
GFile *            g_file_parse_name                 (const char             *parse_name);
GFile *            g_file_get_for_commandline_arg    (const char             *arg);
GFile *            g_file_dup                        (GFile                  *file);
guint              g_file_hash                       (gconstpointer           file);
gboolean           g_file_equal                      (GFile                  *file1,
						      GFile                  *file2);
char *             g_file_get_basename               (GFile                  *file);
char *             g_file_get_path                   (GFile                  *file);
char *             g_file_get_uri                    (GFile                  *file);
char *             g_file_get_parse_name             (GFile                  *file);
GFile *            g_file_get_parent                 (GFile                  *file);
GFile *            g_file_get_child                  (GFile                  *file,
						      const char             *name);
GFile *            g_file_get_child_for_display_name (GFile                  *file,
						      const char             *display_name,
						      GError                **error);
GFile *            g_file_resolve_relative           (GFile                  *file,
						      const char             *relative_path);
gboolean           g_file_is_native                  (GFile                  *file);
GFileInputStream * g_file_read                       (GFile                  *file,
						      GCancellable           *cancellable,
						      GError                **error);
void               g_file_read_async                 (GFile                  *file,
						      int                     io_priority,
						      GCancellable           *cancellable,
						      GAsyncReadyCallback     callback,
						      gpointer                user_data);
GFileInputStream * g_file_read_finish                (GFile                  *file,
						      GAsyncResult           *res,
						      GError                **error);
GFileOutputStream *g_file_append_to                  (GFile                  *file,
						      GCancellable           *cancellable,
						      GError                **error);
GFileOutputStream *g_file_create                     (GFile                  *file,
						      GCancellable           *cancellable,
						      GError                **error);
GFileOutputStream *g_file_replace                    (GFile                  *file,
						      time_t                  mtime,
						      gboolean                make_backup,
						      GCancellable           *cancellable,
						      GError                **error);
GFileInfo *        g_file_get_info                   (GFile                  *file,
						      const char             *attributes,
						      GFileGetInfoFlags       flags,
						      GCancellable           *cancellable,
						      GError                **error);
GFileEnumerator *  g_file_enumerate_children         (GFile                  *file,
						      const char             *attributes,
						      GFileGetInfoFlags       flags,
						      GCancellable           *cancellable,
						      GError                **error);
GFile             *g_file_set_display_name           (GFile                  *file,
						      const char             *display_name,
						      GCancellable           *cancellable,
						      GError                **error);
gboolean           g_file_delete                     (GFile                  *file,
						      GCancellable           *cancellable,
						      GError                **error);
gboolean           g_file_copy                       (GFile                  *source,
						      GFile                  *destination,
						      GFileCopyFlags          flags,
						      GCancellable           *cancellable,
						      GFileProgressCallback   progress_callback,
						      gpointer                progress_callback_data,
						      GError                **error);
gboolean           g_file_move                       (GFile                  *source,
						      GFile                  *destination,
						      GFileCopyFlags          flags,
						      GCancellable           *cancellable,
						      GFileProgressCallback   progress_callback,
						      gpointer                progress_callback_data,
						      GError                **error);
gboolean           g_file_make_directory             (GFile                  *file,
						      GCancellable           *cancellable,
						      GError                **error);
gboolean           g_file_make_symbolic_link         (GFile                  *file,
						      const char             *symlink_value,
						      GCancellable           *cancellable,
						      GError                **error);
gboolean           g_file_set_attribute              (GFile                  *file,
						      const char             *attribute,
						      GFileAttributeType      type,
						      gconstpointer           value,
						      GFileGetInfoFlags       flags,
						      GCancellable           *cancellable,
						      GError                **error);
gboolean           g_file_set_attribute_string       (GFile                  *file,
						      const char             *attribute,
						      const char             *value,
						      GFileGetInfoFlags       flags,
						      GCancellable           *cancellable,
						      GError                **error);
gboolean           g_file_set_attribute_byte_string  (GFile                  *file,
						      const char             *attribute,
						      const char             *value,
						      GFileGetInfoFlags       flags,
						      GCancellable           *cancellable,
						      GError                **error);
gboolean           g_file_set_attribute_uint32       (GFile                  *file,
						      const char             *attribute,
						      guint32                 value,
						      GFileGetInfoFlags       flags,
						      GCancellable           *cancellable,
						      GError                **error);
gboolean           g_file_set_attribute_int32        (GFile                  *file,
						      const char             *attribute,
						      const char             *value,
						      GFileGetInfoFlags       flags,
						      GCancellable           *cancellable,
						      GError                **error);
gboolean           g_file_set_attribute_uint64       (GFile                  *file,
						      const char             *attribute,
						      guint64                 value,
						      GFileGetInfoFlags       flags,
						      GCancellable           *cancellable,
						      GError                **error);
gboolean           g_file_set_attribute_int64        (GFile                  *file,
						      const char             *attribute,
						      gint64                  value,
						      GFileGetInfoFlags       flags,
						      GCancellable           *cancellable,
						      GError                **error);

void               g_mount_for_location              (GFile                  *location,
						      GMountOperation        *mount_operation,
						      GAsyncReadyCallback     callback,
						      gpointer                user_data);
gboolean           g_mount_for_location_finish       (GFile                  *location,
						      GAsyncResult           *result,
						      GError                **error);
void               g_file_mount_mountable            (GFile                  *file,
						      GMountOperation        *mount_operation,
						      GAsyncReadyCallback     callback,
						      gpointer                user_data);
GFile *            g_file_mount_mountable_finish     (GFile                  *file,
						      GAsyncResult           *result,
						      GError                **error);
void               g_file_unmount_mountable          (GFile                  *file,
						      GAsyncReadyCallback     callback,
						      gpointer                user_data);
gboolean           g_file_unmount_mountable_finish   (GFile                  *file,
						      GAsyncResult           *result,
						      GError                **error);
void               g_file_eject_mountable            (GFile                  *file,
						      GAsyncReadyCallback     callback,
						      gpointer                user_data);
gboolean           g_file_eject_mountable_finish     (GFile                  *file,
						      GAsyncResult           *result,
						      GError                **error);

GDirectoryMonitor* g_file_monitor_directory          (GFile                  *file);
GFileMonitor*      g_file_monitor_file               (GFile                  *file);




/* Utilities */

void     g_file_get_contents_async  (GFile                *file,
				     GCancellable         *cancellable,
				     GAsyncReadyCallback   callback,
				     gpointer              user_data);
gboolean g_file_get_contents_finish (GFile                *file,
				     GAsyncResult         *res,
				     gchar               **contents,
				     gsize                *length,
				     GError              **error);

G_END_DECLS

#endif /* __G_FILE_H__ */