Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIURLParser Interface Reference

nsIURLParser specifies the interface to an URL parser that attempts to follow the definitions of RFC 2396. More...

import "nsIURLParser.idl";

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

List of all members.

Public Member Functions

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>.

Detailed Description

nsIURLParser specifies the interface to an URL parser that attempts to follow the definitions of RFC 2396.

Definition at line 46 of file nsIURLParser.idl.


Member Function Documentation

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 
)

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 
)

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 
)

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 
)

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 
)

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 
)

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 
)

userinfo = <username>:<password>


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