Web Inspector: tint all pixels drawn by shader program when hovering ShaderProgramTre...
[WebKit-https.git] / Source / WebCore / inspector / agents / 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 "CanvasBase.h"
30 #include "InspectorCanvas.h"
31 #include "InspectorWebAgentBase.h"
32 #include "Timer.h"
33 #include <JavaScriptCore/InspectorBackendDispatchers.h>
34 #include <JavaScriptCore/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 #if ENABLE(WEBGL)
41 #include "InspectorShaderProgram.h"
42 #endif
43
44 namespace Inspector {
45 class InjectedScriptManager;
46 }
47
48 namespace WebCore {
49
50 class CanvasRenderingContext;
51 #if ENABLE(WEBGL)
52 class WebGLProgram;
53 class WebGLRenderingContextBase;
54 #endif
55
56 typedef String ErrorString;
57
58 class InspectorCanvasAgent final : public InspectorAgentBase, public CanvasObserver, public Inspector::CanvasBackendDispatcherHandler {
59     WTF_MAKE_NONCOPYABLE(InspectorCanvasAgent);
60     WTF_MAKE_FAST_ALLOCATED;
61 public:
62     explicit InspectorCanvasAgent(WebAgentContext&);
63     virtual ~InspectorCanvasAgent() = default;
64
65     void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) override;
66     void willDestroyFrontendAndBackend(Inspector::DisconnectReason) override;
67     void discardAgent() override;
68
69     // CanvasBackendDispatcherHandler
70     void enable(ErrorString&) override;
71     void disable(ErrorString&) override;
72     void requestNode(ErrorString&, const String& canvasId, int* nodeId) override;
73     void requestContent(ErrorString&, const String& canvasId, String* content) override;
74     void requestCSSCanvasClientNodes(ErrorString&, const String& canvasId, RefPtr<JSON::ArrayOf<int>>&) override;
75     void resolveCanvasContext(ErrorString&, const String& canvasId, const String* objectGroup, RefPtr<Inspector::Protocol::Runtime::RemoteObject>&) override;
76     void startRecording(ErrorString&, const String& canvasId, const bool* singleFrame, const int* memoryLimit) override;
77     void stopRecording(ErrorString&, const String& canvasId) override;
78     void requestShaderSource(ErrorString&, const String& programId, const String& shaderType, String*) override;
79     void updateShader(ErrorString&, const String& programId, const String& shaderType, const String& source) override;
80     void setShaderProgramDisabled(ErrorString&, const String& programId, bool disabled) override;
81     void setShaderProgramHighlighted(ErrorString&, const String& programId, bool highlighted) override;
82
83     // InspectorInstrumentation
84     void frameNavigated(Frame&);
85     void didChangeCSSCanvasClientNodes(CanvasBase&);
86     void didCreateCanvasRenderingContext(CanvasRenderingContext&);
87     void willDestroyCanvasRenderingContext(CanvasRenderingContext&);
88     void didChangeCanvasMemory(CanvasRenderingContext&);
89     void recordCanvasAction(CanvasRenderingContext&, const String&, Vector<RecordCanvasActionVariant>&& = { });
90     void didFinishRecordingCanvasFrame(CanvasRenderingContext&, bool forceDispatch = false);
91     void consoleStartRecordingCanvas(CanvasRenderingContext&, JSC::ExecState&, JSC::JSObject* options);
92 #if ENABLE(WEBGL)
93     void didEnableExtension(WebGLRenderingContextBase&, const String&);
94     void didCreateProgram(WebGLRenderingContextBase&, WebGLProgram&);
95     void willDeleteProgram(WebGLProgram&);
96     bool isShaderProgramDisabled(WebGLProgram&);
97     bool isShaderProgramHighlighted(WebGLProgram&);
98 #endif
99
100     // CanvasObserver
101     void canvasChanged(CanvasBase&, const FloatRect&) override { }
102     void canvasResized(CanvasBase&) override { }
103     void canvasDestroyed(CanvasBase&) override;
104
105 private:
106     void canvasDestroyedTimerFired();
107     void canvasRecordingTimerFired();
108     void clearCanvasData();
109     String unbindCanvas(InspectorCanvas&);
110     InspectorCanvas* assertInspectorCanvas(ErrorString&, const String& identifier);
111     InspectorCanvas* findInspectorCanvas(CanvasRenderingContext&);
112 #if ENABLE(WEBGL)
113     String unbindProgram(InspectorShaderProgram&);
114     InspectorShaderProgram* assertInspectorProgram(ErrorString&, const String& identifier);
115     InspectorShaderProgram* findInspectorProgram(WebGLProgram&);
116
117     HashMap<String, RefPtr<InspectorShaderProgram>> m_identifierToInspectorProgram;
118 #endif
119
120     std::unique_ptr<Inspector::CanvasFrontendDispatcher> m_frontendDispatcher;
121     RefPtr<Inspector::CanvasBackendDispatcher> m_backendDispatcher;
122     Inspector::InjectedScriptManager& m_injectedScriptManager;
123     HashMap<String, RefPtr<InspectorCanvas>> m_identifierToInspectorCanvas;
124     Vector<String> m_removedCanvasIdentifiers;
125     Timer m_canvasDestroyedTimer;
126     Timer m_canvasRecordingTimer;
127
128     bool m_enabled { false };
129 };
130
131 } // namespace WebCore