2 * Copyright (C) 2010, 2011 Apple Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
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.
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.
26 #ifndef WebFrameLoaderClient_h
27 #define WebFrameLoaderClient_h
29 #include <WebCore/FrameLoaderClient.h>
36 class WebFrameLoaderClient : public WebCore::FrameLoaderClient {
38 WebFrameLoaderClient(WebFrame*);
39 ~WebFrameLoaderClient();
41 WebFrame* webFrame() const { return m_frame; }
43 bool frameHasCustomRepresentation() const { return m_frameHasCustomRepresentation; }
46 virtual void frameLoaderDestroyed();
48 virtual bool hasHTMLView() const;
49 virtual bool hasWebView() const;
51 virtual void makeRepresentation(WebCore::DocumentLoader*);
52 virtual void forceLayout();
53 virtual void forceLayoutForNonHTML();
55 virtual void setCopiesOnScroll();
57 virtual void detachedFromParent2();
58 virtual void detachedFromParent3();
60 virtual void assignIdentifierToInitialRequest(unsigned long identifier, WebCore::DocumentLoader*, const WebCore::ResourceRequest&);
62 virtual void dispatchWillSendRequest(WebCore::DocumentLoader*, unsigned long identifier, WebCore::ResourceRequest&, const WebCore::ResourceResponse& redirectResponse);
63 virtual bool shouldUseCredentialStorage(WebCore::DocumentLoader*, unsigned long identifier);
64 virtual void dispatchDidReceiveAuthenticationChallenge(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::AuthenticationChallenge&);
65 virtual void dispatchDidCancelAuthenticationChallenge(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::AuthenticationChallenge&);
66 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
67 virtual bool canAuthenticateAgainstProtectionSpace(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ProtectionSpace&);
69 virtual void dispatchDidReceiveResponse(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceResponse&);
70 virtual void dispatchDidReceiveContentLength(WebCore::DocumentLoader*, unsigned long identifier, int dataLength);
71 virtual void dispatchDidFinishLoading(WebCore::DocumentLoader*, unsigned long identifier);
72 virtual void dispatchDidFailLoading(WebCore::DocumentLoader*, unsigned long identifier, const WebCore::ResourceError&);
73 virtual bool dispatchDidLoadResourceFromMemoryCache(WebCore::DocumentLoader*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&, int length);
74 virtual void dispatchDidLoadResourceByXMLHttpRequest(unsigned long identifier, const WTF::String&);
76 virtual void dispatchDidHandleOnloadEvents();
77 virtual void dispatchDidReceiveServerRedirectForProvisionalLoad();
78 virtual void dispatchDidCancelClientRedirect();
79 virtual void dispatchWillPerformClientRedirect(const WebCore::KURL&, double interval, double fireDate);
80 virtual void dispatchDidChangeLocationWithinPage();
81 virtual void dispatchDidPushStateWithinPage();
82 virtual void dispatchDidReplaceStateWithinPage();
83 virtual void dispatchDidPopStateWithinPage();
84 virtual void dispatchWillClose();
85 virtual void dispatchDidReceiveIcon();
86 virtual void dispatchDidStartProvisionalLoad();
87 virtual void dispatchDidReceiveTitle(const WebCore::StringWithDirection&);
88 virtual void dispatchDidChangeIcons(WebCore::IconType);
89 virtual void dispatchDidCommitLoad();
90 virtual void dispatchDidFailProvisionalLoad(const WebCore::ResourceError&);
91 virtual void dispatchDidFailLoad(const WebCore::ResourceError&);
92 virtual void dispatchDidFinishDocumentLoad();
93 virtual void dispatchDidFinishLoad();
95 virtual void dispatchDidFirstLayout();
96 virtual void dispatchDidFirstVisuallyNonEmptyLayout();
97 virtual void dispatchDidLayout();
99 virtual WebCore::Frame* dispatchCreatePage(const WebCore::NavigationAction&);
100 virtual void dispatchShow();
102 virtual void dispatchDecidePolicyForResponse(WebCore::FramePolicyFunction, const WebCore::ResourceResponse&, const WebCore::ResourceRequest&);
103 virtual void dispatchDecidePolicyForNewWindowAction(WebCore::FramePolicyFunction, const WebCore::NavigationAction&, const WebCore::ResourceRequest&, PassRefPtr<WebCore::FormState>, const String& frameName);
104 virtual void dispatchDecidePolicyForNavigationAction(WebCore::FramePolicyFunction, const WebCore::NavigationAction&, const WebCore::ResourceRequest&, PassRefPtr<WebCore::FormState>);
105 virtual void cancelPolicyCheck();
107 virtual void dispatchUnableToImplementPolicy(const WebCore::ResourceError&);
109 virtual void dispatchWillSendSubmitEvent(WebCore::HTMLFormElement*) { }
110 virtual void dispatchWillSubmitForm(WebCore::FramePolicyFunction, PassRefPtr<WebCore::FormState>);
112 virtual void dispatchDidLoadMainResource(WebCore::DocumentLoader*);
113 virtual void revertToProvisionalState(WebCore::DocumentLoader*);
114 virtual void setMainDocumentError(WebCore::DocumentLoader*, const WebCore::ResourceError&);
116 // Maybe these should go into a ProgressTrackerClient some day
117 virtual void willChangeEstimatedProgress();
118 virtual void didChangeEstimatedProgress();
119 virtual void postProgressStartedNotification();
120 virtual void postProgressEstimateChangedNotification();
121 virtual void postProgressFinishedNotification();
123 virtual void setMainFrameDocumentReady(bool);
125 virtual void startDownload(const WebCore::ResourceRequest&, const String& suggestedName = String());
127 virtual void willChangeTitle(WebCore::DocumentLoader*);
128 virtual void didChangeTitle(WebCore::DocumentLoader*);
130 virtual void committedLoad(WebCore::DocumentLoader*, const char*, int);
131 virtual void finishedLoading(WebCore::DocumentLoader*);
133 virtual void updateGlobalHistory();
134 virtual void updateGlobalHistoryRedirectLinks();
136 virtual bool shouldGoToHistoryItem(WebCore::HistoryItem*) const;
137 virtual bool shouldStopLoadingForHistoryItem(WebCore::HistoryItem*) const;
139 virtual void didDisplayInsecureContent();
140 virtual void didRunInsecureContent(WebCore::SecurityOrigin*, const WebCore::KURL&);
142 virtual WebCore::ResourceError cancelledError(const WebCore::ResourceRequest&);
143 virtual WebCore::ResourceError blockedError(const WebCore::ResourceRequest&);
144 virtual WebCore::ResourceError cannotShowURLError(const WebCore::ResourceRequest&);
145 virtual WebCore::ResourceError interruptedForPolicyChangeError(const WebCore::ResourceRequest&);
147 virtual WebCore::ResourceError cannotShowMIMETypeError(const WebCore::ResourceResponse&);
148 virtual WebCore::ResourceError fileDoesNotExistError(const WebCore::ResourceResponse&);
149 virtual WebCore::ResourceError pluginWillHandleLoadError(const WebCore::ResourceResponse&);
151 virtual bool shouldFallBack(const WebCore::ResourceError&);
153 virtual bool canHandleRequest(const WebCore::ResourceRequest&) const;
154 virtual bool canShowMIMEType(const String& MIMEType) const;
155 virtual bool canShowMIMETypeAsHTML(const String& MIMEType) const;
156 virtual bool representationExistsForURLScheme(const String& URLScheme) const;
157 virtual String generatedMIMETypeForURLScheme(const String& URLScheme) const;
159 virtual void frameLoadCompleted();
160 virtual void saveViewStateToItem(WebCore::HistoryItem*);
161 virtual void restoreViewState();
162 virtual void provisionalLoadStarted();
163 virtual void didFinishLoad();
164 virtual void prepareForDataSourceReplacement();
166 virtual PassRefPtr<WebCore::DocumentLoader> createDocumentLoader(const WebCore::ResourceRequest&, const WebCore::SubstituteData&);
167 virtual void setTitle(const WebCore::StringWithDirection&, const WebCore::KURL&);
169 virtual String userAgent(const WebCore::KURL&);
171 virtual void savePlatformDataToCachedFrame(WebCore::CachedFrame*);
172 virtual void transitionToCommittedFromCachedFrame(WebCore::CachedFrame*);
173 virtual void transitionToCommittedForNewPage();
175 virtual void didSaveToPageCache();
176 virtual void didRestoreFromPageCache();
178 virtual void dispatchDidBecomeFrameset(bool);
180 virtual bool canCachePage() const;
181 virtual void download(WebCore::ResourceHandle*, const WebCore::ResourceRequest&, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&);
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);
185 virtual void didTransferChildFrameToNewDocument(WebCore::Page*);
186 virtual void transferLoadingResourceFromPage(WebCore::ResourceLoader*, const WebCore::ResourceRequest&, WebCore::Page*);
188 virtual PassRefPtr<WebCore::Widget> createPlugin(const WebCore::IntSize&, WebCore::HTMLPlugInElement*, const WebCore::KURL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually);
189 virtual void redirectDataToPlugin(WebCore::Widget* pluginWidget);
191 virtual PassRefPtr<WebCore::Widget> createJavaAppletWidget(const WebCore::IntSize&, WebCore::HTMLAppletElement*, const WebCore::KURL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues);
193 virtual WebCore::ObjectContentType objectContentType(const WebCore::KURL&, const String& mimeType, bool shouldPreferPlugInsForImages);
194 virtual String overrideMediaType() const;
196 virtual void dispatchDidClearWindowObjectInWorld(WebCore::DOMWrapperWorld*);
198 virtual void documentElementAvailable();
199 virtual void didPerformFirstNavigation() const; // "Navigation" here means a transition from one page to another that ends up in the back/forward list.
201 virtual void registerForIconNotification(bool listen = true);
204 virtual RemoteAXObjectRef accessibilityRemoteObject();
206 #if ENABLE(MAC_JAVA_BRIDGE)
207 virtual jobject javaApplet(NSView*);
209 virtual NSCachedURLResponse* willCacheResponse(WebCore::DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const;
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);
216 virtual bool shouldUsePluginDocument(const String& /*mimeType*/) const;
218 virtual void didChangeScrollOffset();
220 virtual PassRefPtr<WebCore::FrameNetworkingContext> createNetworkingContext();
223 RefPtr<PluginView> m_pluginView;
224 bool m_hasSentResponseToPluginView;
225 bool m_frameHasCustomRepresentation;
228 } // namespace WebKit
230 #endif // WebFrameLoaderClient_h