Reviewed by Brady.
[WebKit-https.git] / WebKit / Loader / WebFrameLoaderClient.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 typedef struct LoadErrorResetToken LoadErrorResetToken;
32
33 @class WebDocumentLoader;
34 @class WebPolicyDecisionListener;
35 @class WebResource;
36
37 @protocol WebFrameLoaderClient
38
39 - (BOOL)_hasWebView; // mainly for assertions
40
41 - (BOOL)_hasBackForwardList;
42 - (void)_resetBackForwardList;
43
44 - (BOOL)_provisionalItemIsTarget;
45 - (BOOL)_loadProvisionalItemFromPageCache;
46 - (void)_invalidateCurrentItemPageCache;
47
48 - (BOOL)_privateBrowsingEnabled;
49
50 - (void)_makeDocumentView;
51 - (void)_makeRepresentationForDocumentLoader:(WebDocumentLoader *)loader;
52 - (void)_setDocumentViewFromPageCache:(NSDictionary *)dictionary;
53 - (void)_forceLayout;
54 - (void)_forceLayoutForNonHTML;
55
56 - (WebResource *)_archivedSubresourceForURL:(NSURL *)URL fromDocumentLoader:(WebDocumentLoader *)loader;
57
58 - (void)_updateHistoryForCommit;
59
60 - (void)_updateHistoryForBackForwardNavigation;
61 - (void)_updateHistoryForReload;
62 - (void)_updateHistoryForStandardLoad;
63 - (void)_updateHistoryForInternalLoad;
64
65 - (void)_updateHistoryAfterClientRedirect;
66
67 - (void)_setCopiesOnScroll;
68
69 - (LoadErrorResetToken *)_tokenForLoadErrorReset;
70 - (void)_resetAfterLoadError:(LoadErrorResetToken *)token;
71 - (void)_doNotResetAfterLoadError:(LoadErrorResetToken *)token;
72
73 - (void)_detachedFromParent1;
74 - (void)_detachedFromParent2;
75 - (void)_detachedFromParent3;
76 - (void)_detachedFromParent4;
77
78 - (void)_loadedFromPageCache;
79
80 - (void)_downloadWithLoadingConnection:(NSURLConnection *)connection request:(NSURLRequest *)request response:(NSURLResponse *)response proxy:(id)proxy;
81
82 - (id)_dispatchIdentifierForInitialRequest:(NSURLRequest *)request fromDocumentLoader:(WebDocumentLoader *)loader;
83 - (NSURLRequest *)_dispatchResource:(id)identifier willSendRequest:(NSURLRequest *)clientRequest redirectResponse:(NSURLResponse *)redirectResponse fromDocumentLoader:(WebDocumentLoader *)loader;
84 - (void)_dispatchDidReceiveAuthenticationChallenge:(NSURLAuthenticationChallenge *)currentWebChallenge forResource:(id)identifier fromDocumentLoader:(WebDocumentLoader *)loader;
85 - (void)_dispatchDidCancelAuthenticationChallenge:(NSURLAuthenticationChallenge *)currentWebChallenge forResource:(id)identifier fromDocumentLoader:(WebDocumentLoader *)loader;
86 - (void)_dispatchResource:(id)identifier didReceiveResponse:(NSURLResponse *)r fromDocumentLoader:(WebDocumentLoader *)loader;
87 - (void)_dispatchResource:(id)identifier didReceiveContentLength:(int)lengthReceived fromDocumentLoader:(WebDocumentLoader *)loader;
88 - (void)_dispatchResource:(id)identifier didFinishLoadingFromDocumentLoader:(WebDocumentLoader *)loader;
89 - (void)_dispatchResource:(id)identifier didFailLoadingWithError:error fromDocumentLoader:(WebDocumentLoader *)loader;
90
91 - (void)_dispatchDidHandleOnloadEventsForFrame;
92 - (void)_dispatchDidReceiveServerRedirectForProvisionalLoadForFrame;
93 - (void)_dispatchDidCancelClientRedirectForFrame;
94 - (void)_dispatchWillPerformClientRedirectToURL:(NSURL *)URL delay:(NSTimeInterval)seconds fireDate:(NSDate *)date;
95 - (void)_dispatchDidChangeLocationWithinPageForFrame;
96 - (void)_dispatchWillCloseFrame;
97 - (void)_dispatchDidReceiveIcon:(NSImage *)icon;
98 - (void)_dispatchDidStartProvisionalLoadForFrame;
99 - (void)_dispatchDidReceiveTitle:(NSString *)title;
100 - (void)_dispatchDidCommitLoadForFrame;
101 - (void)_dispatchDidFailProvisionalLoadWithError:(NSError *)error;
102 - (void)_dispatchDidFailLoadWithError:(NSError *)error;
103 - (void)_dispatchDidFinishLoadForFrame;
104 - (void)_dispatchDidFirstLayoutInFrame;
105
106 - (WebFrame *)_dispatchCreateWebViewWithRequest:(NSURLRequest *)request;
107 - (void)_dispatchShow;
108
109 - (void)_dispatchDecidePolicyForMIMEType:(NSString *)MIMEType request:(NSURLRequest *)request decisionListener:(WebPolicyDecisionListener *)decisionListener;
110 - (void)_dispatchDecidePolicyForNewWindowAction:(NSDictionary *)action request:(NSURLRequest *)request newFrameName:(NSString *)frameName decisionListener:(WebPolicyDecisionListener *)decisionListener;
111 - (void)_dispatchDecidePolicyForNavigationAction:(NSDictionary *)action request:(NSURLRequest *)request decisionListener:(WebPolicyDecisionListener *)decisionListener;
112 - (void)_dispatchUnableToImplementPolicyWithError:(NSError *)error;
113
114 - (void)_dispatchDidLoadMainResourceForDocumentLoader:(WebDocumentLoader *)loader;
115 - (void)_clearLoadingFromPageCacheForDocumentLoader:(WebDocumentLoader *)loader;
116 - (BOOL)_isDocumentLoaderLoadingFromPageCache:(WebDocumentLoader *)documentLoader;
117
118 - (void)_progressStarted;
119 - (void)_progressCompleted;
120
121 - (void)_incrementProgressForIdentifier:(id)identifier response:(NSURLResponse *)response;
122 - (void)_incrementProgressForIdentifier:(id)identifier data:(NSData *)data;
123 - (void)_completeProgressForIdentifier:(id)identifier;
124
125 - (void)_setMainFrameDocumentReady:(BOOL)ready;
126
127 - (void)_startDownloadWithRequest:(NSURLRequest *)request;
128
129 - (void)_willChangeTitleForDocument:(WebDocumentLoader *)loader;
130 - (void)_didChangeTitleForDocument:(WebDocumentLoader *)loader;
131
132 - (void)_revertToProvisionalWithDocumentLoader:(WebDocumentLoader *)loader;
133 - (void)_committedLoadWithDocumentLoader:(WebDocumentLoader *)loader data:(NSData *)data;
134 - (void)_finishedLoadingDocument:(WebDocumentLoader *)loader;
135 - (void)_documentLoader:(WebDocumentLoader *)loader setMainDocumentError:(NSError *)error;
136 - (void)_finalSetupForReplaceWithDocumentLoader:(WebDocumentLoader *)loader;
137 - (NSURL *)_URLForHistoryForDocumentLoader:(WebDocumentLoader *)loader;
138
139 - (NSError *)_cancelledErrorWithRequest:(NSURLRequest *)request;
140 - (NSError *)_cannotShowURLErrorWithRequest:(NSURLRequest *)request;
141 - (NSError *)_interruptForPolicyChangeErrorWithRequest:(NSURLRequest *)request;
142
143 - (NSError *)_cannotShowMIMETypeErrorWithResponse:(NSURLResponse *)response;
144 - (NSError *)_fileDoesNotExistErrorWithResponse:(NSURLResponse *)response;
145
146 - (BOOL)_shouldFallBackForError:(NSError *)error;
147
148 - (NSURL *)_mainFrameURL;
149
150 @end