2010-07-01 Simon Fraser <simon.fraser@apple.com>
[WebKit-https.git] / WebKit2 / WebProcess / WebPage / LayerBackedDrawingArea.h
1 /*
2  * Copyright (C) 2010 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 LayerBackedDrawingArea_h
27 #define LayerBackedDrawingArea_h
28
29 #if USE(ACCELERATED_COMPOSITING)
30
31 #include "DrawingArea.h"
32 #include "RunLoop.h"
33 #include <WebCore/IntPoint.h>
34 #include <WebCore/GraphicsLayerClient.h>
35
36 #if PLATFORM(MAC)
37 #include <wtf/RetainPtr.h>
38 #ifdef __OBJC__
39 @class CALayer;
40 #else
41 class CALayer;
42 #endif
43 typedef struct __WKCARemoteLayerClientRef *WKCARemoteLayerClientRef;
44 #endif
45
46 namespace WebCore {
47     class GraphicsContext;
48     class GraphicsLayer;
49     class IntRect;
50 }
51
52 namespace WebKit {
53
54 class LayerBackedDrawingArea : public DrawingArea, private WebCore::GraphicsLayerClient {
55 public:
56     LayerBackedDrawingArea(WebPage*);
57     virtual ~LayerBackedDrawingArea();
58
59     virtual void invalidateWindow(const WebCore::IntRect& rect, bool immediate);
60     virtual void invalidateContentsAndWindow(const WebCore::IntRect& rect, bool immediate);
61     virtual void invalidateContentsForSlowScroll(const WebCore::IntRect& rect, bool immediate);
62     virtual void scroll(const WebCore::IntSize& scrollDelta, const WebCore::IntRect& rectToScroll, const WebCore::IntRect& clipRect);
63     virtual void setNeedsDisplay(const WebCore::IntRect&);
64     virtual void display();
65
66     virtual void attachCompositingContext(WebCore::GraphicsLayer*);
67     virtual void detachCompositingContext();
68     virtual void scheduleCompositingLayerSync();
69     virtual void syncCompositingLayers();
70
71     virtual void didReceiveMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder&);
72
73 private:
74
75     // GraphicsLayerClient
76     virtual void notifyAnimationStarted(const WebCore::GraphicsLayer*, double /*time*/) { }
77     virtual void notifySyncRequired(const WebCore::GraphicsLayer*) { }
78 public:
79     virtual void paintContents(const WebCore::GraphicsLayer*, WebCore::GraphicsContext&, WebCore::GraphicsLayerPaintingPhase, const WebCore::IntRect& inClip);
80 private:
81     virtual bool showDebugBorders() const;
82     virtual bool showRepaintCounter() const;
83
84     void scheduleDisplay();
85     
86     // CoreIPC message handlers.
87     void setSize(const WebCore::IntSize& viewSize);
88     void suspendPainting();
89     void resumePainting();
90     void didUpdate();
91     
92     void platformInit();
93     void platformClear();
94
95 #if PLATFORM(MAC)
96     void setUpUpdateLayoutRunLoopObserver();
97     void scheduleUpdateLayoutRunLoopObserver();
98     void removeUpdateLayoutRunLoopObserver();
99
100     static void updateLayoutRunLoopObserverCallback(CFRunLoopObserverRef, CFRunLoopActivity, void*);
101     void updateLayoutRunLoopObserverFired();
102 #endif
103
104     RunLoop::Timer<LayerBackedDrawingArea> m_syncTimer;
105
106     OwnPtr<WebCore::GraphicsLayer> m_backingLayer;
107 #if PLATFORM(MAC)
108     RetainPtr<WKCARemoteLayerClientRef> m_remoteLayerRef;
109     RetainPtr<CFRunLoopObserverRef> m_updateLayoutRunLoopObserver;
110 #endif
111
112     bool m_attached;
113     bool m_shouldPaint;
114 };
115
116 } // namespace WebKit
117
118 #endif // USE(ACCELERATED_COMPOSITING)
119
120 #endif // LayerBackedDrawingArea_h