53804819cbf19c0ef7b9ae12ba1b0ec5944ff638
[WebKit-https.git] / Source / WebKit / UIProcess / RemoteLayerTree / RemoteLayerTreeNode.h
1 /*
2  * Copyright (C) 2018 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 <WebCore/GraphicsLayer.h>
29 #include <wtf/RetainPtr.h>
30
31 OBJC_CLASS CALayer;
32 #if PLATFORM(IOS_FAMILY)
33 OBJC_CLASS UIView;
34 #endif
35
36 namespace WebKit {
37
38 class RemoteLayerTreeScrollbars;
39
40 class RemoteLayerTreeNode {
41     WTF_MAKE_FAST_ALLOCATED;
42 public:
43     RemoteLayerTreeNode(WebCore::GraphicsLayer::PlatformLayerID, RetainPtr<CALayer>);
44 #if PLATFORM(IOS_FAMILY)
45     RemoteLayerTreeNode(WebCore::GraphicsLayer::PlatformLayerID, RetainPtr<UIView>);
46 #endif
47     ~RemoteLayerTreeNode();
48
49     static std::unique_ptr<RemoteLayerTreeNode> createWithPlainLayer(WebCore::GraphicsLayer::PlatformLayerID);
50
51     CALayer *layer() const { return m_layer.get(); }
52 #if PLATFORM(IOS_FAMILY)
53     UIView *uiView() const { return m_uiView.get(); }
54 #endif
55
56     WebCore::GraphicsLayer::PlatformLayerID layerID() const { return m_layerID; }
57
58     const WebCore::Region& eventRegion() const { return m_eventRegion; }
59     void setEventRegion(const WebCore::Region&);
60
61     void detachFromParent();
62
63     static WebCore::GraphicsLayer::PlatformLayerID layerID(CALayer *);
64     static RemoteLayerTreeNode* forCALayer(CALayer *);
65
66     static NSString *appendLayerDescription(NSString *description, CALayer *);
67
68 private:
69     void initializeLayer();
70
71     WebCore::GraphicsLayer::PlatformLayerID m_layerID;
72
73     RetainPtr<CALayer> m_layer;
74 #if PLATFORM(IOS_FAMILY)
75     RetainPtr<UIView> m_uiView;
76 #endif
77
78     WebCore::Region m_eventRegion;
79 };
80
81 }