2 * Include file with client-application 'file' access to libcaptive
3 * Copyright (C) 2002 Jan Kratochvil <project-captive@jankratochvil.net>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; exactly version 2 of June 1991 is required
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 #ifndef _CAPTIVE_CLIENT_FILE_H
21 #define _CAPTIVE_CLIENT_FILE_H 1
24 #include <glib/gmacros.h>
25 #include <glib-object.h>
26 #include <libgnomevfs/gnome-vfs-handle.h> /* for GnomeVFSOpenMode */
27 #include "captive/client-vfs.h"
28 #include "captive/client-file-info.h"
33 #define CAPTIVE_FILE_TYPE_OBJECT (captive_file_object_get_type())
34 #define CAPTIVE_FILE_OBJECT(object) (G_TYPE_CHECK_INSTANCE_CAST((object),CAPTIVE_FILE_TYPE_OBJECT,CaptiveFileObject))
35 #define CAPTIVE_FILE_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),CAPTIVE_FILE_TYPE_OBJECT,CaptiveFileObjectClass))
36 #define CAPTIVE_FILE_IS_OBJECT(object) (G_TYPE_CHECK_INSTANCE_TYPE((object),CAPTIVE_FILE_TYPE_OBJECT))
37 #define CAPTIVE_FILE_IS_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),CAPTIVE_FILE_TYPE_OBJECT))
38 #define CAPTIVE_FILE_OBJECT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),CAPTIVE_FILE_TYPE_OBJECT,CaptiveFileObjectClass))
39 typedef struct _CaptiveFileObject CaptiveFileObject;
40 typedef struct _CaptiveFileObjectClass CaptiveFileObjectClass;
43 GType captive_file_object_get_type(void);
45 GnomeVFSResult captive_file_new_open(CaptiveFileObject **captive_file_object_return,
46 CaptiveVfsObject *captive_vfs_object,const gchar *pathname,GnomeVFSOpenMode mode);
47 GnomeVFSResult captive_file_new_create(CaptiveFileObject **captive_file_object_return,
48 CaptiveVfsObject *captive_vfs_object,const gchar *pathname,GnomeVFSOpenMode mode,gboolean exclusive,guint perm);
49 CaptiveVfsObject *captive_file_ref_vfs(CaptiveFileObject *captive_file_object);
50 GnomeVFSResult captive_file_read(CaptiveFileObject *captive_file_object,
51 gpointer buffer,GnomeVFSFileSize num_bytes,GnomeVFSFileSize *bytes_read_return);
52 GnomeVFSResult captive_file_write(CaptiveFileObject *captive_file_object,
53 gconstpointer buffer,GnomeVFSFileSize num_bytes,GnomeVFSFileSize *bytes_written_return);
54 GnomeVFSResult captive_file_seek
55 (CaptiveFileObject *captive_file_object,GnomeVFSSeekPosition whence,GnomeVFSFileOffset offset);
56 GnomeVFSResult captive_file_tell(CaptiveFileObject *captive_file_object,GnomeVFSFileOffset *offset_return);
57 GnomeVFSResult captive_file_remove(CaptiveFileObject *captive_file_object);
58 GnomeVFSResult captive_file_file_info_get(CaptiveFileObject *captive_file_object,
59 CaptiveFileInfoObject **captive_file_info_object_return);
60 GnomeVFSResult captive_file_file_info_set(CaptiveFileObject *captive_file_object,
61 CaptiveFileInfoObject *captive_file_info_object,GnomeVFSSetFileInfoMask mask);
62 GnomeVFSResult captive_file_truncate(CaptiveFileObject *captive_file_object,GnomeVFSFileSize file_size);
63 GnomeVFSResult captive_file_move(CaptiveFileObject *captive_file_object_old,const gchar *pathname_new,gboolean force_replace);
68 #endif /* _CAPTIVE_CLIENT_FILE_H */