6d465a5a1f5344b9bb60266482467ded9cebc012
[WebKit-https.git] / Source / WebKit / UIProcess / API / gtk / PageClientImpl.cpp
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  * Portions Copyright (c) 2010 Motorola Mobility, Inc.  All rights reserved.
4  * Copyright (C) 2011 Igalia S.L.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
17  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
19  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
25  * THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 #include "config.h"
29 #include "PageClientImpl.h"
30
31 #include "DrawingAreaProxyImpl.h"
32 #include "NativeWebKeyboardEvent.h"
33 #include "NativeWebMouseEvent.h"
34 #include "NativeWebWheelEvent.h"
35 #include "NotImplemented.h"
36 #include "WebColorPickerGtk.h"
37 #include "WebContextMenuProxyGtk.h"
38 #include "WebEventFactory.h"
39 #include "WebKitColorChooser.h"
40 #include "WebKitPopupMenu.h"
41 #include "WebKitWebViewBasePrivate.h"
42 #include "WebKitWebViewPrivate.h"
43 #include "WebPageProxy.h"
44 #include "WebProcessPool.h"
45 #include <WebCore/CairoUtilities.h>
46 #include <WebCore/Cursor.h>
47 #include <WebCore/EventNames.h>
48 #include <WebCore/GtkUtilities.h>
49 #include <WebCore/RefPtrCairo.h>
50 #include <wtf/Compiler.h>
51 #include <wtf/text/CString.h>
52 #include <wtf/text/WTFString.h>
53
54 using namespace WebCore;
55
56 namespace WebKit {
57
58 PageClientImpl::PageClientImpl(GtkWidget* viewWidget)
59     : m_viewWidget(viewWidget)
60 {
61 }
62
63 // PageClient's pure virtual functions
64 std::unique_ptr<DrawingAreaProxy> PageClientImpl::createDrawingAreaProxy()
65 {
66     return std::make_unique<DrawingAreaProxyImpl>(*webkitWebViewBaseGetPage(WEBKIT_WEB_VIEW_BASE(m_viewWidget)));
67 }
68
69 void PageClientImpl::setViewNeedsDisplay(const WebCore::Region& region)
70 {
71     gtk_widget_queue_draw_region(m_viewWidget, toCairoRegion(region).get());
72 }
73
74 void PageClientImpl::requestScroll(const WebCore::FloatPoint&, const WebCore::IntPoint&, bool)
75 {
76     notImplemented();
77 }
78
79 WebCore::FloatPoint PageClientImpl::viewScrollPosition()
80 {
81     return { };
82 }
83
84 WebCore::IntSize PageClientImpl::viewSize()
85 {
86     auto* drawingArea = static_cast<DrawingAreaProxyImpl*>(webkitWebViewBaseGetPage(WEBKIT_WEB_VIEW_BASE(m_viewWidget))->drawingArea());
87     return drawingArea ? drawingArea->size() : IntSize();
88 }
89
90 bool PageClientImpl::isViewWindowActive()
91 {
92     return webkitWebViewBaseIsInWindowActive(WEBKIT_WEB_VIEW_BASE(m_viewWidget));
93 }
94
95 bool PageClientImpl::isViewFocused()
96 {
97     return webkitWebViewBaseIsFocused(WEBKIT_WEB_VIEW_BASE(m_viewWidget));
98 }
99
100 bool PageClientImpl::isViewVisible()
101 {
102     return webkitWebViewBaseIsVisible(WEBKIT_WEB_VIEW_BASE(m_viewWidget));
103 }
104
105 bool PageClientImpl::isViewInWindow()
106 {
107     return webkitWebViewBaseIsInWindow(WEBKIT_WEB_VIEW_BASE(m_viewWidget));
108 }
109
110 void PageClientImpl::PageClientImpl::processDidExit()
111 {
112     notImplemented();
113 }
114
115 void PageClientImpl::didRelaunchProcess()
116 {
117     webkitWebViewBaseDidRelaunchWebProcess(WEBKIT_WEB_VIEW_BASE(m_viewWidget));
118 }
119
120 void PageClientImpl::toolTipChanged(const String&, const String& newToolTip)
121 {
122     webkitWebViewBaseSetTooltipText(WEBKIT_WEB_VIEW_BASE(m_viewWidget), newToolTip.utf8().data());
123 }
124
125 void PageClientImpl::setCursor(const WebCore::Cursor& cursor)
126 {
127     if (!gtk_widget_get_realized(m_viewWidget))
128         return;
129
130     // [GTK] Widget::setCursor() gets called frequently
131     // http://bugs.webkit.org/show_bug.cgi?id=16388
132     // Setting the cursor may be an expensive operation in some backends,
133     // so don't re-set the cursor if it's already set to the target value.
134     GdkWindow* window = gtk_widget_get_window(m_viewWidget);
135     GdkCursor* currentCursor = gdk_window_get_cursor(window);
136     GdkCursor* newCursor = cursor.platformCursor().get();
137     if (currentCursor != newCursor)
138         gdk_window_set_cursor(window, newCursor);
139 }
140
141 void PageClientImpl::setCursorHiddenUntilMouseMoves(bool /* hiddenUntilMouseMoves */)
142 {
143     notImplemented();
144 }
145
146 void PageClientImpl::didChangeViewportProperties(const WebCore::ViewportAttributes&)
147 {
148     notImplemented();
149 }
150
151 void PageClientImpl::registerEditCommand(Ref<WebEditCommandProxy>&& command, WebPageProxy::UndoOrRedo undoOrRedo)
152 {
153     m_undoController.registerEditCommand(WTFMove(command), undoOrRedo);
154 }
155
156 void PageClientImpl::clearAllEditCommands()
157 {
158     m_undoController.clearAllEditCommands();
159 }
160
161 bool PageClientImpl::canUndoRedo(WebPageProxy::UndoOrRedo undoOrRedo)
162 {
163     return m_undoController.canUndoRedo(undoOrRedo);
164 }
165
166 void PageClientImpl::executeUndoRedo(WebPageProxy::UndoOrRedo undoOrRedo)
167 {
168     m_undoController.executeUndoRedo(undoOrRedo);
169 }
170
171 FloatRect PageClientImpl::convertToDeviceSpace(const FloatRect& viewRect)
172 {
173     notImplemented();
174     return viewRect;
175 }
176
177 FloatRect PageClientImpl::convertToUserSpace(const FloatRect& viewRect)
178 {
179     notImplemented();
180     return viewRect;
181 }
182
183 IntPoint PageClientImpl::screenToRootView(const IntPoint& point)
184 {
185     IntPoint widgetPositionOnScreen = convertWidgetPointToScreenPoint(m_viewWidget, IntPoint());
186     IntPoint result(point);
187     result.move(-widgetPositionOnScreen.x(), -widgetPositionOnScreen.y());
188     return result;
189 }
190
191 IntRect PageClientImpl::rootViewToScreen(const IntRect& rect)
192 {
193     return IntRect(convertWidgetPointToScreenPoint(m_viewWidget, rect.location()), rect.size());
194 }
195
196 void PageClientImpl::doneWithKeyEvent(const NativeWebKeyboardEvent& event, bool wasEventHandled)
197 {
198     if (wasEventHandled)
199         return;
200     if (event.isFakeEventForComposition())
201         return;
202
203     WebKitWebViewBase* webkitWebViewBase = WEBKIT_WEB_VIEW_BASE(m_viewWidget);
204     webkitWebViewBaseForwardNextKeyEvent(webkitWebViewBase);
205     gtk_main_do_event(event.nativeEvent());
206 }
207
208 RefPtr<WebPopupMenuProxy> PageClientImpl::createPopupMenuProxy(WebPageProxy& page)
209 {
210     if (WEBKIT_IS_WEB_VIEW(m_viewWidget))
211         return WebKitPopupMenu::create(m_viewWidget, page);
212     return WebPopupMenuProxyGtk::create(m_viewWidget, page);
213 }
214
215 Ref<WebContextMenuProxy> PageClientImpl::createContextMenuProxy(WebPageProxy& page, ContextMenuContextData&& context, const UserData& userData)
216 {
217     return WebContextMenuProxyGtk::create(m_viewWidget, page, WTFMove(context), userData);
218 }
219
220 RefPtr<WebColorPicker> PageClientImpl::createColorPicker(WebPageProxy* page, const WebCore::Color& color, const WebCore::IntRect& rect)
221 {
222     if (WEBKIT_IS_WEB_VIEW(m_viewWidget))
223         return WebKitColorChooser::create(*page, color, rect);
224     return WebColorPickerGtk::create(*page, color, rect);
225 }
226
227 void PageClientImpl::enterAcceleratedCompositingMode(const LayerTreeContext& layerTreeContext)
228 {
229     webkitWebViewBaseEnterAcceleratedCompositingMode(WEBKIT_WEB_VIEW_BASE(m_viewWidget), layerTreeContext);
230 }
231
232 void PageClientImpl::exitAcceleratedCompositingMode()
233 {
234     webkitWebViewBaseExitAcceleratedCompositingMode(WEBKIT_WEB_VIEW_BASE(m_viewWidget));
235 }
236
237 void PageClientImpl::updateAcceleratedCompositingMode(const LayerTreeContext& layerTreeContext)
238 {
239     webkitWebViewBaseUpdateAcceleratedCompositingMode(WEBKIT_WEB_VIEW_BASE(m_viewWidget), layerTreeContext);
240 }
241
242 void PageClientImpl::pageClosed()
243 {
244     webkitWebViewBasePageClosed(WEBKIT_WEB_VIEW_BASE(m_viewWidget));
245 }
246
247 void PageClientImpl::preferencesDidChange()
248 {
249     notImplemented();
250 }
251
252 void PageClientImpl::selectionDidChange()
253 {
254     webkitWebViewBaseUpdateTextInputState(WEBKIT_WEB_VIEW_BASE(m_viewWidget));
255     if (WEBKIT_IS_WEB_VIEW(m_viewWidget))
256         webkitWebViewSelectionDidChange(WEBKIT_WEB_VIEW(m_viewWidget));
257 }
258
259 void PageClientImpl::didChangeContentSize(const IntSize& size)
260 {
261     webkitWebViewBaseSetContentsSize(WEBKIT_WEB_VIEW_BASE(m_viewWidget), size);
262 }
263
264 #if ENABLE(DRAG_SUPPORT)
265 void PageClientImpl::startDrag(Ref<SelectionData>&& selection, DragOperation dragOperation, RefPtr<ShareableBitmap>&& dragImage)
266 {
267     WebKitWebViewBase* webView = WEBKIT_WEB_VIEW_BASE(m_viewWidget);
268     webkitWebViewBaseDragAndDropHandler(webView).startDrag(WTFMove(selection), dragOperation, WTFMove(dragImage));
269
270     // A drag starting should prevent a double-click from happening. This might
271     // happen if a drag is followed very quickly by another click (like in the WTR).
272     webkitWebViewBaseResetClickCounter(webView);
273 }
274 #endif
275
276 void PageClientImpl::handleDownloadRequest(DownloadProxy* download)
277 {
278     if (WEBKIT_IS_WEB_VIEW(m_viewWidget))
279         webkitWebViewHandleDownloadRequest(WEBKIT_WEB_VIEW(m_viewWidget), download);
280 }
281
282 void PageClientImpl::didCommitLoadForMainFrame(const String& /* mimeType */, bool /* useCustomContentProvider */ )
283 {
284     webkitWebViewBaseResetClickCounter(WEBKIT_WEB_VIEW_BASE(m_viewWidget));
285 }
286
287 #if ENABLE(FULLSCREEN_API)
288 WebFullScreenManagerProxyClient& PageClientImpl::fullScreenManagerProxyClient()
289 {
290     return *this;
291 }
292
293 void PageClientImpl::closeFullScreenManager()
294 {
295     notImplemented();
296 }
297
298 bool PageClientImpl::isFullScreen()
299 {
300     return webkitWebViewBaseIsFullScreen(WEBKIT_WEB_VIEW_BASE(m_viewWidget));
301 }
302
303 void PageClientImpl::enterFullScreen()
304 {
305     if (!m_viewWidget)
306         return;
307
308     if (isFullScreen())
309         return;
310
311     if (WEBKIT_IS_WEB_VIEW(m_viewWidget))
312         webkitWebViewEnterFullScreen(WEBKIT_WEB_VIEW(m_viewWidget));
313     else
314         webkitWebViewBaseEnterFullScreen(WEBKIT_WEB_VIEW_BASE(m_viewWidget));
315 }
316
317 void PageClientImpl::exitFullScreen()
318 {
319     if (!m_viewWidget)
320         return;
321
322     if (!isFullScreen())
323         return;
324
325     if (WEBKIT_IS_WEB_VIEW(m_viewWidget))
326         webkitWebViewExitFullScreen(WEBKIT_WEB_VIEW(m_viewWidget));
327     else
328         webkitWebViewBaseExitFullScreen(WEBKIT_WEB_VIEW_BASE(m_viewWidget));
329 }
330
331 void PageClientImpl::beganEnterFullScreen(const IntRect& /* initialFrame */, const IntRect& /* finalFrame */)
332 {
333     notImplemented();
334 }
335
336 void PageClientImpl::beganExitFullScreen(const IntRect& /* initialFrame */, const IntRect& /* finalFrame */)
337 {
338     notImplemented();
339 }
340
341 #endif // ENABLE(FULLSCREEN_API)
342
343 #if ENABLE(TOUCH_EVENTS)
344 void PageClientImpl::doneWithTouchEvent(const NativeWebTouchEvent& event, bool wasEventHandled)
345 {
346     const GdkEvent* touchEvent = event.nativeEvent();
347
348 #if HAVE(GTK_GESTURES)
349     GestureController& gestureController = webkitWebViewBaseGestureController(WEBKIT_WEB_VIEW_BASE(m_viewWidget));
350     if (wasEventHandled) {
351         gestureController.reset();
352         return;
353     }
354     wasEventHandled = gestureController.handleEvent(const_cast<GdkEvent*>(event.nativeEvent()));
355 #endif
356
357     if (wasEventHandled)
358         return;
359
360     // Emulate pointer events if unhandled.
361     if (!touchEvent->touch.emulating_pointer)
362         return;
363
364     GUniquePtr<GdkEvent> pointerEvent;
365
366     if (touchEvent->type == GDK_TOUCH_UPDATE) {
367         pointerEvent.reset(gdk_event_new(GDK_MOTION_NOTIFY));
368         pointerEvent->motion.time = touchEvent->touch.time;
369         pointerEvent->motion.x = touchEvent->touch.x;
370         pointerEvent->motion.y = touchEvent->touch.y;
371         pointerEvent->motion.x_root = touchEvent->touch.x_root;
372         pointerEvent->motion.y_root = touchEvent->touch.y_root;
373         pointerEvent->motion.state = touchEvent->touch.state | GDK_BUTTON1_MASK;
374     } else {
375         switch (touchEvent->type) {
376         case GDK_TOUCH_CANCEL:
377             FALLTHROUGH;
378         case GDK_TOUCH_END:
379             pointerEvent.reset(gdk_event_new(GDK_BUTTON_RELEASE));
380             pointerEvent->button.state = touchEvent->touch.state | GDK_BUTTON1_MASK;
381             break;
382         case GDK_TOUCH_BEGIN:
383             pointerEvent.reset(gdk_event_new(GDK_BUTTON_PRESS));
384             break;
385         default:
386             ASSERT_NOT_REACHED();
387         }
388
389         pointerEvent->button.button = 1;
390         pointerEvent->button.time = touchEvent->touch.time;
391         pointerEvent->button.x = touchEvent->touch.x;
392         pointerEvent->button.y = touchEvent->touch.y;
393         pointerEvent->button.x_root = touchEvent->touch.x_root;
394         pointerEvent->button.y_root = touchEvent->touch.y_root;
395     }
396
397     gdk_event_set_device(pointerEvent.get(), gdk_event_get_device(touchEvent));
398     gdk_event_set_source_device(pointerEvent.get(), gdk_event_get_source_device(touchEvent));
399     pointerEvent->any.window = GDK_WINDOW(g_object_ref(touchEvent->any.window));
400     pointerEvent->any.send_event = TRUE;
401
402     gtk_widget_event(m_viewWidget, pointerEvent.get());
403 }
404 #endif // ENABLE(TOUCH_EVENTS)
405
406 void PageClientImpl::wheelEventWasNotHandledByWebCore(const NativeWebWheelEvent& event)
407 {
408     webkitWebViewBaseForwardNextWheelEvent(WEBKIT_WEB_VIEW_BASE(m_viewWidget));
409     gtk_main_do_event(event.nativeEvent());
410 }
411
412 void PageClientImpl::didFinishLoadingDataForCustomContentProvider(const String&, const IPC::DataReference&)
413 {
414 }
415
416 void PageClientImpl::navigationGestureDidBegin()
417 {
418 }
419
420 void PageClientImpl::navigationGestureWillEnd(bool, WebBackForwardListItem&)
421 {
422 }
423
424 void PageClientImpl::navigationGestureDidEnd(bool, WebBackForwardListItem&)
425 {
426 }
427
428 void PageClientImpl::navigationGestureDidEnd()
429 {
430 }
431
432 void PageClientImpl::willRecordNavigationSnapshot(WebBackForwardListItem&)
433 {
434 }
435
436 void PageClientImpl::didRemoveNavigationGestureSnapshot()
437 {
438 }
439
440 void PageClientImpl::didFirstVisuallyNonEmptyLayoutForMainFrame()
441 {
442 }
443
444 void PageClientImpl::didFinishLoadForMainFrame()
445 {
446 }
447
448 void PageClientImpl::didSameDocumentNavigationForMainFrame(SameDocumentNavigationType)
449 {
450 }
451
452 void PageClientImpl::didChangeBackgroundColor()
453 {
454 }
455
456 void PageClientImpl::refView()
457 {
458     g_object_ref(m_viewWidget);
459 }
460
461 void PageClientImpl::derefView()
462 {
463     g_object_unref(m_viewWidget);
464 }
465
466 #if ENABLE(VIDEO) && USE(GSTREAMER)
467 bool PageClientImpl::decidePolicyForInstallMissingMediaPluginsPermissionRequest(InstallMissingMediaPluginsPermissionRequest& request)
468 {
469     if (!WEBKIT_IS_WEB_VIEW(m_viewWidget))
470         return false;
471
472     webkitWebViewRequestInstallMissingMediaPlugins(WEBKIT_WEB_VIEW(m_viewWidget), request);
473     return true;
474 }
475 #endif
476
477 JSGlobalContextRef PageClientImpl::javascriptGlobalContext()
478 {
479     if (!WEBKIT_IS_WEB_VIEW(m_viewWidget))
480         return nullptr;
481
482     return webkit_web_view_get_javascript_global_context(WEBKIT_WEB_VIEW(m_viewWidget));
483 }
484
485 void PageClientImpl::zoom(double zoomLevel)
486 {
487     if (WEBKIT_IS_WEB_VIEW(m_viewWidget)) {
488         webkit_web_view_set_zoom_level(WEBKIT_WEB_VIEW(m_viewWidget), zoomLevel);
489         return;
490     }
491
492     webkitWebViewBaseGetPage(WEBKIT_WEB_VIEW_BASE(m_viewWidget))->setPageZoomFactor(zoomLevel);
493 }
494
495 } // namespace WebKit