Reviewed by Darin.
[WebKit-https.git] / WebKit / Misc / WebNSURLExtras.h
1 /*
2  * Copyright (C) 2005 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #import <Foundation/Foundation.h>
30
31 @interface NSURL (WebNSURLExtras)
32
33 + (NSURL *)_web_URLWithUserTypedString:(NSString *)string;
34 + (NSURL *)_web_URLWithUserTypedString:(NSString *)string relativeToURL:(NSURL *)URL;
35
36 + (NSURL *)_web_URLWithDataAsString:(NSString *)string;
37 + (NSURL *)_web_URLWithDataAsString:(NSString *)string relativeToURL:(NSURL *)baseURL;
38
39 + (NSURL *)_web_URLWithData:(NSData *)data;
40 + (NSURL *)_web_URLWithData:(NSData *)data relativeToURL:(NSURL *)baseURL;
41
42 - (NSURL *)_web_URLWithLowercasedScheme;
43
44 - (NSData *)_web_originalData;
45 - (NSString *)_web_originalDataAsString;
46 - (const char *)_web_URLCString;
47
48 - (NSData *)_web_hostData;
49 - (NSString *)_web_hostString;
50
51 - (NSString *)_web_userVisibleString;
52
53 - (BOOL)_web_isEmpty;
54
55 // FIXME: change these names back to _web_ when identically-named
56 // methods are removed from Foundation
57
58 - (NSURL *)_webkit_canonicalize;
59 - (NSURL *)_webkit_URLByRemovingFragment;
60 - (NSURL *)_webkit_URLByRemovingResourceSpecifier;
61
62 - (BOOL)_webkit_isJavaScriptURL;
63 - (NSString *)_webkit_scriptIfJavaScriptURL;
64 - (BOOL)_webkit_isFTPDirectoryURL;
65
66 - (BOOL)_webkit_shouldLoadAsEmptyDocument;
67
68 - (NSString *)_webkit_suggestedFilenameWithMIMEType:(NSString *)MIMEType;
69
70 @end
71
72 @interface NSString (WebNSURLExtras)
73
74 - (BOOL)_web_isUserVisibleURL;
75
76 - (BOOL)_web_hostNameNeedsDecodingWithRange:(NSRange)range; // returns NO if decodeHostNameWithRange: would return nil, but more efficient
77 - (BOOL)_web_hostNameNeedsEncodingWithRange:(NSRange)range; // returns NO if encodeHostNameWithRange: would return nil, but more efficient
78
79 - (NSString *)_web_decodeHostNameWithRange:(NSRange)range; // turns funny-looking ASCII form into Unicode, returns nil if no decoding needed
80 - (NSString *)_web_encodeHostNameWithRange:(NSRange)range; // turns Unicode into funny-looking ASCII form, returns nil if no decoding needed
81
82 - (NSString *)_web_decodeHostName; // turns funny-looking ASCII form into Unicode, returns self if no decoding needed, convenient cover
83 - (NSString *)_web_encodeHostName; // turns Unicode into funny-looking ASCII form, returns self if no decoding needed, convenient cover
84
85 // FIXME: change these names back to _web_ when identically-named
86 // methods are removed from or renamed in Foundation
87 - (BOOL)_webkit_isJavaScriptURL;
88 - (BOOL)_webkit_isFTPDirectoryURL;
89 - (BOOL)_webkit_isFileURL;
90 - (BOOL)_webkit_looksLikeAbsoluteURL;
91 - (NSRange)_webkit_rangeOfURLScheme;
92 - (NSString *)_webkit_URLFragment;
93 - (NSString *)_webkit_scriptIfJavaScriptURL;
94
95 @end