[chromium] Need a way to test lost compositor context recovery
[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 float pageScaleFactor() const;
159     virtual void scalePage(float scaleFactor, WebPoint origin);
160     virtual bool isFixedLayoutModeEnabled() const;
161     virtual void enableFixedLayoutMode(bool enable);
162     virtual WebSize fixedLayoutSize() const;
163     virtual void setFixedLayoutSize(const WebSize&);
164     virtual void performMediaPlayerAction(
165         const WebMediaPlayerAction& action,
166         const WebPoint& location);
167     virtual void copyImageAt(const WebPoint& point);
168     virtual void dragSourceEndedAt(
169         const WebPoint& clientPoint,
170         const WebPoint& screenPoint,
171         WebDragOperation operation);
172     virtual void dragSourceMovedTo(
173         const WebPoint& clientPoint,
174         const WebPoint& screenPoint,
175         WebDragOperation operation);
176     virtual void dragSourceSystemDragEnded();
177     virtual WebDragOperation dragTargetDragEnter(
178         const WebDragData&,
179         const WebPoint& clientPoint,
180         const WebPoint& screenPoint,
181         WebDragOperationsMask operationsAllowed);
182     virtual WebDragOperation dragTargetDragOver(
183         const WebPoint& clientPoint,
184         const WebPoint& screenPoint,
185         WebDragOperationsMask operationsAllowed);
186     virtual void dragTargetDragLeave();
187     virtual void dragTargetDrop(
188         const WebPoint& clientPoint,
189         const WebPoint& screenPoint);
190     virtual unsigned long createUniqueIdentifierForRequest();
191     virtual void inspectElementAt(const WebPoint& point);
192     virtual WebString inspectorSettings() const;
193     virtual void setInspectorSettings(const WebString& settings);
194     virtual bool inspectorSetting(const WebString& key, WebString* value) const;
195     virtual void setInspectorSetting(const WebString& key,
196                                      const WebString& value);
197     virtual WebDevToolsAgent* devToolsAgent();
198     virtual WebAccessibilityObject accessibilityObject();
199     virtual void applyAutofillSuggestions(
200         const WebNode&,
201         const WebVector<WebString>& names,
202         const WebVector<WebString>& labels,
203         const WebVector<WebString>& icons,
204         const WebVector<int>& uniqueIDs,
205         int separatorIndex);
206     virtual void hidePopups();
207     virtual void setScrollbarColors(unsigned inactiveColor,
208                                     unsigned activeColor,
209                                     unsigned trackColor);
210     virtual void setSelectionColors(unsigned activeBackgroundColor,
211                                     unsigned activeForegroundColor,
212                                     unsigned inactiveBackgroundColor,
213                                     unsigned inactiveForegroundColor);
214     virtual void performCustomContextMenuAction(unsigned action);
215     virtual void exitFullscreen();
216
217     // CCLayerTreeHostClient
218     virtual void animateAndLayout(double frameBeginTime);
219     virtual PassOwnPtr<WebCore::CCThread> createCompositorThread();
220     virtual PassRefPtr<WebCore::GraphicsContext3D> createLayerTreeHostContext3D();
221     virtual PassOwnPtr<WebCore::LayerPainterChromium> createRootLayerPainter();
222     virtual void didRecreateGraphicsContext(bool success);
223 #if !USE(THREADED_COMPOSITING)
224     virtual void scheduleComposite();
225 #endif
226
227     // WebViewImpl
228
229     void setIgnoreInputEvents(bool newValue);
230     WebDevToolsAgentPrivate* devToolsAgentPrivate() { return m_devToolsAgent.get(); }
231
232     PageOverlay* pageOverlay() const { return m_pageOverlay.get(); }
233     void setPageOverlayClient(PageOverlay::PageOverlayClient*);
234
235     void setOverlayLayer(WebCore::GraphicsLayer*);
236
237     const WebPoint& lastMouseDownPoint() const
238     {
239         return m_lastMouseDownPoint;
240     }
241
242     WebCore::Frame* focusedWebCoreFrame() const;
243
244     // Returns the currently focused Node or null if no node has focus.
245     WebCore::Node* focusedWebCoreNode();
246
247     static WebViewImpl* fromPage(WebCore::Page*);
248
249     WebViewClient* client()
250     {
251         return m_client;
252     }
253
254     WebAutofillClient* autofillClient()
255     {
256         return m_autofillClient;
257     }
258
259     WebPermissionClient* permissionClient()
260     {
261         return m_permissionClient;
262     }
263
264     WebSpellCheckClient* spellCheckClient()
265     {
266         return m_spellCheckClient;
267     }
268
269     // Returns the page object associated with this view. This may be null when
270     // the page is shutting down, but will be valid at all other times.
271     WebCore::Page* page() const
272     {
273         return m_page.get();
274     }
275
276     WebCore::RenderTheme* theme() const;
277
278     // Returns the main frame associated with this view. This may be null when
279     // the page is shutting down, but will be valid at all other times.
280     WebFrameImpl* mainFrameImpl();
281
282     // History related methods:
283     void observeNewNavigation();
284
285     // Event related methods:
286     void mouseMove(const WebMouseEvent&);
287     void mouseLeave(const WebMouseEvent&);
288     void mouseDown(const WebMouseEvent&);
289     void mouseUp(const WebMouseEvent&);
290     void mouseContextMenu(const WebMouseEvent&);
291     void mouseDoubleClick(const WebMouseEvent&);
292     bool mouseWheel(const WebMouseWheelEvent&);
293     bool gestureEvent(const WebGestureEvent&);
294     bool keyEvent(const WebKeyboardEvent&);
295     bool charEvent(const WebKeyboardEvent&);
296     bool touchEvent(const WebTouchEvent&);
297
298     // Handles context menu events orignated via the the keyboard. These
299     // include the VK_APPS virtual key and the Shift+F10 combine. Code is
300     // based on the Webkit function bool WebView::handleContextMenuEvent(WPARAM
301     // wParam, LPARAM lParam) in webkit\webkit\win\WebView.cpp. The only
302     // significant change in this function is the code to convert from a
303     // Keyboard event to the Right Mouse button down event.
304     bool sendContextMenuEvent(const WebKeyboardEvent&);
305
306     // Notifies the WebView that a load has been committed. isNewNavigation
307     // will be true if a new session history item should be created for that
308     // load.
309     void didCommitLoad(bool* isNewNavigation);
310
311     // Returns true if popup menus should be rendered by the browser, false if
312     // they should be rendered by WebKit (which is the default).
313     static bool useExternalPopupMenus();
314
315     bool contextMenuAllowed() const
316     {
317         return m_contextMenuAllowed;
318     }
319
320     // Set the disposition for how this webview is to be initially shown.
321     void setInitialNavigationPolicy(WebNavigationPolicy policy)
322     {
323         m_initialNavigationPolicy = policy;
324     }
325     WebNavigationPolicy initialNavigationPolicy() const
326     {
327         return m_initialNavigationPolicy;
328     }
329
330     // Determines whether a page should e.g. be opened in a background tab.
331     // Returns false if it has no opinion, in which case it doesn't set *policy.
332     static bool navigationPolicyFromMouseEvent(
333         unsigned short button,
334         bool ctrl,
335         bool shift,
336         bool alt,
337         bool meta,
338         WebNavigationPolicy*);
339
340     // Start a system drag and drop operation.
341     void startDragging(
342         const WebDragData& dragData,
343         WebDragOperationsMask mask,
344         const WebImage& dragImage,
345         const WebPoint& dragImageOffset);
346
347     void autofillPopupDidHide()
348     {
349         m_autofillPopupShowing = false;
350     }
351
352 #if ENABLE(NOTIFICATIONS)
353     // Returns the provider of desktop notifications.
354     NotificationPresenterImpl* notificationPresenterImpl();
355 #endif
356
357     // Tries to scroll a frame or any parent of a frame. Returns true if the view
358     // was scrolled.
359     bool propagateScroll(WebCore::ScrollDirection, WebCore::ScrollGranularity);
360
361     // Notification that a popup was opened/closed.
362     void popupOpened(WebCore::PopupContainer* popupContainer);
363     void popupClosed(WebCore::PopupContainer* popupContainer);
364
365     void hideAutofillPopup();
366
367     // Returns the input event we're currently processing. This is used in some
368     // cases where the WebCore DOM event doesn't have the information we need.
369     static const WebInputEvent* currentInputEvent()
370     {
371         return m_currentInputEvent;
372     }
373
374 #if USE(ACCELERATED_COMPOSITING)
375     bool allowsAcceleratedCompositing();
376     bool pageHasRTLStyle() const;
377     void setRootGraphicsLayer(WebCore::GraphicsLayer*);
378     void setRootLayerNeedsDisplay();
379     void scrollRootLayerRect(const WebCore::IntSize& scrollDelta, const WebCore::IntRect& clipRect);
380     void invalidateRootLayerRect(const WebCore::IntRect&);
381     void doUpdateAndComposite();
382 #endif
383
384     // Returns the onscreen 3D context used by the compositor. This is
385     // used by the renderer's code to set up resource sharing between
386     // the compositor's context and subordinate contexts for APIs like
387     // WebGL. Returns 0 if compositing support is not compiled in.
388     virtual WebGraphicsContext3D* graphicsContext3D();
389
390     virtual void setVisibilityState(WebPageVisibilityState, bool);
391
392     WebCore::PopupContainer* selectPopup() const { return m_selectPopup.get(); }
393
394     // Returns true if the event leads to scrolling.
395     static bool mapKeyCodeForScroll(int keyCode,
396                                    WebCore::ScrollDirection* scrollDirection,
397                                    WebCore::ScrollGranularity* scrollGranularity);
398
399     // Called by a full frame plugin inside this view to inform it that its
400     // zoom level has been updated.  The plugin should only call this function
401     // if the zoom change was triggered by the browser, it's only needed in case
402     // a plugin can update its own zoom, say because of its own UI.
403     void fullFramePluginZoomLevelChanged(double zoomLevel);
404
405 #if ENABLE(GESTURE_RECOGNIZER)
406     void resetGestureRecognizer();
407 #endif
408
409     void loseCompositorContext();
410
411 private:
412     friend class WebView;  // So WebView::Create can call our constructor
413     friend class WTF::RefCounted<WebViewImpl>;
414
415     enum DragAction {
416       DragEnter,
417       DragOver
418     };
419
420     WebViewImpl(WebViewClient*);
421     virtual ~WebViewImpl();
422
423     // Returns true if the event was actually processed.
424     bool keyEventDefault(const WebKeyboardEvent&);
425
426     // Returns true if the autocomple has consumed the event.
427     bool autocompleteHandleKeyEvent(const WebKeyboardEvent&);
428
429     // Repaints the Autofill popup. Should be called when the suggestions
430     // have changed. Note that this should only be called when the Autofill
431     // popup is showing.
432     void refreshAutofillPopup();
433
434     // Returns true if the view was scrolled.
435     bool scrollViewWithKeyboard(int keyCode, int modifiers);
436
437     void hideSelectPopup();
438
439     // Converts |pos| from window coordinates to contents coordinates and gets
440     // the HitTestResult for it.
441     WebCore::HitTestResult hitTestResultForWindowPos(const WebCore::IntPoint&);
442
443     // Consolidate some common code between starting a drag over a target and
444     // updating a drag over a target. If we're starting a drag, |isEntering|
445     // should be true.
446     WebDragOperation dragTargetDragEnterOrOver(const WebPoint& clientPoint,
447                                                const WebPoint& screenPoint,
448                                                DragAction);
449
450 #if USE(ACCELERATED_COMPOSITING)
451     void setIsAcceleratedCompositingActive(bool);
452 #if !USE(THREADED_COMPOSITING)
453     void doComposite();
454 #endif
455     void doPixelReadbackToCanvas(WebCanvas*, const WebCore::IntRect&);
456     void reallocateRenderer();
457     void updateLayerTreeViewport();
458 #endif
459
460     WebViewClient* m_client;
461     WebAutofillClient* m_autofillClient;
462     WebPermissionClient* m_permissionClient;
463     WebSpellCheckClient* m_spellCheckClient;
464
465     ChromeClientImpl m_chromeClientImpl;
466     ContextMenuClientImpl m_contextMenuClientImpl;
467     DragClientImpl m_dragClientImpl;
468     EditorClientImpl m_editorClientImpl;
469     InspectorClientImpl m_inspectorClientImpl;
470
471     WebSize m_size;
472
473     WebPoint m_lastMousePosition;
474     OwnPtr<WebCore::Page> m_page;
475
476     // This flag is set when a new navigation is detected. It is used to satisfy
477     // the corresponding argument to WebFrameClient::didCommitProvisionalLoad.
478     bool m_observedNewNavigation;
479 #ifndef NDEBUG
480     // Used to assert that the new navigation we observed is the same navigation
481     // when we make use of m_observedNewNavigation.
482     const WebCore::DocumentLoader* m_newNavigationLoader;
483 #endif
484
485     // An object that can be used to manipulate m_page->settings() without linking
486     // against WebCore. This is lazily allocated the first time GetWebSettings()
487     // is called.
488     OwnPtr<WebSettingsImpl> m_webSettings;
489
490     // A copy of the web drop data object we received from the browser.
491     RefPtr<WebCore::ChromiumDataObject> m_currentDragData;
492
493     // The point relative to the client area where the mouse was last pressed
494     // down. This is used by the drag client to determine what was under the
495     // mouse when the drag was initiated. We need to track this here in
496     // WebViewImpl since DragClient::startDrag does not pass the position the
497     // mouse was at when the drag was initiated, only the current point, which
498     // can be misleading as it is usually not over the element the user actually
499     // dragged by the time a drag is initiated.
500     WebPoint m_lastMouseDownPoint;
501
502     // Keeps track of the current zoom level. 0 means no zoom, positive numbers
503     // mean zoom in, negative numbers mean zoom out.
504     double m_zoomLevel;
505
506     double m_minimumZoomLevel;
507
508     double m_maximumZoomLevel;
509
510     bool m_contextMenuAllowed;
511
512     bool m_doingDragAndDrop;
513
514     bool m_ignoreInputEvents;
515
516     // Webkit expects keyPress events to be suppressed if the associated keyDown
517     // event was handled. Safari implements this behavior by peeking out the
518     // associated WM_CHAR event if the keydown was handled. We emulate
519     // this behavior by setting this flag if the keyDown was handled.
520     bool m_suppressNextKeypressEvent;
521
522     // The policy for how this webview is to be initially shown.
523     WebNavigationPolicy m_initialNavigationPolicy;
524
525     // Represents whether or not this object should process incoming IME events.
526     bool m_imeAcceptEvents;
527
528     // The available drag operations (copy, move link...) allowed by the source.
529     WebDragOperation m_operationsAllowed;
530
531     // The current drag operation as negotiated by the source and destination.
532     // When not equal to DragOperationNone, the drag data can be dropped onto the
533     // current drop target in this WebView (the drop target can accept the drop).
534     WebDragOperation m_dragOperation;
535
536     // Whether an Autofill popup is currently showing.
537     bool m_autofillPopupShowing;
538
539     // The Autofill popup client.
540     OwnPtr<AutofillPopupMenuClient> m_autofillPopupClient;
541
542     // The Autofill popup.
543     RefPtr<WebCore::PopupContainer> m_autofillPopup;
544
545     // The popup associated with a select element.
546     RefPtr<WebCore::PopupContainer> m_selectPopup;
547
548     OwnPtr<WebDevToolsAgentPrivate> m_devToolsAgent;
549     OwnPtr<PageOverlay> m_pageOverlay;
550
551     // Whether the webview is rendering transparently.
552     bool m_isTransparent;
553
554     // Whether the user can press tab to focus links.
555     bool m_tabsToLinks;
556
557     // Inspector settings.
558     WebString m_inspectorSettings;
559
560     typedef HashMap<WTF::String, WTF::String> SettingsMap;
561     OwnPtr<SettingsMap> m_inspectorSettingsMap;
562     OwnPtr<DragScrollTimer> m_dragScrollTimer;
563
564 #if ENABLE(NOTIFICATIONS)
565     // The provider of desktop notifications;
566     NotificationPresenterImpl m_notificationPresenter;
567 #endif
568
569     // If set, the (plugin) node which has mouse capture.
570     RefPtr<WebCore::Node> m_mouseCaptureNode;
571
572 #if USE(ACCELERATED_COMPOSITING)
573     WebCore::IntRect m_rootLayerScrollDamage;
574     RefPtr<WebCore::CCLayerTreeHost> m_layerTreeHost;
575     WebCore::GraphicsLayer* m_rootGraphicsLayer;
576     bool m_isAcceleratedCompositingActive;
577     bool m_compositorCreationFailed;
578     // If true, the graphics context is being restored.
579     bool m_recreatingGraphicsContext;
580 #endif
581     static const WebInputEvent* m_currentInputEvent;
582
583 #if ENABLE(INPUT_SPEECH)
584     OwnPtr<SpeechInputClientImpl> m_speechInputClient;
585 #endif
586     // If we attempt to fetch the on-screen GraphicsContext3D before
587     // the compositor has been turned on, we need to instantiate it
588     // early. This member holds on to the GC3D in this case.
589     RefPtr<WebCore::GraphicsContext3D> m_temporaryOnscreenGraphicsContext3D;
590     OwnPtr<DeviceOrientationClientProxy> m_deviceOrientationClientProxy;
591     OwnPtr<GeolocationClientProxy> m_geolocationClientProxy;
592
593 #if ENABLE(GESTURE_RECOGNIZER)
594     OwnPtr<WebCore::PlatformGestureRecognizer> m_gestureRecognizer;
595 #endif
596 };
597
598 } // namespace WebKit
599
600 #endif