726c5749ca422be10cd670ebfbcfe0500a92b655
[WebKit-https.git] / Source / WebKit2 / WebProcess / WebPage / DrawingArea.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 DrawingArea_h
27 #define DrawingArea_h
28
29 #include "DrawingAreaInfo.h"
30 #include "LayerTreeContext.h"
31 #include "MessageReceiver.h"
32 #include <WebCore/FloatRect.h>
33 #include <WebCore/IntRect.h>
34 #include <WebCore/LayerFlushThrottleState.h>
35 #include <WebCore/PlatformScreen.h>
36 #include <WebCore/ViewState.h>
37 #include <functional>
38 #include <wtf/Forward.h>
39 #include <wtf/Noncopyable.h>
40 #include <wtf/TypeCasts.h>
41
42 namespace IPC {
43 class Connection;
44 class MessageDecoder;
45 }
46
47 namespace WebCore {
48 class DisplayRefreshMonitor;
49 class Frame;
50 class FrameView;
51 class GraphicsLayer;
52 class GraphicsLayerFactory;
53 class MachSendRight;
54 }
55
56 namespace WebKit {
57
58 struct ColorSpaceData;
59 class LayerTreeHost;
60 class WebPage;
61 struct WebPageCreationParameters;
62 struct WebPreferencesStore;
63
64 class DrawingArea : public IPC::MessageReceiver {
65     WTF_MAKE_NONCOPYABLE(DrawingArea);
66
67 public:
68     static std::unique_ptr<DrawingArea> create(WebPage&, const WebPageCreationParameters&);
69     virtual ~DrawingArea();
70     
71     DrawingAreaType type() const { return m_type; }
72
73     virtual void setNeedsDisplay() = 0;
74     virtual void setNeedsDisplayInRect(const WebCore::IntRect&) = 0;
75     virtual void scroll(const WebCore::IntRect& scrollRect, const WebCore::IntSize& scrollDelta) = 0;
76
77     // FIXME: These should be pure virtual.
78     virtual void pageBackgroundTransparencyChanged() { }
79     virtual void forceRepaint() { }
80     virtual bool forceRepaintAsync(uint64_t /*callbackID*/) { return false; }
81     virtual void setLayerTreeStateIsFrozen(bool) { }
82     virtual bool layerTreeStateIsFrozen() const { return false; }
83     virtual LayerTreeHost* layerTreeHost() const { return 0; }
84
85     virtual void setPaintingEnabled(bool) { }
86     virtual void updatePreferences(const WebPreferencesStore&) { }
87     virtual void mainFrameContentSizeChanged(const WebCore::IntSize&) { }
88
89 #if PLATFORM(COCOA)
90     virtual void setExposedRect(const WebCore::FloatRect&) = 0;
91     virtual WebCore::FloatRect exposedRect() const = 0;
92     virtual void acceleratedAnimationDidStart(uint64_t /*layerID*/, const String& /*key*/, double /*startTime*/) { }
93     virtual void acceleratedAnimationDidEnd(uint64_t /*layerID*/, const String& /*key*/) { }
94     virtual void addFence(const WebCore::MachSendRight&) { }
95 #endif
96 #if PLATFORM(IOS)
97     virtual void setExposedContentRect(const WebCore::FloatRect&) = 0;
98 #endif
99     virtual void mainFrameScrollabilityChanged(bool) { }
100
101     virtual bool supportsAsyncScrolling() { return false; }
102
103     virtual bool shouldUseTiledBackingForFrameView(const WebCore::FrameView*) { return false; }
104
105     virtual WebCore::GraphicsLayerFactory* graphicsLayerFactory() { return nullptr; }
106     virtual void setRootCompositingLayer(WebCore::GraphicsLayer*) = 0;
107     virtual void scheduleCompositingLayerFlush() = 0;
108     virtual void scheduleCompositingLayerFlushImmediately() = 0;
109
110 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
111     virtual RefPtr<WebCore::DisplayRefreshMonitor> createDisplayRefreshMonitor(PlatformDisplayID);
112 #endif
113
114 #if USE(COORDINATED_GRAPHICS_MULTIPROCESS)
115     virtual void didReceiveCoordinatedLayerTreeHostMessage(IPC::Connection&, IPC::MessageDecoder&) = 0;
116 #endif
117
118     virtual void dispatchAfterEnsuringUpdatedScrollPosition(std::function<void ()>);
119
120     virtual void viewStateDidChange(WebCore::ViewState::Flags, bool /* wantsDidUpdateViewState */, const Vector<uint64_t>& /* callbackIDs */) { }
121     virtual void setLayerHostingMode(LayerHostingMode) { }
122
123     virtual bool markLayersVolatileImmediatelyIfPossible() { return true; }
124
125     virtual bool adjustLayerFlushThrottling(WebCore::LayerFlushThrottleState::Flags) { return false; }
126
127     virtual void attachViewOverlayGraphicsLayer(WebCore::Frame*, WebCore::GraphicsLayer*) { }
128
129 #if PLATFORM(COCOA)
130     // Used by TiledCoreAnimationDrawingArea.
131     virtual void updateGeometry(const WebCore::IntSize& viewSize, const WebCore::IntSize& layerPosition, bool flushSynchronously) { }
132
133     virtual void replyWithFenceAfterNextFlush(uint64_t callbackID) { ASSERT_NOT_REACHED(); }
134 #endif
135
136 protected:
137     DrawingArea(DrawingAreaType, WebPage&);
138
139     DrawingAreaType m_type;
140     WebPage& m_webPage;
141
142 #if USE(TEXTURE_MAPPER_GL) && PLATFORM(GTK)
143     uint64_t m_nativeSurfaceHandleForCompositing;
144 #endif
145
146 private:
147     // IPC::MessageReceiver.
148     virtual void didReceiveMessage(IPC::Connection&, IPC::MessageDecoder&) override;
149
150     // Message handlers.
151     // FIXME: These should be pure virtual.
152     virtual void updateBackingStoreState(uint64_t /*backingStoreStateID*/, bool /*respondImmediately*/, float /*deviceScaleFactor*/, const WebCore::IntSize& /*size*/, 
153                                          const WebCore::IntSize& /*scrollOffset*/) { }
154     virtual void didUpdate() { }
155
156 #if PLATFORM(COCOA)
157     // Used by TiledCoreAnimationDrawingArea.
158     virtual void setDeviceScaleFactor(float) { }
159     virtual void setColorSpace(const ColorSpaceData&) { }
160
161     virtual void adjustTransientZoom(double scale, WebCore::FloatPoint origin) { }
162     virtual void commitTransientZoom(double scale, WebCore::FloatPoint origin) { }
163
164     virtual void addTransactionCallbackID(uint64_t callbackID) { ASSERT_NOT_REACHED(); }
165 #endif
166
167 #if USE(TEXTURE_MAPPER_GL) && PLATFORM(GTK)
168     virtual void setNativeSurfaceHandleForCompositing(uint64_t) = 0;
169 #endif
170 };
171
172 } // namespace WebKit
173
174 #define SPECIALIZE_TYPE_TRAITS_DRAWING_AREA(ToValueTypeName, AreaType) \
175 SPECIALIZE_TYPE_TRAITS_BEGIN(WebKit::ToValueTypeName) \
176     static bool isType(const WebKit::DrawingArea& area) { return area.type() == WebKit::AreaType; } \
177 SPECIALIZE_TYPE_TRAITS_END()
178
179 #endif // DrawingArea_h