[WTF] Import std::optional reference implementation as WTF::Optional
[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 #pragma once
27
28 #include "DrawingAreaInfo.h"
29 #include "LayerTreeContext.h"
30 #include "MessageReceiver.h"
31 #include <WebCore/ActivityState.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 <functional>
38 #include <wtf/Forward.h>
39 #include <wtf/Noncopyable.h>
40 #include <wtf/TypeCasts.h>
41 #include <wtf/Vector.h>
42
43 namespace IPC {
44 class Connection;
45 class Decoder;
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 setViewExposedRect(std::optional<WebCore::FloatRect>) = 0;
92     virtual std::optional<WebCore::FloatRect> viewExposedRect() const = 0;
93
94     virtual void acceleratedAnimationDidStart(uint64_t /*layerID*/, const String& /*key*/, double /*startTime*/) { }
95     virtual void acceleratedAnimationDidEnd(uint64_t /*layerID*/, const String& /*key*/) { }
96     virtual void addFence(const WebCore::MachSendRight&) { }
97 #endif
98 #if PLATFORM(IOS)
99     virtual WebCore::FloatRect exposedContentRect() const = 0;
100     virtual void setExposedContentRect(const WebCore::FloatRect&) = 0;
101 #endif
102     virtual void mainFrameScrollabilityChanged(bool) { }
103
104     virtual bool supportsAsyncScrolling() { return false; }
105
106     virtual bool shouldUseTiledBackingForFrameView(const WebCore::FrameView*) { return false; }
107
108     virtual WebCore::GraphicsLayerFactory* graphicsLayerFactory() { return nullptr; }
109     virtual void setRootCompositingLayer(WebCore::GraphicsLayer*) = 0;
110     virtual void scheduleCompositingLayerFlush() = 0;
111     virtual void scheduleCompositingLayerFlushImmediately() = 0;
112
113 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
114     virtual RefPtr<WebCore::DisplayRefreshMonitor> createDisplayRefreshMonitor(WebCore::PlatformDisplayID);
115 #endif
116
117 #if USE(COORDINATED_GRAPHICS_MULTIPROCESS)
118     virtual void didReceiveCoordinatedLayerTreeHostMessage(IPC::Connection&, IPC::Decoder&) = 0;
119 #endif
120
121     virtual void dispatchAfterEnsuringUpdatedScrollPosition(std::function<void ()>);
122
123     virtual void activityStateDidChange(WebCore::ActivityState::Flags, bool /* wantsDidUpdateActivityState */, const Vector<uint64_t>& /* callbackIDs */) { }
124     virtual void setLayerHostingMode(LayerHostingMode) { }
125
126     virtual bool markLayersVolatileImmediatelyIfPossible() { return true; }
127
128     virtual bool adjustLayerFlushThrottling(WebCore::LayerFlushThrottleState::Flags) { return false; }
129
130     virtual void attachViewOverlayGraphicsLayer(WebCore::Frame*, WebCore::GraphicsLayer*) { }
131
132     virtual void setShouldScaleViewToFitDocument(bool) { }
133
134     virtual bool dispatchDidReachLayoutMilestone(WebCore::LayoutMilestones) { return false; }
135
136 #if PLATFORM(COCOA)
137     // Used by TiledCoreAnimationDrawingArea.
138     virtual void updateGeometry(const WebCore::IntSize& viewSize, const WebCore::IntSize& layerPosition, bool flushSynchronously, const WebCore::MachSendRight& fencePort) { }
139 #endif
140
141     virtual void layerHostDidFlushLayers() { };
142
143 protected:
144     DrawingArea(DrawingAreaType, WebPage&);
145
146     DrawingAreaType m_type;
147     WebPage& m_webPage;
148
149 #if USE(TEXTURE_MAPPER_GL) && PLATFORM(GTK) && PLATFORM(X11) && !USE(REDIRECTED_XCOMPOSITE_WINDOW)
150     uint64_t m_nativeSurfaceHandleForCompositing { 0 };
151 #endif
152
153 private:
154     // IPC::MessageReceiver.
155     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
156     void didReceiveSyncMessage(IPC::Connection&, IPC::Decoder&, std::unique_ptr<IPC::Encoder>&) override;
157
158     // Message handlers.
159     // FIXME: These should be pure virtual.
160     virtual void updateBackingStoreState(uint64_t /*backingStoreStateID*/, bool /*respondImmediately*/, float /*deviceScaleFactor*/, const WebCore::IntSize& /*size*/, 
161                                          const WebCore::IntSize& /*scrollOffset*/) { }
162     virtual void didUpdate() { }
163
164 #if PLATFORM(COCOA)
165     // Used by TiledCoreAnimationDrawingArea.
166     virtual void setDeviceScaleFactor(float) { }
167     virtual void setColorSpace(const ColorSpaceData&) { }
168
169     virtual void adjustTransientZoom(double scale, WebCore::FloatPoint origin) { }
170     virtual void commitTransientZoom(double scale, WebCore::FloatPoint origin) { }
171
172     virtual void addTransactionCallbackID(uint64_t callbackID) { ASSERT_NOT_REACHED(); }
173 #endif
174
175 #if USE(TEXTURE_MAPPER_GL) && PLATFORM(GTK) && PLATFORM(X11) && !USE(REDIRECTED_XCOMPOSITE_WINDOW)
176     virtual void setNativeSurfaceHandleForCompositing(uint64_t) = 0;
177     virtual void destroyNativeSurfaceHandleForCompositing(bool&) = 0;
178 #endif
179 };
180
181 } // namespace WebKit
182
183 #define SPECIALIZE_TYPE_TRAITS_DRAWING_AREA(ToValueTypeName, AreaType) \
184 SPECIALIZE_TYPE_TRAITS_BEGIN(WebKit::ToValueTypeName) \
185     static bool isType(const WebKit::DrawingArea& area) { return area.type() == WebKit::AreaType; } \
186 SPECIALIZE_TYPE_TRAITS_END()