Reviewed by Maciej
[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 "FrameLoaderTypes.h"
32 #include "StringHash.h"
33 #include <wtf/Forward.h>
34 #include <wtf/Platform.h>
35
36 namespace WebCore {
37
38     class AuthenticationChallenge;
39     class DocumentLoader;
40     class Element;
41     class FormState;
42     class Frame;
43     class FrameLoader;
44     class HistoryItem;
45     class HTMLFrameOwnerElement;
46     class IntSize;
47     class KURL;
48     class NavigationAction;
49     class PageCache;
50     class ResourceError;
51     class ResourceHandle;
52     class ResourceLoader;
53     class ResourceRequest;
54     class ResourceResponse;
55     class String;
56     class Widget;
57
58     typedef void (FrameLoader::*FramePolicyFunction)(PolicyAction);
59
60     class FrameLoaderClient {
61     public:
62         virtual ~FrameLoaderClient() {  }
63         virtual void frameLoaderDestroyed() = 0;
64         
65         virtual bool hasWebView() const = 0; // mainly for assertions
66         virtual bool hasFrameView() const = 0; // ditto
67
68         virtual bool privateBrowsingEnabled() const = 0;
69
70         virtual void makeDocumentView() = 0;
71         virtual void makeRepresentation(DocumentLoader*) = 0;
72         virtual void setDocumentViewFromPageCache(PageCache*) = 0;
73         virtual void forceLayout() = 0;
74         virtual void forceLayoutForNonHTML() = 0;
75
76         virtual void setCopiesOnScroll() = 0;
77
78         virtual void detachedFromParent2() = 0;
79         virtual void detachedFromParent3() = 0;
80         virtual void detachedFromParent4() = 0;
81
82         virtual void loadedFromPageCache() = 0;
83
84         virtual void assignIdentifierToInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&) = 0;
85
86         virtual void dispatchWillSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse) = 0;
87         virtual void dispatchDidReceiveAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;
88         virtual void dispatchDidCancelAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;        
89         virtual void dispatchDidReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&) = 0;
90         virtual void dispatchDidReceiveContentLength(DocumentLoader*, unsigned long identifier, int lengthReceived) = 0;
91         virtual void dispatchDidFinishLoading(DocumentLoader*, unsigned long identifier) = 0;
92         virtual void dispatchDidFailLoading(DocumentLoader*, unsigned long identifier, const ResourceError&) = 0;
93         virtual bool dispatchDidLoadResourceFromMemoryCache(DocumentLoader*, const ResourceRequest&, const ResourceResponse&, int length) = 0;
94
95         virtual void dispatchDidHandleOnloadEvents() = 0;
96         virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() = 0;
97         virtual void dispatchDidCancelClientRedirect() = 0;
98         virtual void dispatchWillPerformClientRedirect(const KURL&, double interval, double fireDate) = 0;
99         virtual void dispatchDidChangeLocationWithinPage() = 0;
100         virtual void dispatchWillClose() = 0;
101         virtual void dispatchDidReceiveIcon() = 0;
102         virtual void dispatchDidStartProvisionalLoad() = 0;
103         virtual void dispatchDidReceiveTitle(const String& title) = 0;
104         virtual void dispatchDidCommitLoad() = 0;
105         virtual void dispatchDidFailProvisionalLoad(const ResourceError&) = 0;
106         virtual void dispatchDidFailLoad(const ResourceError&) = 0;
107         virtual void dispatchDidFinishDocumentLoad() = 0;
108         virtual void dispatchDidFinishLoad() = 0;
109         virtual void dispatchDidFirstLayout() = 0;
110
111         virtual Frame* dispatchCreatePage() = 0;
112         virtual void dispatchShow() = 0;
113
114         virtual void dispatchDecidePolicyForMIMEType(FramePolicyFunction, const String& MIMEType, const ResourceRequest&) = 0;
115         virtual void dispatchDecidePolicyForNewWindowAction(FramePolicyFunction, const NavigationAction&, const ResourceRequest&, const String& frameName) = 0;
116         virtual void dispatchDecidePolicyForNavigationAction(FramePolicyFunction, const NavigationAction&, const ResourceRequest&) = 0;
117         virtual void cancelPolicyCheck() = 0;
118
119         virtual void dispatchUnableToImplementPolicy(const ResourceError&) = 0;
120
121         virtual void dispatchWillSubmitForm(FramePolicyFunction, PassRefPtr<FormState>) = 0;
122
123         virtual void dispatchDidLoadMainResource(DocumentLoader*) = 0;
124         virtual void revertToProvisionalState(DocumentLoader*) = 0;
125         virtual void setMainDocumentError(DocumentLoader*, const ResourceError&) = 0;
126         virtual void clearUnarchivingState(DocumentLoader*) = 0;
127
128         // Maybe these should go into a ProgressTrackerClient some day
129         virtual void willChangeEstimatedProgress() { }
130         virtual void didChangeEstimatedProgress() { }
131         virtual void postProgressStartedNotification() = 0;
132         virtual void postProgressEstimateChangedNotification() = 0;
133         virtual void postProgressFinishedNotification() = 0;
134         
135         virtual void setMainFrameDocumentReady(bool) = 0;
136
137         virtual void startDownload(const ResourceRequest&) = 0;
138
139         virtual void willChangeTitle(DocumentLoader*) = 0;
140         virtual void didChangeTitle(DocumentLoader*) = 0;
141
142         virtual void committedLoad(DocumentLoader*, const char*, int) = 0;
143         virtual void finishedLoading(DocumentLoader*) = 0;
144         virtual void finalSetupForReplace(DocumentLoader*) = 0;
145         
146         virtual void updateGlobalHistoryForStandardLoad(const KURL&) = 0;
147         virtual void updateGlobalHistoryForReload(const KURL&) = 0;
148         virtual bool shouldGoToHistoryItem(HistoryItem*) const = 0;
149
150         virtual ResourceError cancelledError(const ResourceRequest&) = 0;
151         virtual ResourceError cannotShowURLError(const ResourceRequest&) = 0;
152         virtual ResourceError interruptForPolicyChangeError(const ResourceRequest&) = 0;
153
154         virtual ResourceError cannotShowMIMETypeError(const ResourceResponse&) = 0;
155         virtual ResourceError fileDoesNotExistError(const ResourceResponse&) = 0;
156
157         virtual bool shouldFallBack(const ResourceError&) = 0;
158
159         virtual void setDefersLoading(bool) = 0;
160
161         virtual bool willUseArchive(ResourceLoader*, const ResourceRequest&, const KURL& originalURL) const = 0;
162         virtual bool isArchiveLoadPending(ResourceLoader*) const = 0;
163         virtual void cancelPendingArchiveLoad(ResourceLoader*) = 0;
164         virtual void clearArchivedResources() = 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 saveScrollPositionAndViewStateToItem(HistoryItem*) = 0;
173         virtual void restoreScrollPositionAndViewState() = 0;
174         virtual void provisionalLoadStarted() = 0;
175         virtual void didFinishLoad() = 0;
176         virtual void prepareForDataSourceReplacement() = 0;
177
178         virtual PassRefPtr<WebCore::DocumentLoader> createDocumentLoader(const WebCore::ResourceRequest&) = 0;
179         virtual void setTitle(const String& title, const KURL&) = 0;
180
181         virtual String userAgent() = 0;
182         
183         virtual void saveDocumentViewToPageCache(PageCache*) = 0;
184         virtual bool canCachePage() const = 0;
185         virtual void download(ResourceHandle*, const ResourceRequest&, const ResourceResponse&) = 0;
186
187         virtual Frame* createFrame(const KURL& url, const String& name, HTMLFrameOwnerElement* ownerElement,
188                                    const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) = 0;
189         virtual Widget* createPlugin(Element*, const KURL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) = 0;
190         virtual void redirectDataToPlugin(Widget* pluginWidget) = 0;
191         
192         virtual Widget* createJavaAppletWidget(const IntSize&, Element*, const KURL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) = 0;
193
194         virtual ObjectContentType objectContentType(const KURL& url, const String& mimeType) = 0;
195         virtual String overrideMediaType() const = 0;
196
197         virtual void windowObjectCleared() const = 0;
198     };
199
200 } // namespace WebCore
201
202 #endif // FrameLoaderClient_h