2011-02-07 Anders Carlsson <andersca@apple.com>
[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 PassRefPtr<DrawingAreaImpl> create(WebPage*, const WebPageCreationParameters&);
41     virtual ~DrawingAreaImpl();
42
43 private:
44     DrawingAreaImpl(WebPage*, const WebPageCreationParameters&);
45
46     // DrawingArea
47     virtual void setNeedsDisplay(const WebCore::IntRect&);
48     virtual void scroll(const WebCore::IntRect& scrollRect, const WebCore::IntSize& scrollOffset);
49     virtual void forceRepaint();
50
51     virtual void didInstallPageOverlay();
52     virtual void didUninstallPageOverlay();
53     virtual void setPageOverlayNeedsDisplay(const WebCore::IntRect&);
54     
55     virtual void attachCompositingContext();
56     virtual void detachCompositingContext();
57     virtual void setRootCompositingLayer(WebCore::GraphicsLayer*);
58     virtual void scheduleCompositingLayerSync();
59     virtual void syncCompositingLayers();
60     virtual void didReceiveMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*);
61
62     // CoreIPC message handlers.
63     virtual void setSize(const WebCore::IntSize&, const WebCore::IntSize& scrollOffset);
64     virtual void didUpdate();
65     virtual void suspendPainting();
66     virtual void resumePainting();
67
68     void enterAcceleratedCompositingMode(WebCore::GraphicsLayer*);
69     void exitAcceleratedCompositingMode();
70
71     void scheduleDisplay();
72     void display();
73     void display(UpdateInfo&);
74
75     Region m_dirtyRegion;
76     WebCore::IntRect m_scrollRect;
77     WebCore::IntSize m_scrollOffset;
78
79     // Whether we're currently processing a setSize message.
80     bool m_inSetSize;
81
82     // Whether we're waiting for a DidUpdate message. Used for throttling paints so that the 
83     // web process won't paint more frequent than the UI process can handle.
84     bool m_isWaitingForDidUpdate;
85
86     // Whether painting is suspended. We'll still keep track of the dirty region but we 
87     // won't paint until painting has resumed again.
88     bool m_isPaintingSuspended;
89
90     RunLoop::Timer<DrawingAreaImpl> m_displayTimer;
91
92     // The layer tree host that handles accelerated compositing.
93     RefPtr<LayerTreeHost> m_layerTreeHost;
94 };
95
96 } // namespace WebKit
97
98 #endif // DrawingAreaImpl_h