/usr/include/gnome-vfs-module-2.0/libgnomevfs/gnome-vfs-method.h is in libgnomevfs2-dev 1:2.24.4-6+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/* gnome-vfs-method.h - Virtual class for access methods in the GNOME
Virtual File System.
Copyright (C) 1999, 2001 Free Software Foundation
The Gnome Library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.
The Gnome Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with the Gnome Library; see the file COPYING.LIB. If not,
write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
Author: Ettore Perazzoli <ettore@comm2000.it>
Seth Nickell <snickell@stanford.edu>
*/
#ifndef GNOME_VFS_METHOD_H
#define GNOME_VFS_METHOD_H
/*
* The following include helps Solaris copy with its own headers. (With 64-
* bit stuff enabled they like to #define open open64, etc.)
* See http://bugzilla.gnome.org/show_bug.cgi?id=71184 for details.
*/
#ifndef _WIN32
#include <unistd.h>
#endif
#include <libgnomevfs/gnome-vfs-context.h>
#include <libgnomevfs/gnome-vfs-file-info.h>
#include <libgnomevfs/gnome-vfs-find-directory.h>
#include <libgnomevfs/gnome-vfs-handle.h>
#include <libgnomevfs/gnome-vfs-transform.h>
#include <libgnomevfs/gnome-vfs-monitor.h>
G_BEGIN_DECLS
#define _GNOME_VFS_METHOD_PARAM_CHECK(expression) \
g_return_val_if_fail ((expression), GNOME_VFS_ERROR_BAD_PARAMETERS);
typedef struct GnomeVFSMethod GnomeVFSMethod;
typedef GnomeVFSMethod * (* GnomeVFSMethodInitFunc)(const char *method_name, const char *config_args);
typedef void (*GnomeVFSMethodShutdownFunc)(GnomeVFSMethod *method);
typedef GnomeVFSResult (* GnomeVFSMethodOpenFunc)
(GnomeVFSMethod *method,
GnomeVFSMethodHandle
**method_handle_return,
GnomeVFSURI *uri,
GnomeVFSOpenMode mode,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodCreateFunc)
(GnomeVFSMethod *method,
GnomeVFSMethodHandle
**method_handle_return,
GnomeVFSURI *uri,
GnomeVFSOpenMode mode,
gboolean exclusive,
guint perm,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodCloseFunc)
(GnomeVFSMethod *method,
GnomeVFSMethodHandle *method_handle,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodReadFunc)
(GnomeVFSMethod *method,
GnomeVFSMethodHandle *method_handle,
gpointer buffer,
GnomeVFSFileSize num_bytes,
GnomeVFSFileSize *bytes_read_return,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodWriteFunc)
(GnomeVFSMethod *method,
GnomeVFSMethodHandle *method_handle,
gconstpointer buffer,
GnomeVFSFileSize num_bytes,
GnomeVFSFileSize *bytes_written_return,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodSeekFunc)
(GnomeVFSMethod *method,
GnomeVFSMethodHandle *method_handle,
GnomeVFSSeekPosition whence,
GnomeVFSFileOffset offset,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodTellFunc)
(GnomeVFSMethod *method,
GnomeVFSMethodHandle *method_handle,
GnomeVFSFileSize *offset_return);
typedef GnomeVFSResult (* GnomeVFSMethodOpenDirectoryFunc)
(GnomeVFSMethod *method,
GnomeVFSMethodHandle **method_handle,
GnomeVFSURI *uri,
GnomeVFSFileInfoOptions options,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodCloseDirectoryFunc)
(GnomeVFSMethod *method,
GnomeVFSMethodHandle *method_handle,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodReadDirectoryFunc)
(GnomeVFSMethod *method,
GnomeVFSMethodHandle *method_handle,
GnomeVFSFileInfo *file_info,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodGetFileInfoFunc)
(GnomeVFSMethod *method,
GnomeVFSURI *uri,
GnomeVFSFileInfo *file_info,
GnomeVFSFileInfoOptions options,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodGetFileInfoFromHandleFunc)
(GnomeVFSMethod *method,
GnomeVFSMethodHandle *method_handle,
GnomeVFSFileInfo *file_info,
GnomeVFSFileInfoOptions options,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodTruncateFunc) (GnomeVFSMethod *method,
GnomeVFSURI *uri,
GnomeVFSFileSize length,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodTruncateHandleFunc) (GnomeVFSMethod *method,
GnomeVFSMethodHandle *handle,
GnomeVFSFileSize length,
GnomeVFSContext *context);
typedef gboolean (* GnomeVFSMethodIsLocalFunc)
(GnomeVFSMethod *method,
const GnomeVFSURI *uri);
typedef GnomeVFSResult (* GnomeVFSMethodMakeDirectoryFunc)
(GnomeVFSMethod *method,
GnomeVFSURI *uri,
guint perm,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodFindDirectoryFunc)
(GnomeVFSMethod *method,
GnomeVFSURI *find_near_uri,
GnomeVFSFindDirectoryKind kind,
GnomeVFSURI **result_uri,
gboolean create_if_needed,
gboolean find_if_needed,
guint perm,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodRemoveDirectoryFunc)
(GnomeVFSMethod *method,
GnomeVFSURI *uri,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodMoveFunc)
(GnomeVFSMethod *method,
GnomeVFSURI *old_uri,
GnomeVFSURI *new_uri,
gboolean force_replace,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodUnlinkFunc)
(GnomeVFSMethod *method,
GnomeVFSURI *uri,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodCheckSameFSFunc)
(GnomeVFSMethod *method,
GnomeVFSURI *a,
GnomeVFSURI *b,
gboolean *same_fs_return,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodSetFileInfo)
(GnomeVFSMethod *method,
GnomeVFSURI *a,
const GnomeVFSFileInfo *info,
GnomeVFSSetFileInfoMask mask,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodCreateSymbolicLinkFunc)
(GnomeVFSMethod *method,
GnomeVFSURI *uri,
const gchar *target_reference,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodMonitorAddFunc)
(GnomeVFSMethod *method,
GnomeVFSMethodHandle **method_handle_return,
GnomeVFSURI *uri,
GnomeVFSMonitorType monitor_type);
typedef GnomeVFSResult (* GnomeVFSMethodMonitorCancelFunc)
(GnomeVFSMethod *method,
GnomeVFSMethodHandle *handle);
typedef GnomeVFSResult (* GnomeVFSMethodFileControlFunc)
(GnomeVFSMethod *method,
GnomeVFSMethodHandle *method_handle,
const char *operation,
gpointer operation_data,
GnomeVFSContext *context);
typedef GnomeVFSResult (* GnomeVFSMethodForgetCacheFunc)
(GnomeVFSMethod *method,
GnomeVFSMethodHandle *method_handle,
GnomeVFSFileOffset offset,
GnomeVFSFileSize size);
typedef GnomeVFSResult (* GnomeVFSMethodGetVolumeFreeSpaceFunc)
(GnomeVFSMethod *method,
const GnomeVFSURI *uri,
GnomeVFSFileSize *free_space);
/* Use this macro to test whether a given function is implemented in
* a given GnomeVFSMethod. Note that it checks the expected size of the structure
* prior to testing NULL.
*/
#define VFS_METHOD_HAS_FUNC(method,func) ((((char *)&((method)->func)) - ((char *)(method)) < (method)->method_table_size) && method->func != NULL)
/* Structure defining an access method. This is also defined as an
opaque type in `gnome-vfs-types.h'. */
struct GnomeVFSMethod {
gsize method_table_size; /* Used for versioning */
GnomeVFSMethodOpenFunc open;
GnomeVFSMethodCreateFunc create;
GnomeVFSMethodCloseFunc close;
GnomeVFSMethodReadFunc read;
GnomeVFSMethodWriteFunc write;
GnomeVFSMethodSeekFunc seek;
GnomeVFSMethodTellFunc tell;
GnomeVFSMethodTruncateHandleFunc truncate_handle;
GnomeVFSMethodOpenDirectoryFunc open_directory;
GnomeVFSMethodCloseDirectoryFunc close_directory;
GnomeVFSMethodReadDirectoryFunc read_directory;
GnomeVFSMethodGetFileInfoFunc get_file_info;
GnomeVFSMethodGetFileInfoFromHandleFunc get_file_info_from_handle;
GnomeVFSMethodIsLocalFunc is_local;
GnomeVFSMethodMakeDirectoryFunc make_directory;
GnomeVFSMethodRemoveDirectoryFunc remove_directory;
GnomeVFSMethodMoveFunc move;
GnomeVFSMethodUnlinkFunc unlink;
GnomeVFSMethodCheckSameFSFunc check_same_fs;
GnomeVFSMethodSetFileInfo set_file_info;
GnomeVFSMethodTruncateFunc truncate;
GnomeVFSMethodFindDirectoryFunc find_directory;
GnomeVFSMethodCreateSymbolicLinkFunc create_symbolic_link;
GnomeVFSMethodMonitorAddFunc monitor_add;
GnomeVFSMethodMonitorCancelFunc monitor_cancel;
GnomeVFSMethodFileControlFunc file_control;
GnomeVFSMethodForgetCacheFunc forget_cache;
GnomeVFSMethodGetVolumeFreeSpaceFunc get_volume_free_space;
};
gboolean gnome_vfs_method_init (void);
GnomeVFSMethod *gnome_vfs_method_get (const gchar *name);
GnomeVFSTransform *gnome_vfs_transform_get (const gchar *name);
void _gnome_vfs_method_shutdown (void);
G_END_DECLS
#endif /* GNOME_VFS_METHOD_H */
|