FrameLoaderClient.h revision f1c0bbb9bf698154c206e842f94b72d277a96094 
1/*
2 * Copyright (C) 2006, 2007, 2008, 2009 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/Platform.h>
36#include <wtf/Vector.h>
37
38typedef class _jobject* jobject;
39
40#if PLATFORM(MAC) && !defined(__OBJC__)
41class NSCachedURLResponse;
42class NSView;
43#endif
44
45namespace WebCore {
46
47    class AuthenticationChallenge;
48    class CachedFrame;
49    class Color;
50    class DocumentLoader;
51    class Element;
52    class FormState;
53    class Frame;
54    class FrameLoader;
55    class HistoryItem;
56    class HTMLAppletElement;
57    class HTMLFrameOwnerElement;
58    class HTMLPlugInElement;
59    class IntSize;
60    class KURL;
61    class NavigationAction;
62    class ResourceError;
63    class ResourceHandle;
64    class ResourceLoader;
65    struct ResourceRequest;
66    class ResourceResponse;
67    class ScriptString;
68    class SharedBuffer;
69    class SubstituteData;
70    class String;
71    class Widget;
72
73#ifdef ANDROID_HISTORY_CLIENT
74    class BackForwardList;
75#endif
76
77    typedef void (FrameLoader::*FramePolicyFunction)(PolicyAction);
78
79    class FrameLoaderClient {
80    public:
81        // An inline function cannot be the first non-abstract virtual function declared
82        // in the class as it results in the vtable being generated as a weak symbol.
83        // This hurts performance (in Mac OS X at least, when loadig frameworks), so we
84        // don't want to do it in WebKit.
85        virtual bool hasHTMLView() const;
86
87        virtual ~FrameLoaderClient() { }
88
89        virtual void frameLoaderDestroyed() = 0;
90
91        virtual bool hasWebView() const = 0; // mainly for assertions
92
93        virtual void makeRepresentation(DocumentLoader*) = 0;
94        virtual void forceLayout() = 0;
95        virtual void forceLayoutForNonHTML() = 0;
96
97        virtual void setCopiesOnScroll() = 0;
98
99        virtual void detachedFromParent2() = 0;
100        virtual void detachedFromParent3() = 0;
101
102        virtual void assignIdentifierToInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&) = 0;
103
104        virtual void dispatchWillSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse) = 0;
105        virtual bool shouldUseCredentialStorage(DocumentLoader*, unsigned long identifier) = 0;
106        virtual void dispatchDidReceiveAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;
107        virtual void dispatchDidCancelAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;
108        virtual void dispatchDidReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&) = 0;
109        virtual void dispatchDidReceiveContentLength(DocumentLoader*, unsigned long identifier, int lengthReceived) = 0;
110        virtual void dispatchDidFinishLoading(DocumentLoader*, unsigned long identifier) = 0;
111        virtual void dispatchDidFailLoading(DocumentLoader*, unsigned long identifier, const ResourceError&) = 0;
112        virtual bool dispatchDidLoadResourceFromMemoryCache(DocumentLoader*, const ResourceRequest&, const ResourceResponse&, int length) = 0;
113        virtual void dispatchDidLoadResourceByXMLHttpRequest(unsigned long identifier, const ScriptString&) = 0;
114
115        virtual void dispatchDidHandleOnloadEvents() = 0;
116        virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() = 0;
117        virtual void dispatchDidCancelClientRedirect() = 0;
118        virtual void dispatchWillPerformClientRedirect(const KURL&, double interval, double fireDate) = 0;
119        virtual void dispatchDidChangeLocationWithinPage() = 0;
120        virtual void dispatchWillClose() = 0;
121        virtual void dispatchDidReceiveIcon() = 0;
122        virtual void dispatchDidStartProvisionalLoad() = 0;
123        virtual void dispatchDidReceiveTitle(const String& title) = 0;
124        virtual void dispatchDidCommitLoad() = 0;
125        virtual void dispatchDidFailProvisionalLoad(const ResourceError&) = 0;
126        virtual void dispatchDidFailLoad(const ResourceError&) = 0;
127        virtual void dispatchDidFinishDocumentLoad() = 0;
128        virtual void dispatchDidFinishLoad() = 0;
129        virtual void dispatchDidFirstLayout() = 0;
130        virtual void dispatchDidFirstVisuallyNonEmptyLayout() = 0;
131
132        virtual Frame* dispatchCreatePage() = 0;
133        virtual void dispatchShow() = 0;
134
135        virtual void dispatchDecidePolicyForMIMEType(FramePolicyFunction, const String& MIMEType, const ResourceRequest&) = 0;
136        virtual void dispatchDecidePolicyForNewWindowAction(FramePolicyFunction, const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>, const String& frameName) = 0;
137        virtual void dispatchDecidePolicyForNavigationAction(FramePolicyFunction, const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>) = 0;
138        virtual void cancelPolicyCheck() = 0;
139
140        virtual void dispatchUnableToImplementPolicy(const ResourceError&) = 0;
141
142        virtual void dispatchWillSubmitForm(FramePolicyFunction, PassRefPtr<FormState>) = 0;
143
144        virtual void dispatchDidLoadMainResource(DocumentLoader*) = 0;
145        virtual void revertToProvisionalState(DocumentLoader*) = 0;
146        virtual void setMainDocumentError(DocumentLoader*, const ResourceError&) = 0;
147
148        // Maybe these should go into a ProgressTrackerClient some day
149        virtual void willChangeEstimatedProgress() { }
150        virtual void didChangeEstimatedProgress() { }
151        virtual void postProgressStartedNotification() = 0;
152        virtual void postProgressEstimateChangedNotification() = 0;
153        virtual void postProgressFinishedNotification() = 0;
154
155        virtual void setMainFrameDocumentReady(bool) = 0;
156
157        virtual void startDownload(const ResourceRequest&) = 0;
158
159        virtual void willChangeTitle(DocumentLoader*) = 0;
160        virtual void didChangeTitle(DocumentLoader*) = 0;
161
162        virtual void committedLoad(DocumentLoader*, const char*, int) = 0;
163        virtual void finishedLoading(DocumentLoader*) = 0;
164
165        virtual void updateGlobalHistory() = 0;
166        virtual void updateGlobalHistoryRedirectLinks() = 0;
167
168        virtual bool shouldGoToHistoryItem(HistoryItem*) const = 0;
169#ifdef ANDROID_HISTORY_CLIENT
170        virtual void dispatchDidAddHistoryItem(HistoryItem*) const = 0;
171        virtual void dispatchDidRemoveHistoryItem(HistoryItem*, int) const = 0;
172        virtual void dispatchDidChangeHistoryIndex(BackForwardList*) const = 0;
173#endif
174
175        virtual ResourceError cancelledError(const ResourceRequest&) = 0;
176        virtual ResourceError blockedError(const ResourceRequest&) = 0;
177        virtual ResourceError cannotShowURLError(const ResourceRequest&) = 0;
178        virtual ResourceError interruptForPolicyChangeError(const ResourceRequest&) = 0;
179
180        virtual ResourceError cannotShowMIMETypeError(const ResourceResponse&) = 0;
181        virtual ResourceError fileDoesNotExistError(const ResourceResponse&) = 0;
182        virtual ResourceError pluginWillHandleLoadError(const ResourceResponse&) = 0;
183
184        virtual bool shouldFallBack(const ResourceError&) = 0;
185
186        virtual bool canHandleRequest(const ResourceRequest&) const = 0;
187        virtual bool canShowMIMEType(const String& MIMEType) const = 0;
188        virtual bool representationExistsForURLScheme(const String& URLScheme) const = 0;
189        virtual String generatedMIMETypeForURLScheme(const String& URLScheme) const = 0;
190
191        virtual void frameLoadCompleted() = 0;
192        virtual void saveViewStateToItem(HistoryItem*) = 0;
193        virtual void restoreViewState() = 0;
194        virtual void provisionalLoadStarted() = 0;
195        virtual void didFinishLoad() = 0;
196        virtual void prepareForDataSourceReplacement() = 0;
197
198        virtual PassRefPtr<DocumentLoader> createDocumentLoader(const ResourceRequest&, const SubstituteData&) = 0;
199        virtual void setTitle(const String& title, const KURL&) = 0;
200
201        virtual String userAgent(const KURL&) = 0;
202
203        virtual void savePlatformDataToCachedFrame(CachedFrame*) = 0;
204        virtual void transitionToCommittedFromCachedFrame(CachedFrame*) = 0;
205        virtual void transitionToCommittedForNewPage() = 0;
206
207        virtual bool canCachePage() const = 0;
208        virtual void download(ResourceHandle*, const ResourceRequest&, const ResourceRequest&, const ResourceResponse&) = 0;
209
210        virtual PassRefPtr<Frame> createFrame(const KURL& url, const String& name, HTMLFrameOwnerElement* ownerElement,
211                                   const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) = 0;
212        virtual Widget* createPlugin(const IntSize&, HTMLPlugInElement*, const KURL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) = 0;
213        virtual void redirectDataToPlugin(Widget* pluginWidget) = 0;
214
215        virtual Widget* createJavaAppletWidget(const IntSize&, HTMLAppletElement*, const KURL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) = 0;
216
217        virtual ObjectContentType objectContentType(const KURL& url, const String& mimeType) = 0;
218        virtual String overrideMediaType() const = 0;
219
220        virtual void windowObjectCleared() = 0;
221        virtual void documentElementAvailable() = 0;
222        virtual void didPerformFirstNavigation() const = 0; // "Navigation" here means a transition from one page to another that ends up in the back/forward list.
223
224        virtual void registerForIconNotification(bool listen = true) = 0;
225#ifdef ANDROID_APPLE_TOUCH_ICON
226        virtual void dispatchDidReceiveTouchIconURL(const String& url) = 0;
227#endif
228
229#if PLATFORM(MAC)
230#if ENABLE(MAC_JAVA_BRIDGE)
231        virtual jobject javaApplet(NSView*) { return 0; }
232#endif
233        virtual NSCachedURLResponse* willCacheResponse(DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const = 0;
234#endif
235#if USE(CFNETWORK)
236        virtual bool shouldCacheResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&, const unsigned char* data, unsigned long long length) = 0;
237#endif
238
239        virtual bool shouldUsePluginDocument(const String& /*mimeType*/) const { return false; }
240    };
241
242} // namespace WebCore
243
244#endif // FrameLoaderClient_h
245