Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Friends
nsResURL Class Reference

#include <nsResProtocolHandler.h>

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

List of all members.

Public Member Functions

 nsResURL ()
virtual nsStandardURLStartClone ()
virtual nsresult EnsureFile ()
NS_IMETHOD GetClassIDNoAlloc (nsCID *aCID)
AUTF8String getCommonBaseSpec (in nsIURI aURIToCompare)
 This method takes a uri and compares the two.
AUTF8String getRelativeSpec (in nsIURI aURIToCompare)
 This method takes a uri and returns a substring of this if it can be made relative to the uri passed in.
boolean equals (in nsIURI other)
 URI equivalence test (not a strict string comparison).
boolean schemeIs (in string scheme)
 An optimization to do scheme checks without requiring the users of nsIURI to GetScheme, thereby saving extra allocating and freeing.
nsIURI clone ()
 Clones the current URI.
AUTF8String resolve (in AUTF8String relativePath)
 This method resolves a relative string into an absolute URI string, using this URI as the base.
void init (in unsigned long aUrlType, in long aDefaultPort, in AUTF8String aSpec, in string aOriginCharset, in nsIURI aBaseURI)
 Initialize a standard URL.
void read (in nsIObjectInputStream aInputStream)
 Initialize the object implementing nsISerializable, which must have been freshly constructed via CreateInstance.
void write (in nsIObjectOutputStream aOutputStream)
 Serialize the object implementing nsISerializable to aOutputStream, by writing each data member that must be recovered later to reconstitute a working replica of this object, in a canonical member and byte order, to aOutputStream.
void getInterfaces (out PRUint32 count,[array, size_is(count), retval] out nsIIDPtr array)
 Get an ordered list of the interface ids that instances of the class promise to implement.
nsISupports getHelperForLanguage (in PRUint32 language)
 Get a language mapping specific helper object that may assist in using objects of this class in a specific lanaguage.

Static Public Member Functions

static void InitGlobalObjects ()
static void ShutdownGlobalObjects ()

Public Attributes

attribute nsIFile file
 Get/Set nsIFile corresponding to this URL.
attribute AUTF8String filePath
 Returns a path including the directory and file portions of a URL.
attribute AUTF8String param
 Returns the parameters specified after the ; in the URL.
attribute AUTF8String query
 Returns the query portion (the part after the "?") of the URL.
attribute AUTF8String ref
 Returns the reference portion (the part after the "#") of the URL.
attribute AUTF8String directory
 Returns the directory portion of a URL.
attribute AUTF8String fileName
 Returns the file name portion of a URL.
attribute AUTF8String fileBaseName
 Returns the file basename portion of a filename in a url.
attribute AUTF8String fileExtension
 Returns the file extension portion of a filename in a url.
attribute AUTF8String spec
 Returns a string representation of the URI.
