Remove an unneeded argument from FrameLoaderClient::download
[WebKit-https.git] / Source / WebKit2 / WebProcess / WebCoreSupport / WebFrameLoaderClient.h
1 /*
2  * Copyright (C) 2010, 2011 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef WebFrameLoaderClient_h
27 #define WebFrameLoaderClient_h
28
29 #include <WebCore/FrameLoaderClient.h>
30
31 namespace WebKit {
32
33 class PluginView;
34 class WebFrame;
35     
36 class WebFrameLoaderClient : public WebCore::FrameLoaderClient {
37 public:
38     WebFrameLoaderClient(WebFrame*);
39     ~WebFrameLoaderClient();
40
41     WebFrame* webFrame() const { return m_frame; }
42
43     bool frameHasCustomRepresentation() const { return m_frameHasCustomRepresentation; }
44
45 private:
46     virtual void frameLoaderDestroyed() OVERRIDE;
47
48     virtual bool hasHTMLView() const OVERRIDE;
49     virtual bool hasWebView() const OVERRIDE;
50     
51     virtual void makeRepresentation(WebCore::DocumentLoader*) OVERRIDE;
52     virtual void forceLayout() OVERRIDE;
53     virtual void forceLayoutForNonHTML() OVERRIDE;
54     
55     virtual void setCopiesOnScroll() OVERRIDE;
56     
57     virtual void detachedFromParent2() OVERRIDE;
58     virtual void detachedFromParent3() OVERRIDE;
59     
60     virtual void assignIdentifierToInitialRequest(unsigned long identifier, WebCore::DocumentLoader*, const WebCore::ResourceRequest&) OVERRIDE;
61     
62     virtual void dispatchWillSendRequest(WebCore::DocumentLoader*, unsigned long identifier, WebCore::ResourceRequest&, const WebCore::ResourceResponse& redirectResponse) OVERRIDE;
63     virtual bool shouldUseCredentialStorage(WebCore::DocumentLoader*, unsigned long identifier) OVERRIDE;
64     virtual void dispatchDidReceiveAuthenticationChallenge(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::AuthenticationChallenge&) OVERRIDE;
65     virtual void dispatchDidCancelAuthenticationChallenge(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::AuthenticationChallenge&) OVERRIDE;
66 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
67     virtual bool canAuthenticateAgainstProtectionSpace(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ProtectionSpace&) OVERRIDE;
68 #endif
69     virtual void dispatchDidReceiveResponse(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceResponse&) OVERRIDE;
70     virtual void dispatchDidReceiveContentLength(WebCore::DocumentLoader*, unsigned long identifier, int dataLength) OVERRIDE;
71     virtual void dispatchDidFinishLoading(WebCore::DocumentLoader*, unsigned long identifier) OVERRIDE;
72     virtual void dispatchDidFailLoading(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceError&) OVERRIDE;
73     virtual bool dispatchDidLoadResourceFromMemoryCache(WebCore::DocumentLoader*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&, int length) OVERRIDE;
74     
75     virtual void dispatchDidHandleOnloadEvents() OVERRIDE;
76     virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() OVERRIDE;
77     virtual void dispatchDidCancelClientRedirect() OVERRIDE;
78     virtual void dispatchWillPerformClientRedirect(const WebCore::KURL&, double interval, double fireDate) OVERRIDE;
79     virtual void dispatchDidChangeLocationWithinPage() OVERRIDE;
80     virtual void dispatchDidPushStateWithinPage() OVERRIDE;
81     virtual void dispatchDidReplaceStateWithinPage() OVERRIDE;
82     virtual void dispatchDidPopStateWithinPage() OVERRIDE;
83     virtual void dispatchWillClose() OVERRIDE;
84     virtual void dispatchDidReceiveIcon() OVERRIDE;
85     virtual void dispatchDidStartProvisionalLoad() OVERRIDE;
86     virtual void dispatchDidReceiveTitle(const WebCore::StringWithDirection&) OVERRIDE;
87     virtual void dispatchDidChangeIcons(WebCore::IconType) OVERRIDE;
88     virtual void dispatchDidCommitLoad() OVERRIDE;
89     virtual void dispatchDidFailProvisionalLoad(const WebCore::ResourceError&) OVERRIDE;
90     virtual void dispatchDidFailLoad(const WebCore::ResourceError&) OVERRIDE;
91     virtual void dispatchDidFinishDocumentLoad() OVERRIDE;
92     virtual void dispatchDidFinishLoad() OVERRIDE;
93
94     virtual void dispatchDidFirstLayout() OVERRIDE;
95     virtual void dispatchDidFirstVisuallyNonEmptyLayout() OVERRIDE;
96     virtual void dispatchDidLayout() OVERRIDE;
97
98     virtual WebCore::Frame* dispatchCreatePage(const WebCore::NavigationAction&) OVERRIDE;
99     virtual void dispatchShow() OVERRIDE;
100     
101     virtual void dispatchDecidePolicyForResponse(WebCore::FramePolicyFunction, const WebCore::ResourceResponse&, const WebCore::ResourceRequest&) OVERRIDE;
102     virtual void dispatchDecidePolicyForNewWindowAction(WebCore::FramePolicyFunction, const WebCore::NavigationAction&, const WebCore::ResourceRequest&, PassRefPtr<WebCore::FormState>, const String& frameName) OVERRIDE;
103     virtual void dispatchDecidePolicyForNavigationAction(WebCore::FramePolicyFunction, const WebCore::NavigationAction&, const WebCore::ResourceRequest&, PassRefPtr<WebCore::FormState>) OVERRIDE;
104     virtual void cancelPolicyCheck() OVERRIDE;
105     
106     virtual void dispatchUnableToImplementPolicy(const WebCore::ResourceError&) OVERRIDE;
107     
108     virtual void dispatchWillSendSubmitEvent(WebCore::HTMLFormElement*) OVERRIDE { }
109     virtual void dispatchWillSubmitForm(WebCore::FramePolicyFunction, PassRefPtr<WebCore::FormState>) OVERRIDE;
110     
111     virtual void dispatchDidLoadMainResource(WebCore::DocumentLoader*) OVERRIDE;
112     virtual void revertToProvisionalState(WebCore::DocumentLoader*) OVERRIDE;
113     virtual void setMainDocumentError(WebCore::DocumentLoader*, const WebCore::ResourceError&) OVERRIDE;
114     
115     // Maybe these should go into a ProgressTrackerClient some day
116     virtual void willChangeEstimatedProgress() OVERRIDE;
117     virtual void didChangeEstimatedProgress() OVERRIDE;
118     virtual void postProgressStartedNotification() OVERRIDE;
119     virtual void postProgressEstimateChangedNotification() OVERRIDE;
120     virtual void postProgressFinishedNotification() OVERRIDE;
121     
122     virtual void setMainFrameDocumentReady(bool) OVERRIDE;
123     
124     virtual void startDownload(const WebCore::ResourceRequest&, const String& suggestedName = String()) OVERRIDE;
125     
126     virtual void willChangeTitle(WebCore::DocumentLoader*) OVERRIDE;
127     virtual void didChangeTitle(WebCore::DocumentLoader*) OVERRIDE;
128     
129     virtual void committedLoad(WebCore::DocumentLoader*, const char*, int) OVERRIDE;
130     virtual void finishedLoading(WebCore::DocumentLoader*) OVERRIDE;
131     
132     virtual void updateGlobalHistory() OVERRIDE;
133     virtual void updateGlobalHistoryRedirectLinks() OVERRIDE;
134     
135     virtual bool shouldGoToHistoryItem(WebCore::HistoryItem*) const OVERRIDE;
136     virtual bool shouldStopLoadingForHistoryItem(WebCore::HistoryItem*) const OVERRIDE;
137
138     virtual void didDisplayInsecureContent() OVERRIDE;
139     virtual void didRunInsecureContent(WebCore::SecurityOrigin*, const WebCore::KURL&) OVERRIDE;
140     virtual void didDetectXSS(const WebCore::KURL&, bool didBlockEntirePage) OVERRIDE;
141
142     virtual WebCore::ResourceError cancelledError(const WebCore::ResourceRequest&) OVERRIDE;
143     virtual WebCore::ResourceError blockedError(const WebCore::ResourceRequest&) OVERRIDE;
144     virtual WebCore::ResourceError cannotShowURLError(const WebCore::ResourceRequest&) OVERRIDE;
145     virtual WebCore::ResourceError interruptedForPolicyChangeError(const WebCore::ResourceRequest&) OVERRIDE;
146     
147     virtual WebCore::ResourceError cannotShowMIMETypeError(const WebCore::ResourceResponse&) OVERRIDE;
148     virtual WebCore::ResourceError fileDoesNotExistError(const WebCore::ResourceResponse&) OVERRIDE;
149     virtual WebCore::ResourceError pluginWillHandleLoadError(const WebCore::ResourceResponse&) OVERRIDE;
150     
151     virtual bool shouldFallBack(const WebCore::ResourceError&) OVERRIDE;
152     
153     virtual bool canHandleRequest(const WebCore::ResourceRequest&) const OVERRIDE;
154     virtual bool canShowMIMEType(const String& MIMEType) const OVERRIDE;
155     virtual bool canShowMIMETypeAsHTML(const String& MIMEType) const OVERRIDE;
156     virtual bool representationExistsForURLScheme(const String& URLScheme) const OVERRIDE;
157     virtual String generatedMIMETypeForURLScheme(const String& URLScheme) const OVERRIDE;
158     
159     virtual void frameLoadCompleted() OVERRIDE;
160     virtual void saveViewStateToItem(WebCore::HistoryItem*) OVERRIDE;
161     virtual void restoreViewState() OVERRIDE;
162     virtual void provisionalLoadStarted() OVERRIDE;
163     virtual void didFinishLoad() OVERRIDE;
164     virtual void prepareForDataSourceReplacement() OVERRIDE;
165     
166     virtual PassRefPtr<WebCore::DocumentLoader> createDocumentLoader(const WebCore::ResourceRequest&, const WebCore::SubstituteData&);
167     virtual void setTitle(const WebCore::StringWithDirection&, const WebCore::KURL&) OVERRIDE;
168     
169     virtual String userAgent(const WebCore::KURL&) OVERRIDE;
170     
171     virtual void savePlatformDataToCachedFrame(WebCore::CachedFrame*) OVERRIDE;
172     virtual void transitionToCommittedFromCachedFrame(WebCore::CachedFrame*) OVERRIDE;
173     virtual void transitionToCommittedForNewPage() OVERRIDE;
174
175     virtual void didSaveToPageCache() OVERRIDE;
176     virtual void didRestoreFromPageCache() OVERRIDE;
177
178     virtual void dispatchDidBecomeFrameset(bool) OVERRIDE;
179
180     virtual bool canCachePage() const OVERRIDE;
181     virtual void download(WebCore::ResourceHandle*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&) OVERRIDE;
182     
183     virtual PassRefPtr<WebCore::Frame> createFrame(const WebCore::KURL& url, const String& name, WebCore::HTMLFrameOwnerElement* ownerElement,
184                                           const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) OVERRIDE;
185     virtual void didTransferChildFrameToNewDocument(WebCore::Page*) OVERRIDE;
186     virtual void transferLoadingResourceFromPage(WebCore::ResourceLoader*, const WebCore::ResourceRequest&, WebCore::Page*) OVERRIDE;
187     
188     virtual PassRefPtr<WebCore::Widget> createPlugin(const WebCore::IntSize&, WebCore::HTMLPlugInElement*, const WebCore::KURL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) OVERRIDE;
189     virtual void redirectDataToPlugin(WebCore::Widget* pluginWidget) OVERRIDE;
190     
191     virtual PassRefPtr<WebCore::Widget> createJavaAppletWidget(const WebCore::IntSize&, WebCore::HTMLAppletElement*, const WebCore::KURL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) OVERRIDE;
192     
193     virtual WebCore::ObjectContentType objectContentType(const WebCore::KURL&, const String& mimeType, bool shouldPreferPlugInsForImages) OVERRIDE;
194     virtual String overrideMediaType() const OVERRIDE;
195
196     virtual void dispatchDidClearWindowObjectInWorld(WebCore::DOMWrapperWorld*) OVERRIDE;
197
198     virtual void documentElementAvailable() OVERRIDE;
199     virtual void didPerformFirstNavigation() const OVERRIDE; // "Navigation" here means a transition from one page to another that ends up in the back/forward list.
200     
201     virtual void registerForIconNotification(bool listen = true) OVERRIDE;
202     
203 #if PLATFORM(MAC)
204     virtual RemoteAXObjectRef accessibilityRemoteObject() OVERRIDE;
205     
206 #if ENABLE(MAC_JAVA_BRIDGE)
207     virtual jobject javaApplet(NSView*) OVERRIDE;
208 #endif
209     virtual NSCachedURLResponse* willCacheResponse(WebCore::DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const OVERRIDE;
210 #endif
211 #if PLATFORM(WIN) && USE(CFNETWORK)
212     // FIXME: Windows should use willCacheResponse - <https://bugs.webkit.org/show_bug.cgi?id=57257>.
213     virtual bool shouldCacheResponse(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceResponse&, const unsigned char* data, unsigned long long length) OVERRIDE;
214 #endif
215     
216     virtual bool shouldUsePluginDocument(const String& /*mimeType*/) const OVERRIDE;
217
218     virtual void didChangeScrollOffset() OVERRIDE;
219
220     virtual PassRefPtr<WebCore::FrameNetworkingContext> createNetworkingContext() OVERRIDE;
221
222     WebFrame* m_frame;
223     RefPtr<PluginView> m_pluginView;
224     bool m_hasSentResponseToPluginView;
225     bool m_frameHasCustomRepresentation;
226 };
227
228 } // namespace WebKit
229
230 #endif // WebFrameLoaderClient_h