Web Inspector: "Reload Web Inspector" button no longer partially works
[WebKit-https.git] / Source / WebKit / UIProcess / PageClient.h
1 /*
2  * Copyright (C) 2010-2016 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 "LayerTreeContext.h"
29 #include "SameDocumentNavigationType.h"
30 #include "ShareableBitmap.h"
31 #include "WebColorPicker.h"
32 #include "WebDataListSuggestionsDropdown.h"
33 #include "WebPopupMenuProxy.h"
34 #include <WebCore/AlternativeTextClient.h>
35 #include <WebCore/EditorClient.h>
36 #include <WebCore/URL.h>
37 #include <WebCore/UserInterfaceLayoutDirection.h>
38 #include <WebCore/ValidationBubble.h>
39 #include <wtf/CompletionHandler.h>
40 #include <wtf/Forward.h>
41 #include <wtf/Variant.h>
42 #include <wtf/WeakPtr.h>
43
44 #if PLATFORM(COCOA)
45 #include "LayerRepresentation.h"
46 #include "PluginComplexTextInputState.h"
47 #include "WKFoundation.h"
48
49 OBJC_CLASS CALayer;
50 OBJC_CLASS NSFileWrapper;
51 OBJC_CLASS NSSet;
52 OBJC_CLASS _WKRemoteObjectRegistry;
53
54 #if USE(APPKIT)
55 OBJC_CLASS WKView;
56 OBJC_CLASS NSTextAlternatives;
57 #endif
58 #endif
59
60 namespace API {
61 class Attachment;
62 class HitTestResult;
63 class Object;
64 class OpenPanelParameters;
65 class SecurityOrigin;
66 }
67
68 namespace IPC {
69 class DataReference;
70 }
71
72 namespace WebCore {
73 class Color;
74 class Cursor;
75 class FloatQuad;
76 class Region;
77 class TextIndicator;
78 class WebMediaSessionManager;
79
80 enum class RouteSharingPolicy : uint8_t;
81 enum class ScrollbarStyle;
82 enum class TextIndicatorWindowLifetime : uint8_t;
83 enum class TextIndicatorWindowDismissalAnimation : uint8_t;
84
85 struct DictionaryPopupInfo;
86 struct Highlight;
87 struct TextIndicatorData;
88 struct ViewportAttributes;
89 struct ShareDataWithParsedURL;
90
91 template <typename> class RectEdges;
92 using FloatBoxExtent = RectEdges<float>;
93 }
94
95 #if ENABLE(DRAG_SUPPORT)
96 namespace WebCore {
97 struct DragItem;
98 }
99 #endif
100
101 namespace WebKit {
102
103 enum class UndoOrRedo : bool;
104
105 class ContextMenuContextData;
106 class DownloadProxy;
107 class DrawingAreaProxy;
108 class NativeWebGestureEvent;
109 class NativeWebKeyboardEvent;
110 class NativeWebMouseEvent;
111 class NativeWebWheelEvent;
112 class RemoteLayerTreeTransaction;
113 class SafeBrowsingWarning;
114 class UserData;
115 class ViewSnapshot;
116 class WebBackForwardListItem;
117 class WebContextMenuProxy;
118 class WebEditCommandProxy;
119 class WebFrameProxy;
120 class WebOpenPanelResultListenerProxy;
121 class WebPageProxy;
122 class WebPopupMenuProxy;
123
124 enum class ContinueUnsafeLoad : bool { No, Yes };
125
126 struct AssistedNodeInformation;
127 struct InteractionInformationAtPosition;
128 struct WebHitTestResultData;
129
130 #if ENABLE(TOUCH_EVENTS)
131 class NativeWebTouchEvent;
132 #endif
133
134 #if ENABLE(INPUT_TYPE_COLOR)
135 class WebColorPicker;
136 #endif
137
138 #if ENABLE(DATALIST_ELEMENT)
139 class WebDataListSuggestionsDropdown;
140 #endif
141
142 #if ENABLE(FULLSCREEN_API)
143 class WebFullScreenManagerProxyClient;
144 #endif
145
146 #if USE(GSTREAMER)
147 class InstallMissingMediaPluginsPermissionRequest;
148 #endif
149
150 #if PLATFORM(COCOA)
151 struct ColorSpaceData;
152 #endif
153
154 class PageClient : public CanMakeWeakPtr<PageClient> {
155 public:
156     virtual ~PageClient() { }
157
158     // Create a new drawing area proxy for the given page.
159     virtual std::unique_ptr<DrawingAreaProxy> createDrawingAreaProxy() = 0;
160
161     // Tell the view to invalidate the given region. The region is in view coordinates.
162     virtual void setViewNeedsDisplay(const WebCore::Region&) = 0;
163
164     // Tell the view to scroll to the given position, and whether this was a programmatic scroll.
165     virtual void requestScroll(const WebCore::FloatPoint& scrollPosition, const WebCore::IntPoint& scrollOrigin, bool isProgrammaticScroll) = 0;
166
167     // Return the current scroll position (not necessarily the same as the WebCore scroll position, because of scaling, insets etc.)
168     virtual WebCore::FloatPoint viewScrollPosition() = 0;
169
170     // Return the size of the view the page is associated with.
171     virtual WebCore::IntSize viewSize() = 0;
172
173     // Return whether the view's containing window is active.
174     virtual bool isViewWindowActive() = 0;
175
176     // Return whether the view is focused.
177     virtual bool isViewFocused() = 0;
178
179     // Return whether the view is visible.
180     virtual bool isViewVisible() = 0;
181
182     // Return whether the view is visible, or occluded by another window.
183     virtual bool isViewVisibleOrOccluded() { return isViewVisible(); }
184
185     // Return whether the view is in a window.
186     virtual bool isViewInWindow() = 0;
187
188     // Return whether the view is visually idle.
189     virtual bool isVisuallyIdle() { return !isViewVisible(); }
190
191     // Return the layer hosting mode for the view.
192     virtual LayerHostingMode viewLayerHostingMode() { return LayerHostingMode::InProcess; }
193
194     virtual void processDidExit() = 0;
195     virtual void processWillSwap() { processDidExit(); }
196     virtual void didRelaunchProcess() = 0;
197     virtual void pageClosed() = 0;
198
199     virtual void preferencesDidChange() = 0;
200
201     virtual void toolTipChanged(const String&, const String&) = 0;
202
203 #if PLATFORM(IOS_FAMILY)
204     // FIXME: Adopt the WKUIDelegatePrivate callback on iOS and remove this.
205     virtual void decidePolicyForGeolocationPermissionRequest(WebFrameProxy&, API::SecurityOrigin&, Function<void(bool)>&) = 0;
206 #endif
207
208     virtual void didStartProvisionalLoadForMainFrame() { };
209     virtual void didFailProvisionalLoadForMainFrame() { };
210     virtual void didCommitLoadForMainFrame(const String& mimeType, bool useCustomContentProvider) = 0;
211
212     virtual void handleDownloadRequest(DownloadProxy*) = 0;
213
214     virtual bool handleRunOpenPanel(WebPageProxy*, WebFrameProxy*, API::OpenPanelParameters*, WebOpenPanelResultListenerProxy*) { return false; }
215     virtual bool showShareSheet(const WebCore::ShareDataWithParsedURL&, WTF::CompletionHandler<void (bool)>&&) { return false; }
216
217     virtual void didChangeContentSize(const WebCore::IntSize&) = 0;
218
219     virtual void showSafeBrowsingWarning(const SafeBrowsingWarning&, CompletionHandler<void(Variant<ContinueUnsafeLoad, WebCore::URL>&&)>&& completionHandler) { completionHandler(ContinueUnsafeLoad::Yes); }
220     virtual void clearSafeBrowsingWarning() { }
221     
222 #if ENABLE(DRAG_SUPPORT)
223 #if PLATFORM(GTK)
224     virtual void startDrag(Ref<WebCore::SelectionData>&&, WebCore::DragOperation, RefPtr<ShareableBitmap>&& dragImage) = 0;
225 #else
226     virtual void startDrag(const WebCore::DragItem&, const ShareableBitmap::Handle&) { }
227 #endif
228     virtual void didPerformDragOperation(bool) { }
229 #endif // ENABLE(DRAG_SUPPORT)
230
231     virtual void setCursor(const WebCore::Cursor&) = 0;
232     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
233     virtual void didChangeViewportProperties(const WebCore::ViewportAttributes&) = 0;
234
235     virtual void registerEditCommand(Ref<WebEditCommandProxy>&&, UndoOrRedo) = 0;
236     virtual void clearAllEditCommands() = 0;
237     virtual bool canUndoRedo(UndoOrRedo) = 0;
238     virtual void executeUndoRedo(UndoOrRedo) = 0;
239     virtual void wheelEventWasNotHandledByWebCore(const NativeWebWheelEvent&) = 0;
240 #if PLATFORM(COCOA)
241     virtual void accessibilityWebProcessTokenReceived(const IPC::DataReference&) = 0;
242     virtual bool executeSavedCommandBySelector(const String& selector) = 0;
243     virtual void updateSecureInputState() = 0;
244     virtual void resetSecureInputState() = 0;
245     virtual void notifyInputContextAboutDiscardedComposition() = 0;
246     virtual void makeFirstResponder() = 0;
247     virtual void assistiveTechnologyMakeFirstResponder() = 0;
248     virtual void setAcceleratedCompositingRootLayer(LayerOrView *) = 0;
249     virtual LayerOrView *acceleratedCompositingRootLayer() const = 0;
250     virtual RefPtr<ViewSnapshot> takeViewSnapshot() = 0;
251 #if ENABLE(MAC_GESTURE_EVENTS)
252     virtual void gestureEventWasNotHandledByWebCore(const NativeWebGestureEvent&) = 0;
253 #endif
254 #endif
255
256 #if PLATFORM(COCOA) || PLATFORM(GTK)
257     virtual void selectionDidChange() = 0;
258 #endif
259
260 #if USE(APPKIT)
261     virtual void setPromisedDataForImage(const String& pasteboardName, Ref<WebCore::SharedBuffer>&& imageBuffer, const String& filename, const String& extension, const String& title, const String& url, const String& visibleUrl, RefPtr<WebCore::SharedBuffer>&& archiveBuffer) = 0;
262 #endif
263
264     virtual WebCore::FloatRect convertToDeviceSpace(const WebCore::FloatRect&) = 0;
265     virtual WebCore::FloatRect convertToUserSpace(const WebCore::FloatRect&) = 0;
266     virtual WebCore::IntPoint screenToRootView(const WebCore::IntPoint&) = 0;
267     virtual WebCore::IntRect rootViewToScreen(const WebCore::IntRect&) = 0;
268 #if PLATFORM(MAC)
269     virtual WebCore::IntRect rootViewToWindow(const WebCore::IntRect&) = 0;
270 #endif
271 #if PLATFORM(IOS_FAMILY)
272     virtual WebCore::IntPoint accessibilityScreenToRootView(const WebCore::IntPoint&) = 0;
273     virtual WebCore::IntRect rootViewToAccessibilityScreen(const WebCore::IntRect&) = 0;
274     virtual void didNotHandleTapAsClick(const WebCore::IntPoint&) = 0;
275     virtual void didCompleteSyntheticClick() = 0;
276 #endif
277     
278     virtual void doneWithKeyEvent(const NativeWebKeyboardEvent&, bool wasEventHandled) = 0;
279 #if ENABLE(TOUCH_EVENTS)
280     virtual void doneWithTouchEvent(const NativeWebTouchEvent&, bool wasEventHandled) = 0;
281 #endif
282
283     virtual RefPtr<WebPopupMenuProxy> createPopupMenuProxy(WebPageProxy&) = 0;
284 #if ENABLE(CONTEXT_MENUS)
285     virtual Ref<WebContextMenuProxy> createContextMenuProxy(WebPageProxy&, ContextMenuContextData&&, const UserData&) = 0;
286 #endif
287
288 #if ENABLE(INPUT_TYPE_COLOR)
289     virtual RefPtr<WebColorPicker> createColorPicker(WebPageProxy*, const WebCore::Color& initialColor, const WebCore::IntRect&, Vector<WebCore::Color>&&) = 0;
290 #endif
291
292 #if ENABLE(DATALIST_ELEMENT)
293     virtual RefPtr<WebDataListSuggestionsDropdown> createDataListSuggestionsDropdown(WebPageProxy&) = 0;
294 #endif
295
296 #if PLATFORM(COCOA)
297     virtual Ref<WebCore::ValidationBubble> createValidationBubble(const String& message, const WebCore::ValidationBubble::Settings&) = 0;
298 #endif
299
300 #if PLATFORM(COCOA)
301     virtual void setTextIndicator(Ref<WebCore::TextIndicator>, WebCore::TextIndicatorWindowLifetime) = 0;
302     virtual void clearTextIndicator(WebCore::TextIndicatorWindowDismissalAnimation) = 0;
303     virtual void setTextIndicatorAnimationProgress(float) = 0;
304 #endif
305
306     virtual void enterAcceleratedCompositingMode(const LayerTreeContext&) = 0;
307     virtual void exitAcceleratedCompositingMode() = 0;
308     virtual void updateAcceleratedCompositingMode(const LayerTreeContext&) = 0;
309
310 #if PLATFORM(MAC)
311     virtual void pluginFocusOrWindowFocusChanged(uint64_t pluginComplexTextInputIdentifier, bool pluginHasFocusAndWindowHasFocus) = 0;
312     virtual void setPluginComplexTextInputState(uint64_t pluginComplexTextInputIdentifier, PluginComplexTextInputState) = 0;
313     virtual void didPerformDictionaryLookup(const WebCore::DictionaryPopupInfo&) = 0;
314     virtual void showCorrectionPanel(WebCore::AlternativeTextType, const WebCore::FloatRect& boundingBoxOfReplacedString, const String& replacedString, const String& replacementString, const Vector<String>& alternativeReplacementStrings) = 0;
315     virtual void dismissCorrectionPanel(WebCore::ReasonForDismissingAlternativeText) = 0;
316     virtual String dismissCorrectionPanelSoon(WebCore::ReasonForDismissingAlternativeText) = 0;
317     virtual void recordAutocorrectionResponse(WebCore::AutocorrectionResponse, const String& replacedString, const String& replacementString) = 0;
318     virtual void recommendedScrollbarStyleDidChange(WebCore::ScrollbarStyle) = 0;
319     virtual void handleControlledElementIDResponse(const String&) = 0;
320
321     virtual CGRect boundsOfLayerInLayerBackedWindowCoordinates(CALayer *) const = 0;
322
323     virtual ColorSpaceData colorSpace() = 0;
324
325     virtual void showPlatformContextMenu(NSMenu *, WebCore::IntPoint) = 0;
326
327     virtual void startWindowDrag() = 0;
328     virtual NSWindow *platformWindow() = 0;
329     virtual void setShouldSuppressFirstResponderChanges(bool) = 0;
330
331     virtual bool effectiveAppearanceIsDark() const = 0;
332
333 #if WK_API_ENABLED
334     virtual NSView *inspectorAttachmentView() = 0;
335     virtual _WKRemoteObjectRegistry *remoteObjectRegistry() = 0;
336 #endif
337
338 #if USE(APPKIT)
339     virtual void intrinsicContentSizeDidChange(const WebCore::IntSize& intrinsicContentSize) = 0;
340 #if USE(DICTATION_ALTERNATIVES)
341     virtual uint64_t addDictationAlternatives(const RetainPtr<NSTextAlternatives>&) = 0;
342     virtual void removeDictationAlternatives(uint64_t dictationContext) = 0;
343     virtual void showDictationAlternativeUI(const WebCore::FloatRect& boundingBoxOfDictatedText, uint64_t dictationContext) = 0;
344     virtual Vector<String> dictationAlternatives(uint64_t dictationContext) = 0;
345 #endif // USE(DICTATION_ALTERNATIVES)
346 #if USE(INSERTION_UNDO_GROUPING)
347     virtual void registerInsertionUndoGrouping() = 0;
348 #endif // USE(INSERTION_UNDO_GROUPING)
349 #endif // USE(APPKIT)
350     virtual void setEditableElementIsFocused(bool) = 0;
351 #endif // PLATFORM(MAC)
352
353 #if PLATFORM(IOS_FAMILY)
354     virtual void commitPotentialTapFailed() = 0;
355     virtual void didGetTapHighlightGeometries(uint64_t requestID, const WebCore::Color&, const Vector<WebCore::FloatQuad>& highlightedQuads, const WebCore::IntSize& topLeftRadius, const WebCore::IntSize& topRightRadius, const WebCore::IntSize& bottomLeftRadius, const WebCore::IntSize& bottomRightRadius) = 0;
356
357     virtual void didCommitLayerTree(const RemoteLayerTreeTransaction&) = 0;
358     virtual void layerTreeCommitComplete() = 0;
359
360     virtual void couldNotRestorePageState() = 0;
361     virtual void restorePageState(std::optional<WebCore::FloatPoint> scrollPosition, const WebCore::FloatPoint& scrollOrigin, const WebCore::FloatBoxExtent& obscuredInsetsOnSave, double scale) = 0;
362     virtual void restorePageCenterAndScale(std::optional<WebCore::FloatPoint> center, double scale) = 0;
363
364     virtual void startAssistingNode(const AssistedNodeInformation&, bool userIsInteracting, bool blurPreviousNode, bool changingActivityState, API::Object* userData) = 0;
365     virtual void stopAssistingNode() = 0;
366     virtual bool isAssistingNode() = 0;
367     virtual bool interpretKeyEvent(const NativeWebKeyboardEvent&, bool isCharEvent) = 0;
368     virtual void positionInformationDidChange(const InteractionInformationAtPosition&) = 0;
369     virtual void saveImageToLibrary(Ref<WebCore::SharedBuffer>&&) = 0;
370     virtual void showPlaybackTargetPicker(bool hasVideo, const WebCore::IntRect& elementRect, WebCore::RouteSharingPolicy, const String&) = 0;
371     virtual void disableDoubleTapGesturesDuringTapIfNecessary(uint64_t requestID) = 0;
372     virtual double minimumZoomScale() const = 0;
373     virtual WebCore::FloatRect documentRect() const = 0;
374     virtual void scrollingNodeScrollViewWillStartPanGesture() = 0;
375     virtual void scrollingNodeScrollViewDidScroll() = 0;
376     virtual void scrollingNodeScrollWillStartScroll() = 0;
377     virtual void scrollingNodeScrollDidEndScroll() = 0;
378     virtual Vector<String> mimeTypesWithCustomContentProviders() = 0;
379
380     virtual void showInspectorHighlight(const WebCore::Highlight&) = 0;
381     virtual void hideInspectorHighlight() = 0;
382
383     virtual void showInspectorIndication() = 0;
384     virtual void hideInspectorIndication() = 0;
385
386     virtual void enableInspectorNodeSearch() = 0;
387     virtual void disableInspectorNodeSearch() = 0;
388 #endif
389
390     // Auxiliary Client Creation
391 #if ENABLE(FULLSCREEN_API)
392     virtual WebFullScreenManagerProxyClient& fullScreenManagerProxyClient() = 0;
393 #endif
394
395     // Custom representations.
396     virtual void didFinishLoadingDataForCustomContentProvider(const String& suggestedFilename, const IPC::DataReference&) = 0;
397
398     virtual void navigationGestureDidBegin() = 0;
399     virtual void navigationGestureWillEnd(bool willNavigate, WebBackForwardListItem&) = 0;
400     virtual void navigationGestureDidEnd(bool willNavigate, WebBackForwardListItem&) = 0;
401     virtual void navigationGestureDidEnd() = 0;
402     virtual void willRecordNavigationSnapshot(WebBackForwardListItem&) = 0;
403     virtual void didRemoveNavigationGestureSnapshot() = 0;
404
405     virtual void didFirstVisuallyNonEmptyLayoutForMainFrame() = 0;
406     virtual void didFinishLoadForMainFrame() = 0;
407     virtual void didFailLoadForMainFrame() = 0;
408     virtual void didSameDocumentNavigationForMainFrame(SameDocumentNavigationType) = 0;
409
410     virtual void didChangeBackgroundColor() = 0;
411     virtual void isPlayingAudioWillChange() = 0;
412     virtual void isPlayingAudioDidChange() = 0;
413     virtual void pinnedStateWillChange() { }
414     virtual void pinnedStateDidChange() { }
415
416 #if PLATFORM(MAC)
417     virtual void didPerformImmediateActionHitTest(const WebHitTestResultData&, bool contentPreventsDefault, API::Object*) = 0;
418     virtual NSObject *immediateActionAnimationControllerForHitTestResult(RefPtr<API::HitTestResult>, uint64_t, RefPtr<API::Object>) = 0;
419     virtual void didHandleAcceptedCandidate() = 0;
420 #endif
421
422     virtual void didFinishProcessingAllPendingMouseEvents() = 0;
423
424     virtual void videoControlsManagerDidChange() { }
425
426 #if ENABLE(WIRELESS_PLAYBACK_TARGET) && !PLATFORM(IOS_FAMILY)
427     virtual WebCore::WebMediaSessionManager& mediaSessionManager() = 0;
428 #endif
429
430     virtual void refView() = 0;
431     virtual void derefView() = 0;
432
433 #if ENABLE(VIDEO) && USE(GSTREAMER)
434     virtual bool decidePolicyForInstallMissingMediaPluginsPermissionRequest(InstallMissingMediaPluginsPermissionRequest&) = 0;
435 #endif
436
437     virtual void didRestoreScrollPosition() = 0;
438
439     virtual bool windowIsFrontWindowUnderMouse(const NativeWebMouseEvent&) { return false; }
440
441     virtual WebCore::UserInterfaceLayoutDirection userInterfaceLayoutDirection() = 0;
442
443 #if USE(QUICK_LOOK)
444     virtual void requestPasswordForQuickLookDocument(const String& fileName, WTF::Function<void(const String&)>&&) = 0;
445 #endif
446
447 #if ENABLE(DATA_INTERACTION)
448     virtual void didHandleStartDataInteractionRequest(bool started) = 0;
449     virtual void didHandleAdditionalDragItemsRequest(bool added) = 0;
450     virtual void didConcludeEditDataInteraction(std::optional<WebCore::TextIndicatorData>) = 0;
451     virtual void didChangeDataInteractionCaretRect(const WebCore::IntRect& previousCaretRect, const WebCore::IntRect& caretRect) = 0;
452 #endif
453
454 #if ENABLE(ATTACHMENT_ELEMENT)
455     virtual void didInsertAttachment(API::Attachment&, const String& source) { }
456     virtual void didRemoveAttachment(API::Attachment&) { }
457 #if PLATFORM(COCOA)
458     virtual NSFileWrapper *allocFileWrapperInstance() const { return nullptr; }
459     virtual NSSet *serializableFileWrapperClasses() const { return nullptr; }
460 #endif
461 #endif
462 };
463
464 } // namespace WebKit