Add ObjC equivalent of WKPageNavigationClient.didChangeBackForwardList
[WebKit-https.git] / Source / WebKit / UIProcess / API / APINavigationClient.h
1 /*
2  * Copyright (C) 2014, 2015 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 #pragma once
27
28 #include "APIData.h"
29 #include "PluginModuleInfo.h"
30 #include "ProcessTerminationReason.h"
31 #include "SameDocumentNavigationType.h"
32 #include "WebEvent.h"
33 #include "WebFramePolicyListenerProxy.h"
34 #include "WebsitePolicies.h"
35 #include <WebCore/FrameLoaderTypes.h>
36 #include <WebCore/LayoutMilestones.h>
37 #include <wtf/Forward.h>
38
39 namespace WebCore {
40 class ResourceError;
41 class ResourceRequest;
42 class ResourceResponse;
43 struct SecurityOriginData;
44 }
45
46 namespace WebKit {
47 class AuthenticationChallengeProxy;
48 class QuickLookDocumentData;
49 class WebBackForwardListItem;
50 class WebFramePolicyListenerProxy;
51 class WebFrameProxy;
52 class WebPageProxy;
53 class WebProtectionSpace;
54 struct NavigationActionData;
55 struct WebNavigationDataStore;
56 }
57
58 namespace API {
59
60 class Dictionary;
61 class Navigation;
62 class NavigationAction;
63 class NavigationResponse;
64 class Object;
65
66 class NavigationClient {
67 public:
68     virtual ~NavigationClient() { }
69
70     virtual void didStartProvisionalNavigation(WebKit::WebPageProxy&, Navigation*, Object*) { }
71     virtual void didReceiveServerRedirectForProvisionalNavigation(WebKit::WebPageProxy&, Navigation*, Object*) { }
72     virtual void willPerformClientRedirect(WebKit::WebPageProxy&, const WTF::String&, double) { }
73     virtual void didCancelClientRedirect(WebKit::WebPageProxy&) { }
74     virtual void didFailProvisionalNavigationWithError(WebKit::WebPageProxy&, WebKit::WebFrameProxy&, Navigation*, const WebCore::ResourceError&, Object*) { }
75     virtual void didFailProvisionalLoadInSubframeWithError(WebKit::WebPageProxy&, WebKit::WebFrameProxy&, const WebCore::SecurityOriginData&, Navigation*, const WebCore::ResourceError&, Object*) { }
76     virtual void didCommitNavigation(WebKit::WebPageProxy&, Navigation*, Object*) { }
77     virtual void didFinishDocumentLoad(WebKit::WebPageProxy&, Navigation*, Object*) { }
78     virtual void didFinishNavigation(WebKit::WebPageProxy&, Navigation*, Object*) { }
79     virtual void didFailNavigationWithError(WebKit::WebPageProxy&, WebKit::WebFrameProxy&, Navigation*, const WebCore::ResourceError&, Object*) { }
80     virtual void didSameDocumentNavigation(WebKit::WebPageProxy&, Navigation*, WebKit::SameDocumentNavigationType, Object*) { }
81
82     virtual void renderingProgressDidChange(WebKit::WebPageProxy&, WebCore::LayoutMilestones) { }
83
84     virtual bool canAuthenticateAgainstProtectionSpace(WebKit::WebPageProxy&, WebKit::WebProtectionSpace*) { return false; }
85     virtual void didReceiveAuthenticationChallenge(WebKit::WebPageProxy&, WebKit::AuthenticationChallengeProxy*) { }
86
87     // FIXME: These function should not be part of this client.
88     virtual void processDidTerminate(WebKit::WebPageProxy&, WebKit::ProcessTerminationReason) { }
89     virtual void processDidBecomeResponsive(WebKit::WebPageProxy&) { }
90     virtual void processDidBecomeUnresponsive(WebKit::WebPageProxy&) { }
91
92     virtual RefPtr<Data> webCryptoMasterKey(WebKit::WebPageProxy&) { return nullptr; }
93
94 #if USE(QUICK_LOOK)
95     virtual void didStartLoadForQuickLookDocumentInMainFrame(const WTF::String& fileName, const WTF::String& uti) { }
96     virtual void didFinishLoadForQuickLookDocumentInMainFrame(const WebKit::QuickLookDocumentData&) { }
97 #endif
98
99     virtual void decidePolicyForNavigationAction(WebKit::WebPageProxy&, Ref<NavigationAction>&&, Ref<WebKit::WebFramePolicyListenerProxy>&& listener, Object*)
100     {
101         listener->use({ });
102     }
103
104     virtual void decidePolicyForNavigationResponse(WebKit::WebPageProxy&, NavigationResponse&, Ref<WebKit::WebFramePolicyListenerProxy>&& listener, Object*)
105     {
106         listener->use({ });
107     }
108     
109     virtual void contentRuleListNotification(WebKit::WebPageProxy&, WebCore::URL&&, Vector<WTF::String>&&, Vector<WTF::String>&&) { };
110     
111 #if ENABLE(NETSCAPE_PLUGIN_API)
112     virtual bool didFailToInitializePlugIn(WebKit::WebPageProxy&, API::Dictionary&) { return false; }
113     virtual WebKit::PluginModuleLoadPolicy decidePolicyForPluginLoad(WebKit::WebPageProxy&, WebKit::PluginModuleLoadPolicy currentPluginLoadPolicy, Dictionary*, WTF::String&)
114     {
115         return currentPluginLoadPolicy;
116     }
117 #endif
118
119 #if ENABLE(WEBGL)
120     virtual void webGLLoadPolicy(WebKit::WebPageProxy&, const WebCore::URL&, WTF::Function<void(WebCore::WebGLLoadPolicy)>&& completionHandler) const { completionHandler(WebCore::WebGLLoadPolicy::WebGLAllowCreation); }
121     virtual void resolveWebGLLoadPolicy(WebKit::WebPageProxy&, const WebCore::URL&, WTF::Function<void(WebCore::WebGLLoadPolicy)>&& completionHandler) const { completionHandler(WebCore::WebGLLoadPolicy::WebGLAllowCreation); }
122 #endif
123     
124     virtual bool willGoToBackForwardListItem(WebKit::WebPageProxy&, WebKit::WebBackForwardListItem&, bool inPageCache, Object*) { return false; }
125
126     virtual void didBeginNavigationGesture(WebKit::WebPageProxy&) { }
127     virtual void willEndNavigationGesture(WebKit::WebPageProxy&, bool willNavigate, WebKit::WebBackForwardListItem&) { }
128     virtual void didEndNavigationGesture(WebKit::WebPageProxy&, bool willNavigate, WebKit::WebBackForwardListItem&) { }
129     virtual void didRemoveNavigationGestureSnapshot(WebKit::WebPageProxy&) { }
130     virtual bool didChangeBackForwardList(WebKit::WebPageProxy&, WebKit::WebBackForwardListItem*, const Vector<Ref<WebKit::WebBackForwardListItem>>&) { return false; }
131 };
132
133 } // namespace API