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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
|
/*
* DO NOT EDIT. THIS FILE IS GENERATED FROM c:/mozilla/netwerk/base/public/nsIURL.idl
*/
#ifndef __gen_nsIURL_h__
#define __gen_nsIURL_h__
#ifndef __gen_nsIURI_h__
#include "nsIURI.h"
#endif
/* For IDL files that don't want to include root IDL files. */
#ifndef NS_NO_VTABLE
#define NS_NO_VTABLE
#endif
/* starting interface: nsIURL */
#define NS_IURL_IID_STR "d6116970-8034-11d3-9399-00104ba0fd40"
#define NS_IURL_IID \
{0xd6116970, 0x8034, 0x11d3, \
{ 0x93, 0x99, 0x00, 0x10, 0x4b, 0xa0, 0xfd, 0x40 }}
/**
* The nsIURL interface provides convenience methods that further
* break down the path portion of nsIURI:
*
* http://directory/fileBaseName.fileExtension?query
* http://directory/fileBaseName.fileExtension#ref
* http://directory/fileBaseName.fileExtension;param
* \ \ /
* \ -----------------------
* \ | /
* \ fileName /
* ----------------------------
* |
* filePath
*
* @status FROZEN
*/
class NS_NO_VTABLE nsIURL : public nsIURI {
public:
NS_DEFINE_STATIC_IID_ACCESSOR(NS_IURL_IID)
/*************************************************************************
* The URL path is broken down into the following principal components:
*/
/**
* 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.
*/
/* attribute AUTF8String filePath; */
NS_IMETHOD GetFilePath(nsACString & aFilePath) = 0;
NS_IMETHOD SetFilePath(const nsACString & aFilePath) = 0;
/**
* Returns the parameters specified after the ; in the URL.
*
* Some characters may be escaped.
*/
/* attribute AUTF8String param; */
NS_IMETHOD GetParam(nsACString & aParam) = 0;
NS_IMETHOD SetParam(const nsACString & aParam) = 0;
/**
* 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.
*/
/* attribute AUTF8String query; */
NS_IMETHOD GetQuery(nsACString & aQuery) = 0;
NS_IMETHOD SetQuery(const nsACString & aQuery) = 0;
/**
* 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.
*/
/* attribute AUTF8String ref; */
NS_IMETHOD GetRef(nsACString & aRef) = 0;
NS_IMETHOD SetRef(const nsACString & aRef) = 0;
/*************************************************************************
* The URL filepath is broken down into the following sub-components:
*/
/**
* 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.
*/
/* attribute AUTF8String directory; */
NS_IMETHOD GetDirectory(nsACString & aDirectory) = 0;
NS_IMETHOD SetDirectory(const nsACString & aDirectory) = 0;
/**
* 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.
*/
/* attribute AUTF8String fileName; */
NS_IMETHOD GetFileName(nsACString & aFileName) = 0;
NS_IMETHOD SetFileName(const nsACString & aFileName) = 0;
/*************************************************************************
* The URL filename is broken down even further:
*/
/**
* Returns the file basename portion of a filename in a url.
*
* Some characters may be escaped.
*/
/* attribute AUTF8String fileBaseName; */
NS_IMETHOD GetFileBaseName(nsACString & aFileBaseName) = 0;
NS_IMETHOD SetFileBaseName(const nsACString & aFileBaseName) = 0;
/**
* 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.
*/
/* attribute AUTF8String fileExtension; */
NS_IMETHOD GetFileExtension(nsACString & aFileExtension) = 0;
NS_IMETHOD SetFileExtension(const nsACString & aFileExtension) = 0;
/**
* 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:///
*/
/* AUTF8String getCommonBaseSpec (in nsIURI aURIToCompare); */
NS_IMETHOD GetCommonBaseSpec(nsIURI *aURIToCompare, nsACString & _retval) = 0;
/**
* 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.
*/
/* AUTF8String getRelativeSpec (in nsIURI aURIToCompare); */
NS_IMETHOD GetRelativeSpec(nsIURI *aURIToCompare, nsACString & _retval) = 0;
};
/* Use this macro when declaring classes that implement this interface. */
#define NS_DECL_NSIURL \
NS_IMETHOD GetFilePath(nsACString & aFilePath); \
NS_IMETHOD SetFilePath(const nsACString & aFilePath); \
NS_IMETHOD GetParam(nsACString & aParam); \
NS_IMETHOD SetParam(const nsACString & aParam); \
NS_IMETHOD GetQuery(nsACString & aQuery); \
NS_IMETHOD SetQuery(const nsACString & aQuery); \
NS_IMETHOD GetRef(nsACString & aRef); \
NS_IMETHOD SetRef(const nsACString & aRef); \
NS_IMETHOD GetDirectory(nsACString & aDirectory); \
NS_IMETHOD SetDirectory(const nsACString & aDirectory); \
NS_IMETHOD GetFileName(nsACString & aFileName); \
NS_IMETHOD SetFileName(const nsACString & aFileName); \
NS_IMETHOD GetFileBaseName(nsACString & aFileBaseName); \
NS_IMETHOD SetFileBaseName(const nsACString & aFileBaseName); \
NS_IMETHOD GetFileExtension(nsACString & aFileExtension); \
NS_IMETHOD SetFileExtension(const nsACString & aFileExtension); \
NS_IMETHOD GetCommonBaseSpec(nsIURI *aURIToCompare, nsACString & _retval); \
NS_IMETHOD GetRelativeSpec(nsIURI *aURIToCompare, nsACString & _retval);
/* Use this macro to declare functions that forward the behavior of this interface to another object. */
#define NS_FORWARD_NSIURL(_to) \
NS_IMETHOD GetFilePath(nsACString & aFilePath) { return _to GetFilePath(aFilePath); } \
NS_IMETHOD SetFilePath(const nsACString & aFilePath) { return _to SetFilePath(aFilePath); } \
NS_IMETHOD GetParam(nsACString & aParam) { return _to GetParam(aParam); } \
NS_IMETHOD SetParam(const nsACString & aParam) { return _to SetParam(aParam); } \
NS_IMETHOD GetQuery(nsACString & aQuery) { return _to GetQuery(aQuery); } \
NS_IMETHOD SetQuery(const nsACString & aQuery) { return _to SetQuery(aQuery); } \
NS_IMETHOD GetRef(nsACString & aRef) { return _to GetRef(aRef); } \
NS_IMETHOD SetRef(const nsACString & aRef) { return _to SetRef(aRef); } \
NS_IMETHOD GetDirectory(nsACString & aDirectory) { return _to GetDirectory(aDirectory); } \
NS_IMETHOD SetDirectory(const nsACString & aDirectory) { return _to SetDirectory(aDirectory); } \
NS_IMETHOD GetFileName(nsACString & aFileName) { return _to GetFileName(aFileName); } \
NS_IMETHOD SetFileName(const nsACString & aFileName) { return _to SetFileName(aFileName); } \
NS_IMETHOD GetFileBaseName(nsACString & aFileBaseName) { return _to GetFileBaseName(aFileBaseName); } \
NS_IMETHOD SetFileBaseName(const nsACString & aFileBaseName) { return _to SetFileBaseName(aFileBaseName); } \
NS_IMETHOD GetFileExtension(nsACString & aFileExtension) { return _to GetFileExtension(aFileExtension); } \
NS_IMETHOD SetFileExtension(const nsACString & aFileExtension) { return _to SetFileExtension(aFileExtension); } \
NS_IMETHOD GetCommonBaseSpec(nsIURI *aURIToCompare, nsACString & _retval) { return _to GetCommonBaseSpec(aURIToCompare, _retval); } \
NS_IMETHOD GetRelativeSpec(nsIURI *aURIToCompare, nsACString & _retval) { return _to GetRelativeSpec(aURIToCompare, _retval); }
/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
#define NS_FORWARD_SAFE_NSIURL(_to) \
NS_IMETHOD GetFilePath(nsACString & aFilePath) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetFilePath(aFilePath); } \
NS_IMETHOD SetFilePath(const nsACString & aFilePath) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetFilePath(aFilePath); } \
NS_IMETHOD GetParam(nsACString & aParam) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetParam(aParam); } \
NS_IMETHOD SetParam(const nsACString & aParam) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetParam(aParam); } \
NS_IMETHOD GetQuery(nsACString & aQuery) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetQuery(aQuery); } \
NS_IMETHOD SetQuery(const nsACString & aQuery) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetQuery(aQuery); } \
NS_IMETHOD GetRef(nsACString & aRef) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetRef(aRef); } \
NS_IMETHOD SetRef(const nsACString & aRef) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetRef(aRef); } \
NS_IMETHOD GetDirectory(nsACString & aDirectory) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDirectory(aDirectory); } \
NS_IMETHOD SetDirectory(const nsACString & aDirectory) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetDirectory(aDirectory); } \
NS_IMETHOD GetFileName(nsACString & aFileName) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetFileName(aFileName); } \
NS_IMETHOD SetFileName(const nsACString & aFileName) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetFileName(aFileName); } \
NS_IMETHOD GetFileBaseName(nsACString & aFileBaseName) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetFileBaseName(aFileBaseName); } \
NS_IMETHOD SetFileBaseName(const nsACString & aFileBaseName) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetFileBaseName(aFileBaseName); } \
NS_IMETHOD GetFileExtension(nsACString & aFileExtension) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetFileExtension(aFileExtension); } \
NS_IMETHOD SetFileExtension(const nsACString & aFileExtension) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetFileExtension(aFileExtension); } \
NS_IMETHOD GetCommonBaseSpec(nsIURI *aURIToCompare, nsACString & _retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCommonBaseSpec(aURIToCompare, _retval); } \
NS_IMETHOD GetRelativeSpec(nsIURI *aURIToCompare, nsACString & _retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetRelativeSpec(aURIToCompare, _retval); }
#if 0
/* Use the code below as a template for the implementation class for this interface. */
/* Header file */
class nsURL : public nsIURL
{
public:
NS_DECL_ISUPPORTS
NS_DECL_NSIURL
nsURL();
private:
~nsURL();
protected:
/* additional members */
};
/* Implementation file */
NS_IMPL_ISUPPORTS1(nsURL, nsIURL)
nsURL::nsURL()
{
/* member initializers and constructor code */
}
nsURL::~nsURL()
{
/* destructor code */
}
/* attribute AUTF8String filePath; */
NS_IMETHODIMP nsURL::GetFilePath(nsACString & aFilePath)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsURL::SetFilePath(const nsACString & aFilePath)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
/* attribute AUTF8String param; */
NS_IMETHODIMP nsURL::GetParam(nsACString & aParam)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsURL::SetParam(const nsACString & aParam)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
/* attribute AUTF8String query; */
NS_IMETHODIMP nsURL::GetQuery(nsACString & aQuery)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsURL::SetQuery(const nsACString & aQuery)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
/* attribute AUTF8String ref; */
NS_IMETHODIMP nsURL::GetRef(nsACString & aRef)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsURL::SetRef(const nsACString & aRef)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
/* attribute AUTF8String directory; */
NS_IMETHODIMP nsURL::GetDirectory(nsACString & aDirectory)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsURL::SetDirectory(const nsACString & aDirectory)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
/* attribute AUTF8String fileName; */
NS_IMETHODIMP nsURL::GetFileName(nsACString & aFileName)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsURL::SetFileName(const nsACString & aFileName)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
/* attribute AUTF8String fileBaseName; */
NS_IMETHODIMP nsURL::GetFileBaseName(nsACString & aFileBaseName)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsURL::SetFileBaseName(const nsACString & aFileBaseName)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
/* attribute AUTF8String fileExtension; */
NS_IMETHODIMP nsURL::GetFileExtension(nsACString & aFileExtension)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsURL::SetFileExtension(const nsACString & aFileExtension)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
/* AUTF8String getCommonBaseSpec (in nsIURI aURIToCompare); */
NS_IMETHODIMP nsURL::GetCommonBaseSpec(nsIURI *aURIToCompare, nsACString & _retval)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
/* AUTF8String getRelativeSpec (in nsIURI aURIToCompare); */
NS_IMETHODIMP nsURL::GetRelativeSpec(nsIURI *aURIToCompare, nsACString & _retval)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
/* End of implementation class template. */
#endif
#endif /* __gen_nsIURL_h__ */
|
