blob: a30c7fc4792caddaa4a6039b5dc0d0cb8f9f1712 [file] [log] [blame]
/*
* Copyright (C) 2017 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "CallTracerTypes.h"
#include "CanvasBase.h"
#include "InspectorCanvas.h"
#include "InspectorWebAgentBase.h"
#include "Timer.h"
#include <JavaScriptCore/InspectorBackendDispatchers.h>
#include <JavaScriptCore/InspectorFrontendDispatchers.h>
#include <initializer_list>
#include <wtf/Forward.h>
namespace Inspector {
class InjectedScriptManager;
}
namespace WebCore {
class CanvasRenderingContext;
class InspectorShaderProgram;
#if ENABLE(WEBGL)
class WebGLProgram;
class WebGLRenderingContextBase;
#endif
#if ENABLE(WEBGPU)
class GPUCanvasContext;
class WebGPUDevice;
class WebGPUPipeline;
class WebGPUSwapChain;
#endif
typedef String ErrorString;
class InspectorCanvasAgent final : public InspectorAgentBase, public Inspector::CanvasBackendDispatcherHandler, public CanvasObserver {
WTF_MAKE_NONCOPYABLE(InspectorCanvasAgent);
WTF_MAKE_FAST_ALLOCATED;
public:
InspectorCanvasAgent(PageAgentContext&);
~InspectorCanvasAgent() override;
// InspectorAgentBase
void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) override;
void willDestroyFrontendAndBackend(Inspector::DisconnectReason) override;
void discardAgent() override;
// CanvasBackendDispatcherHandler
void enable(ErrorString&) override;
void disable(ErrorString&) override;
void requestNode(ErrorString&, const String& canvasId, int* nodeId) override;
void requestContent(ErrorString&, const String& canvasId, String* content) override;
void requestClientNodes(ErrorString&, const String& canvasId, RefPtr<JSON::ArrayOf<int>>&) override;
void resolveContext(ErrorString&, const String& canvasId, const String* objectGroup, RefPtr<Inspector::Protocol::Runtime::RemoteObject>&) override;
void setRecordingAutoCaptureFrameCount(ErrorString&, int count) override;
void startRecording(ErrorString&, const String& canvasId, const int* frameCount, const int* memoryLimit) override;
void stopRecording(ErrorString&, const String& canvasId) override;
void requestShaderSource(ErrorString&, const String& programId, const String& shaderType, String* source) override;
void updateShader(ErrorString&, const String& programId, const String& shaderType, const String& source) override;
void setShaderProgramDisabled(ErrorString&, const String& programId, bool disabled) override;
void setShaderProgramHighlighted(ErrorString&, const String& programId, bool highlighted) override;
// CanvasObserver
void canvasChanged(CanvasBase&, const FloatRect&) override;
void canvasResized(CanvasBase&) override { }
void canvasDestroyed(CanvasBase&) override;
// InspectorInstrumentation
void frameNavigated(Frame&);
void didChangeCSSCanvasClientNodes(CanvasBase&);
void didCreateCanvasRenderingContext(CanvasRenderingContext&);
void didChangeCanvasMemory(CanvasRenderingContext&);
void recordCanvasAction(CanvasRenderingContext&, const String&, std::initializer_list<RecordCanvasActionVariant>&& = { });
void didFinishRecordingCanvasFrame(CanvasRenderingContext&, bool forceDispatch = false);
void consoleStartRecordingCanvas(CanvasRenderingContext&, JSC::ExecState&, JSC::JSObject* options);
#if ENABLE(WEBGL)
void didEnableExtension(WebGLRenderingContextBase&, const String&);
void didCreateWebGLProgram(WebGLRenderingContextBase&, WebGLProgram&);
void willDestroyWebGLProgram(WebGLProgram&);
bool isWebGLProgramDisabled(WebGLProgram&);
bool isWebGLProgramHighlighted(WebGLProgram&);
#endif
#if ENABLE(WEBGPU)
void didCreateWebGPUDevice(WebGPUDevice&);
void willDestroyWebGPUDevice(WebGPUDevice&);
void willConfigureSwapChain(GPUCanvasContext&, WebGPUSwapChain&);
void didCreateWebGPUPipeline(WebGPUDevice&, WebGPUPipeline&);
void willDestroyWebGPUPipeline(WebGPUPipeline&);
#endif
private:
struct RecordingOptions {
Optional<long> frameCount;
Optional<long> memoryLimit;
Optional<String> name;
};
void startRecording(InspectorCanvas&, Inspector::Protocol::Recording::Initiator, RecordingOptions&& = { });
void canvasDestroyedTimerFired();
void programDestroyedTimerFired();
void reset();
InspectorCanvas& bindCanvas(CanvasRenderingContext&, bool captureBacktrace);
#if ENABLE(WEBGPU)
InspectorCanvas& bindCanvas(WebGPUDevice&, bool captureBacktrace);
#endif
void unbindCanvas(InspectorCanvas&);
RefPtr<InspectorCanvas> assertInspectorCanvas(ErrorString&, const String& canvasId);
RefPtr<InspectorCanvas> findInspectorCanvas(CanvasRenderingContext&);
#if ENABLE(WEBGPU)
RefPtr<InspectorCanvas> findInspectorCanvas(WebGPUDevice&);
#endif
void unbindProgram(InspectorShaderProgram&);
RefPtr<InspectorShaderProgram> assertInspectorProgram(ErrorString&, const String& programId);
#if ENABLE(WEBGL)
RefPtr<InspectorShaderProgram> findInspectorProgram(WebGLProgram&);
#endif
#if ENABLE(WEBGPU)
RefPtr<InspectorShaderProgram> findInspectorProgram(WebGPUPipeline&);
#endif
std::unique_ptr<Inspector::CanvasFrontendDispatcher> m_frontendDispatcher;
RefPtr<Inspector::CanvasBackendDispatcher> m_backendDispatcher;
Inspector::InjectedScriptManager& m_injectedScriptManager;
Page& m_inspectedPage;
HashMap<String, RefPtr<InspectorCanvas>> m_identifierToInspectorCanvas;
Vector<String> m_removedCanvasIdentifiers;
Timer m_canvasDestroyedTimer;
HashMap<String, RefPtr<InspectorShaderProgram>> m_identifierToInspectorProgram;
Vector<String> m_removedProgramIdentifiers;
Timer m_programDestroyedTimer;
Optional<size_t> m_recordingAutoCaptureFrameCount;
};
} // namespace WebCore