45cb223bf179adca31ac2252ff721840eca24301
[WebKit-https.git] / WebKit / Loader / WebFrameLoader.h
1 /*
2  * Copyright (C) 2006 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 <Cocoa/Cocoa.h>
30
31 @class DOMElement;
32 @class WebDocumentLoader;
33 @class WebFormState;
34 @class WebFrame;
35 @class WebFrameBridge;
36 @class WebLoader;
37 @class WebMainResourceLoader;
38 @class WebArchive;
39 @protocol WebFrameLoaderClient;
40
41 @class WebArchive;
42 @class WebPolicyDecisionListener;
43 @class WebResource;
44
45 typedef enum {
46     WebFrameStateProvisional,
47     
48     // This state indicates we are ready to commit to a page,
49     // which means the view will transition to use the new data source.
50     WebFrameStateCommittedPage,
51     
52     WebFrameStateComplete
53 } WebFrameState;
54
55 typedef enum {
56     WebPolicyUse,
57     WebPolicyDownload,
58     WebPolicyIgnore,
59 } WebPolicyAction;
60
61 typedef enum {
62     FrameLoadTypeStandard,
63     FrameLoadTypeBack,
64     FrameLoadTypeForward,
65     FrameLoadTypeIndexedBackForward, // a multi-item hop in the backforward list
66     FrameLoadTypeReload,
67     FrameLoadTypeReloadAllowingStaleData,
68     FrameLoadTypeSame,               // user loads same URL again (but not reload button)
69     FrameLoadTypeInternal,
70     FrameLoadTypeReplace
71 } FrameLoadType;
72
73 typedef enum {
74     NavigationTypeLinkClicked,
75     NavigationTypeFormSubmitted,
76     NavigationTypeBackForward,
77     NavigationTypeReload,
78     NavigationTypeFormResubmitted,
79     NavigationTypeOther
80 } NavigationType;
81
82 BOOL isBackForwardLoadType(FrameLoadType type);
83
84 @interface WebFrameLoader : NSObject {
85     WebMainResourceLoader *mainResourceLoader;
86     
87     NSMutableArray *subresourceLoaders;
88     NSMutableArray *plugInStreamLoaders;
89     
90     WebFrame <WebFrameLoaderClient> *client;
91     WebDocumentLoader *documentLoader;
92     WebDocumentLoader *provisionalDocumentLoader;
93     WebDocumentLoader *policyDocumentLoader;
94         
95     WebFrameState state;
96     
97     WebPolicyDecisionListener *listener;
98     
99     NSMutableDictionary *pendingArchivedResources;
100
101     FrameLoadType loadType;
102
103     // state we'll need to continue after waiting for the policy delegate's decision
104     NSURLRequest *policyRequest;
105     NSString *policyFrameName;
106     id policyTarget;
107     SEL policySelector;
108     WebFormState *policyFormState;
109     FrameLoadType policyLoadType;
110
111     BOOL delegateIsHandlingProvisionalLoadError;
112     BOOL delegateIsDecidingNavigationPolicy;
113     BOOL delegateIsHandlingUnimplementablePolicy;
114
115     BOOL firstLayoutDone;
116     BOOL quickRedirectComing;
117     BOOL sentRedirectNotification;
118     BOOL isStoppingLoad;    
119 }
120
121 - (id)initWithClient:(WebFrame <WebFrameLoaderClient> *)client;
122 - (void)addPlugInStreamLoader:(WebLoader *)loader;
123 - (void)removePlugInStreamLoader:(WebLoader *)loader;
124 - (void)setDefersCallbacks:(BOOL)defers;
125 - (void)stopLoadingPlugIns;
126 - (BOOL)isLoadingMainResource;
127 - (BOOL)isLoadingSubresources;
128 - (BOOL)isLoading;
129 - (void)stopLoadingSubresources;
130 - (void)addSubresourceLoader:(WebLoader *)loader;
131 - (void)removeSubresourceLoader:(WebLoader *)loader;
132 - (NSData *)mainResourceData;
133 - (void)releaseMainResourceLoader;
134 - (void)cancelMainResourceLoad;
135 - (BOOL)startLoadingMainResourceWithRequest:(NSMutableURLRequest *)request identifier:(id)identifier;
136 - (void)stopLoadingWithError:(NSError *)error;
137 - (void)clearProvisionalLoad;
138 - (void)stopLoading;
139 - (void)stopLoadingSubframes;
140 - (void)markLoadComplete;
141 - (void)commitProvisionalLoad;
142 - (void)startLoading;
143 - (void)startProvisionalLoad:(WebDocumentLoader *)loader;
144 - (WebDocumentLoader *)activeDocumentLoader;
145 - (WebDocumentLoader *)documentLoader;
146 - (WebDocumentLoader *)provisionalDocumentLoader;
147 - (WebFrameState)state;
148 - (void)setupForReplace;
149 + (CFAbsoluteTime)timeOfLastCompletedLoad;
150 - (void)provisionalLoadStarted;
151 - (void)frameLoadCompleted;
152
153 - (BOOL)defersCallbacks;
154 - (void)defersCallbacksChanged;
155 - (id)_identifierForInitialRequest:(NSURLRequest *)clientRequest;
156 - (NSURLRequest *)_willSendRequest:(NSMutableURLRequest *)clientRequest forResource:(id)identifier redirectResponse:(NSURLResponse *)redirectResponse;
157 - (void)_didReceiveAuthenticationChallenge:(NSURLAuthenticationChallenge *)currentWebChallenge forResource:(id)identifier;
158 - (void)_didCancelAuthenticationChallenge:(NSURLAuthenticationChallenge *)currentWebChallenge forResource:(id)identifier;
159 - (void)_didReceiveResponse:(NSURLResponse *)r forResource:(id)identifier;
160 - (void)_didReceiveData:(NSData *)data contentLength:(int)lengthReceived forResource:(id)identifier;
161 - (void)_didFinishLoadingForResource:(id)identifier;
162 - (void)_didFailLoadingWithError:(NSError *)error forResource:(id)identifier;
163 - (BOOL)_privateBrowsingEnabled;
164 - (void)_didFailLoadingWithError:(NSError *)error forResource:(id)identifier;
165 - (void)_finishedLoadingResource;
166 - (void)_receivedError:(NSError *)error;
167 - (NSURLRequest *)_originalRequest;
168 - (WebFrame *)webFrame;
169 - (void)_receivedMainResourceError:(NSError *)error complete:(BOOL)isComplete;
170 - (NSURLRequest *)initialRequest;
171 - (void)_receivedData:(NSData *)data;
172 - (void)_setRequest:(NSURLRequest *)request;
173 - (void)_downloadWithLoadingConnection:(NSURLConnection *)connection request:(NSURLRequest *)request response:(NSURLResponse *)r proxy:(id)proxy;
174 - (void)_handleFallbackContent;
175 - (BOOL)_isStopping;
176 - (void)_setupForReplaceByMIMEType:(NSString *)newMIMEType;
177 - (void)_setResponse:(NSURLResponse *)response;
178 - (void)_mainReceivedError:(NSError *)error complete:(BOOL)isComplete;
179 - (void)_finishedLoading;
180 - (NSURL *)_URL;
181
182 - (NSError *)cancelledErrorWithRequest:(NSURLRequest *)request;
183 - (NSError *)fileDoesNotExistErrorWithResponse:(NSURLResponse *)response;
184 - (BOOL)willUseArchiveForRequest:(NSURLRequest *)r originalURL:(NSURL *)originalURL loader:(WebLoader *)loader;
185 - (BOOL)archiveLoadPendingForLoader:(WebLoader *)loader;
186 - (void)deliverArchivedResourcesAfterDelay;
187 - (void)cancelPendingArchiveLoadForLoader:(WebLoader *)loader;
188 - (void)clearArchivedResources;
189 - (void)cannotShowMIMETypeForURL:(NSURL *)URL;
190 - (NSError *)interruptForPolicyChangeErrorWithRequest:(NSURLRequest *)request;
191 - (BOOL)isHostedByObjectElement;
192 - (BOOL)isLoadingMainFrame;
193 + (BOOL)_canShowMIMEType:(NSString *)MIMEType;
194 + (BOOL)_representationExistsForURLScheme:(NSString *)URLScheme;
195 + (NSString *)_generatedMIMETypeForURLScheme:(NSString *)URLScheme;
196 - (void)_notifyIconChanged:(NSURL *)iconURL;
197 - (void)_checkNavigationPolicyForRequest:(NSURLRequest *)newRequest andCall:(id)obj withSelector:(SEL)sel;
198 - (void)_checkContentPolicyForMIMEType:(NSString *)MIMEType andCall:(id)obj withSelector:(SEL)sel;
199 - (void)cancelContentPolicy;
200 - (void)_loadRequest:(NSURLRequest *)request archive:(WebArchive *)archive;
201 - (void)reload;
202 - (void)_reloadAllowingStaleDataWithOverrideEncoding:(NSString *)encoding;
203 - (void)_loadRequest:(NSURLRequest *)request triggeringAction:(NSDictionary *)action loadType:(FrameLoadType)loadType formState:(WebFormState *)formState;
204
205 - (void)didReceiveServerRedirectForProvisionalLoadForFrame;
206 - (WebFrameBridge *)bridge;
207 - (void)finishedLoadingDocument:(WebDocumentLoader *)loader;
208 - (void)committedLoadWithDocumentLoader:(WebDocumentLoader *)loader data:(NSData *)data;
209 - (BOOL)isReplacing;
210 - (void)setReplacing;
211 - (void)revertToProvisionalWithDocumentLoader:(WebDocumentLoader *)loader;
212 - (void)documentLoader:(WebDocumentLoader *)loader setMainDocumentError:(NSError *)error;
213 - (void)documentLoader:(WebDocumentLoader *)loader mainReceivedCompleteError:(NSError *)error;
214 - (void)finalSetupForReplaceWithDocumentLoader:(WebDocumentLoader *)loader;
215 - (void)prepareForLoadStart;
216 - (BOOL)subframeIsLoading;
217 - (void)willChangeTitleForDocument:(WebDocumentLoader *)loader;
218 - (void)didChangeTitleForDocument:(WebDocumentLoader *)loader;
219
220 - (FrameLoadType)loadType;
221 - (void)setLoadType:(FrameLoadType)type;
222
223 - (void)invalidatePendingPolicyDecisionCallingDefaultAction:(BOOL)call;
224 - (void)checkNewWindowPolicyForRequest:(NSURLRequest *)request action:(NSDictionary *)action frameName:(NSString *)frameName formState:(WebFormState *)formState andCall:(id)target withSelector:(SEL)selector;
225 - (void)checkNavigationPolicyForRequest:(NSURLRequest *)request documentLoader:(WebDocumentLoader *)loader formState:(WebFormState *)formState andCall:(id)target withSelector:(SEL)selector;
226 - (void)continueAfterWillSubmitForm:(WebPolicyAction)policy;
227 - (void)continueLoadRequestAfterNavigationPolicy:(NSURLRequest *)request formState:(WebFormState *)formState;
228 - (void)loadDocumentLoader:(WebDocumentLoader *)loader withLoadType:(FrameLoadType)loadType formState:(WebFormState *)formState;
229 - (void)handleUnimplementablePolicyWithErrorCode:(int)code forURL:(NSURL *)URL;
230
231 - (void)didFirstLayout;
232 - (BOOL)firstLayoutDone;
233
234 - (void)clientRedirectCancelledOrFinished:(BOOL)cancelWithLoadInProgress;
235 - (void)clientRedirectedTo:(NSURL *)URL delay:(NSTimeInterval)seconds fireDate:(NSDate *)date lockHistory:(BOOL)lockHistory isJavaScriptFormAction:(BOOL)isJavaScriptFormAction;
236 - (void)loadURL:(NSURL *)URL referrer:(NSString *)referrer loadType:(FrameLoadType)loadType target:(NSString *)target triggeringEvent:(NSEvent *)event form:(DOMElement *)form formValues:(NSDictionary *)values;
237 - (void)commitProvisionalLoad:(NSDictionary *)pageCache;
238 - (BOOL)isQuickRedirectComing;
239 - (BOOL)shouldReloadForCurrent:(NSURL *)currentURL andDestination:(NSURL *)destinationURL;
240
241 - (void)transitionToCommitted:(NSDictionary *)pageCache;
242 - (void)checkLoadCompleteForThisFrame;
243 - (void)continueLoadRequestAfterNewWindowPolicy:(NSURLRequest *)request frameName:(NSString *)frameName formState:(WebFormState *)formState;
244 - (void)sendRemainingDelegateMessagesWithIdentifier:(id)identifier response:(NSURLResponse *)response length:(unsigned)length error:(NSError *)error;
245 - (NSURLRequest *)requestFromDelegateForRequest:(NSURLRequest *)request identifier:(id *)identifier error:(NSError **)error;
246 - (void)loadRequest:(NSURLRequest *)request inFrameNamed:(NSString *)frameName;
247 - (void)postWithURL:(NSURL *)URL referrer:(NSString *)referrer target:(NSString *)target data:(NSArray *)postData contentType:(NSString *)contentType triggeringEvent:(NSEvent *)event form:(DOMElement *)form formValues:(NSDictionary *)values;
248
249 - (void)checkLoadComplete;
250 - (void)detachFromParent;
251 - (void)safeLoadURL:(NSURL *)URL;
252 - (void)defersCallbacksChanged;
253 - (void)detachChildren;
254 - (void)addExtraFieldsToRequest:(NSMutableURLRequest *)request mainResource:(BOOL)mainResource alwaysFromRequest:(BOOL)alwaysFromRequest;
255 - (NSDictionary *)actionInformationForNavigationType:(NavigationType)navigationType event:(NSEvent *)event originalURL:(NSURL *)URL;
256 - (NSDictionary *)actionInformationForLoadType:(FrameLoadType)loadType isFormSubmission:(BOOL)isFormSubmission event:(NSEvent *)event originalURL:(NSURL *)URL;
257
258 @end