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