Avoid doing an extra layout in some cases while doing scale-to-fit
[WebKit-https.git] / Source / WebKit2 / WebProcess / WebPage / mac / TiledCoreAnimationDrawingArea.h
1 /*
2  * Copyright (C) 2011 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 TiledCoreAnimationDrawingArea_h
27 #define TiledCoreAnimationDrawingArea_h
28
29 #if !PLATFORM(IOS)
30
31 #include "DrawingArea.h"
32 #include "LayerTreeContext.h"
33 #include <WebCore/FloatRect.h>
34 #include <WebCore/LayerFlushScheduler.h>
35 #include <WebCore/LayerFlushSchedulerClient.h>
36 #include <WebCore/TransformationMatrix.h>
37 #include <wtf/HashMap.h>
38 #include <wtf/RetainPtr.h>
39 #include <wtf/RunLoop.h>
40
41 OBJC_CLASS CALayer;
42
43 namespace WebCore {
44 class FrameView;
45 class PlatformCALayer;
46 class TiledBacking;
47 }
48
49 namespace WebKit {
50
51 class LayerHostingContext;
52
53 class TiledCoreAnimationDrawingArea : public DrawingArea, WebCore::LayerFlushSchedulerClient {
54 public:
55     TiledCoreAnimationDrawingArea(WebPage&, const WebPageCreationParameters&);
56     virtual ~TiledCoreAnimationDrawingArea();
57
58 private:
59     // DrawingArea
60     virtual void setNeedsDisplay() override;
61     virtual void setNeedsDisplayInRect(const WebCore::IntRect&) override;
62     virtual void scroll(const WebCore::IntRect& scrollRect, const WebCore::IntSize& scrollDelta) override;
63
64     virtual void forceRepaint() override;
65     virtual bool forceRepaintAsync(uint64_t callbackID) override;
66     virtual void setLayerTreeStateIsFrozen(bool) override;
67     virtual bool layerTreeStateIsFrozen() const override;
68     virtual void setRootCompositingLayer(WebCore::GraphicsLayer*) override;
69     virtual void scheduleCompositingLayerFlush() override;
70     virtual void scheduleCompositingLayerFlushImmediately() override;
71
72     virtual void updatePreferences(const WebPreferencesStore&) override;
73     virtual void mainFrameContentSizeChanged(const WebCore::IntSize&) override;
74
75     virtual void setExposedRect(const WebCore::FloatRect&) override;
76     virtual WebCore::FloatRect exposedRect() const override { return m_scrolledExposedRect; }
77
78     virtual bool supportsAsyncScrolling() override { return true; }
79
80     virtual void dispatchAfterEnsuringUpdatedScrollPosition(std::function<void ()>) override;
81
82     virtual bool shouldUseTiledBackingForFrameView(const WebCore::FrameView*) override;
83
84     virtual void viewStateDidChange(WebCore::ViewState::Flags changed, bool wantsDidUpdateViewState, const Vector<uint64_t>&) override;
85     void didUpdateViewStateTimerFired();
86
87     virtual void attachViewOverlayGraphicsLayer(WebCore::Frame*, WebCore::GraphicsLayer*) override;
88
89     virtual void replyWithFenceAfterNextFlush(uint64_t callbackID) override;
90
91     // WebCore::LayerFlushSchedulerClient
92     virtual bool flushLayers() override;
93
94     // Message handlers.
95     virtual void updateGeometry(const WebCore::IntSize& viewSize, const WebCore::IntSize& layerPosition, bool flushSynchronously) override;
96     virtual void setDeviceScaleFactor(float) override;
97     void suspendPainting();
98     void resumePainting();
99     void setLayerHostingMode(LayerHostingMode) override;
100     virtual void setColorSpace(const ColorSpaceData&) override;
101     virtual void addFence(const WebCore::MachSendRight&) override;
102
103     virtual void setShouldScaleViewToFitDocument(bool) override;
104
105     virtual void adjustTransientZoom(double scale, WebCore::FloatPoint origin) override;
106     virtual void commitTransientZoom(double scale, WebCore::FloatPoint origin) override;
107     void applyTransientZoomToPage(double scale, WebCore::FloatPoint origin);
108     WebCore::PlatformCALayer* layerForTransientZoom() const;
109     WebCore::PlatformCALayer* shadowLayerForTransientZoom() const;
110
111     void applyTransientZoomToLayers(double scale, WebCore::FloatPoint origin);
112
113     void updateLayerHostingContext();
114
115     void setRootCompositingLayer(CALayer *);
116     void updateRootLayers();
117
118     WebCore::TiledBacking* mainFrameTiledBacking() const;
119     void updateDebugInfoLayer(bool showLayer);
120
121     void updateIntrinsicContentSizeIfNeeded();
122     void updateScrolledExposedRect();
123     void scaleViewToFitDocumentIfNeeded();
124
125     bool m_layerTreeStateIsFrozen;
126     WebCore::LayerFlushScheduler m_layerFlushScheduler;
127
128     std::unique_ptr<LayerHostingContext> m_layerHostingContext;
129
130     RetainPtr<CALayer> m_hostingLayer;
131     RetainPtr<CALayer> m_rootLayer;
132     RetainPtr<CALayer> m_debugInfoLayer;
133
134     RetainPtr<CALayer> m_pendingRootLayer;
135
136     bool m_isPaintingSuspended;
137
138     WebCore::FloatRect m_exposedRect;
139     WebCore::FloatRect m_scrolledExposedRect;
140
141     WebCore::IntSize m_lastSentIntrinsicContentSize;
142     bool m_inUpdateGeometry;
143
144     double m_transientZoomScale;
145     WebCore::FloatPoint m_transientZoomOrigin;
146
147     WebCore::TransformationMatrix m_transform;
148
149     RunLoop::Timer<TiledCoreAnimationDrawingArea> m_sendDidUpdateViewStateTimer;
150     Vector<uint64_t> m_nextViewStateChangeCallbackIDs;
151     bool m_wantsDidUpdateViewState;
152
153     WebCore::GraphicsLayer* m_viewOverlayRootLayer;
154
155     Vector<uint64_t> m_fenceCallbacksForAfterNextFlush;
156     bool m_shouldScaleViewToFitDocument { false };
157     bool m_isScalingViewToFitDocument { false };
158     WebCore::IntSize m_lastViewSizeForScaleToFit;
159     WebCore::IntSize m_lastDocumentSizeForScaleToFit;
160 };
161
162 } // namespace WebKit
163
164 SPECIALIZE_TYPE_TRAITS_DRAWING_AREA(TiledCoreAnimationDrawingArea, DrawingAreaTypeTiledCoreAnimation)
165
166 #endif // !PLATFORM(IOS)
167
168 #endif // TiledCoreAnimationDrawingArea_h