| /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ |
| /* ***** BEGIN LICENSE BLOCK ***** |
| * Version: MPL 1.1/GPL 2.0/LGPL 2.1 |
| * |
| * The contents of this file are subject to the Mozilla Public License Version |
| * 1.1 (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * http://www.mozilla.org/MPL/ |
| * |
| * Software distributed under the License is distributed on an "AS IS" basis, |
| * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License |
| * for the specific language governing rights and limitations under the |
| * License. |
| * |
| * The Original Code is mozilla.org code. |
| * |
| * The Initial Developer of the Original Code is |
| * Netscape Communications Corporation. |
| * Portions created by the Initial Developer are Copyright (C) 1998 |
| * the Initial Developer. All Rights Reserved. |
| * |
| * Contributor(s): |
| * Gagan Saksena <gagan@netscape.com> (original author) |
| * Darin Fisher <darin@netscape.com> |
| * |
| * Alternatively, the contents of this file may be used under the terms of |
| * either the GNU General Public License Version 2 or later (the "GPL"), or |
| * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), |
| * in which case the provisions of the GPL or the LGPL are applicable instead |
| * of those above. If you wish to allow use of your version of this file only |
| * under the terms of either the GPL or the LGPL, and not to allow others to |
| * use your version of this file under the terms of the MPL, indicate your |
| * decision by deleting the provisions above and replace them with the notice |
| * and other provisions required by the GPL or the LGPL. If you do not delete |
| * the provisions above, a recipient may use your version of this file under |
| * the terms of any one of the MPL, the GPL or the LGPL. |
| * |
| * ***** END LICENSE BLOCK ***** */ |
| |
| #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. |
| * |
| * @status UNDER_REVIEW |
| */ |
| [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); |
| }; |