#include <uri.h>
Public Member Functions | |
void | reference () const |
void | unreference () const |
GnomeVFSURI * | gobj () |
Provides access to the underlying C instance. | |
const GnomeVFSURI * | gobj () const |
Provides access to the underlying C instance. | |
GnomeVFSURI * | gobj_copy () const |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
Glib::RefPtr< Uri > | resolve_relative (const Glib::ustring &relative_reference) |
Create a new Uri from relative_reference to this object. | |
Glib::RefPtr< Uri > | append_string (const Glib::ustring &uri_fragment) |
Create a new Uri object by appending uri_fragment to this Uri object. | |
Glib::RefPtr< Uri > | append_path (const Glib::ustring &path) |
Create a new Uri object by appending path to this Uri object. | |
Glib::RefPtr< Uri > | append_file_name (const Glib::ustring &filename) |
Create a new Uri object by appending filename to this Uri object. | |
Glib::ustring | to_string (URIHideOptions hide_options=URI_HIDE_NONE) const |
Translate this Uri into a printable string. | |
Glib::RefPtr< Uri > | dup () |
Duplicate this Uri. | |
bool | is_local () const |
Check if this Uri is a local (native) file system. | |
bool | has_parent () const |
Check if this Uri has a parent or not. | |
Glib::RefPtr< Uri > | get_parent () |
Retrieve this object's parent Uri. | |
Glib::RefPtr< const Uri > | get_parent () const |
Retrieve this object's parent Uri. | |
Glib::ustring | get_host_name () const |
Retrieve this object's host name. | |
Glib::ustring | get_scheme () const |
Retrieve this object's scheme. | |
guint | get_host_port () const |
Retrieve this object's host port number. | |
Glib::ustring | get_user_name () const |
Retrieve the user name in this object. | |
Glib::ustring | get_password () const |
Retrieve the password for this object. | |
void | set_host_name (const Glib::ustring &host_name) |
Set host_name as the host name accessed by this Uri. | |
void | set_host_port (guint host_port) |
Set the host port number in this Uri. | |
void | set_user_name (const Glib::ustring &user_name) |
Set user_name as the user name for this Uri. | |
void | set_password (const Glib::ustring &password) |
Set password as the password for this Uri. | |
bool | equal (const Glib::RefPtr< const Uri > &uri) const |
Compare a and b . | |
bool | is_parent (const Glib::RefPtr< const Uri > &possible_child, bool recursive=true) const |
Check if possible_child is contained by this Uri. | |
Glib::ustring | get_path () const |
Retrieve full path name for this Uri. | |
Glib::ustring | get_fragment_identifier () const |
Retrieve the optional fragment identifier for this Uri. | |
Glib::ustring | extract_dirname () const |
Extract the name of the directory in which the file pointed to by this Uri is stored as a new string. | |
Glib::ustring | extract_short_name () const |
Retrieve base file name for this Uri, ignoring any trailing path separators. | |
Glib::ustring | extract_short_path_name () const |
Retrieve base file name for this Uri, ignoring any trailing path separators. | |
Glib::RefPtr< FileInfo > | get_file_info (FileInfoOptions options=FILE_INFO_DEFAULT) const throw (exception) |
Retrieve the file info for this Uri. | |
void | create_symbolic_link (const Glib::ustring &target_reference) throw (exception) |
Creates a symbolic link from this Uri to target_reference. | |
bool | uri_exists () const |
Check if this Uri points to an existing entity. | |
FileSize | get_volume_free_space () const throw (exception) |
This only works for URIs with the file: scheme. | |
Static Public Member Functions | |
static Glib::RefPtr< Uri > | create (const Glib::ustring &uri) |
Create a new Uri from the text string uri. | |
static Glib::ustring | make_full_from_relative (const Glib::ustring &base_uri, const Glib::ustring &relative_uri) |
Returns a full Uri given a full base URI, and a secondary URI which may be relative. | |
static Glib::ustring | format_for_display (const Glib::ustring &uri) |
Filter, modify, unescape and change URIs to make them appropriate to display to users. | |
static Glib::ustring | make_from_input (const Glib::ustring &uri) |
Takes a user input path/URI and makes a valid URI out of it. | |
static Glib::ustring | make_from_input (const Glib::ustring &uri, MakeURIDirs dirs) |
static Glib::ustring | make_canonical_strip_fragment (const Glib::ustring &uri) |
If the uri passed contains a fragment (anything after a '#') strips if, then makes the URI canonical. | |
static bool | uris_match (const Glib::ustring &uri_1, const Glib::ustring &uri_2) |
Compare two URIs. | |
static Glib::ustring | get_scheme (const Glib::ustring &uri) |
Retrieve the scheme used in uri. | |
static Glib::ustring | make_from_shell_arg (const Glib::ustring &uri) |
Similar to gnome_vfs_make_uri_from_input, except that:. | |
Protected Member Functions | |
Uri () | |
void | operator delete (void *, size_t) |
Related Functions | |
(Note that these are not member functions.) | |
bool | operator== (const Uri &lhs, const Uri &rhs) |
bool | operator!= (const Uri &lhs, const Uri &rhs) |
Glib::RefPtr< Gnome::Vfs::Uri > | wrap (GnomeVFSURI *object, bool take_copy=false) |
Gnome::Vfs::Uri::Uri | ( | ) | [protected] |
Glib::RefPtr<Uri> Gnome::Vfs::Uri::append_file_name | ( | const Glib::ustring & | filename | ) |
Create a new Uri object by appending filename to this Uri object.
This takes care of adding an appropriate directory separator between the end of the Uri and the start of filename if necessary.
filename | Any "regular" file name (can include #, /, etc). |
Glib::RefPtr<Uri> Gnome::Vfs::Uri::append_path | ( | const Glib::ustring & | path | ) |
Glib::RefPtr<Uri> Gnome::Vfs::Uri::append_string | ( | const Glib::ustring & | uri_fragment | ) |
Create a new Uri object by appending uri_fragment to this Uri object.
This takes care of adding an appropriate directory separator between the end of the Uri and the start of uri_fragment if necessary.
uri_fragment | A piece of a Uri (ie a fully escaped partial path). |
static Glib::RefPtr<Uri> Gnome::Vfs::Uri::create | ( | const Glib::ustring & | uri | ) | [static] |
void Gnome::Vfs::Uri::create_symbolic_link | ( | const Glib::ustring & | target_reference | ) | throw (exception) |
Creates a symbolic link from this Uri to target_reference.
target_reference | URI to point the link to (full or relative path). |
Glib::RefPtr<Uri> Gnome::Vfs::Uri::dup | ( | ) |
bool Gnome::Vfs::Uri::equal | ( | const Glib::RefPtr< const Uri > & | uri | ) | const |
Compare a and b .
b | A GnomeVFSURI. |
true
if a and b are equal, false
otherwise.Glib::ustring Gnome::Vfs::Uri::extract_dirname | ( | ) | const |
Extract the name of the directory in which the file pointed to by this Uri is stored as a new string.
The string will end with a GNOME_VFS_URI_PATH_CHR.
Glib::ustring Gnome::Vfs::Uri::extract_short_name | ( | ) | const |
Retrieve base file name for this Uri, ignoring any trailing path separators.
This matches the XPG definition of basename, but not g_basename. This is often useful when you want the name of something that is pointed to by a Uri, and don't care whether the uri has a directory or file form. If this Uri points to the root of a domain, this method returns the host name; if there's no host name, returns GNOME_VFS_URI_PATH_STR.
See also: extract_short_path_name.
Glib::ustring Gnome::Vfs::Uri::extract_short_path_name | ( | ) | const |
Retrieve base file name for this Uri, ignoring any trailing path separators.
This matches the XPG definition of basename, but not g_basename. This is often useful when you want the name of something that is pointed to by a Uri, and don't care whether the uri has a directory or file form. If this Uri points to the root (including the root of any domain), this method returns GNOME_VFS_URI_PATH_STR.
See also: extract_short_name.
static Glib::ustring Gnome::Vfs::Uri::format_for_display | ( | const Glib::ustring & | uri | ) | [static] |
Filter, modify, unescape and change URIs to make them appropriate to display to users.
The conversion is done such that the roundtrip to UTF-8 is reversible.
Rules: file: URI's without fragments should appear as local paths file: URI's with fragments should appear as file: URI's All other URI's appear as expected
uri : a URI
Glib::RefPtr<FileInfo> Gnome::Vfs::Uri::get_file_info | ( | FileInfoOptions | options = FILE_INFO_DEFAULT |
) | const throw (exception) |
Glib::ustring Gnome::Vfs::Uri::get_fragment_identifier | ( | ) | const |
Glib::ustring Gnome::Vfs::Uri::get_host_name | ( | ) | const |
Retrieve this object's host name.
guint Gnome::Vfs::Uri::get_host_port | ( | ) | const |
Retrieve this object's host port number.
Glib::RefPtr<const Uri> Gnome::Vfs::Uri::get_parent | ( | ) | const |
Glib::RefPtr<Uri> Gnome::Vfs::Uri::get_parent | ( | ) |
Glib::ustring Gnome::Vfs::Uri::get_password | ( | ) | const |
Glib::ustring Gnome::Vfs::Uri::get_path | ( | ) | const |
static Glib::ustring Gnome::Vfs::Uri::get_scheme | ( | const Glib::ustring & | uri | ) | [static] |
Retrieve the scheme used in uri.
uri | A stringified URI. |
Glib::ustring Gnome::Vfs::Uri::get_scheme | ( | ) | const |
Retrieve this object's scheme.
Glib::ustring Gnome::Vfs::Uri::get_user_name | ( | ) | const |
This only works for URIs with the file: scheme.
vfs_uri,: |
const GnomeVFSURI* Gnome::Vfs::Uri::gobj | ( | ) | const |
Provides access to the underlying C instance.
GnomeVFSURI* Gnome::Vfs::Uri::gobj | ( | ) |
Provides access to the underlying C instance.
GnomeVFSURI* Gnome::Vfs::Uri::gobj_copy | ( | ) | const |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
bool Gnome::Vfs::Uri::has_parent | ( | ) | const |
bool Gnome::Vfs::Uri::is_local | ( | ) | const |
Check if this Uri is a local (native) file system.
false
if uri is not a local file system, true
otherwise. bool Gnome::Vfs::Uri::is_parent | ( | const Glib::RefPtr< const Uri > & | possible_child, | |
bool | recursive = true | |||
) | const |
Check if possible_child is contained by this Uri.
If recursive is false
, just try the immediate parent directory, else search up through the hierarchy.
possible_child | A Glib::RefPtr to the Uri to test. | |
recursive | A flag to turn recursive check on. |
true
if possible_child is contained in this Uri. static Glib::ustring Gnome::Vfs::Uri::make_canonical_strip_fragment | ( | const Glib::ustring & | uri | ) | [static] |
If the uri passed contains a fragment (anything after a '#') strips if, then makes the URI canonical.
static Glib::ustring Gnome::Vfs::Uri::make_from_input | ( | const Glib::ustring & | uri, | |
MakeURIDirs | dirs | |||
) | [static] |
static Glib::ustring Gnome::Vfs::Uri::make_from_input | ( | const Glib::ustring & | uri | ) | [static] |
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 UTF8 in the entry showing the string.
location | A possibly mangled "uri", in UTF8. |
static Glib::ustring Gnome::Vfs::Uri::make_from_shell_arg | ( | const Glib::ustring & | uri | ) | [static] |
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
location | A possibly mangled "uri". |
static Glib::ustring Gnome::Vfs::Uri::make_full_from_relative | ( | const Glib::ustring & | base_uri, | |
const Glib::ustring & | relative_uri | |||
) | [static] |
Returns a full Uri given a full base URI, and a secondary URI which may be relative.
base_uri | A string representing the base URI. | |
relative_uri | A URI fragment/reference to be appended to base_uri . |
0
for some bad errors). void Gnome::Vfs::Uri::operator delete | ( | void * | , | |
size_t | ||||
) | [protected] |
void Gnome::Vfs::Uri::reference | ( | ) | const |
Glib::RefPtr<Uri> Gnome::Vfs::Uri::resolve_relative | ( | const Glib::ustring & | relative_reference | ) |
void Gnome::Vfs::Uri::set_host_name | ( | const Glib::ustring & | host_name | ) |
Set host_name as the host name accessed by this Uri.
host_name | A string representing a host name. |
void Gnome::Vfs::Uri::set_host_port | ( | guint | host_port | ) |
Set the host port number in this Uri.
If host_port is zero, the default port for this object's toplevel access method is used.
host_port | A TCP/IP port number. |
void Gnome::Vfs::Uri::set_password | ( | const Glib::ustring & | password | ) |
void Gnome::Vfs::Uri::set_user_name | ( | const Glib::ustring & | user_name | ) |
Set user_name as the user name for this Uri.
user_name | A string representing a user name on the host accessed by this object. |
Glib::ustring Gnome::Vfs::Uri::to_string | ( | URIHideOptions | hide_options = URI_HIDE_NONE |
) | const |
Translate this Uri into a printable string.
The string will not contain the Uri elements specified by hide_options .
hide_options | Bitmask specifying what URI elements (e.g. password, user name etc.) should NOT be represented in the returned string. |
void Gnome::Vfs::Uri::unreference | ( | ) | const |
bool Gnome::Vfs::Uri::uri_exists | ( | ) | const |
static bool Gnome::Vfs::Uri::uris_match | ( | const Glib::ustring & | uri_1, | |
const Glib::ustring & | uri_2 | |||
) | [static] |
Compare two URIs.
uri_1 | Stringified URI to compare with uri_2 . | |
uri_2 | Stringified URI to compare with uri_1 . |
true
if they are the same, false
otherwise.
lhs | The left-hand side | |
rhs | The right-hand side |
lhs | The left-hand side | |
rhs | The right-hand side |
Glib::RefPtr< Gnome::Vfs::Uri > wrap | ( | GnomeVFSURI * | object, | |
bool | take_copy = false | |||
) | [related] |
object | The C instance | |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |