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