1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
/* -*- 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 "nsISupports.idl"
/**
* URIs are essentially structured names for things -- anything. This interface
* provides accessors to set and query the most basic components of an URI.
* Subclasses, including nsIURL, impose greater structure on the URI.
*
* This interface follows Tim Berners-Lee's URI spec (RFC2396) [1], where the
* basic URI components are defined as such:
*
* ftp://username:password@hostname:portnumber/pathname
* \ / \ / \ / \ /\ /
* - --------------- ------ -------- -------
* | | | | |
* | | | | Path
* | | | Port
* | | Host /
* | UserPass /
* Scheme /
* \ /
* --------------------------------
* |
* PrePath
*
* The definition of the URI components has been extended to allow for
* internationalized domain names [2] and the more generic IRI structure [3].
*
* [1] http://www.ietf.org/rfc/rfc2396.txt
* [2] http://www.ietf.org/internet-drafts/draft-ietf-idn-idna-06.txt
* [3] http://www.ietf.org/internet-drafts/draft-masinter-url-i18n-08.txt
*/
%{C++
#undef GetPort // XXX Windows!
#undef SetPort // XXX Windows!
%}
/**
* nsIURI - interface for an uniform resource identifier w/ i18n support.
*
* AUTF8String attributes may contain unescaped UTF-8 characters.
* Consumers should be careful to escape the UTF-8 strings as necessary, but
* should always try to "display" the UTF-8 version as provided by this
* interface.
*
* AUTF8String attributes may also contain escaped characters.
*
* Unescaping URI segments is unadvised unless there is intimate
* knowledge of the underlying charset or there is no plan to display (or
* otherwise enforce a charset on) the resulting URI substring.
*
* @status FROZEN
*/
[scriptable, uuid(07a22cc0-0ce5-11d3-9331-00104ba0fd40)]
interface nsIURI : nsISupports
{
/************************************************************************
* The URI is broken down into the following principal components:
*/
/**
* 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.
*/
attribute AUTF8String spec;
/**
* The prePath (eg. scheme://user:password@host:port) returns the string
* before the path. This is useful for authentication or managing sessions.
*
* Some characters may be escaped.
*/
readonly attribute AUTF8String prePath;
/**
* The Scheme is the protocol to which this URI refers. The scheme is
* restricted to the US-ASCII charset per RFC2396.
*/
attribute ACString scheme;
/**
* The username:password (or username only if value doesn't contain a ':')
*
* Some characters may be escaped.
*/
attribute AUTF8String userPass;
/**
* The optional username and password, assuming the preHost consists of
* username:password.
*
* Some characters may be escaped.
*/
attribute AUTF8String username;
attribute AUTF8String password;
/**
* The host:port (or simply the host, if port == -1).
*
* Characters are NOT escaped.
*/
attribute AUTF8String hostPort;
/**
* 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.
*/
attribute AUTF8String host;
/**
* A port value of -1 corresponds to the protocol's default port (eg. -1
* implies port 80 for http URIs).
*/
attribute long port;
/**
* The path, typically including at least a leading '/' (but may also be
* empty, depending on the protocol).
*
* Some characters may be escaped.
*/
attribute AUTF8String path;
/************************************************************************
* An URI supports the following methods:
*/
/**
* URI equivalence test (not a strict string comparison).
*
* eg. http://foo.com:80/ == http://foo.com/
*/
boolean equals(in nsIURI other);
/**
* 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).
*/
boolean schemeIs(in string scheme);
/**
* 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.
*/
nsIURI clone();
/**
* 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.
*/
AUTF8String resolve(in AUTF8String relativePath);
/************************************************************************
* Additional attributes:
*/
/**
* 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.
*/
readonly attribute ACString asciiSpec;
/**
* 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.
*/
readonly attribute ACString asciiHost;
/**
* 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.
*/
readonly attribute ACString originCharset;
};
|
