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