10992f8fd76690783dd70b7c1fbf24146ac4b3a6
[WebKit-https.git] / WebCore / loader / FrameLoaderClient.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 #ifndef FrameLoaderClient_h
29 #define FrameLoaderClient_h
30
31 #include "FrameLoaderTypes.h"
32 #include <wtf/Forward.h>
33 #include <wtf/Noncopyable.h>
34
35 #if PLATFORM(MAC)
36 #ifdef __OBJC__
37 @class NSURLConnection;
38 #else
39 class NSImage;
40 class NSURLConnection;
41 #endif
42 #endif
43
44 namespace WebCore {
45
46     class DocumentLoader;
47     class Element;
48     class FormState;
49     class Frame;
50     class FrameLoader;
51     class KURL;
52     class NavigationAction;
53     class String;
54     class ResourceLoader;
55
56     struct LoadErrorResetToken;
57
58     typedef void (FrameLoader::*FramePolicyFunction)(PolicyAction);
59
60     class FrameLoaderClient : Noncopyable {
61     public:
62         virtual void detachFrameLoader() = 0;
63
64         virtual bool hasWebView() const = 0; // mainly for assertions
65         virtual bool hasFrameView() const = 0; // ditto
66
67         virtual bool hasBackForwardList() const = 0;
68         virtual void resetBackForwardList() = 0;
69
70         virtual bool provisionalItemIsTarget() const = 0;
71         virtual bool loadProvisionalItemFromPageCache() = 0;
72         virtual void invalidateCurrentItemPageCache() = 0;
73
74         virtual bool privateBrowsingEnabled() const = 0;
75
76         virtual void makeDocumentView() = 0;
77         virtual void makeRepresentation(DocumentLoader*) = 0;
78 #if PLATFORM(MAC)
79         virtual void setDocumentViewFromPageCache(NSDictionary *) = 0;
80 #endif
81         virtual void forceLayout() = 0;
82         virtual void forceLayoutForNonHTML() = 0;
83
84         virtual void updateHistoryForCommit() = 0;
85
86         virtual void updateHistoryForBackForwardNavigation() = 0;
87         virtual void updateHistoryForReload() = 0;
88         virtual void updateHistoryForStandardLoad() = 0;
89         virtual void updateHistoryForInternalLoad() = 0;
90
91         virtual void updateHistoryAfterClientRedirect() = 0;
92
93         virtual void setCopiesOnScroll() = 0;
94
95         virtual LoadErrorResetToken* tokenForLoadErrorReset() = 0;
96         virtual void resetAfterLoadError(LoadErrorResetToken*) = 0;
97         virtual void doNotResetAfterLoadError(LoadErrorResetToken*) = 0;
98
99         virtual void willCloseDocument() = 0;
100
101         virtual void detachedFromParent1() = 0;
102         virtual void detachedFromParent2() = 0;
103         virtual void detachedFromParent3() = 0;
104         virtual void detachedFromParent4() = 0;
105
106         virtual void loadedFromPageCache() = 0;
107
108 #if PLATFORM(MAC)
109         virtual void download(NSURLConnection *, NSURLRequest *, NSURLResponse *, id proxy) = 0;
110
111         virtual id dispatchIdentifierForInitialRequest(DocumentLoader*, NSURLRequest *) = 0;
112         virtual NSURLRequest *dispatchWillSendRequest(DocumentLoader*, id identifier, NSURLRequest *, NSURLResponse *redirectResponse) = 0;
113         virtual void dispatchDidReceiveAuthenticationChallenge(DocumentLoader*, id identifier, NSURLAuthenticationChallenge *) = 0;
114         virtual void dispatchDidCancelAuthenticationChallenge(DocumentLoader*, id identifier, NSURLAuthenticationChallenge *) = 0;
115         virtual void dispatchDidReceiveResponse(DocumentLoader*, id identifier, NSURLResponse *) = 0;
116         virtual void dispatchDidReceiveContentLength(DocumentLoader*, id identifier, int lengthReceived) = 0;
117         virtual void dispatchDidFinishLoading(DocumentLoader*, id identifier) = 0;
118         virtual void dispatchDidFailLoading(DocumentLoader*, id identifier, NSError *) = 0;
119         virtual bool dispatchDidLoadResourceFromMemoryCache(DocumentLoader*, NSURLRequest *, NSURLResponse *, int length) = 0;
120 #endif
121
122         virtual void dispatchDidHandleOnloadEvents() = 0;
123         virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() = 0;
124         virtual void dispatchDidCancelClientRedirect() = 0;
125         virtual void dispatchWillPerformClientRedirect(const KURL&, double interval, double fireDate) = 0;
126         virtual void dispatchDidChangeLocationWithinPage() = 0;
127         virtual void dispatchWillClose() = 0;
128         virtual void dispatchDidReceiveIcon() = 0;
129         virtual void dispatchDidStartProvisionalLoad() = 0;
130         virtual void dispatchDidReceiveTitle(const String& title) = 0;
131         virtual void dispatchDidCommitLoad() = 0;
132 #if PLATFORM(MAC)
133         virtual void dispatchDidFailProvisionalLoad(NSError *) = 0;
134         virtual void dispatchDidFailLoad(NSError *) = 0;
135 #endif
136         virtual void dispatchDidFinishLoad() = 0;
137         virtual void dispatchDidFirstLayout() = 0;
138
139 #if PLATFORM(MAC)
140         virtual Frame* dispatchCreatePage(NSURLRequest *) = 0;
141 #endif
142         virtual void dispatchShow() = 0;
143
144 #if PLATFORM(MAC)
145         virtual void dispatchDecidePolicyForMIMEType(FramePolicyFunction, const String& MIMEType, NSURLRequest *) = 0;
146         virtual void dispatchDecidePolicyForNewWindowAction(FramePolicyFunction, const NavigationAction&, NSURLRequest *, const String& frameName) = 0;
147         virtual void dispatchDecidePolicyForNavigationAction(FramePolicyFunction, const NavigationAction&, NSURLRequest *) = 0;
148 #endif
149         virtual void cancelPolicyCheck() = 0;
150
151 #if PLATFORM(MAC)
152         virtual void dispatchUnableToImplementPolicy(NSError *) = 0;
153 #endif
154
155         virtual void dispatchWillSubmitForm(FramePolicyFunction, PassRefPtr<FormState>) = 0;
156
157         virtual void dispatchDidLoadMainResource(DocumentLoader*) = 0;
158         virtual void clearLoadingFromPageCache(DocumentLoader*) = 0;
159         virtual bool isLoadingFromPageCache(DocumentLoader*) = 0;
160         virtual void revertToProvisionalState(DocumentLoader*) = 0;
161 #if PLATFORM(MAC)
162         virtual void setMainDocumentError(DocumentLoader*, NSError *) = 0;
163 #endif
164         virtual void clearUnarchivingState(DocumentLoader*) = 0;
165
166         virtual void progressStarted() = 0;
167         virtual void progressCompleted() = 0;
168
169 #if PLATFORM(MAC)
170         virtual void incrementProgress(id identifier, NSURLResponse *) = 0;
171         virtual void incrementProgress(id identifier, NSData *) = 0;
172         virtual void completeProgress(id identifier) = 0;
173 #endif
174
175         virtual void setMainFrameDocumentReady(bool) = 0;
176
177 #if PLATFORM(MAC)
178         virtual void startDownload(NSURLRequest *) = 0;
179 #endif
180
181         virtual void willChangeTitle(DocumentLoader*) = 0;
182         virtual void didChangeTitle(DocumentLoader*) = 0;
183
184 #if PLATFORM(MAC)
185         virtual void committedLoad(DocumentLoader*, NSData *) = 0;
186 #endif
187         virtual void finishedLoading(DocumentLoader*) = 0;
188         virtual void finalSetupForReplace(DocumentLoader*) = 0;
189
190 #if PLATFORM(MAC)
191         virtual NSError *cancelledError(NSURLRequest *) = 0;
192         virtual NSError *cannotShowURLError(NSURLRequest *) = 0;
193         virtual NSError *interruptForPolicyChangeError(NSURLRequest *) = 0;
194
195         virtual NSError *cannotShowMIMETypeError(NSURLResponse *) = 0;
196         virtual NSError *fileDoesNotExistError(NSURLResponse *) = 0;
197
198         virtual bool shouldFallBack(NSError *) = 0;
199 #endif
200
201         virtual void setDefersLoading(bool) = 0;
202
203 #if PLATFORM(MAC)
204         virtual bool willUseArchive(ResourceLoader*, NSURLRequest *, NSURL *originalURL) const = 0;
205 #endif
206         virtual bool isArchiveLoadPending(ResourceLoader*) const = 0;
207         virtual void cancelPendingArchiveLoad(ResourceLoader*) = 0;
208         virtual void clearArchivedResources() = 0;
209
210 #if PLATFORM(MAC)
211         virtual bool canHandleRequest(NSURLRequest *) const = 0;
212 #endif
213         virtual bool canShowMIMEType(const String& MIMEType) const = 0;
214         virtual bool representationExistsForURLScheme(const String& URLScheme) const = 0;
215         virtual String generatedMIMETypeForURLScheme(const String& URLScheme) const = 0;
216
217         virtual void frameLoadCompleted() = 0;
218         virtual void restoreScrollPositionAndViewState() = 0;
219         virtual void provisionalLoadStarted() = 0;
220         virtual bool shouldTreatURLAsSameAsCurrent(const KURL&) const = 0;
221         virtual void addHistoryItemForFragmentScroll() = 0;
222         virtual void didFinishLoad() = 0;
223         virtual void prepareForDataSourceReplacement() = 0;
224 #if PLATFORM(MAC)
225         virtual PassRefPtr<DocumentLoader> createDocumentLoader(NSURLRequest *) = 0;
226 #endif
227         virtual void setTitle(const String& title, const KURL&) = 0;
228
229         virtual String userAgent() = 0;
230
231     protected:
232         virtual ~FrameLoaderClient();
233     };
234
235 }
236
237 #endif