readonly attribute AUTF8String prePath
 The prePath (eg.
attribute ACString scheme
 The Scheme is the protocol to which this URI refers.
attribute AUTF8String userPass
 The username:password (or username only if value doesn't contain a ':')
attribute AUTF8String username
 The optional username and password, assuming the preHost consists of username:password.
attribute AUTF8String password
attribute AUTF8String hostPort
 The host:port (or simply the host, if port == -1).
attribute AUTF8String host
 The host is the internet domain name to which this URI refers.
attribute long port
 A port value of -1 corresponds to the protocol's default port (eg.
attribute AUTF8String path
 The path, typically including at least a leading '/' (but may also be empty, depending on the protocol).
readonly attribute ACString asciiSpec
 The URI spec with an ASCII compatible encoding.
readonly attribute ACString asciiHost
 The URI host with an ASCII compatible encoding.
readonly attribute ACString originCharset
 The charset of the document from which this URI originated.
const unsigned long URLTYPE_STANDARD = 1
 blah:foo/bar => blah://foo/bar blah:/foo/bar => blah:///foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah:///foo/bar
const unsigned long URLTYPE_AUTHORITY = 2
 blah:foo/bar => blah://foo/bar blah:/foo/bar => blah://foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah://foo/bar
const unsigned long URLTYPE_NO_AUTHORITY = 3
 blah:foo/bar => blah:///foo/bar blah:/foo/bar => blah:///foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah:///foo/bar
attribute boolean mutable
 Control whether or not this URL can be modified.
readonly attribute string contractID
 A contract ID through which an instance of this class can be created (or accessed as a service, if |flags & SINGLETON|), or null.
readonly attribute string classDescription
 A human readable string naming the class, or null.
readonly attribute nsCIDPtr classID
 A class ID through which an instance of this class can be created (or accessed as a service, if |flags & SINGLETON|), or null.
readonly attribute PRUint32 implementationLanguage
 Return language type from list in nsIProgrammingLanguage.
const PRUint32 SINGLETON = 1 << 0
 Bitflags for 'flags' attribute.
const PRUint32 THREADSAFE = 1 << 1
const PRUint32 MAIN_THREAD_ONLY = 1 << 2
const PRUint32 DOM_OBJECT = 1 << 3
const PRUint32 PLUGIN_OBJECT = 1 << 4
const PRUint32 EAGER_CLASSINFO = 1 << 5
const PRUint32 CONTENT_NODE = 1 << 6
 'flags' attribute bitflag: whether objects of this type implement nsIContent.
const PRUint32 RESERVED = 1 << 31
readonly attribute PRUint32 flags
readonly attribute nsCID classIDNoAlloc
 Also a class ID through which an instance of this class can be created (or accessed as a service, if |flags & SINGLETON|).

Protected Attributes

nsCOMPtr< nsIFilemFile

Friends

class nsPrefObserver
class nsSegmentEncoder

Detailed Description

Definition at line 51 of file nsResProtocolHandler.h.


Constructor & Destructor Documentation

nsResURL::nsResURL ( ) [inline]

Definition at line 54 of file nsResProtocolHandler.h.


Member Function Documentation

nsIURI nsIURI::clone ( ) [inherited]

Clones the current URI.

For some protocols, this is more than just an optimization. For example, under MacOS, the spec of a file URL does not necessarily uniquely identify a file since two volumes could share the same name.

Here is the caller graph for this function:

Reimplemented from nsStandardURL.

Definition at line 82 of file nsResProtocolHandler.cpp.

{
    nsresult rv;

    NS_ENSURE_TRUE(gResHandler, NS_ERROR_NOT_AVAILABLE);

    nsCAutoString spec;
    rv = gResHandler->ResolveURI(this, spec);
    if (NS_FAILED(rv)) return rv;

    rv = net_GetFileFromURLSpec(spec, getter_AddRefs(mFile));
#ifdef DEBUG_bsmedberg
    if (NS_SUCCEEDED(rv)) {
        PRBool exists = PR_TRUE;
        mFile->Exists(&exists);
        if (!exists) {
            printf("resource %s doesn't exist!\n", spec.get());
        }
    }
#endif

    return rv;
}

Here is the call graph for this function:

boolean nsIURI::equals ( in nsIURI  other) [inherited]

URI equivalence test (not a strict string comparison).

eg. http://foo.com:80/ == http://foo.com/

Definition at line 115 of file nsResProtocolHandler.cpp.

{
    *aClassIDNoAlloc = kResURLCID;
    return NS_OK;
}
AUTF8String nsIURL::getCommonBaseSpec ( in nsIURI  aURIToCompare) [inherited]

This method takes a uri and compares the two.

The common uri portion is returned as a string. The minimum common uri portion is the protocol, and any of these if present: login, password, host and port If no commonality is found, "" is returned. If they are identical, the whole path with file/ref/etc. is returned. For file uris, it is expected that the common spec would be at least "file:///" since '/' is a shared common root.

Examples: this.spec aURIToCompare.spec result 1) http://mozilla.org/ http://www.mozilla.org/ "" 2) http://foo.com/bar/ ftp://foo.com/bar/ "" 3) http://foo.com:8080/ http://foo.com/bar/ "" 4) ftp://user@foo.com/ ftp://user:pw@foo.com/ "" 5) ftp://foo.com/bar/ ftp://foo.com/bar ftp://foo.com/ 6) ftp://foo.com/bar/ ftp://foo.com/bar/b.html ftp://foo.com/bar/ 7) http://foo.com/a.htm#i http://foo.com/b.htm http://foo.com/ 8) ftp://foo.com/c.htm#i ftp://foo.com/c.htm ftp://foo.com/c.htm 9) file:///a/b/c.html file:///d/e/c.html file:///

nsISupports nsIClassInfo::getHelperForLanguage ( in PRUint32  language) [inherited]

Get a language mapping specific helper object that may assist in using objects of this class in a specific lanaguage.

For instance, if asked for the helper for nsIProgrammingLanguage::JAVASCRIPT this might return an object that can be QI'd into the nsIXPCScriptable interface to assist XPConnect in supplying JavaScript specific behavior to callers of the instance object.

see: nsIProgrammingLanguage.idl

Should return null if no helper available for given language.

void nsIClassInfo::getInterfaces ( out PRUint32  count,
[array, size_is(count), retval] out nsIIDPtr  array 
) [inherited]

Get an ordered list of the interface ids that instances of the class promise to implement.

Note that nsISupports is an implicit member of any such list and need not be included.

Should set *count = 0 and *array = null and return NS_OK if getting the list is not supported.

AUTF8String nsIURL::getRelativeSpec ( in nsIURI  aURIToCompare) [inherited]

This method takes a uri and returns a substring of this if it can be made relative to the uri passed in.

If no commonality is found, the entire uri spec is returned. If they are identical, "" is returned. Filename, query, etc are always returned except when uris are identical.

void nsIStandardURL::init ( in unsigned long  aUrlType,
in long  aDefaultPort,
in AUTF8String  aSpec,
in string  aOriginCharset,
in nsIURI  aBaseURI 
) [inherited]

Initialize a standard URL.

Parameters:
aUrlType- one of the URLTYPE_ flags listed above.
aDefaultPort- if the port parsed from the URL string matches this port, then the port will be removed from the canonical form of the URL.
aSpec- URL string.
aOriginCharset- the charset from which this URI string originated. this corresponds to the charset that should be used when communicating this URI to an origin server, for example. if null, then provide aBaseURI implements this interface, the origin charset of aBaseURI will be assumed, otherwise defaulting to UTF-8 (i.e., no charset transformation from aSpec).
aBaseURI- if null, aSpec must specify an absolute URI. otherwise, aSpec will be resolved relative to aBaseURI.
void nsStandardURL::InitGlobalObjects ( ) [static, inherited]

Definition at line 299 of file nsStandardURL.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void nsISerializable::read ( in nsIObjectInputStream  aInputStream) [inherited]

Initialize the object implementing nsISerializable, which must have been freshly constructed via CreateInstance.

All data members that can't be set to default values must have been serialized by write, and should be read from aInputStream in the same order by this method.

AUTF8String nsIURI::resolve ( in AUTF8String  relativePath) [inherited]

This method resolves a relative string into an absolute URI string, using this URI as the base.

NOTE: some implementations may have no concept of a relative URI.

boolean nsIURI::schemeIs ( in string  scheme) [inherited]

An optimization to do scheme checks without requiring the users of nsIURI to GetScheme, thereby saving extra allocating and freeing.

Returns true if the schemes match (case ignored).

void nsStandardURL::ShutdownGlobalObjects ( ) [static, inherited]

Definition at line 322 of file nsStandardURL.cpp.

Here is the caller graph for this function:

Reimplemented from nsStandardURL.

Definition at line 107 of file nsResProtocolHandler.cpp.

{
    nsResURL *clone;
    NS_NEWXPCOM(clone, nsResURL);
    return clone;
}

Here is the call graph for this function:

void nsISerializable::write ( in nsIObjectOutputStream  aOutputStream) [inherited]

Serialize the object implementing nsISerializable to aOutputStream, by writing each data member that must be recovered later to reconstitute a working replica of this object, in a canonical member and byte order, to aOutputStream.

NB: a class that implements nsISerializable must also implement nsIClassInfo, in particular nsIClassInfo::GetClassID.

Here is the caller graph for this function:


Friends And Related Function Documentation

friend class nsPrefObserver [friend, inherited]

Definition at line 111 of file nsStandardURL.h.

friend class nsSegmentEncoder [friend, inherited]

Definition at line 143 of file nsStandardURL.h.


Member Data Documentation

readonly attribute ACString nsIURI::asciiHost [inherited]

The URI host with an ASCII compatible encoding.

Follows the IDNA draft spec for converting internationalized domain names (UTF-8) to ASCII for compatibility with existing internet infrasture.

Definition at line 220 of file nsIURI.idl.

readonly attribute ACString nsIURI::asciiSpec [inherited]

The URI spec with an ASCII compatible encoding.

Host portion follows the IDNA draft spec. Other parts are URL-escaped per the rules of RFC2396. The result is strictly ASCII.

Definition at line 213 of file nsIURI.idl.

A human readable string naming the class, or null.

Definition at line 86 of file nsIClassInfo.idl.

readonly attribute nsCIDPtr nsIClassInfo::classID [inherited]

A class ID through which an instance of this class can be created (or accessed as a service, if |flags & SINGLETON|), or null.

Definition at line 92 of file nsIClassInfo.idl.

Also a class ID through which an instance of this class can be created (or accessed as a service, if |flags & SINGLETON|).

If the class does not have a CID, it should return NS_ERROR_NOT_AVAILABLE. This attribute exists so C++ callers can avoid allocating and freeing a CID, as would happen if they used classID.

Definition at line 130 of file nsIClassInfo.idl.

'flags' attribute bitflag: whether objects of this type implement nsIContent.

Definition at line 113 of file nsIClassInfo.idl.

A contract ID through which an instance of this class can be created (or accessed as a service, if |flags & SINGLETON|), or null.

Definition at line 81 of file nsIClassInfo.idl.

attribute AUTF8String nsIURL::directory [inherited]

Returns the directory portion of a URL.

If the URL denotes a path to a directory and not a file, e.g. http://foo/bar/, then the Directory attribute accesses the complete /foo/bar/ portion, and the FileName is the empty string. If the trailing slash is omitted, then the Directory is /foo/ and the file is bar (i.e. this is a syntactic, not a semantic breakdown of the Path). And hence dont rely on this for something to be a definitely be a file. But you can get just the leading directory portion for sure.

Some characters may be escaped.

Definition at line 117 of file nsIURL.idl.

const PRUint32 nsIClassInfo::DOM_OBJECT = 1 << 3 [inherited]

Definition at line 106 of file nsIClassInfo.idl.

Definition at line 108 of file nsIClassInfo.idl.

Get/Set nsIFile corresponding to this URL.

  • Getter returns a reference to an immutable object. Callers must clone before attempting to modify the returned nsIFile object. NOTE: this constraint might not be enforced at runtime, so beware!!
  • Setter clones the nsIFile object (allowing the caller to safely modify the nsIFile object after setting it on this interface).

Definition at line 63 of file nsIFileURL.idl.

attribute AUTF8String nsIURL::fileBaseName [inherited]

Returns the file basename portion of a filename in a url.

Some characters may be escaped.

Definition at line 142 of file nsIURL.idl.

attribute AUTF8String nsIURL::fileExtension [inherited]

Returns the file extension portion of a filename in a url.

If a file extension does not exist, the empty string is returned.

Some characters may be escaped.

Definition at line 150 of file nsIURL.idl.

attribute AUTF8String nsIURL::fileName [inherited]

Returns the file name portion of a URL.

If the URL denotes a path to a directory and not a file, e.g. http://foo/bar/, then the Directory attribute accesses the complete /foo/bar/ portion, and the FileName is the empty string. Note that this is purely based on searching for the last trailing slash. And hence dont rely on this to be a definite file.

Some characters may be escaped.

Definition at line 130 of file nsIURL.idl.

attribute AUTF8String nsIURL::filePath [inherited]

Returns a path including the directory and file portions of a URL.

For example, the filePath of "http://foo/bar.html#baz" is "/foo/bar.html".

Some characters may be escaped.

Definition at line 73 of file nsIURL.idl.

readonly attribute PRUint32 nsIClassInfo::flags [inherited]

Definition at line 121 of file nsIClassInfo.idl.

attribute AUTF8String nsIURI::host [inherited]

The host is the internet domain name to which this URI refers.

It could be an IPv4 (or IPv6) address literal. If supported, it could be a non-ASCII internationalized domain name.

Characters are NOT escaped.

Definition at line 152 of file nsIURI.idl.

attribute AUTF8String nsIURI::hostPort [inherited]

The host:port (or simply the host, if port == -1).

Characters are NOT escaped.

Definition at line 143 of file nsIURI.idl.

Return language type from list in nsIProgrammingLanguage.

Definition at line 98 of file nsIClassInfo.idl.

Definition at line 105 of file nsIClassInfo.idl.

nsCOMPtr<nsIFile> nsStandardURL::mFile [protected, inherited]

Definition at line 252 of file nsStandardURL.h.

Control whether or not this URL can be modified.

Protocol handlers can set this flag before handing out an URL to ensure that it is not inadvertently modified.

Definition at line 110 of file nsIStandardURL.idl.

readonly attribute ACString nsIURI::originCharset [inherited]

The charset of the document from which this URI originated.

An empty value implies UTF-8.

If this value is something other than UTF-8 then the URI components (e.g., spec, prePath, username, etc.) will all be fully URL-escaped. Otherwise, the URI components may contain unescaped multibyte UTF-8 characters.

Definition at line 231 of file nsIURI.idl.

attribute AUTF8String nsIURL::param [inherited]

Returns the parameters specified after the ; in the URL.

Some characters may be escaped.

Definition at line 80 of file nsIURL.idl.

attribute AUTF8String nsIURI::password [inherited]

Definition at line 136 of file nsIURI.idl.

attribute AUTF8String nsIURI::path [inherited]

The path, typically including at least a leading '/' (but may also be empty, depending on the protocol).

Some characters may be escaped.

Definition at line 166 of file nsIURI.idl.

Definition at line 107 of file nsIClassInfo.idl.

A port value of -1 corresponds to the protocol's default port (eg.

-1 implies port 80 for http URIs).

