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