69 lines
2.7 KiB
Plaintext
69 lines
2.7 KiB
Plaintext
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "nsIMutable.idl"
|
|
|
|
interface nsIURI;
|
|
|
|
/**
|
|
* nsIStandardURL defines the interface to an URL with the standard
|
|
* file path format common to protocols like http, ftp, and file.
|
|
* It supports initialization from a relative path and provides
|
|
* some customization on how URLs are normalized.
|
|
*/
|
|
[scriptable, uuid(babd6cca-ebe7-4329-967c-d6b9e33caa81)]
|
|
interface nsIStandardURL : nsIMutable
|
|
{
|
|
/**
|
|
* 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_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;
|
|
|
|
/**
|
|
* Initialize a standard URL.
|
|
*
|
|
* @param aUrlType - one of the URLTYPE_ flags listed above.
|
|
* @param 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.
|
|
* @param aSpec - URL string.
|
|
* @param 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).
|
|
* @param aBaseURI - if null, aSpec must specify an absolute URI.
|
|
* otherwise, aSpec will be resolved relative
|
|
* to aBaseURI.
|
|
*/
|
|
void init(in unsigned long aUrlType,
|
|
in long aDefaultPort,
|
|
in AUTF8String aSpec,
|
|
in string aOriginCharset,
|
|
in nsIURI aBaseURI);
|
|
};
|