Web Inspector: Instrument active pixel memory used by canvases
[WebKit-https.git] / Source / WebCore / inspector / InspectorCanvasAgent.h
1 /*
2  * Copyright (C) 2017 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 "HTMLCanvasElement.h"
29 #include "InspectorWebAgentBase.h"
30 #include "Timer.h"
31 #include <inspector/InspectorBackendDispatchers.h>
32 #include <inspector/InspectorFrontendDispatchers.h>
33 #include <wtf/HashMap.h>
34 #include <wtf/HashSet.h>
35 #include <wtf/RefPtr.h>
36 #include <wtf/Vector.h>
37 #include <wtf/text/WTFString.h>
38
39 namespace WebCore {
40
41 class InspectorPageAgent;
42 class WebGLRenderingContextBase;
43
44 typedef String ErrorString;
45
46 class InspectorCanvasAgent final : public InspectorAgentBase, public CanvasObserver, public Inspector::CanvasBackendDispatcherHandler {
47     WTF_MAKE_NONCOPYABLE(InspectorCanvasAgent);
48     WTF_MAKE_FAST_ALLOCATED;
49 public:
50     InspectorCanvasAgent(WebAgentContext&, InspectorPageAgent*);
51     virtual ~InspectorCanvasAgent() { }
52
53     void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) override;
54     void willDestroyFrontendAndBackend(Inspector::DisconnectReason) override;
55     void discardAgent() override;
56
57     // CanvasBackendDispatcherHandler
58     void enable(ErrorString&) override;
59     void disable(ErrorString&) override;
60     void requestNode(ErrorString&, const String& canvasId, int* nodeId) override;
61     void requestContent(ErrorString&, const String& canvasId, String* content) override;
62
63     // InspectorInstrumentation
64     void frameNavigated(Frame&);
65     void didCreateCSSCanvas(HTMLCanvasElement&, const String&);
66     void didCreateCanvasRenderingContext(HTMLCanvasElement&);
67     void didChangeCanvasMemory(HTMLCanvasElement&);
68
69     // CanvasObserver
70     void canvasChanged(HTMLCanvasElement&, const FloatRect&) override { }
71     void canvasResized(HTMLCanvasElement&) override { }
72     void canvasDestroyed(HTMLCanvasElement&) override;
73
74 private:
75     struct CanvasEntry {
76         String identifier;
77         String cssCanvasName;
78         HTMLCanvasElement* element = { nullptr };
79
80         CanvasEntry() { }
81
82         CanvasEntry(const String& identifier, HTMLCanvasElement* canvasElement)
83             : identifier(identifier)
84             , element(canvasElement)
85         {
86         }
87     };
88
89     void canvasDestroyedTimerFired();
90     void clearCanvasData();
91     CanvasEntry* getCanvasEntry(HTMLCanvasElement&);
92     CanvasEntry* getCanvasEntry(const String&);
93     Ref<Inspector::Protocol::Canvas::Canvas> buildObjectForCanvas(const CanvasEntry&, HTMLCanvasElement&);
94
95     std::unique_ptr<Inspector::CanvasFrontendDispatcher> m_frontendDispatcher;
96     RefPtr<Inspector::CanvasBackendDispatcher> m_backendDispatcher;
97     InspectorPageAgent* m_pageAgent;
98
99     HashMap<HTMLCanvasElement*, CanvasEntry> m_canvasEntries;
100     HashMap<HTMLCanvasElement*, String> m_canvasToCSSCanvasId;
101     Vector<String> m_removedCanvasIdentifiers;
102     Timer m_timer;
103     bool m_enabled { false };
104 };
105
106 } // namespace WebCore