1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 1998
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Darin Fisher <darin@netscape.com>
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * either the GNU General Public License Version 2 or later (the "GPL"), or
27 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
36 *
37 * ***** END LICENSE BLOCK ***** */
38
39 #include "nsIProtocolHandler.idl"
40
41 %{C++
42 #include "nsAString.h"
43 %}
44
45 /**
46 * Protocol handler interface for the resource:// protocol
47 */
48 [scriptable, uuid(067ca872-e947-4bd6-8946-a479cb6ba5dd)]
49 interface nsIResProtocolHandler : nsIProtocolHandler
50 {
51 /**
52 * Sets the substitution for the root key:
53 * resource://root/path ==> baseURI.resolve(path)
54 *
55 * A null baseURI removes the specified substitution.
56 *
57 * A root key should always be lowercase; however, this may not be
58 * enforced.
59 */
60 void setSubstitution(in ACString root, in nsIURI baseURI);
61
62 /**
63 * Gets the substitution for the root key.
64 *
65 * @throws NS_ERROR_NOT_AVAILABLE if none exists.
66 */
67 nsIURI getSubstitution(in ACString root);
68
69 /**
70 * Returns TRUE if the substitution exists and FALSE otherwise.
71 */
72 boolean hasSubstitution(in ACString root);
73
74 /**
75 * Utility function to resolve a resource URI. A resolved URI is not
76 * guaranteed to reference a resource that exists (ie. opening a channel to
77 * the resolved URI may fail).
78 *
79 * @throws NS_ERROR_NOT_AVAILABLE if resURI.host() is an unknown root key.
80 */
81 AUTF8String resolveURI(in nsIURI resURI);
82 };