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 *	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)

int	xmlParseURIReference		(xmlURIPtr uri, 
					 const char * str)

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
    char *	fragment	: the fragment identifier
    int	cleanup	: parsing potentially unclean URI
}

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 URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

Function: xmlParseURIReference

int	xmlParseURIReference		(xmlURIPtr uri, 
					 const char * str)

Parse an URI reference string and fills in the appropriate fields of the @uri structure URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

Function: xmlPrintURI

void	xmlPrintURI			(FILE * stream, 
					 xmlURIPtr uri)

Prints the URI in the stream @steam.

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, does not do validity checks ! Output is direct unsigned char translation of %XX values (no encoding)

Daniel Veillard