Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Protected Member Functions
nsBaseURLParser Class Reference

#include <nsURLParsers.h>

Inheritance diagram for nsBaseURLParser:
Inheritance graph
[legend]
Collaboration diagram for nsBaseURLParser:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_NSIURLPARSER 
nsBaseURLParser ()
void parseURL (in string spec, in long specLen, out unsigned long schemePos, out long schemeLen, out unsigned long authorityPos, out long authorityLen, out unsigned long pathPos, out long pathLen)
 The string to parse in the following methods may be given as a null terminated string, in which case the length argument should be -1.
void parseAuthority (in string authority, in long authorityLen, out unsigned long usernamePos, out long usernameLen, out unsigned long passwordPos, out long passwordLen, out unsigned long hostnamePos, out long hostnameLen, out long port)
 ParseAuthority breaks the authority string up into its 4 components: username, password, hostname, and hostport.
void parseUserInfo (in string userinfo, in long userinfoLen, out unsigned long usernamePos, out long usernameLen, out unsigned long passwordPos, out long passwordLen)
 userinfo = <username>:<password>
void parseServerInfo (in string serverinfo, in long serverinfoLen, out unsigned long hostnamePos, out long hostnameLen, out long port)
 serverinfo = <hostname>:<port>
void parsePath (in string path, in long pathLen, out unsigned long filepathPos, out long filepathLen, out unsigned long paramPos, out long paramLen, out unsigned long queryPos, out long queryLen, out unsigned long refPos, out long refLen)
 ParsePath breaks the path string up into its 4 major components: a file path, a param string, a query string, and a reference string.
void parseFilePath (in string filepath, in long filepathLen, out unsigned long directoryPos, out long directoryLen, out unsigned long basenamePos, out long basenameLen, out unsigned long extensionPos, out long extensionLen)
 ParseFilePath breaks the file path string up into: the directory portion, file base name, and file extension.
void parseFileName (in string filename, in long filenameLen, out unsigned long basenamePos, out long basenameLen, out unsigned long extensionPos, out long extensionLen)
 filename = <basename>.

Protected Member Functions

virtual void ParseAfterScheme (const char *spec, PRInt32 specLen, PRUint32 *authPos, PRInt32 *authLen, PRUint32 *pathPos, PRInt32 *pathLen)=0

Detailed Description

Definition at line 48 of file nsURLParsers.h.


Constructor & Destructor Documentation

NS_DECL_ISUPPORTS NS_DECL_NSIURLPARSER nsBaseURLParser::nsBaseURLParser ( ) [inline]

Definition at line 54 of file nsURLParsers.h.

{ }

Member Function Documentation

virtual void nsBaseURLParser::ParseAfterScheme ( const char *  spec,
PRInt32  specLen,
PRUint32 authPos,
PRInt32 authLen,
PRUint32 pathPos,
PRInt32 pathLen 
) [protected, pure virtual]
void nsIURLParser::parseAuthority ( in string  authority,
in long  authorityLen,
out unsigned long  usernamePos,
out long  usernameLen,
out unsigned long  passwordPos,
out long  passwordLen,
out unsigned long  hostnamePos,
out long  hostnameLen,
out long  port 
) [inherited]

ParseAuthority breaks the authority string up into its 4 components: username, password, hostname, and hostport.

auth = <username>:<password><hostname>:<port>

void nsIURLParser::parseFileName ( in string  filename,
in long  filenameLen,
out unsigned long  basenamePos,
out long  basenameLen,
out unsigned long  extensionPos,
out long  extensionLen 
) [inherited]

filename = <basename>.

<extension>

void nsIURLParser::parseFilePath ( in string  filepath,
in long  filepathLen,
out unsigned long  directoryPos,
out long  directoryLen,
out unsigned long  basenamePos,
out long  basenameLen,
out unsigned long  extensionPos,
out long  extensionLen 
) [inherited]

ParseFilePath breaks the file path string up into: the directory portion, file base name, and file extension.

filepath = <directory><basename>.<extension>

void nsIURLParser::parsePath ( in string  path,
in long  pathLen,
out unsigned long  filepathPos,
out long  filepathLen,
out unsigned long  paramPos,
out long  paramLen,
out unsigned long  queryPos,
out long  queryLen,
out unsigned long  refPos,
out long  refLen 
) [inherited]

ParsePath breaks the path string up into its 4 major components: a file path, a param string, a query string, and a reference string.

path = <filepath>;?<query>#<ref>

void nsIURLParser::parseServerInfo ( in string  serverinfo,
in long  serverinfoLen,
out unsigned long  hostnamePos,
out long  hostnameLen,
out long  port 
) [inherited]

serverinfo = <hostname>:<port>

void nsIURLParser::parseURL ( in string  spec,
in long  specLen,
out unsigned long  schemePos,
out long  schemeLen,
out unsigned long  authorityPos,
out long  authorityLen,
out unsigned long  pathPos,
out long  pathLen 
) [inherited]

The string to parse in the following methods may be given as a null terminated string, in which case the length argument should be -1.

Out parameters of the following methods are all optional (ie. the caller may pass-in a NULL value if the corresponding results are not needed). Signed out parameters may hold a value of -1 if the corresponding result is not part of the string being parsed.

The parsing routines attempt to be as forgiving as possible. ParseSpec breaks the URL string up into its 3 major components: a scheme, an authority section (hostname, etc.), and a path.

spec = <scheme>://<authority><path>

void nsIURLParser::parseUserInfo ( in string  userinfo,
in long  userinfoLen,
out unsigned long  usernamePos,
out long  usernameLen,
out unsigned long  passwordPos,
out long  passwordLen 
) [inherited]

userinfo = <username>:<password>


The documentation for this class was generated from the following file: