FrameLoaderClient.h revision 2fc2651226baac27029e38c9d6ef883fa32084db 
1/*
2 * Copyright (C) 2006, 2007, 2008, 2009, 2010 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 "ScrollTypes.h"
34#include <wtf/Forward.h>
35#include <wtf/Vector.h>
36
37#if PLATFORM(MAC)
38#ifdef __OBJC__
39#import <Foundation/Foundation.h>
40typedef id RemoteAXObjectRef;
41#else
42typedef void* RemoteAXObjectRef;
43#endif
44#endif
45
46typedef class _jobject* jobject;
47
48#if PLATFORM(MAC) && !defined(__OBJC__)
49class NSCachedURLResponse;
50class NSView;
51#endif
52
53namespace WebCore {
54
55    class AuthenticationChallenge;
56    class CachedFrame;
57    class Color;
58    class DOMWrapperWorld;
59    class DocumentLoader;
60    class Element;
61    class FormState;
62    class Frame;
63    class FrameLoader;
64    class FrameNetworkingContext;
65    class HistoryItem;
66    class HTMLAppletElement;
67    class HTMLFormElement;
68    class HTMLFrameOwnerElement;
69#if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
70    class HTMLMediaElement;
71#endif
72    class HTMLPlugInElement;
73    class IntSize;
74    class KURL;
75    class NavigationAction;
76    class Page;
77    class ProtectionSpace;
78    class PluginView;
79    class PolicyChecker;
80    class ResourceError;
81    class ResourceHandle;
82    class ResourceLoader;
83    class ResourceRequest;
84    class ResourceResponse;
85    class SecurityOrigin;
86    class SharedBuffer;
87    class SubstituteData;
88    class Widget;
89
90    typedef void (PolicyChecker::*FramePolicyFunction)(PolicyAction);
91
92    class FrameLoaderClient {
93    public:
94        // An inline function cannot be the first non-abstract virtual function declared
95        // in the class as it results in the vtable being generated as a weak symbol.
96        // This hurts performance (in Mac OS X at least, when loadig frameworks), so we
97        // don't want to do it in WebKit.
98        virtual bool hasHTMLView() const;
99
100        virtual ~FrameLoaderClient() { }
101
102        virtual void frameLoaderDestroyed() = 0;
103
104        virtual bool hasWebView() const = 0; // mainly for assertions
105
106        virtual void makeRepresentation(DocumentLoader*) = 0;
107        virtual void forceLayout() = 0;
108        virtual void forceLayoutForNonHTML() = 0;
109
110        virtual void setCopiesOnScroll() = 0;
111
112        virtual void detachedFromParent2() = 0;
113        virtual void detachedFromParent3() = 0;
114
115        virtual void assignIdentifierToInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&) = 0;
116
117        virtual void dispatchWillSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse) = 0;
118        virtual bool shouldUseCredentialStorage(DocumentLoader*, unsigned long identifier) = 0;
119        virtual void dispatchDidReceiveAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;
120        virtual void dispatchDidCancelAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;
121#if USE(PROTECTION_SPACE_AUTH_CALLBACK)
122        virtual bool canAuthenticateAgainstProtectionSpace(DocumentLoader*, unsigned long identifier, const ProtectionSpace&) = 0;
123#endif
124        virtual void dispatchDidReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&) = 0;
125        virtual void dispatchDidReceiveContentLength(DocumentLoader*, unsigned long identifier, int lengthReceived) = 0;
126        virtual void dispatchDidFinishLoading(DocumentLoader*, unsigned long identifier) = 0;
127        virtual void dispatchDidFailLoading(DocumentLoader*, unsigned long identifier, const ResourceError&) = 0;
128        virtual bool dispatchDidLoadResourceFromMemoryCache(DocumentLoader*, const ResourceRequest&, const ResourceResponse&, int length) = 0;
129
130        virtual void dispatchDidHandleOnloadEvents() = 0;
131        virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() = 0;
132        virtual void dispatchDidCancelClientRedirect() = 0;
133        virtual void dispatchWillPerformClientRedirect(const KURL&, double interval, double fireDate) = 0;
134        virtual void dispatchDidNavigateWithinPage() { }
135        virtual void dispatchDidChangeLocationWithinPage() = 0;
136        virtual void dispatchDidPushStateWithinPage() = 0;
137        virtual void dispatchDidReplaceStateWithinPage() = 0;
138        virtual void dispatchDidPopStateWithinPage() = 0;
139        virtual void dispatchWillClose() = 0;
140        virtual void dispatchDidReceiveIcon() = 0;
141        virtual void dispatchDidStartProvisionalLoad() = 0;
142        virtual void dispatchDidReceiveTitle(const String& title) = 0;
143        virtual void dispatchDidChangeIcons() = 0;
144        virtual void dispatchDidCommitLoad() = 0;
145        virtual void dispatchDidFailProvisionalLoad(const ResourceError&) = 0;
146        virtual void dispatchDidFailLoad(const ResourceError&) = 0;
147        virtual void dispatchDidFinishDocumentLoad() = 0;
148        virtual void dispatchDidFinishLoad() = 0;
149        virtual void dispatchDidFirstLayout() = 0;
150        virtual void dispatchDidFirstVisuallyNonEmptyLayout() = 0;
151
152        virtual Frame* dispatchCreatePage(const NavigationAction&) = 0;
153        virtual void dispatchShow() = 0;
154
155        virtual void dispatchDecidePolicyForMIMEType(FramePolicyFunction, const String& MIMEType, const ResourceRequest&) = 0;
156        virtual void dispatchDecidePolicyForNewWindowAction(FramePolicyFunction, const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>, const String& frameName) = 0;
157        virtual void dispatchDecidePolicyForNavigationAction(FramePolicyFunction, const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>) = 0;
158        virtual void cancelPolicyCheck() = 0;
159
160        virtual void dispatchUnableToImplementPolicy(const ResourceError&) = 0;
161
162        virtual void dispatchWillSendSubmitEvent(HTMLFormElement*) = 0;
163        virtual void dispatchWillSubmitForm(FramePolicyFunction, PassRefPtr<FormState>) = 0;
164
165        virtual void dispatchDidLoadMainResource(DocumentLoader*) = 0;
166        virtual void revertToProvisionalState(DocumentLoader*) = 0;
167        virtual void setMainDocumentError(DocumentLoader*, const ResourceError&) = 0;
168
169        // Maybe these should go into a ProgressTrackerClient some day
170        virtual void willChangeEstimatedProgress() { }
171        virtual void didChangeEstimatedProgress() { }
172        virtual void postProgressStartedNotification() = 0;
173        virtual void postProgressEstimateChangedNotification() = 0;
174        virtual void postProgressFinishedNotification() = 0;
175
176        virtual void setMainFrameDocumentReady(bool) = 0;
177
178        virtual void startDownload(const ResourceRequest&) = 0;
179
180        virtual void willChangeTitle(DocumentLoader*) = 0;
181        virtual void didChangeTitle(DocumentLoader*) = 0;
182
183        virtual void committedLoad(DocumentLoader*, const char*, int) = 0;
184        virtual void finishedLoading(DocumentLoader*) = 0;
185
186        virtual void updateGlobalHistory() = 0;
187        virtual void updateGlobalHistoryRedirectLinks() = 0;
188
189        virtual bool shouldGoToHistoryItem(HistoryItem*) const = 0;
190        virtual void dispatchDidAddBackForwardItem(HistoryItem*) const = 0;
191        virtual void dispatchDidRemoveBackForwardItem(HistoryItem*) const = 0;
192        virtual void dispatchDidChangeBackForwardIndex() const = 0;
193
194        // This frame has displayed inactive content (such as an image) from an
195        // insecure source.  Inactive content cannot spread to other frames.
196        virtual void didDisplayInsecureContent() = 0;
197
198        // The indicated security origin has run active content (such as a
199        // script) from an insecure source.  Note that the insecure content can
200        // spread to other frames in the same origin.
201        virtual void didRunInsecureContent(SecurityOrigin*, const KURL&) = 0;
202
203        virtual ResourceError cancelledError(const ResourceRequest&) = 0;
204        virtual ResourceError blockedError(const ResourceRequest&) = 0;
205        virtual ResourceError cannotShowURLError(const ResourceRequest&) = 0;
206        virtual ResourceError interruptForPolicyChangeError(const ResourceRequest&) = 0;
207
208        virtual ResourceError cannotShowMIMETypeError(const ResourceResponse&) = 0;
209        virtual ResourceError fileDoesNotExistError(const ResourceResponse&) = 0;
210        virtual ResourceError pluginWillHandleLoadError(const ResourceResponse&) = 0;
211
212        virtual bool shouldFallBack(const ResourceError&) = 0;
213
214        virtual bool canHandleRequest(const ResourceRequest&) const = 0;
215        virtual bool canShowMIMEType(const String& MIMEType) const = 0;
216        virtual bool canShowMIMETypeAsHTML(const String& MIMEType) const = 0;
217        virtual bool representationExistsForURLScheme(const String& URLScheme) const = 0;
218        virtual String generatedMIMETypeForURLScheme(const String& URLScheme) const = 0;
219
220        virtual void frameLoadCompleted() = 0;
221        virtual void saveViewStateToItem(HistoryItem*) = 0;
222        virtual void restoreViewState() = 0;
223        virtual void provisionalLoadStarted() = 0;
224        virtual void didFinishLoad() = 0;
225        virtual void prepareForDataSourceReplacement() = 0;
226
227        virtual PassRefPtr<DocumentLoader> createDocumentLoader(const ResourceRequest&, const SubstituteData&) = 0;
228        virtual void setTitle(const String& title, const KURL&) = 0;
229
230        virtual String userAgent(const KURL&) = 0;
231
232        virtual void savePlatformDataToCachedFrame(CachedFrame*) = 0;
233        virtual void transitionToCommittedFromCachedFrame(CachedFrame*) = 0;
234        virtual void transitionToCommittedForNewPage() = 0;
235
236        virtual void didSaveToPageCache() = 0;
237        virtual void didRestoreFromPageCache() = 0;
238
239        virtual void dispatchDidBecomeFrameset(bool) = 0; // Can change due to navigation or DOM modification.
240
241        virtual bool canCachePage() const = 0;
242        virtual void download(ResourceHandle*, const ResourceRequest&, const ResourceRequest&, const ResourceResponse&) = 0;
243
244        virtual PassRefPtr<Frame> createFrame(const KURL& url, const String& name, HTMLFrameOwnerElement* ownerElement,
245                                   const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) = 0;
246        virtual void didTransferChildFrameToNewDocument(Page* oldPage) = 0;
247        virtual void transferLoadingResourceFromPage(unsigned long identifier, DocumentLoader*, const ResourceRequest&, Page* oldPage) = 0;
248        virtual PassRefPtr<Widget> createPlugin(const IntSize&, HTMLPlugInElement*, const KURL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) = 0;
249        virtual void redirectDataToPlugin(Widget* pluginWidget) = 0;
250
251        virtual PassRefPtr<Widget> createJavaAppletWidget(const IntSize&, HTMLAppletElement*, const KURL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) = 0;
252
253        virtual void dispatchDidFailToStartPlugin(const PluginView*) const { }
254#if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
255        virtual PassRefPtr<Widget> createMediaPlayerProxyPlugin(const IntSize&, HTMLMediaElement*, const KURL&, const Vector<String>&, const Vector<String>&, const String&) = 0;
256        virtual void hideMediaPlayerProxyPlugin(Widget*) = 0;
257        virtual void showMediaPlayerProxyPlugin(Widget*) = 0;
258#endif
259
260        virtual ObjectContentType objectContentType(const KURL& url, const String& mimeType) = 0;
261        virtual String overrideMediaType() const = 0;
262
263        virtual void dispatchDidClearWindowObjectInWorld(DOMWrapperWorld*) = 0;
264        virtual void documentElementAvailable() = 0;
265        virtual void didPerformFirstNavigation() const = 0; // "Navigation" here means a transition from one page to another that ends up in the back/forward list.
266
267#if USE(V8)
268        virtual void didCreateScriptContextForFrame() = 0;
269        virtual void didDestroyScriptContextForFrame() = 0;
270        virtual void didCreateIsolatedScriptContext() = 0;
271        virtual bool allowScriptExtension(const String& extensionName, int extensionGroup) = 0;
272#endif
273
274        virtual void registerForIconNotification(bool listen = true) = 0;
275#ifdef ANDROID_APPLE_TOUCH_ICON
276        virtual void dispatchDidReceiveTouchIconURL(const String& url, bool precomposed) = 0;
277#endif
278
279#if PLATFORM(MAC)
280        // Allow an accessibility object to retrieve a Frame parent if there's no PlatformWidget.
281        virtual RemoteAXObjectRef accessibilityRemoteObject() = 0;
282#if ENABLE(JAVA_BRIDGE)
283        virtual jobject javaApplet(NSView*) { return 0; }
284#endif
285        virtual NSCachedURLResponse* willCacheResponse(DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const = 0;
286#endif
287#if USE(CFNETWORK)
288        virtual bool shouldCacheResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&, const unsigned char* data, unsigned long long length) = 0;
289#endif
290
291        virtual bool shouldUsePluginDocument(const String& /*mimeType*/) const { return false; }
292        virtual bool shouldLoadMediaElementURL(const KURL&) const { return true; }
293
294        virtual void didChangeScrollOffset() { }
295
296        virtual bool allowJavaScript(bool enabledPerSettings) { return enabledPerSettings; }
297        virtual bool allowPlugins(bool enabledPerSettings) { return enabledPerSettings; }
298        virtual bool allowImages(bool enabledPerSettings) { return enabledPerSettings; }
299
300        // This callback notifies the client that the frame was about to run
301        // JavaScript but did not because allowJavaScript returned false. We
302        // have a separate callback here because there are a number of places
303        // that need to know if JavaScript is enabled but are not necessarily
304        // preparing to execute script.
305        virtual void didNotAllowScript() { }
306        // This callback is similar, but for plugins.
307        virtual void didNotAllowPlugins() { }
308
309        virtual PassRefPtr<FrameNetworkingContext> createNetworkingContext() = 0;
310    };
311
312} // namespace WebCore
313
314#endif // FrameLoaderClient_h
315