Combine event and touch action regions into a single class
[WebKit-https.git] / Source / WebCore / platform / graphics / ca / cocoa / PlatformCALayerCocoa.h
1 /*
2  * Copyright (C) 2010, 2013 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "PlatformCALayer.h"
29
30 OBJC_CLASS NSObject;
31
32 namespace WebCore {
33
34 class PlatformCALayerCocoa final : public PlatformCALayer {
35 public:
36     static Ref<PlatformCALayer> create(LayerType, PlatformCALayerClient*);
37     
38     // This function passes the layer as a void* rather than a PlatformLayer because PlatformLayer
39     // is defined differently for Obj C and C++. This allows callers from both languages.
40     static Ref<PlatformCALayer> create(void* platformLayer, PlatformCALayerClient*);
41
42     WEBCORE_EXPORT static LayerType layerTypeForPlatformLayer(PlatformLayer*);
43
44     ~PlatformCALayerCocoa();
45
46     void setOwner(PlatformCALayerClient*) override;
47
48     void setNeedsDisplay() override;
49     void setNeedsDisplayInRect(const FloatRect& dirtyRect) override;
50
51     void copyContentsFromLayer(PlatformCALayer*) override;
52
53     PlatformCALayer* superlayer() const override;
54     void removeFromSuperlayer() override;
55     void setSublayers(const PlatformCALayerList&) override;
56     void removeAllSublayers() override;
57     void appendSublayer(PlatformCALayer&) override;
58     void insertSublayer(PlatformCALayer&, size_t index) override;
59     void replaceSublayer(PlatformCALayer& reference, PlatformCALayer&) override;
60     const PlatformCALayerList* customSublayers() const override { return m_customSublayers.get(); }
61     void adoptSublayers(PlatformCALayer& source) override;
62
63     void addAnimationForKey(const String& key, PlatformCAAnimation&) override;
64     void removeAnimationForKey(const String& key) override;
65     RefPtr<PlatformCAAnimation> animationForKey(const String& key) override;
66     void animationStarted(const String& key, MonotonicTime beginTime) override;
67     void animationEnded(const String& key) override;
68
69     void setMask(PlatformCALayer*) override;
70
71     bool isOpaque() const override;
72     void setOpaque(bool) override;
73
74     FloatRect bounds() const override;
75     void setBounds(const FloatRect&) override;
76
77     FloatPoint3D position() const override;
78     void setPosition(const FloatPoint3D&) override;
79
80     FloatPoint3D anchorPoint() const override;
81     void setAnchorPoint(const FloatPoint3D&) override;
82
83     TransformationMatrix transform() const override;
84     void setTransform(const TransformationMatrix&) override;
85
86     TransformationMatrix sublayerTransform() const override;
87     void setSublayerTransform(const TransformationMatrix&) override;
88
89     bool isHidden() const override;
90     void setHidden(bool) override;
91
92     bool contentsHidden() const override;
93     void setContentsHidden(bool) override;
94
95     bool userInteractionEnabled() const override;
96     void setUserInteractionEnabled(bool) override;
97
98     void setBackingStoreAttached(bool) override;
99     bool backingStoreAttached() const override;
100
101     bool geometryFlipped() const override;
102     WEBCORE_EXPORT void setGeometryFlipped(bool) override;
103
104     bool isDoubleSided() const override;
105     void setDoubleSided(bool) override;
106
107     bool masksToBounds() const override;
108     void setMasksToBounds(bool) override;
109
110     bool acceleratesDrawing() const override;
111     void setAcceleratesDrawing(bool) override;
112
113     bool wantsDeepColorBackingStore() const override;
114     void setWantsDeepColorBackingStore(bool) override;
115
116     bool supportsSubpixelAntialiasedText() const override;
117     void setSupportsSubpixelAntialiasedText(bool) override;
118
119     bool hasContents() const override;
120     CFTypeRef contents() const override;
121     void setContents(CFTypeRef) override;
122
123     void setContentsRect(const FloatRect&) override;
124
125     void setMinificationFilter(FilterType) override;
126     void setMagnificationFilter(FilterType) override;
127
128     Color backgroundColor() const override;
129     void setBackgroundColor(const Color&) override;
130
131     void setBorderWidth(float) override;
132
133     void setBorderColor(const Color&) override;
134
135     float opacity() const override;
136     void setOpacity(float) override;
137     void setFilters(const FilterOperations&) override;
138     WEBCORE_EXPORT static bool filtersCanBeComposited(const FilterOperations&);
139     void copyFiltersFrom(const PlatformCALayer&) override;
140
141 #if ENABLE(CSS_COMPOSITING)
142     void setBlendMode(BlendMode) override;
143 #endif
144
145     void setName(const String&) override;
146
147     void setSpeed(float) override;
148
149     void setTimeOffset(CFTimeInterval) override;
150
151     float contentsScale() const override;
152     void setContentsScale(float) override;
153
154     float cornerRadius() const override;
155     void setCornerRadius(float) override;
156
157     void setEdgeAntialiasingMask(unsigned) override;
158
159     FloatRoundedRect shapeRoundedRect() const override;
160     void setShapeRoundedRect(const FloatRoundedRect&) override;
161
162     Path shapePath() const override;
163     void setShapePath(const Path&) override;
164
165     WindRule shapeWindRule() const override;
166     void setShapeWindRule(WindRule) override;
167
168     GraphicsLayer::CustomAppearance customAppearance() const override { return m_customAppearance; }
169     void updateCustomAppearance(GraphicsLayer::CustomAppearance) override;
170
171     void setEventRegion(const EventRegion&) override { }
172
173     GraphicsLayer::EmbeddedViewID embeddedViewID() const override;
174
175     TiledBacking* tiledBacking() override;
176
177     Ref<PlatformCALayer> clone(PlatformCALayerClient* owner) const override;
178
179     Ref<PlatformCALayer> createCompatibleLayer(PlatformCALayer::LayerType, PlatformCALayerClient*) const override;
180
181     void enumerateRectsBeingDrawn(CGContextRef, void (^block)(CGRect)) override;
182
183     unsigned backingStoreBytesPerPixel() const override;
184
185 private:
186     PlatformCALayerCocoa(LayerType, PlatformCALayerClient* owner);
187     PlatformCALayerCocoa(PlatformLayer*, PlatformCALayerClient* owner);
188
189     void commonInit();
190
191     bool isPlatformCALayerCocoa() const override { return true; }
192
193     bool requiresCustomAppearanceUpdateOnBoundsChange() const;
194
195     void updateContentsFormat();
196
197     AVPlayerLayer *avPlayerLayer() const;
198
199     RetainPtr<NSObject> m_delegate;
200     std::unique_ptr<PlatformCALayerList> m_customSublayers;
201     GraphicsLayer::CustomAppearance m_customAppearance { GraphicsLayer::CustomAppearance::None };
202     std::unique_ptr<FloatRoundedRect> m_shapeRoundedRect;
203     bool m_wantsDeepColorBackingStore { false };
204     bool m_supportsSubpixelAntialiasedText { false };
205     bool m_backingStoreAttached { true };
206 };
207
208 } // namespace WebCore
209
210 SPECIALIZE_TYPE_TRAITS_PLATFORM_CALAYER(WebCore::PlatformCALayerCocoa, isPlatformCALayerCocoa())