tree		API documentation		The XML C parser and toolkit of Gnome	valid

library of generic URI related routines Implements RFC 2396

Table of Contents

Structure xmlURI
struct _xmlURI

Typedef xmlURI * xmlURIPtr

xmlChar *	xmlBuildRelativeURI	(const xmlChar * URI, 
					 const xmlChar * base)

xmlChar *	xmlBuildURI		(const xmlChar * URI, 
					 const xmlChar * base)

xmlChar *	xmlCanonicPath		(const xmlChar * path)

xmlURIPtr	xmlCreateURI		(void)

void	xmlFreeURI			(xmlURIPtr uri)

int	xmlNormalizeURIPath		(char * path)

xmlURIPtr	xmlParseURI		(const char * str)

xmlURIPtr	xmlParseURIRaw		(const char * str, 
					 int raw)

int	xmlParseURIReference		(xmlURIPtr uri, 
					 const char * str)

xmlChar *	xmlPathToURI		(const xmlChar * path)

void	xmlPrintURI			(FILE * stream, 
					 xmlURIPtr uri)

xmlChar *	xmlSaveUri		(xmlURIPtr uri)

xmlChar *	xmlURIEscape		(const xmlChar * str)

xmlChar *	xmlURIEscapeStr		(const xmlChar * str, 
					 const xmlChar * list)

char *	xmlURIUnescapeString		(const char * str, 
					 int len, 
					 char * target)

Description

Structure xmlURI

Structure xmlURI
struct _xmlURI {
    char *	scheme	: the URI scheme
    char *	opaque	: opaque part
    char *	authority	: the authority part
    char *	server	: the server part
    char *	user	: the user part
    int	port	: the port number
    char *	path	: the path string
    char *	query	: the query string (deprecated - use with
    char *	fragment	: the fragment identifier
    int	cleanup	: parsing potentially unclean URI
    char *	query_raw	: the query string (as it appears in the
}

Function: xmlBuildRelativeURI

xmlChar *	xmlBuildRelativeURI	(const xmlChar * URI, 
					 const xmlChar * base)

Expresses the URI of the reference in terms relative to the base. Some examples of this operation include: base = "http://site1.com/docs/book1.html" URI input URI returned docs/pic1.gif pic1.gif docs/img/pic1.gif img/pic1.gif img/pic1.gif ../img/pic1.gif http://site1.com/docs/pic1.gif pic1.gif http://site2.com/docs/pic1.gif http://site2.com/docs/pic1.gif base = "docs/book1.html" URI input URI returned docs/pic1.gif pic1.gif docs/img/pic1.gif img/pic1.gif img/pic1.gif ../img/pic1.gif http://site1.com/docs/pic1.gif http://site1.com/docs/pic1.gif Note: if the URI reference is really weird or complicated, it may be worthwhile to first convert it into a "nice" one by calling xmlBuildURI (using 'base') before calling this routine, since this routine (for reasonable efficiency) assumes URI has already been through some validation.

Function: xmlBuildURI

xmlChar *	xmlBuildURI		(const xmlChar * URI, 
					 const xmlChar * base)

Computes he final URI of the reference done by checking that the given URI is valid, and building the final URI using the base URI. This is processed according to section 5.2 of the RFC 2396 5.2. Resolving Relative References to Absolute Form

Function: xmlCanonicPath

xmlChar *	xmlCanonicPath		(const xmlChar * path)

Constructs a canonic path from the specified path.

Function: xmlCreateURI

xmlURIPtr	xmlCreateURI		(void)

Simply creates an empty xmlURI

Function: xmlFreeURI

void	xmlFreeURI			(xmlURIPtr uri)

Free up the xmlURI struct

Function: xmlNormalizeURIPath

int	xmlNormalizeURIPath		(char * path)

Applies the 5 normalization steps to a path string--that is, RFC 2396 Section 5.2, steps 6.c through 6.g. Normalization occurs directly on the string, no new allocation is done

Function: xmlParseURI

xmlURIPtr	xmlParseURI		(const char * str)

Parse an URI based on RFC 3986 URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

Function: xmlParseURIRaw

xmlURIPtr	xmlParseURIRaw		(const char * str, 
					 int raw)

Parse an URI but allows to keep intact the original fragments. URI-reference = URI / relative-ref

Function: xmlParseURIReference

int	xmlParseURIReference		(xmlURIPtr uri, 
					 const char * str)

Parse an URI reference string based on RFC 3986 and fills in the appropriate fields of the @uri structure URI-reference = URI / relative-ref

Function: xmlPathToURI

xmlChar *	xmlPathToURI		(const xmlChar * path)

Constructs an URI expressing the existing path

Function: xmlPrintURI

void	xmlPrintURI			(FILE * stream, 
					 xmlURIPtr uri)

Prints the URI in the stream @stream.

Function: xmlSaveUri

xmlChar *	xmlSaveUri		(xmlURIPtr uri)

Save the URI as an escaped string

Function: xmlURIEscape

xmlChar *	xmlURIEscape		(const xmlChar * str)

Escaping routine, does not do validity checks ! It will try to escape the chars needing this, but this is heuristic based it's impossible to be sure.

Function: xmlURIEscapeStr

xmlChar *	xmlURIEscapeStr		(const xmlChar * str, 
					 const xmlChar * list)

This routine escapes a string to hex, ignoring reserved characters (a-z) and the characters in the exception list.

Function: xmlURIUnescapeString

char *	xmlURIUnescapeString		(const char * str, 
					 int len, 
					 char * target)

Unescaping routine, but does not check that the string is an URI. The output is a direct unsigned char translation of %XX values (no encoding) Note that the length of the result can only be smaller or same size as the input string.

Daniel Veillard