enum GnomeVFSMakeURIDirs

typedef enum {
	GNOME_VFS_MAKE_URI_DIR_NONE = 0,
	GNOME_VFS_MAKE_URI_DIR_HOMEDIR = 1 << 0,
	GNOME_VFS_MAKE_URI_DIR_CURRENT = 1 << 1
} GnomeVFSMakeURIDirs;

Flags that can be passed to gnome_vfs_make_uri_from_input_with_dirs(). If the given input might be a relative path it checks for existence of the file in the directory specified by this flag. If both flags are passed the current directory is checked first.

gnome_vfs_format_file_size_for_display ()

char*       gnome_vfs_format_file_size_for_display
                                            (GnomeVFSFileSize size);

Formats the file size passed so that it is easy for the user to read. Gives the size in bytes, kilobytes, megabytes or gigabytes, choosing whatever is appropriate.

gnome_vfs_format_uri_for_display ()

char*       gnome_vfs_format_uri_for_display
                                            (const char *uri);

Filter, modify, unescape and change uri to make it appropriate for display to users. The conversion is done such that the roundtrip to UTF-8 is reversible.

Rules: file: uri without fragments should appear as local paths. file: uri with fragments should appear as file:uri. All other uri appear as expected.

Since 2.2

gnome_vfs_url_show ()

GnomeVFSResult gnome_vfs_url_show           (const char *url);

Launches the default application or component associated with the given url.

Since 2.4

gnome_vfs_url_show_with_env ()

GnomeVFSResult gnome_vfs_url_show_with_env  (const char *url,
                                             char **envp);

Like gnome_vfs_url_show() except that the default action will be launched with the given environment.

Since 2.4

gnome_vfs_escape_string ()

char*       gnome_vfs_escape_string         (const char *string);

Escapes string, replacing any and all special characters with equivalent escape sequences.

gnome_vfs_escape_path_string ()

char*       gnome_vfs_escape_path_string    (const char *path);

Escapes path, replacing only special characters that would not be found in paths (so '/', '&', and '=' will not be escaped by this function).

gnome_vfs_escape_host_and_path_string ()

char*       gnome_vfs_escape_host_and_path_string
                                            (const char *path);

Escapes path, replacing only special characters that would not be found in paths or host name (so '/', '&', '=', ':' and '@' will not be escaped by this function).

gnome_vfs_escape_slashes ()

char*       gnome_vfs_escape_slashes        (const char *string);

Escapes only '/' and '%' characters in string, replacing them with their escape sequence equivalents.

gnome_vfs_escape_set ()

char*       gnome_vfs_escape_set            (const char *string,
                                             const char *match_set);

Escapes all characters in string which are listed in match_set.

gnome_vfs_unescape_string ()

char*       gnome_vfs_unescape_string       (const char *escaped_string,
                                             const char *illegal_characters);

Decodes escaped characters (i.e. PERCENTxx sequences) in escaped_string. Characters are encoded in PERCENTxy form, where xy is the ASCII hex code for character 16x+y.

gnome_vfs_make_uri_canonical ()

char*       gnome_vfs_make_uri_canonical    (const char *uri);

Standardizes the format of the uri, so that it can be used later in other functions that expect a canonical uri.

Since 2.2

gnome_vfs_make_uri_canonical_strip_fragment ()

char*       gnome_vfs_make_uri_canonical_strip_fragment
                                            (const char *uri);

Returns a canonicalized uri. If uri contains a fragment (anything after a '#') strips off that and then makes the uri canonical.

Since 2.2

gnome_vfs_make_path_name_canonical ()

char*       gnome_vfs_make_path_name_canonical
                                            (const char *path);

Calls _gnome_vfs_canonicalize_pathname(), allocating storage for the result and providing for a cleaner memory management.

gnome_vfs_make_uri_from_input ()

char*       gnome_vfs_make_uri_from_input   (const char *location);

Takes a user input path/uri and makes a valid uri out of it.

This function is the reverse of gnome_vfs_format_uri_for_display() but it also handles the fact that the user could have typed arbitrary UTF-8 in the entry showing the string.

Since 2.2

gnome_vfs_make_uri_from_input_with_dirs ()

char*       gnome_vfs_make_uri_from_input_with_dirs
                                            (const char *location,
                                             GnomeVFSMakeURIDirs dirs);

Determines a fully qualified uri from a relative or absolute input path. Basically calls gnome_vfs_make_uri_from_input() except it specifically tries to support paths relative to the specified directories (can be homedir and/or current directory). See GnomeVFSMakeURIDirs for more information.

