2007-11-26 17:13:05 +01:00
|
|
|
/* GIO - GLib Input, Output and Streaming Library
|
|
|
|
|
*
|
|
|
|
|
* Copyright (C) 2006-2007 Red Hat, Inc.
|
|
|
|
|
*
|
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
|
* version 2 of the License, or (at your option) any later version.
|
|
|
|
|
*
|
|
|
|
|
* This 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
|
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU Lesser General
|
|
|
|
|
* Public License along with this library; if not, write to the
|
|
|
|
|
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
|
|
|
|
|
* Boston, MA 02111-1307, USA.
|
|
|
|
|
*
|
|
|
|
|
* Author: Alexander Larsson <alexl@redhat.com>
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef __G_FILE_H__
|
|
|
|
|
#define __G_FILE_H__
|
|
|
|
|
|
|
|
|
|
#include <glib-object.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))
|
|
|
|
|
|
2007-11-27 15:00:13 +01:00
|
|
|
/**
|
|
|
|
|
* GFileQueryInfoFlags:
|
2007-11-28 07:43:33 +01:00
|
|
|
* @G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS: Don't follow symlinks.
|
2007-11-27 15:00:13 +01:00
|
|
|
*
|
|
|
|
|
* Flags used when querying a #GFileInfo.
|
|
|
|
|
*/
|
2007-11-26 17:13:05 +01:00
|
|
|
typedef enum {
|
|
|
|
|
G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS = (1<<0)
|
|
|
|
|
} GFileQueryInfoFlags;
|
|
|
|
|
|
2007-11-27 15:00:13 +01:00
|
|
|
/**
|
|
|
|
|
* GFileCreateFlags:
|
2007-11-28 07:43:33 +01:00
|
|
|
* @G_FILE_CREATE_FLAGS_NONE: No flags set.
|
|
|
|
|
* @G_FILE_CREATE_FLAGS_PRIVATE: Create a file that can only be
|
|
|
|
|
* accessed by the current user.
|
2007-11-27 15:00:13 +01:00
|
|
|
*
|
|
|
|
|
* Flags used when an operation may create a file.
|
|
|
|
|
*/
|
2007-11-26 17:13:05 +01:00
|
|
|
typedef enum {
|
|
|
|
|
G_FILE_CREATE_FLAGS_NONE = 0,
|
|
|
|
|
G_FILE_CREATE_FLAGS_PRIVATE = (1<<0)
|
|
|
|
|
} GFileCreateFlags;
|
|
|
|
|
|
2007-11-27 15:00:13 +01:00
|
|
|
/**
|
|
|
|
|
* GFileCopyFlags:
|
2007-11-28 19:38:53 +01:00
|
|
|
* @G_FILE_COPY_FLAGS_NONE: No flags set.
|
2007-11-27 15:00:13 +01:00
|
|
|
* @G_FILE_COPY_OVERWRITE: Overwrite any existing files
|
2007-11-28 07:43:33 +01:00
|
|
|
* @G_FILE_COPY_BACKUP: Make a backup of any existing files. TODO: explain backup naming scheme.
|
2007-11-27 15:00:13 +01:00
|
|
|
* @G_FILE_COPY_NOFOLLOW_SYMLINKS: Don't follow symlinks.
|
|
|
|
|
* @G_FILE_COPY_ALL_METADATA: Copy all file metadata (see #GFileInfo).
|
|
|
|
|
*
|
|
|
|
|
* Flags used when copying or moving files.
|
|
|
|
|
*/
|
2007-11-26 17:13:05 +01:00
|
|
|
typedef enum {
|
2007-11-28 19:38:53 +01:00
|
|
|
G_FILE_COPY_FLAGS_NONE = 0,
|
2007-11-26 17:13:05 +01:00
|
|
|
G_FILE_COPY_OVERWRITE = (1<<0),
|
|
|
|
|
G_FILE_COPY_BACKUP = (1<<1),
|
|
|
|
|
G_FILE_COPY_NOFOLLOW_SYMLINKS = (1<<2),
|
|
|
|
|
G_FILE_COPY_ALL_METADATA = (1<<3)
|
|
|
|
|
} GFileCopyFlags;
|
|
|
|
|
|
2007-11-27 15:00:13 +01:00
|
|
|
/**
|
|
|
|
|
* GFileMonitorFlags:
|
|
|
|
|
* @G_FILE_MONITOR_FLAGS_NONE: No flags set.
|
|
|
|
|
* @G_FILE_MONITOR_FLAGS_MONITOR_MOUNTS: Watch for mount events.
|
|
|
|
|
*
|
|
|
|
|
* Flags used to set what a #GFileMonitor or #GDirectoryMonitor will watch for.
|
|
|
|
|
*/
|
2007-11-26 17:13:05 +01:00
|
|
|
typedef enum {
|
|
|
|
|
G_FILE_MONITOR_FLAGS_NONE = 0,
|
|
|
|
|
G_FILE_MONITOR_FLAGS_MONITOR_MOUNTS = (1<<0)
|
|
|
|
|
} GFileMonitorFlags;
|
|
|
|
|
|
2007-11-27 15:00:13 +01:00
|
|
|
/**
|
|
|
|
|
* GFile:
|
|
|
|
|
*
|
|
|
|
|
* A handle to an object implementing the #GFileIface interface.
|
|
|
|
|
* Generally stores a location within the file system. Handles do not
|
|
|
|
|
* necessarily represent files or directories that currently exist.
|
|
|
|
|
**/
|
2007-11-26 17:13:05 +01:00
|
|
|
typedef struct _GFile GFile; /* Dummy typedef */
|
|
|
|
|
typedef struct _GFileIface GFileIface;
|
|
|
|
|
typedef struct _GDirectoryMonitor GDirectoryMonitor;
|
|
|
|
|
typedef struct _GFileMonitor GFileMonitor;
|
2007-11-27 15:00:13 +01:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GVolume:
|
|
|
|
|
*
|
|
|
|
|
* A handle to an object implementing the #GVolumeIface interface.
|
|
|
|
|
**/
|
2007-11-26 17:13:05 +01:00
|
|
|
typedef struct _GVolume GVolume; /* Dummy typedef */
|
|
|
|
|
|
2007-11-27 15:00:13 +01:00
|
|
|
/**
|
|
|
|
|
* GFileProgressCallback:
|
|
|
|
|
* @current_num_bytes: the current number of bytes in the operation.
|
|
|
|
|
* @total_num_bytes: the total number of bytes in the operation.
|
|
|
|
|
* @user_data: user data passed to the callback.
|
|
|
|
|
*
|
|
|
|
|
* When doing file operations that may take a while, such as moving
|
|
|
|
|
* a file or copying a file, a progress callback is used to pass how
|
|
|
|
|
* far along that operation is to the application.
|
|
|
|
|
**/
|
2007-11-26 17:13:05 +01:00
|
|
|
typedef void (*GFileProgressCallback) (goffset current_num_bytes,
|
|
|
|
|
goffset total_num_bytes,
|
|
|
|
|
gpointer user_data);
|
2007-11-27 15:00:13 +01:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GFileReadMoreCallback:
|
|
|
|
|
* @file_contents:
|
|
|
|
|
* @file_size:
|
|
|
|
|
* @callback_data:
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
**/
|
2007-11-26 17:13:05 +01:00
|
|
|
typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
|
|
|
|
|
goffset file_size,
|
|
|
|
|
gpointer callback_data);
|
|
|
|
|
|
2007-11-27 15:00:13 +01:00
|
|
|
/**
|
|
|
|
|
* GFileIface:
|
|
|
|
|
* @g_iface: The parent interface.
|
|
|
|
|
* @dup: Duplicates a #GFile.
|
|
|
|
|
* @hash: Creates a hash of a #GFile.
|
|
|
|
|
* @equal: Checks equality of two given #GFile<!-- -->s.
|
|
|
|
|
* @is_native: Checks to see if a file is native to the system.
|
|
|
|
|
* @has_uri_scheme: Checks to see if a #GFile has a given URI scheme.
|
|
|
|
|
* @get_uri_scheme: Gets the URI scheme for a #GFile.
|
|
|
|
|
* @get_basename: Gets the basename for a given #GFile.
|
|
|
|
|
* @get_path: Gets the current path within a #GFile.
|
|
|
|
|
* @get_uri: Gets a URI for the path within a #GFile.
|
|
|
|
|
* @get_parse_name: Gets the parsed name for the #GFile.
|
|
|
|
|
* @get_parent: Gets the parent directory for the #GFile.
|
|
|
|
|
* @contains_file: Checks whether a #GFile contains a specified file.
|
|
|
|
|
* @get_relative_path: Gets the path for a #GFile relative to a given path.
|
|
|
|
|
* @resolve_relative_path: Resolves a relative path for a #GFile to an absolute path.
|
|
|
|
|
* @get_child_for_display_name: Gets the child #GFile for a given display name.
|
|
|
|
|
* @enumerate_children: Gets a #GFileEnumerator with the children of a #GFile.
|
|
|
|
|
* @enumerate_children_async: Asynchronously gets a #GFileEnumerator with the children of a #GFile.
|
|
|
|
|
* @enumerate_children_finish: Finishes asynchronously enumerating the children.
|
|
|
|
|
* @query_info: Gets the #GFileInfo for a #GFile.
|
|
|
|
|
* @query_info_async: Asynchronously gets the #GFileInfo for a #GFile.
|
|
|
|
|
* @query_info_finish: Finishes an asynchronous query info operation.
|
|
|
|
|
* @query_filesystem_info: Gets a #GFileInfo for the file system #GFile is on.
|
|
|
|
|
* @_query_filesystem_info_async: Asynchronously gets a #GFileInfo for the file system #GFile is on.
|
|
|
|
|
* @_query_filesystem_info_finish: Finishes asynchronously getting the file system info.
|
|
|
|
|
* @find_enclosing_volume: Gets a #GVolume for the #GFile.
|
|
|
|
|
* @find_enclosing_volume_async: Asynchronously gets the #GVolume for a #GFile.
|
|
|
|
|
* @find_enclosing_volume_finish: Finishes asynchronously getting the volume.
|
|
|
|
|
* @set_display_name: Sets the display name for a #GFile.
|
|
|
|
|
* @set_display_name_async: Asynchronously sets a #GFile's display name.
|
|
|
|
|
* @set_display_name_finish: Finishes asynchronously setting a #GFile's display name.
|
|
|
|
|
* @query_settable_attributes: Returns a list of #GFileAttribute<!-- -->s that can be set.
|
|
|
|
|
* @_query_settable_attributes_async: Asynchronously gets a list of #GFileAttribute<!-- -->s that can be set.
|
|
|
|
|
* @_query_settable_attributes_finish: Finishes asynchronously querying settable attributes.
|
|
|
|
|
* @query_writable_namespaces: Returns a list of #GFileAttribute namespaces that are writable.
|
|
|
|
|
* @_query_writable_namespaces_async: Asynchronously gets a list of #GFileAttribute namespaces that are writable.
|
|
|
|
|
* @_query_writable_namespaces_finish: Finishes asynchronously querying the writable namespaces.
|
|
|
|
|
* @set_attribute: Sets a #GFileAttribute.
|
|
|
|
|
* @set_attributes_from_info: Sets a #GFileAttribute with information from a #GFileInfo.
|
|
|
|
|
* @set_attributes_async: Asynchronously sets a file's attributes.
|
|
|
|
|
* @set_attributes_finish: Finishes setting a file's attributes asynchronously.
|
|
|
|
|
* @read: Reads a file asynchronously.
|
|
|
|
|
* @read_async: Asynchronously reads a file.
|
|
|
|
|
* @read_finish: Finishes asynchronously reading a file.
|
|
|
|
|
* @append_to: Writes to the end of a file.
|
|
|
|
|
* @append_to_async: Asynchronously writes to the end of a file.
|
|
|
|
|
* @append_to_finish: Finishes an asynchronous file append operation.
|
|
|
|
|
* @create: Creates a new file.
|
|
|
|
|
* @create_async: Asynchronously creates a file.
|
|
|
|
|
* @create_finish: Finishes asynchronously creating a file.
|
|
|
|
|
* @replace: Replaces the contents of a file.
|
|
|
|
|
* @replace_async: Asynchronously replaces the contents of a file.
|
|
|
|
|
* @replace_finish: Finishes asynchronously replacing a file.
|
|
|
|
|
* @delete_file: Deletes a file.
|
|
|
|
|
* @_delete_file_async: Asynchronously deletes a file.
|
|
|
|
|
* @_delete_file_finish: Finishes an asynchronous delete.
|
|
|
|
|
* @trash: Sends a #GFile to the Trash location.
|
|
|
|
|
* @_trash_async: Asynchronously sends a #GFile to the Trash location.
|
|
|
|
|
* @_trash_finish: Finishes an asynchronous file trashing operation.
|
|
|
|
|
* @make_directory: Makes a directory.
|
|
|
|
|
* @_make_directory_async: Asynchronously makes a directory.
|
|
|
|
|
* @_make_directory_finish: Finishes making a directory asynchronously.
|
|
|
|
|
* @make_symbolic_link: Makes a symbolic link.
|
|
|
|
|
* @_make_symbolic_link_async: Asynchronously makes a symbolic link
|
|
|
|
|
* @_make_symbolic_link_finish: Finishes making a symbolic link asynchronously.
|
|
|
|
|
* @copy: Copies a file.
|
|
|
|
|
* @_copy_async: Asynchronously copies a file.
|
|
|
|
|
* @_copy_finish: Finishes an asynchronous copy operation.
|
|
|
|
|
* @move: Moves a file.
|
|
|
|
|
* @_move_async: Asynchronously moves a file.
|
|
|
|
|
* @_move_finish: Finishes an asynchronous move operation.
|
|
|
|
|
* @mount_mountable: Mounts a mountable object.
|
|
|
|
|
* @mount_mountable_finish: Finishes a mounting operation.
|
|
|
|
|
* @unmount_mountable: Unmounts a mountable object.
|
|
|
|
|
* @unmount_mountable_finish: Finishes an unmount operation.
|
|
|
|
|
* @eject_mountable: Ejects a mountable.
|
|
|
|
|
* @eject_mountable_finish: Finishes an eject operation.
|
|
|
|
|
* @mount_for_location: Mounts a specified location.
|
|
|
|
|
* @mount_for_location_finish: Finishes mounting a specified location.
|
|
|
|
|
* @monitor_dir: Creates a #GDirectoryMonitor for the location.
|
|
|
|
|
* @monitor_file: Creates a #GFileMonitor for the location.
|
|
|
|
|
*
|
|
|
|
|
* An interface for writing VFS file handles.
|
|
|
|
|
**/
|
2007-11-26 17:13:05 +01:00
|
|
|
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);
|
|
|
|
|
gboolean (*has_uri_scheme) (GFile *file,
|
|
|
|
|
const char *uri_scheme);
|
|
|
|
|
char * (*get_uri_scheme) (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);
|
|
|
|
|
gboolean (*contains_file) (GFile *parent,
|
|
|
|
|
GFile *descendant);
|
|
|
|
|
char * (*get_relative_path) (GFile *parent,
|
|
|
|
|
GFile *descendant);
|
|
|
|
|
GFile * (*resolve_relative_path) (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,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*enumerate_children_async) (GFile *file,
|
|
|
|
|
const char *attributes,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
int io_priority,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GFileEnumerator * (*enumerate_children_finish) (GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
GFileInfo * (*query_info) (GFile *file,
|
|
|
|
|
const char *attributes,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*query_info_async) (GFile *file,
|
|
|
|
|
const char *attributes,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
int io_priority,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GFileInfo * (*query_info_finish) (GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
GFileInfo * (*query_filesystem_info)(GFile *file,
|
|
|
|
|
const char *attributes,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*_query_filesystem_info_async) (void);
|
|
|
|
|
void (*_query_filesystem_info_finish) (void);
|
|
|
|
|
|
|
|
|
|
GVolume * (*find_enclosing_volume)(GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*find_enclosing_volume_async)(GFile *file,
|
|
|
|
|
int io_priority,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GVolume * (*find_enclosing_volume_finish)(GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
GFile * (*set_display_name) (GFile *file,
|
|
|
|
|
const char *display_name,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*set_display_name_async) (GFile *file,
|
|
|
|
|
const char *display_name,
|
|
|
|
|
int io_priority,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GFile * (*set_display_name_finish) (GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
GFileAttributeInfoList * (*query_settable_attributes) (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*_query_settable_attributes_async) (void);
|
|
|
|
|
void (*_query_settable_attributes_finish) (void);
|
|
|
|
|
|
|
|
|
|
GFileAttributeInfoList * (*query_writable_namespaces) (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*_query_writable_namespaces_async) (void);
|
|
|
|
|
void (*_query_writable_namespaces_finish) (void);
|
|
|
|
|
|
|
|
|
|
gboolean (*set_attribute) (GFile *file,
|
|
|
|
|
const char *attribute,
|
|
|
|
|
const GFileAttributeValue *value,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean (*set_attributes_from_info) (GFile *file,
|
|
|
|
|
GFileInfo *info,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*set_attributes_async) (GFile *file,
|
|
|
|
|
GFileInfo *info,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
int io_priority,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
gboolean (*set_attributes_finish) (GFile *file,
|
|
|
|
|
GAsyncResult *result,
|
|
|
|
|
GFileInfo **info,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
GFileInputStream * (*read) (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
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);
|
|
|
|
|
|
|
|
|
|
GFileOutputStream * (*append_to) (GFile *file,
|
|
|
|
|
GFileCreateFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*append_to_async) (GFile *file,
|
|
|
|
|
GFileCreateFlags flags,
|
|
|
|
|
int io_priority,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GFileOutputStream * (*append_to_finish) (GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
GFileOutputStream * (*create) (GFile *file,
|
|
|
|
|
GFileCreateFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*create_async) (GFile *file,
|
|
|
|
|
GFileCreateFlags flags,
|
|
|
|
|
int io_priority,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GFileOutputStream * (*create_finish) (GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
GFileOutputStream * (*replace) (GFile *file,
|
|
|
|
|
const char *etag,
|
|
|
|
|
gboolean make_backup,
|
|
|
|
|
GFileCreateFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*replace_async) (GFile *file,
|
|
|
|
|
const char *etag,
|
|
|
|
|
gboolean make_backup,
|
|
|
|
|
GFileCreateFlags flags,
|
|
|
|
|
int io_priority,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GFileOutputStream * (*replace_finish) (GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
gboolean (*delete_file) (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*_delete_file_async) (void);
|
|
|
|
|
void (*_delete_file_finish) (void);
|
|
|
|
|
|
|
|
|
|
gboolean (*trash) (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*_trash_async) (void);
|
|
|
|
|
void (*_trash_finish) (void);
|
|
|
|
|
|
|
|
|
|
gboolean (*make_directory) (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*_make_directory_async) (void);
|
|
|
|
|
void (*_make_directory_finish) (void);
|
|
|
|
|
|
|
|
|
|
gboolean (*make_symbolic_link) (GFile *file,
|
|
|
|
|
const char *symlink_value,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*_make_symbolic_link_async) (void);
|
|
|
|
|
void (*_make_symbolic_link_finish) (void);
|
|
|
|
|
|
|
|
|
|
gboolean (*copy) (GFile *source,
|
|
|
|
|
GFile *destination,
|
|
|
|
|
GFileCopyFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GFileProgressCallback progress_callback,
|
|
|
|
|
gpointer progress_callback_data,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*_copy_async) (void);
|
|
|
|
|
void (*_copy_finish) (void);
|
|
|
|
|
|
|
|
|
|
gboolean (*move) (GFile *source,
|
|
|
|
|
GFile *destination,
|
|
|
|
|
GFileCopyFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GFileProgressCallback progress_callback,
|
|
|
|
|
gpointer progress_callback_data,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
void (*_move_async) (void);
|
|
|
|
|
void (*_move_finish) (void);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
void (*mount_mountable) (GFile *file,
|
|
|
|
|
GMountOperation *mount_operation,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GFile * (*mount_mountable_finish) (GFile *file,
|
|
|
|
|
GAsyncResult *result,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*unmount_mountable) (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
gboolean (*unmount_mountable_finish) (GFile *file,
|
|
|
|
|
GAsyncResult *result,
|
|
|
|
|
GError **error);
|
|
|
|
|
void (*eject_mountable) (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
gboolean (*eject_mountable_finish) (GFile *file,
|
|
|
|
|
GAsyncResult *result,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
void (*mount_for_location) (GFile *location,
|
|
|
|
|
GMountOperation *mount_operation,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
gboolean (*mount_for_location_finish) (GFile *location,
|
|
|
|
|
GAsyncResult *result,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
GDirectoryMonitor* (*monitor_dir) (GFile *file,
|
|
|
|
|
GFileMonitorFlags flags,
|
|
|
|
|
GCancellable *cancellable);
|
|
|
|
|
|
|
|
|
|
GFileMonitor* (*monitor_file) (GFile *file,
|
|
|
|
|
GFileMonitorFlags flags,
|
|
|
|
|
GCancellable *cancellable);
|
2007-11-27 15:00:13 +01:00
|
|
|
|
2007-11-26 17:13:05 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
GType g_file_get_type (void) G_GNUC_CONST;
|
|
|
|
|
|
|
|
|
|
GFile * g_file_new_for_path (const char *path);
|
|
|
|
|
GFile * g_file_new_for_uri (const char *uri);
|
|
|
|
|
GFile * g_file_new_for_commandline_arg (const char *arg);
|
|
|
|
|
GFile * g_file_parse_name (const char *parse_name);
|
|
|
|
|
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);
|
|
|
|
|
gboolean g_file_contains_file (GFile *parent,
|
|
|
|
|
GFile *descendant);
|
|
|
|
|
char * g_file_get_relative_path (GFile *parent,
|
|
|
|
|
GFile *descendant);
|
|
|
|
|
GFile * g_file_resolve_relative_path (GFile *file,
|
|
|
|
|
const char *relative_path);
|
|
|
|
|
gboolean g_file_is_native (GFile *file);
|
|
|
|
|
gboolean g_file_has_uri_scheme (GFile *file,
|
|
|
|
|
const char *uri_scheme);
|
|
|
|
|
char * g_file_get_uri_scheme (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,
|
|
|
|
|
GFileCreateFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
GFileOutputStream * g_file_create (GFile *file,
|
|
|
|
|
GFileCreateFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
GFileOutputStream * g_file_replace (GFile *file,
|
|
|
|
|
const char *etag,
|
|
|
|
|
gboolean make_backup,
|
|
|
|
|
GFileCreateFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void g_file_append_to_async (GFile *file,
|
|
|
|
|
GFileCreateFlags flags,
|
|
|
|
|
int io_priority,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GFileOutputStream * g_file_append_to_finish (GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
void g_file_create_async (GFile *file,
|
|
|
|
|
GFileCreateFlags flags,
|
|
|
|
|
int io_priority,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GFileOutputStream * g_file_create_finish (GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
void g_file_replace_async (GFile *file,
|
|
|
|
|
const char *etag,
|
|
|
|
|
gboolean make_backup,
|
|
|
|
|
GFileCreateFlags flags,
|
|
|
|
|
int io_priority,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GFileOutputStream * g_file_replace_finish (GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
GFileInfo * g_file_query_info (GFile *file,
|
|
|
|
|
const char *attributes,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void g_file_query_info_async (GFile *file,
|
|
|
|
|
const char *attributes,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
int io_priority,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GFileInfo * g_file_query_info_finish (GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
GFileInfo * g_file_query_filesystem_info (GFile *file,
|
|
|
|
|
const char *attributes,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
GVolume * g_file_find_enclosing_volume (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
GFileEnumerator * g_file_enumerate_children (GFile *file,
|
|
|
|
|
const char *attributes,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void g_file_enumerate_children_async (GFile *file,
|
|
|
|
|
const char *attributes,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
int io_priority,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GFileEnumerator * g_file_enumerate_children_finish (GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
GFile * g_file_set_display_name (GFile *file,
|
|
|
|
|
const char *display_name,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void g_file_set_display_name_async (GFile *file,
|
|
|
|
|
const char *display_name,
|
|
|
|
|
int io_priority,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GFile * g_file_set_display_name_finish (GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean g_file_delete (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean g_file_trash (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);
|
|
|
|
|
GFileAttributeInfoList *g_file_query_settable_attributes (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
GFileAttributeInfoList *g_file_query_writable_namespaces (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean g_file_set_attribute (GFile *file,
|
|
|
|
|
const char *attribute,
|
|
|
|
|
const GFileAttributeValue *value,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean g_file_set_attributes_from_info (GFile *file,
|
|
|
|
|
GFileInfo *info,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void g_file_set_attributes_async (GFile *file,
|
|
|
|
|
GFileInfo *info,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
int io_priority,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
gboolean g_file_set_attributes_finish (GFile *file,
|
|
|
|
|
GAsyncResult *result,
|
|
|
|
|
GFileInfo **info,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean g_file_set_attribute_string (GFile *file,
|
|
|
|
|
const char *attribute,
|
|
|
|
|
const char *value,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean g_file_set_attribute_byte_string (GFile *file,
|
|
|
|
|
const char *attribute,
|
|
|
|
|
const char *value,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean g_file_set_attribute_uint32 (GFile *file,
|
|
|
|
|
const char *attribute,
|
|
|
|
|
guint32 value,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean g_file_set_attribute_int32 (GFile *file,
|
|
|
|
|
const char *attribute,
|
|
|
|
|
gint32 value,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean g_file_set_attribute_uint64 (GFile *file,
|
|
|
|
|
const char *attribute,
|
|
|
|
|
guint64 value,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean g_file_set_attribute_int64 (GFile *file,
|
|
|
|
|
const char *attribute,
|
|
|
|
|
gint64 value,
|
|
|
|
|
GFileQueryInfoFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void g_mount_for_location (GFile *location,
|
|
|
|
|
GMountOperation *mount_operation,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
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,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
GFile * g_file_mount_mountable_finish (GFile *file,
|
|
|
|
|
GAsyncResult *result,
|
|
|
|
|
GError **error);
|
|
|
|
|
void g_file_unmount_mountable (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
gboolean g_file_unmount_mountable_finish (GFile *file,
|
|
|
|
|
GAsyncResult *result,
|
|
|
|
|
GError **error);
|
|
|
|
|
void g_file_eject_mountable (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
gboolean g_file_eject_mountable_finish (GFile *file,
|
|
|
|
|
GAsyncResult *result,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
gboolean g_file_copy_attributes (GFile *source,
|
|
|
|
|
GFile *destination,
|
|
|
|
|
GFileCopyFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GDirectoryMonitor* g_file_monitor_directory (GFile *file,
|
|
|
|
|
GFileMonitorFlags flags,
|
|
|
|
|
GCancellable *cancellable);
|
|
|
|
|
GFileMonitor* g_file_monitor_file (GFile *file,
|
|
|
|
|
GFileMonitorFlags flags,
|
|
|
|
|
GCancellable *cancellable);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/* Utilities */
|
|
|
|
|
|
|
|
|
|
gboolean g_file_load_contents (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
char **contents,
|
|
|
|
|
gsize *length,
|
|
|
|
|
char **etag_out,
|
|
|
|
|
GError **error);
|
|
|
|
|
void g_file_load_contents_async (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
gboolean g_file_load_contents_finish (GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
char **contents,
|
|
|
|
|
gsize *length,
|
|
|
|
|
char **etag_out,
|
|
|
|
|
GError **error);
|
|
|
|
|
void g_file_load_partial_contents_async (GFile *file,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GFileReadMoreCallback read_more_callback,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
gboolean g_file_load_partial_contents_finish (GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
char **contents,
|
|
|
|
|
gsize *length,
|
|
|
|
|
char **etag_out,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean g_file_replace_contents (GFile *file,
|
|
|
|
|
const char *contents,
|
|
|
|
|
gsize length,
|
|
|
|
|
const char *etag,
|
|
|
|
|
gboolean make_backup,
|
|
|
|
|
GFileCreateFlags flags,
|
|
|
|
|
char **new_etag,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GError **error);
|
|
|
|
|
void g_file_replace_contents_async (GFile *file,
|
|
|
|
|
const char *contents,
|
|
|
|
|
gsize length,
|
|
|
|
|
const char *etag,
|
|
|
|
|
gboolean make_backup,
|
|
|
|
|
GFileCreateFlags flags,
|
|
|
|
|
GCancellable *cancellable,
|
|
|
|
|
GAsyncReadyCallback callback,
|
|
|
|
|
gpointer user_data);
|
|
|
|
|
gboolean g_file_replace_contents_finish (GFile *file,
|
|
|
|
|
GAsyncResult *res,
|
|
|
|
|
char **new_etag,
|
|
|
|
|
GError **error);
|
|
|
|
|
|
|
|
|
|
G_END_DECLS
|
|
|
|
|
|
|
|
|
|
#endif /* __G_FILE_H__ */
|
