Update device orientation & motion permission native SPI as per latest proposal
[WebKit-https.git] / Source / WebKit / UIProcess / API / APIUIClient.h
1 /*
2  * Copyright (C) 2014-2018 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 "WKPage.h"
29 #include "WebEvent.h"
30 #include "WebHitTestResultData.h"
31 #include "WebPageProxy.h"
32 #include <WebCore/FloatRect.h>
33 #include <wtf/CompletionHandler.h>
34
35 #if PLATFORM(IOS_FAMILY)
36 OBJC_CLASS NSArray;
37 OBJC_CLASS _WKActivatedElementInfo;
38 OBJC_CLASS UIViewController;
39 #endif
40
41 namespace WebCore {
42 class ResourceRequest;
43 struct FontAttributes;
44 struct SecurityOriginData;
45 struct WindowFeatures;
46 }
47
48 namespace WebKit {
49 class NativeWebKeyboardEvent;
50 class NativeWebWheelEvent;
51 class NotificationPermissionRequest;
52 class UserMediaPermissionRequestProxy;
53 class WebColorPickerResultListenerProxy;
54 class WebFrameProxy;
55 class WebOpenPanelResultListenerProxy;
56 class WebPageProxy;
57 struct NavigationActionData;
58
59 #if ENABLE(MEDIA_SESSION)
60 class WebMediaSessionMetadata;
61 #endif
62 }
63
64 namespace API {
65
66 class Data;
67 class Dictionary;
68 class Object;
69 class OpenPanelParameters;
70 class SecurityOrigin;
71
72 class UIClient {
73 public:
74     virtual ~UIClient() { }
75
76     virtual void createNewPage(WebKit::WebPageProxy&, Ref<FrameInfo>&&, WebCore::ResourceRequest&&, WebCore::WindowFeatures&&, WebKit::NavigationActionData&&, CompletionHandler<void(RefPtr<WebKit::WebPageProxy>&&)>&& completionHandler) { completionHandler(nullptr); }
77     virtual void showPage(WebKit::WebPageProxy*) { }
78     virtual void fullscreenMayReturnToInline(WebKit::WebPageProxy*) { }
79     virtual void didEnterFullscreen(WebKit::WebPageProxy*) { }
80     virtual void didExitFullscreen(WebKit::WebPageProxy*) { }
81     virtual void hasVideoInPictureInPictureDidChange(WebKit::WebPageProxy*, bool) { }
82     virtual void close(WebKit::WebPageProxy*) { }
83
84     virtual bool takeFocus(WebKit::WebPageProxy*, WKFocusDirection) { return false; }
85     virtual void focus(WebKit::WebPageProxy*) { }
86     virtual void unfocus(WebKit::WebPageProxy*) { }
87
88     virtual void runJavaScriptAlert(WebKit::WebPageProxy*, const WTF::String&, WebKit::WebFrameProxy*, const WebCore::SecurityOriginData&, Function<void ()>&& completionHandler) { completionHandler(); }
89     virtual void runJavaScriptConfirm(WebKit::WebPageProxy*, const WTF::String&, WebKit::WebFrameProxy*, const WebCore::SecurityOriginData&, Function<void (bool)>&& completionHandler) { completionHandler(false); }
90     virtual void runJavaScriptPrompt(WebKit::WebPageProxy*, const WTF::String&, const WTF::String&, WebKit::WebFrameProxy*, const WebCore::SecurityOriginData&, Function<void (const WTF::String&)>&& completionHandler) { completionHandler(WTF::String()); }
91
92     virtual void setStatusText(WebKit::WebPageProxy*, const WTF::String&) { }
93     virtual void mouseDidMoveOverElement(WebKit::WebPageProxy&, const WebKit::WebHitTestResultData&, OptionSet<WebKit::WebEvent::Modifier>, Object*) { }
94 #if ENABLE(NETSCAPE_PLUGIN_API)
95     virtual void unavailablePluginButtonClicked(WebKit::WebPageProxy&, WKPluginUnavailabilityReason, Dictionary&) { }
96 #endif // ENABLE(NETSCAPE_PLUGIN_API)
97
98     virtual void didNotHandleKeyEvent(WebKit::WebPageProxy*, const WebKit::NativeWebKeyboardEvent&) { }
99     virtual void didNotHandleWheelEvent(WebKit::WebPageProxy*, const WebKit::NativeWebWheelEvent&) { }
100
101     virtual void toolbarsAreVisible(WebKit::WebPageProxy&, Function<void(bool)>&& completionHandler) { completionHandler(true); }
102     virtual void setToolbarsAreVisible(WebKit::WebPageProxy&, bool) { }
103     virtual void menuBarIsVisible(WebKit::WebPageProxy&, Function<void(bool)>&& completionHandler) { completionHandler(true); }
104     virtual void setMenuBarIsVisible(WebKit::WebPageProxy&, bool) { }
105     virtual void statusBarIsVisible(WebKit::WebPageProxy&, Function<void(bool)>&& completionHandler) { completionHandler(true); }
106     virtual void setStatusBarIsVisible(WebKit::WebPageProxy&, bool) { }
107     virtual void setIsResizable(WebKit::WebPageProxy&, bool) { }
108
109     virtual void setWindowFrame(WebKit::WebPageProxy&, const WebCore::FloatRect&) { }
110     virtual void windowFrame(WebKit::WebPageProxy&, Function<void(WebCore::FloatRect)>&& completionHandler) { completionHandler({ }); }
111
112     virtual bool canRunBeforeUnloadConfirmPanel() const { return false; }
113     virtual void runBeforeUnloadConfirmPanel(WebKit::WebPageProxy*, const WTF::String&, WebKit::WebFrameProxy*, const WebCore::SecurityOriginData&, Function<void (bool)>&& completionHandler) { completionHandler(true); }
114
115     virtual void pageDidScroll(WebKit::WebPageProxy*) { }
116
117     virtual void exceededDatabaseQuota(WebKit::WebPageProxy*, WebKit::WebFrameProxy*, SecurityOrigin*, const WTF::String&, const WTF::String&, unsigned long long currentQuota, unsigned long long, unsigned long long, unsigned long long, Function<void (unsigned long long)>&& completionHandler)
118     {
119         completionHandler(currentQuota);
120     }
121
122     virtual void reachedApplicationCacheOriginQuota(WebKit::WebPageProxy*, const WebCore::SecurityOrigin&, uint64_t currentQuota, uint64_t, Function<void (unsigned long long)>&& completionHandler)
123     {
124         completionHandler(currentQuota);
125     }
126
127     virtual bool needsFontAttributes() const { return false; }
128     virtual void didChangeFontAttributes(const WebCore::FontAttributes&) { }
129
130     virtual bool runOpenPanel(WebKit::WebPageProxy*, WebKit::WebFrameProxy*, const WebCore::SecurityOriginData&, OpenPanelParameters*, WebKit::WebOpenPanelResultListenerProxy*) { return false; }
131     virtual void decidePolicyForGeolocationPermissionRequest(WebKit::WebPageProxy&, WebKit::WebFrameProxy&, SecurityOrigin&, Function<void(bool)>&) { }
132     virtual void decidePolicyForUserMediaPermissionRequest(WebKit::WebPageProxy&, WebKit::WebFrameProxy&, SecurityOrigin&, SecurityOrigin&, WebKit::UserMediaPermissionRequestProxy& request) { request.deny(); }
133     virtual void checkUserMediaPermissionForOrigin(WebKit::WebPageProxy&, WebKit::WebFrameProxy&, SecurityOrigin&, SecurityOrigin&, WebKit::UserMediaPermissionCheckProxy& request) { request.deny(); }
134     virtual void decidePolicyForNotificationPermissionRequest(WebKit::WebPageProxy&, SecurityOrigin&, Function<void(bool)>&& completionHandler) { completionHandler(false); }
135     virtual void requestStorageAccessConfirm(WebKit::WebPageProxy&, WebKit::WebFrameProxy*, const WTF::String& requestingDomain, const WTF::String& currentDomain, CompletionHandler<void(bool)>&& completionHandler) { completionHandler(true); }
136
137     // Printing.
138     virtual float headerHeight(WebKit::WebPageProxy&, WebKit::WebFrameProxy&) { return 0; }
139     virtual float footerHeight(WebKit::WebPageProxy&, WebKit::WebFrameProxy&) { return 0; }
140     virtual void drawHeader(WebKit::WebPageProxy&, WebKit::WebFrameProxy&, WebCore::FloatRect&&) { }
141     virtual void drawFooter(WebKit::WebPageProxy&, WebKit::WebFrameProxy&, WebCore::FloatRect&&) { }
142     virtual void printFrame(WebKit::WebPageProxy&, WebKit::WebFrameProxy&) { }
143
144     virtual bool canRunModal() const { return false; }
145     virtual void runModal(WebKit::WebPageProxy&) { }
146
147     virtual void saveDataToFileInDownloadsFolder(WebKit::WebPageProxy*, const WTF::String&, const WTF::String&, const WTF::URL&, Data&) { }
148
149     virtual void pinnedStateDidChange(WebKit::WebPageProxy&) { }
150
151     virtual void isPlayingMediaDidChange(WebKit::WebPageProxy&) { }
152     virtual void mediaCaptureStateDidChange(WebCore::MediaProducer::MediaStateFlags) { }
153     virtual void handleAutoplayEvent(WebKit::WebPageProxy&, WebCore::AutoplayEvent, OptionSet<WebCore::AutoplayEventFlags>) { }
154
155 #if ENABLE(MEDIA_SESSION)
156     virtual void mediaSessionMetadataDidChange(WebKit::WebPageProxy&, WebKit::WebMediaSessionMetadata*) { }
157 #endif
158
159 #if PLATFORM(IOS_FAMILY)
160 #if HAVE(APP_LINKS)
161     virtual bool shouldIncludeAppLinkActionsForElement(_WKActivatedElementInfo *) { return true; }
162 #endif
163     virtual RetainPtr<NSArray> actionsForElement(_WKActivatedElementInfo *, RetainPtr<NSArray> defaultActions) { return defaultActions; }
164     virtual void didNotHandleTapAsClick(const WebCore::IntPoint&) { }
165     virtual UIViewController *presentingViewController() { return nullptr; }
166 #endif
167 #if PLATFORM(COCOA)
168     virtual NSDictionary *dataDetectionContext() { return nullptr; }
169 #endif
170
171 #if ENABLE(POINTER_LOCK)
172     virtual void requestPointerLock(WebKit::WebPageProxy*) { }
173     virtual void didLosePointerLock(WebKit::WebPageProxy*) { }
174 #endif
175
176 #if ENABLE(DEVICE_ORIENTATION)
177     virtual void shouldAllowDeviceOrientationAndMotionAccess(WebKit::WebPageProxy&, WebKit::WebFrameProxy& webFrameProxy, const WebCore::SecurityOriginData&, CompletionHandler<void(bool)>&& completionHandler) { completionHandler(true); }
178 #endif
179
180     virtual void didClickAutoFillButton(WebKit::WebPageProxy&, Object*) { }
181
182     virtual void didResignInputElementStrongPasswordAppearance(WebKit::WebPageProxy&, Object*) { }
183
184     virtual void imageOrMediaDocumentSizeChanged(const WebCore::IntSize&) { }
185
186     virtual void didExceedBackgroundResourceLimitWhileInForeground(WebKit::WebPageProxy&, WKResourceLimit) { }
187     
188     virtual void didShowSafeBrowsingWarning() { }
189 };
190
191 } // namespace API