Skip the test added by r92997 on Qt port because it uses a method on EventSender...
[WebKit-https.git] / Source / WebKit / chromium / src / WebViewImpl.h
1 /*
2  * Copyright (C) 2010 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebViewImpl_h
32 #define WebViewImpl_h
33
34 #include "WebNavigationPolicy.h"
35 #include "WebPoint.h"
36 #include "WebRect.h"
37 #include "WebSize.h"
38 #include "WebString.h"
39 #include "WebView.h"
40
41 #include "ChromeClientImpl.h"
42 #include "ContextMenuClientImpl.h"
43 #include "DragClientImpl.h"
44 #include "EditorClientImpl.h"
45 #include "GraphicsContext3D.h"
46 #include "GraphicsLayer.h"
47 #include "InspectorClientImpl.h"
48 #include "IntRect.h"
49 #include "NotificationPresenterImpl.h"
50 #include "PageOverlay.h"
51 #include "cc/CCLayerTreeHost.h"
52 #include <wtf/OwnPtr.h>
53 #include <wtf/RefCounted.h>
54
55 namespace WebCore {
56 class ChromiumDataObject;
57 class DocumentLoader;
58 class Frame;
59 class GraphicsContext3D;
60 class HistoryItem;
61 class HitTestResult;
62 class KeyboardEvent;
63 class Page;
64 class PlatformKeyboardEvent;
65 class PopupContainer;
66 class PopupMenuClient;
67 class Range;
68 class RenderTheme;
69 class Widget;
70 #if ENABLE(GESTURE_RECOGNIZER)
71 class PlatformGestureRecognizer;
72 #endif
73 }
74
75 namespace WebKit {
76 class AutocompletePopupMenuClient;
77 class AutofillPopupMenuClient;
78 class ContextMenuClientImpl;
79 class DeviceOrientationClientProxy;
80 class DragScrollTimer;
81 class GeolocationClientProxy;
82 class SpeechInputClientImpl;
83 class WebAccessibilityObject;
84 class WebDevToolsAgentClient;
85 class WebDevToolsAgentPrivate;
86 class WebFrameImpl;
87 class WebGestureEvent;
88 class WebImage;
89 class WebKeyboardEvent;
90 class WebMouseEvent;
91 class WebMouseWheelEvent;
92 class WebSettingsImpl;
93 class WebTouchEvent;
94
95 class WebViewImpl : public WebView, public WebCore::CCLayerTreeHostClient, public RefCounted<WebViewImpl> {
96 public:
97     // WebWidget methods:
98     virtual void close();
99     virtual WebSize size() { return m_size; }
100     virtual void willStartLiveResize();
101     virtual void resize(const WebSize&);
102     virtual void willEndLiveResize();
103     virtual void animate(double frameBeginTime);
104     virtual void layout();
105     virtual void paint(WebCanvas*, const WebRect&);
106     virtual void themeChanged();
107     virtual void composite(bool finish);
108     virtual bool handleInputEvent(const WebInputEvent&);
109     virtual void mouseCaptureLost();
110     virtual void setFocus(bool enable);
111     virtual bool setComposition(
112         const WebString& text,
113         const WebVector<WebCompositionUnderline>& underlines,
114         int selectionStart,
115         int selectionEnd);
116     virtual bool confirmComposition();
117     virtual bool confirmComposition(const WebString& text);
118     virtual bool compositionRange(size_t* location, size_t* length);
119     virtual WebTextInputType textInputType();
120     virtual WebRect caretOrSelectionBounds();
121     virtual bool selectionRange(WebPoint& start, WebPoint& end) const;
122     virtual bool caretOrSelectionRange(size_t* location, size_t* length);
123     virtual void setTextDirection(WebTextDirection direction);
124     virtual bool isAcceleratedCompositingActive() const;
125
126     // WebView methods:
127     virtual void initializeMainFrame(WebFrameClient*);
128     virtual void setAutofillClient(WebAutofillClient*);
129     virtual void setDevToolsAgentClient(WebDevToolsAgentClient*);
130     virtual void setPermissionClient(WebPermissionClient*);
131     virtual void setSpellCheckClient(WebSpellCheckClient*);
132     virtual WebSettings* settings();
133     virtual WebString pageEncoding() const;
134     virtual void setPageEncoding(const WebString& encoding);
135     virtual bool isTransparent() const;
136     virtual void setIsTransparent(bool value);
137     virtual bool tabsToLinks() const;
138     virtual void setTabsToLinks(bool value);
139     virtual bool tabKeyCyclesThroughElements() const;
140     virtual void setTabKeyCyclesThroughElements(bool value);
141     virtual bool isActive() const;
142     virtual void setIsActive(bool value);
143     virtual void setDomainRelaxationForbidden(bool, const WebString& scheme);
144     virtual bool dispatchBeforeUnloadEvent();
145     virtual void dispatchUnloadEvent();
146     virtual WebFrame* mainFrame();
147     virtual WebFrame* findFrameByName(
148         const WebString& name, WebFrame* relativeToFrame);
149     virtual WebFrame* focusedFrame();
150     virtual void setFocusedFrame(WebFrame* frame);
151     virtual void setInitialFocus(bool reverse);
152     virtual void clearFocusedNode();
153     virtual void scrollFocusedNodeIntoView();
154     virtual double zoomLevel();
155     virtual double setZoomLevel(bool textOnly, double zoomLevel);
156     virtual void zoomLimitsChanged(double minimumZoomLevel,
157                                    double maximumZoomLevel);
158     virtual void scalePage(float scaleFactor, WebPoint origin);
159     virtual void performMediaPlayerAction(
160         const WebMediaPlayerAction& action,
161         const WebPoint& location);
162     virtual void copyImageAt(const WebPoint& point);
163     virtual void dragSourceEndedAt(
164         const WebPoint& clientPoint,
165         const WebPoint& screenPoint,
166         WebDragOperation operation);
167     virtual void dragSourceMovedTo(
168         const WebPoint& clientPoint,
169         const WebPoint& screenPoint,
170         WebDragOperation operation);
171     virtual void dragSourceSystemDragEnded();
172     virtual WebDragOperation dragTargetDragEnter(
173         const WebDragData&,
174         const WebPoint& clientPoint,
175         const WebPoint& screenPoint,
176         WebDragOperationsMask operationsAllowed);
177     virtual WebDragOperation dragTargetDragOver(
178         const WebPoint& clientPoint,
179         const WebPoint& screenPoint,
180         WebDragOperationsMask operationsAllowed);
181     virtual void dragTargetDragLeave();
182     virtual void dragTargetDrop(
183         const WebPoint& clientPoint,
184         const WebPoint& screenPoint);
185     virtual unsigned long createUniqueIdentifierForRequest();
186     virtual void inspectElementAt(const WebPoint& point);
187     virtual WebString inspectorSettings() const;
188     virtual void setInspectorSettings(const WebString& settings);
189     virtual bool inspectorSetting(const WebString& key, WebString* value) const;
190     virtual void setInspectorSetting(const WebString& key,
191                                      const WebString& value);
192     virtual WebDevToolsAgent* devToolsAgent();
193     virtual WebAccessibilityObject accessibilityObject();
194     virtual void applyAutofillSuggestions(
195         const WebNode&,
196         const WebVector<WebString>& names,
197         const WebVector<WebString>& labels,
198         const WebVector<WebString>& icons,
199         const WebVector<int>& uniqueIDs,
200         int separatorIndex);
201     virtual void hidePopups();
202     virtual void setScrollbarColors(unsigned inactiveColor,
203                                     unsigned activeColor,
204                                     unsigned trackColor);
205     virtual void setSelectionColors(unsigned activeBackgroundColor,
206                                     unsigned activeForegroundColor,
207                                     unsigned inactiveBackgroundColor,
208                                     unsigned inactiveForegroundColor);
209     virtual void performCustomContextMenuAction(unsigned action);
210
211     // CCLayerTreeHostClient
212     virtual void animateAndLayout(double frameBeginTime);
213     virtual PassRefPtr<WebCore::GraphicsContext3D> createLayerTreeHostContext3D();
214     virtual PassOwnPtr<WebCore::LayerPainterChromium> createRootLayerPainter();
215     virtual void didRecreateGraphicsContext(bool success);
216 #if !USE(THREADED_COMPOSITING)
217     virtual void scheduleComposite();
218 #endif
219
220     // WebViewImpl
221
222     void setIgnoreInputEvents(bool newValue);
223     WebDevToolsAgentPrivate* devToolsAgentPrivate() { return m_devToolsAgent.get(); }
224
225     PageOverlay* pageOverlay() const { return m_pageOverlay.get(); }
226     void setPageOverlayClient(PageOverlay::PageOverlayClient*);
227
228     void setOverlayLayer(WebCore::GraphicsLayer*);
229
230     const WebPoint& lastMouseDownPoint() const
231     {
232         return m_lastMouseDownPoint;
233     }
234
235     WebCore::Frame* focusedWebCoreFrame() const;
236
237     // Returns the currently focused Node or null if no node has focus.
238     WebCore::Node* focusedWebCoreNode();
239
240     static WebViewImpl* fromPage(WebCore::Page*);
241
242     WebViewClient* client()
243     {
244         return m_client;
245     }
246
247     WebAutofillClient* autofillClient()
248     {
249         return m_autofillClient;
250     }
251
252     WebPermissionClient* permissionClient()
253     {
254         return m_permissionClient;
255     }
256
257     WebSpellCheckClient* spellCheckClient()
258     {
259         return m_spellCheckClient;
260     }
261
262     // Returns the page object associated with this view. This may be null when
263     // the page is shutting down, but will be valid at all other times.
264     WebCore::Page* page() const
265     {
266         return m_page.get();
267     }
268
269     WebCore::RenderTheme* theme() const;
270
271     // Returns the main frame associated with this view. This may be null when
272     // the page is shutting down, but will be valid at all other times.
273     WebFrameImpl* mainFrameImpl();
274
275     // History related methods:
276     void observeNewNavigation();
277
278     // Event related methods:
279     void mouseMove(const WebMouseEvent&);
280     void mouseLeave(const WebMouseEvent&);
281     void mouseDown(const WebMouseEvent&);
282     void mouseUp(const WebMouseEvent&);
283     void mouseContextMenu(const WebMouseEvent&);
284     void mouseDoubleClick(const WebMouseEvent&);
285     bool mouseWheel(const WebMouseWheelEvent&);
286     bool gestureEvent(const WebGestureEvent&);
287     bool keyEvent(const WebKeyboardEvent&);
288     bool charEvent(const WebKeyboardEvent&);
289     bool touchEvent(const WebTouchEvent&);
290
291     // Handles context menu events orignated via the the keyboard. These
292     // include the VK_APPS virtual key and the Shift+F10 combine. Code is
293     // based on the Webkit function bool WebView::handleContextMenuEvent(WPARAM
294     // wParam, LPARAM lParam) in webkit\webkit\win\WebView.cpp. The only
295     // significant change in this function is the code to convert from a
296     // Keyboard event to the Right Mouse button down event.
297     bool sendContextMenuEvent(const WebKeyboardEvent&);
298
299     // Notifies the WebView that a load has been committed. isNewNavigation
300     // will be true if a new session history item should be created for that
301     // load.
302     void didCommitLoad(bool* isNewNavigation);
303
304     // Returns true if popup menus should be rendered by the browser, false if
305     // they should be rendered by WebKit (which is the default).
306     static bool useExternalPopupMenus();
307
308     bool contextMenuAllowed() const
309     {
310         return m_contextMenuAllowed;
311     }
312
313     // Set the disposition for how this webview is to be initially shown.
314     void setInitialNavigationPolicy(WebNavigationPolicy policy)
315     {
316         m_initialNavigationPolicy = policy;
317     }
318     WebNavigationPolicy initialNavigationPolicy() const
319     {
320         return m_initialNavigationPolicy;
321     }
322
323     // Determines whether a page should e.g. be opened in a background tab.
324     // Returns false if it has no opinion, in which case it doesn't set *policy.
325     static bool navigationPolicyFromMouseEvent(
326         unsigned short button,
327         bool ctrl,
328         bool shift,
329         bool alt,
330         bool meta,
331         WebNavigationPolicy*);
332
333     // Start a system drag and drop operation.
334     void startDragging(
335         const WebDragData& dragData,
336         WebDragOperationsMask mask,
337         const WebImage& dragImage,
338         const WebPoint& dragImageOffset);
339
340     void autofillPopupDidHide()
341     {
342         m_autofillPopupShowing = false;
343     }
344
345 #if ENABLE(NOTIFICATIONS)
346     // Returns the provider of desktop notifications.
347     NotificationPresenterImpl* notificationPresenterImpl();
348 #endif
349
350     // Tries to scroll a frame or any parent of a frame. Returns true if the view
351     // was scrolled.
352     bool propagateScroll(WebCore::ScrollDirection, WebCore::ScrollGranularity);
353
354     // Notification that a popup was opened/closed.
355     void popupOpened(WebCore::PopupContainer* popupContainer);
356     void popupClosed(WebCore::PopupContainer* popupContainer);
357
358     void hideAutofillPopup();
359
360     // Returns the input event we're currently processing. This is used in some
361     // cases where the WebCore DOM event doesn't have the information we need.
362     static const WebInputEvent* currentInputEvent()
363     {
364         return m_currentInputEvent;
365     }
366
367 #if USE(ACCELERATED_COMPOSITING)
368     bool allowsAcceleratedCompositing();
369     bool pageHasRTLStyle() const;
370     void setRootGraphicsLayer(WebCore::GraphicsLayer*);
371     void setRootPlatformLayer(WebCore::PlatformLayer*);
372     void setRootLayerNeedsDisplay();
373     void scrollRootLayerRect(const WebCore::IntSize& scrollDelta, const WebCore::IntRect& clipRect);
374     void invalidateRootLayerRect(const WebCore::IntRect&);
375     void doUpdateAndComposite();
376 #endif
377
378     // Returns the onscreen 3D context used by the compositor. This is
379     // used by the renderer's code to set up resource sharing between
380     // the compositor's context and subordinate contexts for APIs like
381     // WebGL. Returns 0 if compositing support is not compiled in.
382     virtual WebGraphicsContext3D* graphicsContext3D();
383
384     virtual void setVisibilityState(WebPageVisibilityState, bool);
385
386     WebCore::PopupContainer* selectPopup() const { return m_selectPopup.get(); }
387
388     // Returns true if the event leads to scrolling.
389     static bool mapKeyCodeForScroll(int keyCode,
390                                    WebCore::ScrollDirection* scrollDirection,
391                                    WebCore::ScrollGranularity* scrollGranularity);
392
393     // Called by a full frame plugin inside this view to inform it that its
394     // zoom level has been updated.  The plugin should only call this function
395     // if the zoom change was triggered by the browser, it's only needed in case
396     // a plugin can update its own zoom, say because of its own UI.
397     void fullFramePluginZoomLevelChanged(double zoomLevel);
398
399 #if ENABLE(GESTURE_RECOGNIZER)
400     void resetGestureRecognizer();
401 #endif
402
403 private:
404     friend class WebView;  // So WebView::Create can call our constructor
405     friend class WTF::RefCounted<WebViewImpl>;
406
407     enum DragAction {
408       DragEnter,
409       DragOver
410     };
411
412     WebViewImpl(WebViewClient*);
413     virtual ~WebViewImpl();
414
415     // Returns true if the event was actually processed.
416     bool keyEventDefault(const WebKeyboardEvent&);
417
418     // Returns true if the autocomple has consumed the event.
419     bool autocompleteHandleKeyEvent(const WebKeyboardEvent&);
420
421     // Repaints the Autofill popup. Should be called when the suggestions
422     // have changed. Note that this should only be called when the Autofill
423     // popup is showing.
424     void refreshAutofillPopup();
425
426     // Returns true if the view was scrolled.
427     bool scrollViewWithKeyboard(int keyCode, int modifiers);
428
429     void hideSelectPopup();
430
431     // Converts |pos| from window coordinates to contents coordinates and gets
432     // the HitTestResult for it.
433     WebCore::HitTestResult hitTestResultForWindowPos(const WebCore::IntPoint&);
434
435     // Consolidate some common code between starting a drag over a target and
436     // updating a drag over a target. If we're starting a drag, |isEntering|
437     // should be true.
438     WebDragOperation dragTargetDragEnterOrOver(const WebPoint& clientPoint,
439                                                const WebPoint& screenPoint,
440                                                DragAction);
441
442 #if USE(ACCELERATED_COMPOSITING)
443     void setIsAcceleratedCompositingActive(bool);
444 #if !USE(THREADED_COMPOSITING)
445     void doComposite();
446 #endif
447     void doPixelReadbackToCanvas(WebCanvas*, const WebCore::IntRect&);
448     void reallocateRenderer();
449     void updateLayerTreeViewport();
450 #endif
451
452     WebViewClient* m_client;
453     WebAutofillClient* m_autofillClient;
454     WebPermissionClient* m_permissionClient;
455     WebSpellCheckClient* m_spellCheckClient;
456
457     ChromeClientImpl m_chromeClientImpl;
458     ContextMenuClientImpl m_contextMenuClientImpl;
459     DragClientImpl m_dragClientImpl;
460     EditorClientImpl m_editorClientImpl;
461     InspectorClientImpl m_inspectorClientImpl;
462
463     WebSize m_size;
464
465     WebPoint m_lastMousePosition;
466     OwnPtr<WebCore::Page> m_page;
467
468     // This flag is set when a new navigation is detected. It is used to satisfy
469     // the corresponding argument to WebFrameClient::didCommitProvisionalLoad.
470     bool m_observedNewNavigation;
471 #ifndef NDEBUG
472     // Used to assert that the new navigation we observed is the same navigation
473     // when we make use of m_observedNewNavigation.
474     const WebCore::DocumentLoader* m_newNavigationLoader;
475 #endif
476
477     // An object that can be used to manipulate m_page->settings() without linking
478     // against WebCore. This is lazily allocated the first time GetWebSettings()
479     // is called.
480     OwnPtr<WebSettingsImpl> m_webSettings;
481
482     // A copy of the web drop data object we received from the browser.
483     RefPtr<WebCore::ChromiumDataObject> m_currentDragData;
484
485     // The point relative to the client area where the mouse was last pressed
486     // down. This is used by the drag client to determine what was under the
487     // mouse when the drag was initiated. We need to track this here in
488     // WebViewImpl since DragClient::startDrag does not pass the position the
489     // mouse was at when the drag was initiated, only the current point, which
490     // can be misleading as it is usually not over the element the user actually
491     // dragged by the time a drag is initiated.
492     WebPoint m_lastMouseDownPoint;
493
494     // Keeps track of the current zoom level. 0 means no zoom, positive numbers
495     // mean zoom in, negative numbers mean zoom out.
496     double m_zoomLevel;
497
498     double m_minimumZoomLevel;
499
500     double m_maximumZoomLevel;
501
502     bool m_contextMenuAllowed;
503
504     bool m_doingDragAndDrop;
505
506     bool m_ignoreInputEvents;
507
508     // Webkit expects keyPress events to be suppressed if the associated keyDown
509     // event was handled. Safari implements this behavior by peeking out the
510     // associated WM_CHAR event if the keydown was handled. We emulate
511     // this behavior by setting this flag if the keyDown was handled.
512     bool m_suppressNextKeypressEvent;
513
514     // The policy for how this webview is to be initially shown.
515     WebNavigationPolicy m_initialNavigationPolicy;
516
517     // Represents whether or not this object should process incoming IME events.
518     bool m_imeAcceptEvents;
519
520     // The available drag operations (copy, move link...) allowed by the source.
521     WebDragOperation m_operationsAllowed;
522
523     // The current drag operation as negotiated by the source and destination.
524     // When not equal to DragOperationNone, the drag data can be dropped onto the
525     // current drop target in this WebView (the drop target can accept the drop).
526     WebDragOperation m_dragOperation;
527
528     // Whether an Autofill popup is currently showing.
529     bool m_autofillPopupShowing;
530
531     // The Autofill popup client.
532     OwnPtr<AutofillPopupMenuClient> m_autofillPopupClient;
533
534     // The Autofill popup.
535     RefPtr<WebCore::PopupContainer> m_autofillPopup;
536
537     // The popup associated with a select element.
538     RefPtr<WebCore::PopupContainer> m_selectPopup;
539
540     OwnPtr<WebDevToolsAgentPrivate> m_devToolsAgent;
541     OwnPtr<PageOverlay> m_pageOverlay;
542
543     // Whether the webview is rendering transparently.
544     bool m_isTransparent;
545
546     // Whether the user can press tab to focus links.
547     bool m_tabsToLinks;
548
549     // Inspector settings.
550     WebString m_inspectorSettings;
551
552     typedef HashMap<WTF::String, WTF::String> SettingsMap;
553     OwnPtr<SettingsMap> m_inspectorSettingsMap;
554     OwnPtr<DragScrollTimer> m_dragScrollTimer;
555
556 #if ENABLE(NOTIFICATIONS)
557     // The provider of desktop notifications;
558     NotificationPresenterImpl m_notificationPresenter;
559 #endif
560
561     // If set, the (plugin) node which has mouse capture.
562     RefPtr<WebCore::Node> m_mouseCaptureNode;
563
564 #if USE(ACCELERATED_COMPOSITING)
565     WebCore::IntRect m_rootLayerScrollDamage;
566     RefPtr<WebCore::CCLayerTreeHost> m_layerTreeHost;
567     WebCore::GraphicsLayer* m_rootGraphicsLayer;
568     bool m_isAcceleratedCompositingActive;
569     bool m_compositorCreationFailed;
570     // If true, the graphics context is being restored.
571     bool m_recreatingGraphicsContext;
572 #endif
573     static const WebInputEvent* m_currentInputEvent;
574
575 #if ENABLE(INPUT_SPEECH)
576     OwnPtr<SpeechInputClientImpl> m_speechInputClient;
577 #endif
578     // If we attempt to fetch the on-screen GraphicsContext3D before
579     // the compositor has been turned on, we need to instantiate it
580     // early. This member holds on to the GC3D in this case.
581     RefPtr<WebCore::GraphicsContext3D> m_temporaryOnscreenGraphicsContext3D;
582     OwnPtr<DeviceOrientationClientProxy> m_deviceOrientationClientProxy;
583     OwnPtr<GeolocationClientProxy> m_geolocationClientProxy;
584
585 #if ENABLE(GESTURE_RECOGNIZER)
586     OwnPtr<WebCore::PlatformGestureRecognizer> m_gestureRecognizer;
587 #endif
588 };
589
590 } // namespace WebKit
591
592 #endif