<rdar://problem/9523192> REGRESSION (5.0.5-ToT, WebKit2): Flash to white when navigat...
[WebKit-https.git] / Source / WebKit2 / WebProcess / WebPage / DrawingAreaImpl.h
1 /*
2  * Copyright (C) 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 DrawingAreaImpl_h
27 #define DrawingAreaImpl_h
28
29 #include "DrawingArea.h"
30 #include "LayerTreeHost.h"
31 #include "Region.h"
32 #include "RunLoop.h"
33
34 namespace WebKit {
35
36 class UpdateInfo;
37
38 class DrawingAreaImpl : public DrawingArea {
39 public:
40     static PassOwnPtr<DrawingAreaImpl> create(WebPage*, const WebPageCreationParameters&);
41     virtual ~DrawingAreaImpl();
42
43     void setLayerHostNeedsDisplay();
44     void layerHostDidFlushLayers();
45
46 private:
47     DrawingAreaImpl(WebPage*, const WebPageCreationParameters&);
48
49     // DrawingArea
50     virtual void setNeedsDisplay(const WebCore::IntRect&);
51     virtual void scroll(const WebCore::IntRect& scrollRect, const WebCore::IntSize& scrollOffset);
52     virtual void setLayerTreeStateIsFrozen(bool);
53     virtual void forceRepaint();
54
55     virtual void didInstallPageOverlay();
56     virtual void didUninstallPageOverlay();
57     virtual void setPageOverlayNeedsDisplay(const WebCore::IntRect&);
58     
59     virtual void setRootCompositingLayer(WebCore::GraphicsLayer*);
60     virtual void scheduleCompositingLayerSync();
61     virtual void syncCompositingLayers();
62     virtual void didReceiveMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*);
63
64     // CoreIPC message handlers.
65     virtual void updateBackingStoreState(uint64_t backingStoreStateID, bool respondImmediately, const WebCore::IntSize&, const WebCore::IntSize& scrollOffset);
66     virtual void didUpdate();
67     virtual void suspendPainting();
68     virtual void resumePainting();
69
70     void sendDidUpdateBackingStoreState();
71
72     void enterAcceleratedCompositingMode(WebCore::GraphicsLayer*);
73     void exitAcceleratedCompositingModeSoon();
74     bool exitAcceleratedCompositingModePending() const { return m_exitCompositingTimer.isActive(); }
75     void exitAcceleratedCompositingMode();
76
77     void scheduleDisplay();
78     void displayTimerFired();
79     void display();
80     void display(UpdateInfo&);
81
82     uint64_t m_backingStoreStateID;
83
84     Region m_dirtyRegion;
85     WebCore::IntRect m_scrollRect;
86     WebCore::IntSize m_scrollOffset;
87
88     // Whether we're currently processing an UpdateBackingStoreState message.
89     bool m_inUpdateBackingStoreState;
90
91     // When true, we should send an UpdateBackingStoreState message instead of any other messages
92     // we normally send to the UI process.
93     bool m_shouldSendDidUpdateBackingStoreState;
94
95     // Whether we're waiting for a DidUpdate message. Used for throttling paints so that the 
96     // web process won't paint more frequent than the UI process can handle.
97     bool m_isWaitingForDidUpdate;
98     
99     // True between sending the 'enter compositing' messages, and the 'exit compositing' message.
100     bool m_compositingAccordingToProxyMessages;
101
102     // When true, we maintain the layer tree in its current state by not leaving accelerated compositing mode
103     // and not scheduling layer flushes.
104     bool m_layerTreeStateIsFrozen;
105
106     // True when we were asked to exit accelerated compositing mode but couldn't because layer tree
107     // state was frozen.
108     bool m_wantsToExitAcceleratedCompositingMode;
109
110     // Whether painting is suspended. We'll still keep track of the dirty region but we 
111     // won't paint until painting has resumed again.
112     bool m_isPaintingSuspended;
113     bool m_alwaysUseCompositing;
114
115     double m_lastDisplayTime;
116
117     RunLoop::Timer<DrawingAreaImpl> m_displayTimer;
118     RunLoop::Timer<DrawingAreaImpl> m_exitCompositingTimer;
119
120     // The layer tree host that handles accelerated compositing.
121     RefPtr<LayerTreeHost> m_layerTreeHost;
122 };
123
124 } // namespace WebKit
125
126 #endif // DrawingAreaImpl_h