Web Inspector: Rename InspectorResourceAgent to InspectorNetworkAgent
[WebKit-https.git] / Source / WebCore / inspector / InspectorLayerTreeAgent.h
1 /*
2  * Copyright (C) 2012, 2015 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef InspectorLayerTreeAgent_h
30 #define InspectorLayerTreeAgent_h
31
32 #include "InspectorWebAgentBase.h"
33 #include "RenderLayer.h"
34 #include <inspector/InspectorBackendDispatchers.h>
35 #include <inspector/InspectorFrontendDispatchers.h>
36 #include <inspector/InspectorProtocolObjects.h>
37 #include <wtf/text/WTFString.h>
38
39 namespace WebCore {
40
41 typedef String ErrorString;
42
43 class InspectorLayerTreeAgent final : public InspectorAgentBase, public Inspector::LayerTreeBackendDispatcherHandler {
44     WTF_MAKE_FAST_ALLOCATED;
45 public:
46     explicit InspectorLayerTreeAgent(WebAgentContext&);
47     virtual ~InspectorLayerTreeAgent();
48
49     virtual void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) override;
50     virtual void willDestroyFrontendAndBackend(Inspector::DisconnectReason) override;
51     void reset();
52
53     // InspectorInstrumentation callbacks.
54     void layerTreeDidChange();
55     void renderLayerDestroyed(const RenderLayer&);
56     void pseudoElementDestroyed(PseudoElement&);
57
58     // Called from the front-end.
59     virtual void enable(ErrorString&) override;
60     virtual void disable(ErrorString&) override;
61     virtual void layersForNode(ErrorString&, int nodeId, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::LayerTree::Layer>>&) override;
62     virtual void reasonsForCompositingLayer(ErrorString&, const String& layerId, RefPtr<Inspector::Protocol::LayerTree::CompositingReasons>&) override;
63
64 private:
65     // RenderLayer-related methods.
66     String bind(const RenderLayer*);
67     void unbind(const RenderLayer*);
68
69     void gatherLayersUsingRenderObjectHierarchy(ErrorString&, RenderObject*, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::LayerTree::Layer>>&);
70     void gatherLayersUsingRenderLayerHierarchy(ErrorString&, RenderLayer*, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::LayerTree::Layer>>&);
71
72     Ref<Inspector::Protocol::LayerTree::Layer> buildObjectForLayer(ErrorString&, RenderLayer*);
73     Ref<Inspector::Protocol::LayerTree::IntRect> buildObjectForIntRect(const IntRect&);
74
75     int idForNode(ErrorString&, Node*);
76
77     String bindPseudoElement(PseudoElement*);
78     void unbindPseudoElement(PseudoElement*);
79
80     std::unique_ptr<Inspector::LayerTreeFrontendDispatcher> m_frontendDispatcher;
81     RefPtr<Inspector::LayerTreeBackendDispatcher> m_backendDispatcher;
82
83     HashMap<const RenderLayer*, String> m_documentLayerToIdMap;
84     HashMap<String, const RenderLayer*> m_idToLayer;
85
86     HashMap<PseudoElement*, String> m_pseudoElementToIdMap;
87     HashMap<String, PseudoElement*> m_idToPseudoElement;
88 };
89
90 } // namespace WebCore
91
92 #endif // !defined(InspectorLayerTreeAgent_h)