1/*
2 * Copyright (C) 2012 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 RemoteLayerTreeHost_h
27#define RemoteLayerTreeHost_h
28
29#include "LayerRepresentation.h"
30#include "RemoteLayerTreeTransaction.h"
31#include <WebCore/PlatformCALayer.h>
32#include <wtf/HashMap.h>
33#include <wtf/RetainPtr.h>
34
35OBJC_CLASS CAAnimation;
36OBJC_CLASS WKAnimationDelegate;
37
38namespace WebKit {
39
40class RemoteLayerTreeDrawingAreaProxy;
41class WebPageProxy;
42
43class RemoteLayerTreeHost {
44public:
45    explicit RemoteLayerTreeHost(RemoteLayerTreeDrawingAreaProxy&);
46    virtual ~RemoteLayerTreeHost();
47
48    LayerOrView *getLayer(WebCore::GraphicsLayer::PlatformLayerID) const;
49    LayerOrView *rootLayer() const { return m_rootLayer; }
50
51    static WebCore::GraphicsLayer::PlatformLayerID layerID(CALayer*);
52
53    // Returns true if the root layer changed.
54    bool updateLayerTree(const RemoteLayerTreeTransaction&, float indicatorScaleFactor  = 1);
55
56    void setIsDebugLayerTreeHost(bool flag) { m_isDebugLayerTreeHost = flag; }
57    bool isDebugLayerTreeHost() const { return m_isDebugLayerTreeHost; }
58
59    typedef HashMap<WebCore::GraphicsLayer::PlatformLayerID, RetainPtr<WKAnimationDelegate>> LayerAnimationDelegateMap;
60    LayerAnimationDelegateMap& animationDelegates() { return m_animationDelegates; }
61
62    void animationDidStart(WebCore::GraphicsLayer::PlatformLayerID, CAAnimation *, double startTime);
63
64    void clearLayers();
65
66    // Detach the root layer; it will be reattached upon the next incoming commit.
67    void detachRootLayer();
68
69private:
70    LayerOrView *createLayer(const RemoteLayerTreeTransaction::LayerCreationProperties&, const RemoteLayerTreeTransaction::LayerProperties*);
71    static void setLayerID(CALayer *, WebCore::GraphicsLayer::PlatformLayerID);
72
73    void layerWillBeRemoved(WebCore::GraphicsLayer::PlatformLayerID);
74
75    RemoteLayerTreeDrawingAreaProxy& m_drawingArea;
76    LayerOrView *m_rootLayer;
77    HashMap<WebCore::GraphicsLayer::PlatformLayerID, RetainPtr<LayerOrView>> m_layers;
78    HashMap<WebCore::GraphicsLayer::PlatformLayerID, RetainPtr<WKAnimationDelegate>> m_animationDelegates;
79    bool m_isDebugLayerTreeHost;
80};
81
82} // namespace WebKit
83
84#endif // RemoteLayerTreeHost_h
85