3c414570f30f96218488844de0065d0dcc695588
[WebKit-https.git] / Source / WebKit2 / UIProcess / PageClient.h
1 /*
2  * Copyright (C) 2010, 2011 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 #ifndef PageClient_h
27 #define PageClient_h
28
29 #include "ShareableBitmap.h"
30 #include "WebColorPicker.h"
31 #include "WebPageProxy.h"
32 #include "WebPopupMenuProxy.h"
33 #include <WebCore/AlternativeTextClient.h>
34 #include <WebCore/EditorClient.h>
35 #include <wtf/Forward.h>
36
37 #if PLATFORM(COCOA)
38 #include "PluginComplexTextInputState.h"
39
40 OBJC_CLASS CALayer;
41
42 #if USE(APPKIT)
43 OBJC_CLASS WKView;
44 OBJC_CLASS NSTextAlternatives;
45 #endif
46 #endif
47
48 namespace WebCore {
49 class Cursor;
50 class TextIndicator;
51 struct Highlight;
52 struct ViewportAttributes;
53 }
54
55 namespace WebKit {
56
57 class DrawingAreaProxy;
58 class NativeWebKeyboardEvent;
59 class RemoteLayerTreeTransaction;
60 class ViewSnapshot;
61 class WebContextMenuProxy;
62 class WebEditCommandProxy;
63 class WebPopupMenuProxy;
64 struct ActionMenuHitTestResult;
65
66 #if ENABLE(TOUCH_EVENTS)
67 class NativeWebTouchEvent;
68 #endif
69
70 #if ENABLE(INPUT_TYPE_COLOR)
71 class WebColorPicker;
72 #endif
73
74 #if ENABLE(FULLSCREEN_API)
75 class WebFullScreenManagerProxyClient;
76 #endif
77
78 #if PLATFORM(COCOA)
79 struct ColorSpaceData;
80 #endif
81
82 class PageClient {
83 public:
84     virtual ~PageClient() { }
85
86     // Create a new drawing area proxy for the given page.
87     virtual std::unique_ptr<DrawingAreaProxy> createDrawingAreaProxy() = 0;
88
89     // Tell the view to invalidate the given rect. The rect is in view coordinates.
90     virtual void setViewNeedsDisplay(const WebCore::IntRect&) = 0;
91
92     // Tell the view to immediately display its invalid rect.
93     virtual void displayView() = 0;
94
95     // Return true if scrollView() can copy bits in the view.
96     virtual bool canScrollView() = 0;
97     // Tell the view to scroll scrollRect by scrollOffset.
98     virtual void scrollView(const WebCore::IntRect& scrollRect, const WebCore::IntSize& scrollOffset) = 0;
99     // Tell the view to scroll to the given position, and whether this was a programmatic scroll.
100     virtual void requestScroll(const WebCore::FloatPoint& scrollPosition, bool isProgrammaticScroll) = 0;
101
102     // Return the size of the view the page is associated with.
103     virtual WebCore::IntSize viewSize() = 0;
104
105     // Return whether the view's containing window is active.
106     virtual bool isViewWindowActive() = 0;
107
108     // Return whether the view is focused.
109     virtual bool isViewFocused() = 0;
110
111     // Return whether the view is visible.
112     virtual bool isViewVisible() = 0;
113
114     // Return whether the view is visible, or occluded by another window.
115     virtual bool isViewVisibleOrOccluded() { return isViewVisible(); }
116
117     // Return whether the view is in a window.
118     virtual bool isViewInWindow() = 0;
119
120     // Return whether the view is visually idle.
121     virtual bool isVisuallyIdle() { return !isViewVisible(); }
122
123     // Return the layer hosting mode for the view.
124     virtual LayerHostingMode viewLayerHostingMode() { return LayerHostingMode::InProcess; }
125
126     virtual void processDidExit() = 0;
127     virtual void didRelaunchProcess() = 0;
128     virtual void pageClosed() = 0;
129
130     virtual void preferencesDidChange() = 0;
131
132     virtual void toolTipChanged(const String&, const String&) = 0;
133
134     virtual bool decidePolicyForGeolocationPermissionRequest(WebFrameProxy&, WebSecurityOrigin&, GeolocationPermissionRequestProxy&)
135     {
136         return false;
137     }
138
139     virtual void didCommitLoadForMainFrame(const String& mimeType, bool useCustomContentProvider) = 0;
140
141 #if USE(TILED_BACKING_STORE)
142     virtual void pageDidRequestScroll(const WebCore::IntPoint&) = 0;
143     virtual void didRenderFrame(const WebCore::IntSize& contentsSize, const WebCore::IntRect& coveredRect) = 0;
144     virtual void pageTransitionViewportReady() = 0;
145 #endif
146 #if USE(COORDINATED_GRAPHICS)
147     virtual void didFindZoomableArea(const WebCore::IntPoint&, const WebCore::IntRect&) = 0;
148 #endif
149
150 #if PLATFORM(EFL) || PLATFORM(GTK)
151     virtual void updateTextInputState() = 0;
152 #endif // PLATFORM(EFL) || PLATOFRM(GTK)
153
154     virtual void handleDownloadRequest(DownloadProxy*) = 0;
155
156     virtual bool handleRunOpenPanel(WebPageProxy*, WebFrameProxy*, WebOpenPanelParameters*, WebOpenPanelResultListenerProxy*) { return false; }
157
158 #if PLATFORM(EFL)
159     virtual void didChangeContentSize(const WebCore::IntSize&) = 0;
160 #endif
161
162 #if PLATFORM(GTK) && ENABLE(DRAG_SUPPORT)
163     virtual void startDrag(const WebCore::DragData&, PassRefPtr<ShareableBitmap> dragImage) = 0;
164 #endif
165
166     virtual void setCursor(const WebCore::Cursor&) = 0;
167     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
168     virtual void didChangeViewportProperties(const WebCore::ViewportAttributes&) = 0;
169
170     virtual void registerEditCommand(PassRefPtr<WebEditCommandProxy>, WebPageProxy::UndoOrRedo) = 0;
171     virtual void clearAllEditCommands() = 0;
172     virtual bool canUndoRedo(WebPageProxy::UndoOrRedo) = 0;
173     virtual void executeUndoRedo(WebPageProxy::UndoOrRedo) = 0;
174 #if PLATFORM(COCOA)
175     virtual void accessibilityWebProcessTokenReceived(const IPC::DataReference&) = 0;
176     virtual bool executeSavedCommandBySelector(const String& selector) = 0;
177     virtual void setDragImage(const WebCore::IntPoint& clientPosition, PassRefPtr<ShareableBitmap> dragImage, bool isLinkDrag) = 0;
178     virtual void updateSecureInputState() = 0;
179     virtual void resetSecureInputState() = 0;
180     virtual void notifyInputContextAboutDiscardedComposition() = 0;
181     virtual void makeFirstResponder() = 0;
182     virtual void setAcceleratedCompositingRootLayer(LayerOrView *) = 0;
183     virtual LayerOrView *acceleratedCompositingRootLayer() const = 0;
184     virtual PassRefPtr<ViewSnapshot> takeViewSnapshot() = 0;
185     virtual void wheelEventWasNotHandledByWebCore(const NativeWebWheelEvent&) = 0;
186 #endif
187
188 #if PLATFORM(MAC) && !USE(ASYNC_NSTEXTINPUTCLIENT)
189     virtual void notifyApplicationAboutInputContextChange() = 0;
190 #endif
191
192 #if USE(APPKIT)
193     virtual void setPromisedData(const String& pasteboardName, PassRefPtr<WebCore::SharedBuffer> imageBuffer, const String& filename, const String& extension, const String& title,
194                                  const String& url, const String& visibleUrl, PassRefPtr<WebCore::SharedBuffer> archiveBuffer) = 0;
195 #endif
196
197 #if PLATFORM(GTK)
198     virtual void getEditorCommandsForKeyEvent(const NativeWebKeyboardEvent&, const AtomicString&, Vector<WTF::String>&) = 0;
199 #endif
200     virtual WebCore::FloatRect convertToDeviceSpace(const WebCore::FloatRect&) = 0;
201     virtual WebCore::FloatRect convertToUserSpace(const WebCore::FloatRect&) = 0;
202     virtual WebCore::IntPoint screenToRootView(const WebCore::IntPoint&) = 0;
203     virtual WebCore::IntRect rootViewToScreen(const WebCore::IntRect&) = 0;
204 #if PLATFORM(IOS)
205     virtual WebCore::IntPoint accessibilityScreenToRootView(const WebCore::IntPoint&) = 0;
206     virtual WebCore::IntRect rootViewToAccessibilityScreen(const WebCore::IntRect&) = 0;
207 #endif
208     
209     virtual void doneWithKeyEvent(const NativeWebKeyboardEvent&, bool wasEventHandled) = 0;
210 #if ENABLE(TOUCH_EVENTS)
211     virtual void doneWithTouchEvent(const NativeWebTouchEvent&, bool wasEventHandled) = 0;
212 #endif
213
214     virtual PassRefPtr<WebPopupMenuProxy> createPopupMenuProxy(WebPageProxy*) = 0;
215     virtual PassRefPtr<WebContextMenuProxy> createContextMenuProxy(WebPageProxy*) = 0;
216
217 #if ENABLE(INPUT_TYPE_COLOR)
218     virtual PassRefPtr<WebColorPicker> createColorPicker(WebPageProxy*, const WebCore::Color& initialColor, const WebCore::IntRect&) = 0;
219 #endif
220
221     virtual void setTextIndicator(PassRefPtr<WebCore::TextIndicator>, bool fadeOut) = 0;
222
223     virtual void enterAcceleratedCompositingMode(const LayerTreeContext&) = 0;
224     virtual void exitAcceleratedCompositingMode() = 0;
225     virtual void updateAcceleratedCompositingMode(const LayerTreeContext&) = 0;
226
227 #if PLATFORM(MAC)
228     virtual void pluginFocusOrWindowFocusChanged(uint64_t pluginComplexTextInputIdentifier, bool pluginHasFocusAndWindowHasFocus) = 0;
229     virtual void setPluginComplexTextInputState(uint64_t pluginComplexTextInputIdentifier, PluginComplexTextInputState) = 0;
230     virtual void didPerformDictionaryLookup(const DictionaryPopupInfo&) = 0;
231     virtual void dismissDictionaryLookupPanel() = 0;
232     virtual void dismissActionMenuPopovers() = 0;
233     virtual void showCorrectionPanel(WebCore::AlternativeTextType, const WebCore::FloatRect& boundingBoxOfReplacedString, const String& replacedString, const String& replacementString, const Vector<String>& alternativeReplacementStrings) = 0;
234     virtual void dismissCorrectionPanel(WebCore::ReasonForDismissingAlternativeText) = 0;
235     virtual String dismissCorrectionPanelSoon(WebCore::ReasonForDismissingAlternativeText) = 0;
236     virtual void recordAutocorrectionResponse(WebCore::AutocorrectionResponseType, const String& replacedString, const String& replacementString) = 0;
237     virtual void recommendedScrollbarStyleDidChange(int32_t newStyle) = 0;
238     virtual void removeNavigationGestureSnapshot() = 0;
239
240     virtual CGRect boundsOfLayerInLayerBackedWindowCoordinates(CALayer *) const = 0;
241
242     virtual ColorSpaceData colorSpace() = 0;
243
244     virtual void showPlatformContextMenu(NSMenu *, WebCore::IntPoint) = 0;
245
246 #if USE(APPKIT)
247     virtual WKView* wkView() const = 0;
248     virtual void intrinsicContentSizeDidChange(const WebCore::IntSize& intrinsicContentSize) = 0;
249 #if USE(DICTATION_ALTERNATIVES)
250     virtual uint64_t addDictationAlternatives(const RetainPtr<NSTextAlternatives>&) = 0;
251     virtual void removeDictationAlternatives(uint64_t dictationContext) = 0;
252     virtual void showDictationAlternativeUI(const WebCore::FloatRect& boundingBoxOfDictatedText, uint64_t dictationContext) = 0;
253     virtual Vector<String> dictationAlternatives(uint64_t dictationContext) = 0;
254 #endif // USE(DICTATION_ALTERNATIVES)
255 #if USE(INSERTION_UNDO_GROUPING)
256     virtual void registerInsertionUndoGrouping() = 0;
257 #endif // USE(INSERTION_UNDO_GROUPING)
258 #endif // USE(APPKIT)
259 #endif // PLATFORM(MAC)
260
261 #if PLATFORM(IOS)
262     virtual void commitPotentialTapFailed() = 0;
263     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;
264
265     virtual void didCommitLayerTree(const RemoteLayerTreeTransaction&) = 0;
266     virtual void dynamicViewportUpdateChangedTarget(double newScale, const WebCore::FloatPoint& newScrollPosition, uint64_t transactionID) = 0;
267     virtual void restorePageState(const WebCore::FloatRect&, double) = 0;
268     virtual void restorePageCenterAndScale(const WebCore::FloatPoint&, double) = 0;
269
270     virtual void startAssistingNode(const AssistedNodeInformation&, bool userIsInteracting, bool blurPreviousNode, API::Object* userData) = 0;
271     virtual void stopAssistingNode() = 0;
272     virtual bool isAssistingNode() = 0;
273     virtual void selectionDidChange() = 0;
274     virtual bool interpretKeyEvent(const NativeWebKeyboardEvent&, bool isCharEvent) = 0;
275     virtual void positionInformationDidChange(const InteractionInformationAtPosition&) = 0;
276     virtual void saveImageToLibrary(PassRefPtr<WebCore::SharedBuffer>) = 0;
277     virtual void didUpdateBlockSelectionWithTouch(uint32_t touch, uint32_t flags, float growThreshold, float shrinkThreshold) = 0;
278     virtual void showPlaybackTargetPicker(bool hasVideo, const WebCore::IntRect& elementRect) = 0;
279     virtual void zoomToRect(WebCore::FloatRect, double minimumScale, double maximumScale) = 0;
280     virtual void didChangeViewportMetaTagWidth(float) = 0;
281     virtual double minimumZoomScale() const = 0;
282     virtual WebCore::FloatSize contentsSize() const = 0;
283     virtual void overflowScrollViewWillStartPanGesture() = 0;
284     virtual void overflowScrollViewDidScroll() = 0;
285     virtual void overflowScrollWillStartScroll() = 0;
286     virtual void overflowScrollDidEndScroll() = 0;
287     virtual void didFinishDrawingPagesToPDF(const IPC::DataReference&) = 0;
288     virtual Vector<String> mimeTypesWithCustomContentProviders() = 0;
289
290 #if ENABLE(INSPECTOR)
291     virtual void showInspectorHighlight(const WebCore::Highlight&) = 0;
292     virtual void hideInspectorHighlight() = 0;
293
294     virtual void showInspectorIndication() = 0;
295     virtual void hideInspectorIndication() = 0;
296
297     virtual void enableInspectorNodeSearch() = 0;
298     virtual void disableInspectorNodeSearch() = 0;
299 #endif
300 #endif
301
302     // Auxiliary Client Creation
303 #if ENABLE(FULLSCREEN_API)
304     virtual WebFullScreenManagerProxyClient& fullScreenManagerProxyClient() = 0;
305 #endif
306
307     // Custom representations.
308     virtual void didFinishLoadingDataForCustomContentProvider(const String& suggestedFilename, const IPC::DataReference&) = 0;
309
310     virtual void navigationGestureDidBegin() = 0;
311     virtual void navigationGestureWillEnd(bool willNavigate, WebBackForwardListItem&) = 0;
312     virtual void navigationGestureDidEnd(bool willNavigate, WebBackForwardListItem&) = 0;
313     virtual void willRecordNavigationSnapshot(WebBackForwardListItem&) = 0;
314
315     virtual void didFirstVisuallyNonEmptyLayoutForMainFrame() = 0;
316     virtual void didFinishLoadForMainFrame() = 0;
317     virtual void didSameDocumentNavigationForMainFrame(SameDocumentNavigationType) = 0;
318
319 #if PLATFORM(MAC)
320     virtual void didPerformActionMenuHitTest(const ActionMenuHitTestResult&, API::Object*) = 0;
321 #endif
322 };
323
324 } // namespace WebKit
325
326 #endif // PageClient_h