4bc05b1c3aaa509901da850835cfa4cd4e7294d0
[WebKit-https.git] / WebCore / loader / FrameLoaderClient.h
1 /*
2  * Copyright (C) 2006, 2007, 2008 Apple 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 #ifndef FrameLoaderClient_h
30 #define FrameLoaderClient_h
31
32 #include "FrameLoaderTypes.h"
33 #include <wtf/Forward.h>
34 #include <wtf/Platform.h>
35 #include <wtf/Vector.h>
36
37 typedef class _jobject* jobject;
38
39 #if PLATFORM(MAC) && !defined(__OBJC__)
40 class NSCachedURLResponse;
41 class NSView;
42 #endif
43
44 namespace WebCore {
45
46     class AuthenticationChallenge;
47     class CachedPage;
48     class Color;
49     class DocumentLoader;
50     class Element;
51     class FormState;
52     class Frame;
53     class FrameLoader;
54     class HistoryItem;
55     class HTMLFrameOwnerElement;
56     class IntSize;
57     class KURL;
58     class NavigationAction;
59     class ResourceError;
60     class ResourceHandle;
61     class ResourceLoader;
62     class ResourceResponse;
63     class SharedBuffer;
64     class SubstituteData;
65     class String;
66     class Widget;
67
68     class ResourceRequest;
69
70     typedef void (FrameLoader::*FramePolicyFunction)(PolicyAction);
71
72     class FrameLoaderClient {
73     public:
74         virtual ~FrameLoaderClient();
75         virtual void frameLoaderDestroyed() = 0;
76         
77         virtual bool hasWebView() const = 0; // mainly for assertions
78
79         virtual bool hasHTMLView() const { return true; }
80
81         virtual void makeRepresentation(DocumentLoader*) = 0;
82         virtual void forceLayout() = 0;
83         virtual void forceLayoutForNonHTML() = 0;
84
85         virtual void setCopiesOnScroll() = 0;
86
87         virtual void detachedFromParent2() = 0;
88         virtual void detachedFromParent3() = 0;
89
90         virtual void assignIdentifierToInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&) = 0;
91
92         virtual void dispatchWillSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse) = 0;
93         virtual bool shouldUseCredentialStorage(DocumentLoader*, unsigned long identifier) = 0;
94         virtual void dispatchDidReceiveAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;
95         virtual void dispatchDidCancelAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;        
96         virtual void dispatchDidReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&) = 0;
97         virtual void dispatchDidReceiveContentLength(DocumentLoader*, unsigned long identifier, int lengthReceived) = 0;
98         virtual void dispatchDidFinishLoading(DocumentLoader*, unsigned long identifier) = 0;
99         virtual void dispatchDidFailLoading(DocumentLoader*, unsigned long identifier, const ResourceError&) = 0;
100         virtual bool dispatchDidLoadResourceFromMemoryCache(DocumentLoader*, const ResourceRequest&, const ResourceResponse&, int length) = 0;
101
102         virtual void dispatchDidHandleOnloadEvents() = 0;
103         virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() = 0;
104         virtual void dispatchDidCancelClientRedirect() = 0;
105         virtual void dispatchWillPerformClientRedirect(const KURL&, double interval, double fireDate) = 0;
106         virtual void dispatchDidChangeLocationWithinPage() = 0;
107         virtual void dispatchWillClose() = 0;
108         virtual void dispatchDidReceiveIcon() = 0;
109         virtual void dispatchDidStartProvisionalLoad() = 0;
110         virtual void dispatchDidReceiveTitle(const String& title) = 0;
111         virtual void dispatchDidCommitLoad() = 0;
112         virtual void dispatchDidFailProvisionalLoad(const ResourceError&) = 0;
113         virtual void dispatchDidFailLoad(const ResourceError&) = 0;
114         virtual void dispatchDidFinishDocumentLoad() = 0;
115         virtual void dispatchDidFinishLoad() = 0;
116         virtual void dispatchDidFirstLayout() = 0;
117         virtual void dispatchDidFirstVisuallyNonEmptyLayout() = 0;
118
119         virtual Frame* dispatchCreatePage() = 0;
120         virtual void dispatchShow() = 0;
121
122         virtual void dispatchDecidePolicyForMIMEType(FramePolicyFunction, const String& MIMEType, const ResourceRequest&) = 0;
123         virtual void dispatchDecidePolicyForNewWindowAction(FramePolicyFunction, const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>, const String& frameName) = 0;
124         virtual void dispatchDecidePolicyForNavigationAction(FramePolicyFunction, const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>) = 0;
125         virtual void cancelPolicyCheck() = 0;
126
127         virtual void dispatchUnableToImplementPolicy(const ResourceError&) = 0;
128
129         virtual void dispatchWillSubmitForm(FramePolicyFunction, PassRefPtr<FormState>) = 0;
130
131         virtual void dispatchDidLoadMainResource(DocumentLoader*) = 0;
132         virtual void revertToProvisionalState(DocumentLoader*) = 0;
133         virtual void setMainDocumentError(DocumentLoader*, const ResourceError&) = 0;
134
135         // Maybe these should go into a ProgressTrackerClient some day
136         virtual void willChangeEstimatedProgress() { }
137         virtual void didChangeEstimatedProgress() { }
138         virtual void postProgressStartedNotification() = 0;
139         virtual void postProgressEstimateChangedNotification() = 0;
140         virtual void postProgressFinishedNotification() = 0;
141         
142         virtual void setMainFrameDocumentReady(bool) = 0;
143
144         virtual void startDownload(const ResourceRequest&) = 0;
145
146         virtual void willChangeTitle(DocumentLoader*) = 0;
147         virtual void didChangeTitle(DocumentLoader*) = 0;
148
149         virtual void committedLoad(DocumentLoader*, const char*, int) = 0;
150         virtual void finishedLoading(DocumentLoader*) = 0;
151         
152         virtual void updateGlobalHistory() = 0;
153         virtual bool shouldGoToHistoryItem(HistoryItem*) const = 0;
154
155         virtual ResourceError cancelledError(const ResourceRequest&) = 0;
156         virtual ResourceError blockedError(const ResourceRequest&) = 0;
157         virtual ResourceError cannotShowURLError(const ResourceRequest&) = 0;
158         virtual ResourceError interruptForPolicyChangeError(const ResourceRequest&) = 0;
159
160         virtual ResourceError cannotShowMIMETypeError(const ResourceResponse&) = 0;
161         virtual ResourceError fileDoesNotExistError(const ResourceResponse&) = 0;
162         virtual ResourceError pluginWillHandleLoadError(const ResourceResponse&) = 0;
163
164         virtual bool shouldFallBack(const ResourceError&) = 0;
165
166         virtual bool canHandleRequest(const ResourceRequest&) const = 0;
167         virtual bool canShowMIMEType(const String& MIMEType) const = 0;
168         virtual bool representationExistsForURLScheme(const String& URLScheme) const = 0;
169         virtual String generatedMIMETypeForURLScheme(const String& URLScheme) const = 0;
170
171         virtual void frameLoadCompleted() = 0;
172         virtual void saveViewStateToItem(HistoryItem*) = 0;
173         virtual void restoreViewState() = 0;
174         virtual void provisionalLoadStarted() = 0;
175         virtual void didFinishLoad() = 0;
176         virtual void prepareForDataSourceReplacement() = 0;
177
178         virtual PassRefPtr<DocumentLoader> createDocumentLoader(const ResourceRequest&, const SubstituteData&) = 0;
179         virtual void setTitle(const String& title, const KURL&) = 0;
180
181         virtual String userAgent(const KURL&) = 0;
182         
183         virtual void savePlatformDataToCachedPage(CachedPage*) = 0;
184         virtual void transitionToCommittedFromCachedPage(CachedPage*) = 0;
185         virtual void transitionToCommittedForNewPage() = 0;
186
187         virtual bool canCachePage() const = 0;
188         virtual void download(ResourceHandle*, const ResourceRequest&, const ResourceRequest&, const ResourceResponse&) = 0;
189
190         virtual PassRefPtr<Frame> createFrame(const KURL& url, const String& name, HTMLFrameOwnerElement* ownerElement,
191                                    const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) = 0;
192         virtual Widget* createPlugin(const IntSize&, Element*, const KURL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) = 0;
193         virtual void redirectDataToPlugin(Widget* pluginWidget) = 0;
194         
195         virtual Widget* createJavaAppletWidget(const IntSize&, Element*, const KURL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) = 0;
196
197         virtual ObjectContentType objectContentType(const KURL& url, const String& mimeType) = 0;
198         virtual String overrideMediaType() const = 0;
199
200         virtual void windowObjectCleared() = 0;
201         virtual void didPerformFirstNavigation() const = 0; // "Navigation" here means a transition from one page to another that ends up in the back/forward list.
202         
203         virtual void registerForIconNotification(bool listen = true) = 0;
204         
205 #if PLATFORM(MAC)
206 #if ENABLE(MAC_JAVA_BRIDGE)
207         virtual jobject javaApplet(NSView*) { return 0; }
208 #endif
209         virtual NSCachedURLResponse* willCacheResponse(DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const = 0;
210 #endif
211
212     protected:
213         static void transitionToCommittedForNewPage(Frame*, const IntSize&, const Color&, bool, const IntSize &, bool);
214     };
215
216 } // namespace WebCore
217
218 #endif // FrameLoaderClient_h