Since 2.4

gnome_vfs_make_uri_from_shell_arg ()

char*       gnome_vfs_make_uri_from_shell_arg
                                            (const char *uri);

Similar to gnome_vfs_make_uri_from_input(), except that:

1) guesses relative paths instead of http domains. 2) doesn't bother stripping leading/trailing white space. 3) doesn't bother with ~ expansion--that's done by the shell.

Since 2.2

gnome_vfs_make_uri_full_from_relative ()

char*       gnome_vfs_make_uri_full_from_relative
                                            (const char *base_uri,
                                             const char *relative_uri);

Returns a string representing the full uri given a full base_uri and a secondary uri which may be relative.

Since 2.2

gnome_vfs_expand_initial_tilde ()

char*       gnome_vfs_expand_initial_tilde  (const char *path);

If path starts with a ~, representing the user's home directory, expand it to the actual path location.

gnome_vfs_unescape_string_for_display ()

char*       gnome_vfs_unescape_string_for_display
                                            (const char *escaped);

Similar to gnome_vfs_unescape_string, but it returns something semi-intelligable to a user even upon receiving traumatic input such as 00 or URIs in bad form.

See also: gnome_vfs_unescape_string().

WARNING: You should never use this function on a whole URI! It unescapes reserved characters, and can result in a mangled URI that can not be re-entered. For example, it unescapes "#" "&" and "?", which have special meanings in URI strings.

gnome_vfs_get_local_path_from_uri ()

char*       gnome_vfs_get_local_path_from_uri
                                            (const char *uri);

Create a local path for a file:/// uri. Do not use with uris of other methods.

gnome_vfs_get_uri_from_local_path ()

char*       gnome_vfs_get_uri_from_local_path
                                            (const char *local_full_path);

Returns a file:/// URI for the local path local_full_path, such as a path provided by gtk_file_chooser_get_filename(). The resulting URI may be provided, for instance, to gnome_vfs_uri_new().

On Windows local_full_path should be in the UTF-8 encoding, and can start with a drive letter, but doesn't have to.

gnome_vfs_is_executable_command_string ()

gboolean    gnome_vfs_is_executable_command_string
                                            (const char *command_string);

Checks if command_string starts with the full path of an executable file or an executable in $PATH.

gnome_vfs_list_deep_free ()

void        gnome_vfs_list_deep_free        (GList *list);

Free list and call g_free() on all data members.

gnome_vfs_get_volume_free_space ()

GnomeVFSResult gnome_vfs_get_volume_free_space
                                            (const GnomeVFSURI *vfs_uri,
                                             GnomeVFSFileSize *size);

Stores the amount of free space in bytes on vfs-uri's volume in size.

gnome_vfs_icon_path_from_filename ()

char*       gnome_vfs_icon_path_from_filename
                                            (const char *filename);

gnome_vfs_is_primary_thread ()

gboolean    gnome_vfs_is_primary_thread     (void);

Check if the current thread is the thread with the main glib event loop.

gnome_vfs_get_uri_scheme ()

char*       gnome_vfs_get_uri_scheme        (const char *uri);

Retrieve the scheme used in uri.

Since 2.2

gnome_vfs_uris_match ()

gboolean    gnome_vfs_uris_match            (const char *uri_1,
                                             const char *uri_2);

Compare two uris.

Since 2.2

GNOME_VFS_ASSERT_PRIMARY_THREAD

#define GNOME_VFS_ASSERT_PRIMARY_THREAD g_assert (gnome_vfs_is_primary_thread())

Asserts that the current thread is the thread with the main glib event loop

GNOME_VFS_ASSERT_SECONDARY_THREAD

#define GNOME_VFS_ASSERT_SECONDARY_THREAD g_assert (!gnome_vfs_is_primary_thread())

Asserts that the current thread is NOT the thread with the main glib event loop

gnome_vfs_open_fd ()

GnomeVFSResult gnome_vfs_open_fd            (GnomeVFSHandle **handle,
                                             int filedes);

Converts an open unix file descript into a GnomeVFSHandle that can be used with the normal GnomeVFS file operations. When the handle is closed the file descriptor will also be closed.

gnome_vfs_read_entire_file ()

GnomeVFSResult gnome_vfs_read_entire_file   (const char *uri,
                                             int *file_size,
                                             char **file_contents);

Reads an entire file into memory for convenience. Beware accidentally loading large files into memory with this function.

Since version 2.10 the string stored in file_contents will be null-terminated, so for text files you can use result as a normal string.

Since 2.2