Contents Up Previous Next

wxURI

wxURI is used to extract information from a URI (Uniform Resource Identifier).

For information about URIs, see RFC 3986.

In short, a URL is a URI. In other words, URL is a subset of a URI - all acceptable URLs are also acceptable URIs.

wxURI automatically escapes invalid characters in a string, so there is no chance of wxURI "failing" on construction/creation.

wxURI supports copy construction and standard assignment operators. wxURI can also be inherited from to provide furthur functionality.

Derived from

wxObject

Include files

<wx/uri.h>

Members

Obtaining individual components
Deviations from the RFC
wxURI::wxURI
wxURI::BuildURI
wxURI::BuildUnescapedURI
wxURI::Create
wxURI::GetFragment
wxURI::GetHostType
wxURI::GetPassword
wxURI::GetPath
wxURI::GetPort
wxURI::GetQuery
wxURI::GetScheme
wxURI::GetServer
wxURI::GetUser
wxURI::GetUserInfo
wxURI::HasFragment
wxURI::HasPath
wxURI::HasPort
wxURI::HasQuery
wxURI::HasScheme
wxURI::HasServer
wxURI::HasUser
wxURI::IsReference
wxURI::operator ==
wxURI::Resolve
wxURI::Unescape

Obtaining individual components

To obtain individual components you can use one of the following methods

GetScheme
GetUserInfo
GetServer
GetPort
GetPath
GetQuery
GetFragment

However, you should check HasXXX before calling a get method, which determines whether or not the component referred to by the method is defined according to RFC 2396.

Consider an undefined component equivalent to a NULL C string.

HasScheme
HasUserInfo
HasServer
HasPort
HasPath
HasQuery
HasFragment

Example: 

//protocol will hold the http protocol (i.e. "http")
wxString protocol;
wxURI myuri(wxT("http://mysite.com"));
if(myuri.HasScheme())
   protocol = myuri.GetScheme();

Deviations from the RFC

Note that on URIs with a "file" scheme wxURI does not parse the userinfo, server, or port portion. This is to keep compatability with wxFileSystem, the old wxURL, and older url specifications.

wxURI::wxURI

wxURI()

Creates an empty URI.

wxURI(const wxChar* uri)

Constructor for quick creation.

uri

wxURI(const wxURI& uri)

Copies this URI from another URI.

uri

wxURI::BuildURI

wxString BuildURI() const

Builds the URI from its individual components and adds proper separators.

If the URI is not a reference or is not resolved, the URI that is returned from Get is the same one passed to Create.

wxURI::BuildUnescapedURI

wxString BuildUnescapedURI() const

Builds the URI from its individual components, adds proper separators, and returns escape sequences to normal characters.

Note that it is preferred to call this over Unescape(BuildURI()) since BuildUnescapedURI performs some optimizations over the plain method.

wxURI::Create

const wxChar* Create(const wxStringuri)

Creates this URI from the string uri.

Returns the position at which parsing stopped (there is no such thing as an "invalid" wxURI).

uri

wxURI::GetFragment

const wxString GetFragment() const

Obtains the fragment of this URI.

The fragment of a URI is the last value of the URI, and is the value after a '' character after the path of the URI.

http://mysite.com/mypath#<fragment>

wxURI::GetHostType

const HostType& GetHostType() const

Obtains the host type of this URI, which is of type wxURI::HostType:

wxURI_REGNAME Server is a host name, or the Server component itself is undefined.
wxURI_IPV4ADDRESS Server is a IP version 4 address (XXX.XXX.XXX.XXX)
wxURI_IPV6ADDRESS Server is a IP version 6 address ((XXX:)XXX::(XXX)XXX:XXX
wxURI_IPVFUTURE Server is an IP address, but not versions 4 or 6

wxURI::GetPassword

const wxString GetPassword() const

Returns the password part of the userinfo component of this URI. Note that this is explicitly depreciated by RFC 1396 and should generally be avoided if possible.

http://<user>:<password>@mysite.com/mypath

wxURI::GetPath

const wxString GetPath() const

Returns the (normalized) path of the URI.

The path component of a URI comes directly after the scheme component if followed by zero or one slashes ('/'), or after the server/port component.

Absolute paths include the leading '/' character.

http://mysite.com<path>

wxURI::GetPort

const wxString GetPort() const

Returns a string representation of the URI's port.

The Port of a URI is a value after the server, and must come after a colon (:).

http://mysite.com:<port>

Note that you can easily get the numeric value of the port by using wxAtoi or wxString::Format.

wxURI::GetQuery

const wxString GetQuery() const

Returns the Query component of the URI.

The query component is what is commonly passed to a cgi application, and must come after the path component, and after a '?' character.

http://mysite.com/mypath?<query>

wxURI::GetScheme

const wxString GetScheme() const

Returns the Scheme component of the URI.

The first part of the uri.

<scheme>://mysite.com

wxURI::GetServer

const wxString GetServer() const

Returns the Server component of the URI.

The server of the uri can be a server name or a type of ip address. See GetHostType for the possible values for the host type of the server component.

http://<server>/mypath

wxURI::GetUser

const wxString GetUser() const

Returns the username part of the userinfo component of this URI. Note that this is explicitly depreciated by RFC 1396 and should generally be avoided if possible.

http://<user>:<password>@mysite.com/mypath

wxURI::GetUserInfo

const wxString GetUserInfo() const

Returns the UserInfo component of the URI.

The component of a URI before the server component that is postfixed by a '@' character.

http://<userinfo>@mysite.com/mypath

wxURI::HasFragment

bool HasFragment() const

Returns true if the Fragment component of the URI exists.

wxURI::HasPath

bool HasPath() const

Returns true if the Path component of the URI exists.

wxURI::HasPort

bool HasPort() const

Returns true if the Port component of the URI exists.

wxURI::HasQuery

bool HasQuery() const

Returns true if the Query component of the URI exists.

wxURI::HasScheme

bool HasScheme() const

Returns true if the Scheme component of the URI exists.

wxURI::HasServer

bool HasServer() const

Returns true if the Server component of the URI exists.

wxURI::HasUser

bool HasUser() const

Returns true if the User component of the URI exists.

wxURI::IsReference

bool IsReference() const

Returns true if a valid [absolute] URI, otherwise this URI is a URI reference and not a full URI, and IsReference returns false.

wxURI::operator ==

void operator ==(const wxURI& uricomp)

Compares this URI to another URI, and returns true if this URI equals uricomp, otherwise it returns false.

uricomp

wxURI::Resolve

void Resolve(const wxURI& base, int flags = wxURI_STRICT)

Inherits this URI from a base URI - components that do not exist in this URI are copied from the base, and if this URI's path is not an absolute path (prefixed by a '/'), then this URI's path is merged with the base's path.

For instance, resolving "../mydir" from "http://mysite.com/john/doe" results in the scheme (http) and server (mysite.com) being copied into this URI, since they do not exist. In addition, since the path of this URI is not absolute (does not begin with '/'), the path of the base's is merged with this URI's path, resulting in the URI "http://mysite.com/john/mydir".

base

flags

wxURI::Unescape

wxString Unescape(const wxString& uri)

Translates all escape sequences (normal characters and returns the result.

This is the preferred over deprecated wxURL::ConvertFromURI.

If you want to unescape an entire wxURI, use BuildUnescapedURI instead, as it performs some optimizations over this method.

uri