d88c2faba3f081215d00795fb0dcdbbcc4aab139
[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 "CallTracerTypes.h"
29 #include "HTMLCanvasElement.h"
30 #include "InspectorCanvas.h"
31 #include "InspectorWebAgentBase.h"
32 #include "Timer.h"
33 #include <inspector/InspectorBackendDispatchers.h>
34 #include <inspector/InspectorFrontendDispatchers.h>
35 #include <wtf/HashMap.h>
36 #include <wtf/RefPtr.h>
37 #include <wtf/Vector.h>
38 #include <wtf/text/WTFString.h>
39
40 namespace Inspector {
41 class InjectedScriptManager;
42 }
43
44 namespace WebCore {
45
46 class CanvasRenderingContext;
47 class WebGLRenderingContextBase;
48
49 typedef String ErrorString;
50
51 class InspectorCanvasAgent final : public InspectorAgentBase, public CanvasObserver, public Inspector::CanvasBackendDispatcherHandler {
52     WTF_MAKE_NONCOPYABLE(InspectorCanvasAgent);
53     WTF_MAKE_FAST_ALLOCATED;
54 public:
55     explicit InspectorCanvasAgent(WebAgentContext&);
56     virtual ~InspectorCanvasAgent() { }
57
58     void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) override;
59     void willDestroyFrontendAndBackend(Inspector::DisconnectReason) override;
60     void discardAgent() override;
61
62     // CanvasBackendDispatcherHandler
63     void enable(ErrorString&) override;
64     void disable(ErrorString&) override;
65     void requestNode(ErrorString&, const String& canvasId, int* nodeId) override;
66     void requestContent(ErrorString&, const String& canvasId, String* content) override;
67     void requestCSSCanvasClientNodes(ErrorString&, const String& canvasId, RefPtr<Inspector::Protocol::Array<int>>&) override;
68     void resolveCanvasContext(ErrorString&, const String& canvasId, const String* const objectGroup, RefPtr<Inspector::Protocol::Runtime::RemoteObject>&) override;
69     void requestRecording(ErrorString&, const String& canvasId, const bool* const singleFrame, const int* const memoryLimit) override;
70     void cancelRecording(ErrorString&, const String& canvasId) override;
71
72     // InspectorInstrumentation
73     void frameNavigated(Frame&);
74     void didCreateCSSCanvas(HTMLCanvasElement&, const String&);
75     void didChangeCSSCanvasClientNodes(HTMLCanvasElement&);
76     void didCreateCanvasRenderingContext(HTMLCanvasElement&);
77     void didChangeCanvasMemory(HTMLCanvasElement&);
78     void recordCanvasAction(CanvasRenderingContext&, const String&, Vector<RecordCanvasActionVariant>&& = { });
79     void didFinishRecordingCanvasFrame(HTMLCanvasElement&, bool forceDispatch = false);
80
81     // CanvasObserver
82     void canvasChanged(HTMLCanvasElement&, const FloatRect&) override { }
83     void canvasResized(HTMLCanvasElement&) override { }
84     void canvasDestroyed(HTMLCanvasElement&) override;
85
86 private:
87     void canvasDestroyedTimerFired();
88     void canvasRecordingTimerFired();
89     void clearCanvasData();
90     String unbindCanvas(InspectorCanvas&);
91     InspectorCanvas* assertInspectorCanvas(ErrorString&, const String&);
92     InspectorCanvas* findInspectorCanvas(HTMLCanvasElement&);
93
94     std::unique_ptr<Inspector::CanvasFrontendDispatcher> m_frontendDispatcher;
95     RefPtr<Inspector::CanvasBackendDispatcher> m_backendDispatcher;
96     Inspector::InjectedScriptManager& m_injectedScriptManager;
97
98     HashMap<String, RefPtr<InspectorCanvas>> m_identifierToInspectorCanvas;
99     HashMap<HTMLCanvasElement*, String> m_canvasToCSSCanvasName;
100     Vector<String> m_removedCanvasIdentifiers;
101     Timer m_canvasDestroyedTimer;
102     Timer m_canvasRecordingTimer;
103
104     bool m_enabled { false };
105 };
106
107 } // namespace WebCore