Definition at line 158 of file nsIURI.idl.

readonly attribute AUTF8String nsIURI::prePath [inherited]

The prePath (eg.

scheme://user:password:port) returns the string before the path. This is useful for authentication or managing sessions.

Some characters may be escaped.

Definition at line 114 of file nsIURI.idl.

attribute AUTF8String nsIURL::query [inherited]

Returns the query portion (the part after the "?") of the URL.

If there isn't one, an empty string is returned.

Some characters may be escaped.

Definition at line 88 of file nsIURL.idl.

attribute AUTF8String nsIURL::ref [inherited]

Returns the reference portion (the part after the "#") of the URL.

If there isn't one, an empty string is returned.

Some characters may be escaped.

Definition at line 96 of file nsIURL.idl.

const PRUint32 nsIClassInfo::RESERVED = 1 << 31 [inherited]

Definition at line 118 of file nsIClassInfo.idl.

attribute ACString nsIURI::scheme [inherited]

The Scheme is the protocol to which this URI refers.

The scheme is restricted to the US-ASCII charset per RFC2396.

Definition at line 120 of file nsIURI.idl.

const PRUint32 nsIClassInfo::SINGLETON = 1 << 0 [inherited]

Bitflags for 'flags' attribute.

Definition at line 103 of file nsIClassInfo.idl.

attribute AUTF8String nsIURI::spec [inherited]

Returns a string representation of the URI.

Setting the spec causes the new spec to be parsed, initializing the URI.

Some characters may be escaped.

Definition at line 106 of file nsIURI.idl.

const PRUint32 nsIClassInfo::THREADSAFE = 1 << 1 [inherited]

Definition at line 104 of file nsIClassInfo.idl.

const unsigned long nsIStandardURL::URLTYPE_AUTHORITY = 2 [inherited]

blah:foo/bar => blah://foo/bar blah:/foo/bar => blah://foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah://foo/bar

Definition at line 69 of file nsIStandardURL.idl.

blah:foo/bar => blah:///foo/bar blah:/foo/bar => blah:///foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah:///foo/bar

Definition at line 77 of file nsIStandardURL.idl.

const unsigned long nsIStandardURL::URLTYPE_STANDARD = 1 [inherited]

blah:foo/bar => blah://foo/bar blah:/foo/bar => blah:///foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah:///foo/bar

Definition at line 61 of file nsIStandardURL.idl.

attribute AUTF8String nsIURI::username [inherited]

The optional username and password, assuming the preHost consists of username:password.

Some characters may be escaped.

Definition at line 135 of file nsIURI.idl.

attribute AUTF8String nsIURI::userPass [inherited]

The username:password (or username only if value doesn't contain a ':')

Some characters may be escaped.

Definition at line 127 of file nsIURI.idl.


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