Details
GnomeVFSToplevelURI
typedef struct {
/* Base object. */
GnomeVFSURI uri;
/* Server location information. */
gchar *host_name;
guint host_port;
/* Authorization information. */
gchar *user_name;
gchar *password;
/* The parent URN, if it exists */
gchar *urn;
/* Reserved to avoid future breaks in ABI compatibility */
void *reserved1;
void *reserved2;
} GnomeVFSToplevelURI;
enum GnomeVFSURIHideOptions
typedef enum {
GNOME_VFS_URI_HIDE_NONE = 0,
GNOME_VFS_URI_HIDE_USER_NAME = 1 << 0,
GNOME_VFS_URI_HIDE_PASSWORD = 1 << 1,
GNOME_VFS_URI_HIDE_HOST_NAME = 1 << 2,
GNOME_VFS_URI_HIDE_HOST_PORT = 1 << 3,
GNOME_VFS_URI_HIDE_TOPLEVEL_METHOD = 1 << 4,
GNOME_VFS_URI_HIDE_FRAGMENT_IDENTIFIER = 1 << 8
} GnomeVFSURIHideOptions;
GNOME_VFS_URI_HIDE_NONE | don't hide anything
|
GNOME_VFS_URI_HIDE_USER_NAME | hide the user name
|
GNOME_VFS_URI_HIDE_PASSWORD | hide the password
|
GNOME_VFS_URI_HIDE_HOST_NAME | hide the host name
|
GNOME_VFS_URI_HIDE_HOST_PORT | hide the port
|
GNOME_VFS_URI_HIDE_TOPLEVEL_METHOD | hide the method (e.g. http, file)
|
GNOME_VFS_URI_HIDE_FRAGMENT_IDENTIFIER | hide the fragment identifier
|
GNOME_VFS_URI_MAGIC_CHR
#define GNOME_VFS_URI_MAGIC_CHR '#'
GNOME_VFS_URI_MAGIC_STR
#define GNOME_VFS_URI_MAGIC_STR "#"
GNOME_VFS_URI_PATH_CHR
#define GNOME_VFS_URI_PATH_CHR '/'
GNOME_VFS_URI_PATH_STR
#define GNOME_VFS_URI_PATH_STR "/"
gnome_vfs_uri_new ()
GnomeVFSURI* gnome_vfs_uri_new (const gchar *text_uri);
text_uri : | A string representing a URI.
|
Returns : | The new URI.
|
gnome_vfs_uri_resolve_relative ()
GnomeVFSURI* gnome_vfs_uri_resolve_relative (const GnomeVFSURI *base,
const gchar *relative_reference);
base : | The base URI.
|
relative_reference : | A string representing a possibly relative URI reference
|
Returns : | The new URI.
|
gnome_vfs_uri_ref ()
GnomeVFSURI* gnome_vfs_uri_ref (GnomeVFSURI *uri);
uri : | A GnomeVFSURI.
|
Returns : | uri.
|
gnome_vfs_uri_unref ()
void gnome_vfs_uri_unref (GnomeVFSURI *uri);
gnome_vfs_uri_append_string ()
GnomeVFSURI* gnome_vfs_uri_append_string (const GnomeVFSURI *uri,
const char *uri_fragment);
uri : | A GnomeVFSURI.
|
uri_fragment : | A piece of a URI (ie a fully escaped partial path)
|
Returns : | The new URI obtained by combining uri and path.
|
gnome_vfs_uri_append_path ()
GnomeVFSURI* gnome_vfs_uri_append_path (const GnomeVFSURI *uri,
const char *path);
uri : | A GnomeVFSURI.
|
path : | A non-escaped file path
|
Returns : | The new URI obtained by combining uri and path.
|
gnome_vfs_uri_append_file_name ()
GnomeVFSURI* gnome_vfs_uri_append_file_name (const GnomeVFSURI *uri,
const gchar *filename);
uri : | A GnomeVFSURI.
|
filename : | any "regular" file name (can include #, /, etc)
|
Returns : | The new URI obtained by combining uri and path.
|
gnome_vfs_uri_to_string ()
gchar* gnome_vfs_uri_to_string (const GnomeVFSURI *uri,
GnomeVFSURIHideOptions hide_options);
uri : | A GnomeVFSURI.
|
hide_options : | Bitmask specifying what URI elements (e.g. password,
user name etc.) should not be represented in the returned string.
|
Returns : | A malloced printable string representing uri.
|
gnome_vfs_uri_dup ()
GnomeVFSURI* gnome_vfs_uri_dup (const GnomeVFSURI *uri);
uri : | A GnomeVFSURI.
|
Returns : | A pointer to a new URI that is exactly the same as uri.
|
gnome_vfs_uri_is_local ()
gboolean gnome_vfs_uri_is_local (const GnomeVFSURI *uri);
uri : | A GnomeVFSURI.
|
Returns : | FALSE if uri is not a local file system, TRUE otherwise.
|
gnome_vfs_uri_has_parent ()
gboolean gnome_vfs_uri_has_parent (const GnomeVFSURI *uri);
uri : | A GnomeVFSURI.
|
Returns : | TRUE if uri has a parent, FALSE otherwise.
|
gnome_vfs_uri_get_parent ()
GnomeVFSURI* gnome_vfs_uri_get_parent (const GnomeVFSURI *uri);
uri : | A GnomeVFSURI.
|
Returns : | A pointer to uri's parent URI.
|
gnome_vfs_uri_get_toplevel ()
GnomeVFSToplevelURI* gnome_vfs_uri_get_toplevel
(const GnomeVFSURI *uri);
uri : | A GnomeVFSURI.
|
Returns : | A pointer to the toplevel URI object.
|
gnome_vfs_uri_get_host_name ()
const gchar* gnome_vfs_uri_get_host_name (const GnomeVFSURI *uri);
uri : | A GnomeVFSURI.
|
Returns : | A string representing the host name.
|
gnome_vfs_uri_get_scheme ()
const gchar* gnome_vfs_uri_get_scheme (const GnomeVFSURI *uri);
uri : | A GnomeVFSURI
|
Returns : | A string representing the scheme
|
gnome_vfs_uri_get_host_port ()
guint gnome_vfs_uri_get_host_port (const GnomeVFSURI *uri);
uri : | A GnomeVFSURI.
|
Returns : | The host port number used by uri. If the value is zero, the
default port value for the specified toplevel access method is used.
|
gnome_vfs_uri_get_user_name ()
const gchar* gnome_vfs_uri_get_user_name (const GnomeVFSURI *uri);
uri : | A GnomeVFSURI.
|
Returns : | A string representing the user name in uri.
|
gnome_vfs_uri_get_password ()
const gchar* gnome_vfs_uri_get_password (const GnomeVFSURI *uri);
uri : | A GnomeVFSURI.
|
Returns : | The password for uri.
|
gnome_vfs_uri_set_host_name ()
void gnome_vfs_uri_set_host_name (GnomeVFSURI *uri,
const gchar *host_name);
uri : | A GnomeVFSURI.
|
host_name : | A string representing a host name.
|
gnome_vfs_uri_set_host_port ()
void gnome_vfs_uri_set_host_port (GnomeVFSURI *uri,
guint host_port);
uri : | A GnomeVFSURI.
|
host_port : | A TCP/IP port number.
|
gnome_vfs_uri_set_user_name ()
void gnome_vfs_uri_set_user_name (GnomeVFSURI *uri,
const gchar *user_name);
uri : | A GnomeVFSURI.
|
user_name : | A string representing a user name on the host accessed by uri.
|
gnome_vfs_uri_set_password ()
void gnome_vfs_uri_set_password (GnomeVFSURI *uri,
const gchar *password);
uri : | A GnomeVFSURI.
|
password : | A password string.
|
gnome_vfs_uri_equal ()
gboolean gnome_vfs_uri_equal (const GnomeVFSURI *a,
const GnomeVFSURI *b);
a : | A GnomeVFSURI.
|
b : | A GnomeVFSURI.
|
Returns : | TRUE if a and b are equal, FALSE otherwise.
FIXME: This comparison should take into account the possiblity
that unreserved characters may be escaped.
...or perhaps gnome_vfs_uri_new should unescape unreserved characters?
|
gnome_vfs_uri_is_parent ()
gboolean gnome_vfs_uri_is_parent (const GnomeVFSURI *possible_parent,
const GnomeVFSURI *possible_child,
gboolean recursive);
possible_parent : | A GnomeVFSURI.
|
possible_child : | A GnomeVFSURI.
|
recursive : | a flag to turn recursive check on.
|
Returns : | TRUE if possible_child is contained in possible_child.
|
gnome_vfs_uri_get_path ()
const gchar* gnome_vfs_uri_get_path (const GnomeVFSURI *uri);
uri : | A GnomeVFSURI
|
Returns : | A pointer to the full path name in uri. Notice that the
pointer points to the name store in uri, so the name returned must not
be modified nor freed.
|
gnome_vfs_uri_get_fragment_identifier ()
const gchar* gnome_vfs_uri_get_fragment_identifier
(const GnomeVFSURI *uri);
gnome_vfs_uri_extract_dirname ()
gchar* gnome_vfs_uri_extract_dirname (const GnomeVFSURI *uri);
uri : | A GnomeVFSURI
|
Returns : | A pointer to the newly allocated string representing the
parent directory.
|
gnome_vfs_uri_extract_short_name ()
gchar* gnome_vfs_uri_extract_short_name
(const GnomeVFSURI *uri);
uri : | A GnomeVFSURI
|
Returns : | A pointer to the newly allocated string representing the
unescaped short form of the name.
|
gnome_vfs_uri_extract_short_path_name ()
gchar* gnome_vfs_uri_extract_short_path_name
(const GnomeVFSURI *uri);
uri : | A GnomeVFSURI
|
Returns : | A pointer to the newly allocated string representing the
escaped short form of the name.
|
gnome_vfs_uri_hequal ()
gint gnome_vfs_uri_hequal (gconstpointer a,
gconstpointer b);
a : | a pointer to a GnomeVFSURI
|
b : | a pointer to a GnomeVFSURI
|
Returns : | TRUE if the URIs are the same
|
gnome_vfs_uri_hash ()
guint gnome_vfs_uri_hash (gconstpointer p);
p : | a pointer to a GnomeVFSURI
|
Returns : | a hash key corresponding to p
|
gnome_vfs_uri_list_parse ()
GList* gnome_vfs_uri_list_parse (const gchar *uri_list);
uri_list : |
|
Returns : | A GList of GnomeVFSURIs
|
gnome_vfs_uri_list_ref ()
GList* gnome_vfs_uri_list_ref (GList *list);
list : | list of GnomeVFSURI elements
|
Returns : | list
|
gnome_vfs_uri_list_unref ()
GList* gnome_vfs_uri_list_unref (GList *list);
list : | list of GnomeVFSURI elements
|
Returns : | list
|
gnome_vfs_uri_list_copy ()
GList* gnome_vfs_uri_list_copy (GList *list);
list : | list of GnomeVFSURI elements
|
Returns : | a newly referenced duplicate of list
|
gnome_vfs_uri_list_free ()
void gnome_vfs_uri_list_free (GList *list);
list : | list of GnomeVFSURI elements
|
gnome_vfs_uri_make_full_from_relative ()
char* gnome_vfs_uri_make_full_from_relative
(const char *base_uri,
const char *relative_uri);
base_uri : | a string representing the base URI
|
relative_uri : | a URI fragment/reference to be appended to base_uri
|
Returns : | the URI (NULL for some bad errors).
|