InspectorDebuggerAgent.h [plain text]
#ifndef InspectorDebuggerAgent_h
#define InspectorDebuggerAgent_h
#include "InspectorBackendDispatchers.h"
#include "InspectorFrontendDispatchers.h"
#include "bindings/ScriptValue.h"
#include "debugger/Debugger.h"
#include "inspector/InspectorAgentBase.h"
#include "inspector/ScriptBreakpoint.h"
#include "inspector/ScriptDebugListener.h"
#include <wtf/Forward.h>
#include <wtf/HashMap.h>
#include <wtf/Noncopyable.h>
#include <wtf/Vector.h>
#include <wtf/text/StringHash.h>
namespace WTF {
class Stopwatch;
}
namespace Inspector {
class InjectedScript;
class InjectedScriptManager;
class InspectorArray;
class InspectorObject;
class InspectorValue;
class ScriptDebugServer;
typedef String ErrorString;
class JS_EXPORT_PRIVATE InspectorDebuggerAgent : public InspectorAgentBase, public ScriptDebugListener, public DebuggerBackendDispatcherHandler {
WTF_MAKE_NONCOPYABLE(InspectorDebuggerAgent);
WTF_MAKE_FAST_ALLOCATED;
public:
static const char* backtraceObjectGroup;
virtual ~InspectorDebuggerAgent();
virtual void didCreateFrontendAndBackend(FrontendChannel*, BackendDispatcher*) override;
virtual void willDestroyFrontendAndBackend(DisconnectReason) override;
virtual void enable(ErrorString&) override;
virtual void disable(ErrorString&) override;
virtual void setBreakpointsActive(ErrorString&, bool active) override;
virtual void setBreakpointByUrl(ErrorString&, int lineNumber, const String* optionalURL, const String* optionalURLRegex, const int* optionalColumnNumber, const Inspector::InspectorObject* options, Inspector::Protocol::Debugger::BreakpointId*, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Debugger::Location>>& locations) override;
virtual void setBreakpoint(ErrorString&, const Inspector::InspectorObject& location, const Inspector::InspectorObject* options, Inspector::Protocol::Debugger::BreakpointId*, RefPtr<Inspector::Protocol::Debugger::Location>& actualLocation) override;
virtual void removeBreakpoint(ErrorString&, const String& breakpointIdentifier) override;
virtual void continueToLocation(ErrorString&, const InspectorObject& location) override;
virtual void searchInContent(ErrorString&, const String& scriptID, const String& query, const bool* optionalCaseSensitive, const bool* optionalIsRegex, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::GenericTypes::SearchMatch>>&) override;
virtual void getScriptSource(ErrorString&, const String& scriptID, String* scriptSource) override;
virtual void getFunctionDetails(ErrorString&, const String& functionId, RefPtr<Inspector::Protocol::Debugger::FunctionDetails>&) override;
virtual void pause(ErrorString&) override;
virtual void resume(ErrorString&) override;
virtual void stepOver(ErrorString&) override;
virtual void stepInto(ErrorString&) override;
virtual void stepOut(ErrorString&) override;
virtual void setPauseOnExceptions(ErrorString&, const String& pauseState) override;
virtual void evaluateOnCallFrame(ErrorString&, const String& callFrameId, const String& expression, const String* objectGroup, const bool* includeCommandLineAPI, const bool* doNotPauseOnExceptionsAndMuteConsole, const bool* returnByValue, const bool* generatePreview, const bool* saveResult, RefPtr<Inspector::Protocol::Runtime::RemoteObject>& result, Inspector::Protocol::OptOutput<bool>* wasThrown, Inspector::Protocol::OptOutput<int>* savedResultIndex) override;
virtual void setOverlayMessage(ErrorString&, const String*) override;
bool isPaused();
void setSuppressAllPauses(bool);
void handleConsoleAssert(const String& message);
void schedulePauseOnNextStatement(DebuggerFrontendDispatcher::Reason breakReason, RefPtr<InspectorObject>&& data);
void cancelPauseOnNextStatement();
void breakProgram(DebuggerFrontendDispatcher::Reason breakReason, RefPtr<InspectorObject>&& data);
void scriptExecutionBlockedByCSP(const String& directiveText);
class Listener {
public:
virtual ~Listener() { }
virtual void debuggerWasEnabled() = 0;
virtual void debuggerWasDisabled() = 0;
virtual void stepInto() = 0;
virtual void didPause() = 0;
};
void setListener(Listener* listener) { m_listener = listener; }
virtual ScriptDebugServer& scriptDebugServer() = 0;
protected:
InspectorDebuggerAgent(InjectedScriptManager*);
InjectedScriptManager* injectedScriptManager() const { return m_injectedScriptManager; }
virtual InjectedScript injectedScriptForEval(ErrorString&, const int* executionContextId) = 0;
virtual void startListeningScriptDebugServer() = 0;
virtual void stopListeningScriptDebugServer(bool skipRecompile) = 0;
virtual void muteConsole() = 0;
virtual void unmuteConsole() = 0;
virtual void enable();
virtual void disable(bool skipRecompile);
virtual void didPause(JSC::ExecState*, const Deprecated::ScriptValue& callFrames, const Deprecated::ScriptValue& exceptionOrCaughtValue) override;
virtual void didContinue() override;
virtual String sourceMapURLForScript(const Script&);
void didClearGlobalObject();
private:
Ref<Inspector::Protocol::Array<Inspector::Protocol::Debugger::CallFrame>> currentCallFrames(InjectedScript);
virtual void didParseSource(JSC::SourceID, const Script&) override final;
virtual void failedToParseSource(const String& url, const String& data, int firstLine, int errorLine, const String& errorMessage) override final;
virtual void breakpointActionSound(int breakpointActionIdentifier) override;
virtual void breakpointActionProbe(JSC::ExecState*, const ScriptBreakpointAction&, unsigned batchId, unsigned sampleId, const Deprecated::ScriptValue& sample) override final;
RefPtr<Inspector::Protocol::Debugger::Location> resolveBreakpoint(const String& breakpointIdentifier, JSC::SourceID, const ScriptBreakpoint&);
bool assertPaused(ErrorString&);
void clearDebuggerBreakpointState();
void clearInspectorBreakpointState();
void clearBreakDetails();
void clearExceptionValue();
RefPtr<InspectorObject> buildBreakpointPauseReason(JSC::BreakpointID);
RefPtr<InspectorObject> buildExceptionPauseReason(const Deprecated::ScriptValue& exception, const InjectedScript&);
bool breakpointActionsFromProtocol(ErrorString&, RefPtr<InspectorArray>& actions, BreakpointActions* result);
typedef HashMap<JSC::SourceID, Script> ScriptsMap;
typedef HashMap<String, Vector<JSC::BreakpointID>> BreakpointIdentifierToDebugServerBreakpointIDsMap;
typedef HashMap<String, RefPtr<InspectorObject>> BreakpointIdentifierToBreakpointMap;
typedef HashMap<JSC::BreakpointID, String> DebugServerBreakpointIDToBreakpointIdentifier;
InjectedScriptManager* m_injectedScriptManager;
std::unique_ptr<DebuggerFrontendDispatcher> m_frontendDispatcher;
RefPtr<DebuggerBackendDispatcher> m_backendDispatcher;
Listener* m_listener {nullptr};
JSC::ExecState* m_pausedScriptState {nullptr};
Deprecated::ScriptValue m_currentCallStack;
ScriptsMap m_scripts;
BreakpointIdentifierToDebugServerBreakpointIDsMap m_breakpointIdentifierToDebugServerBreakpointIDs;
BreakpointIdentifierToBreakpointMap m_javaScriptBreakpoints;
DebugServerBreakpointIDToBreakpointIdentifier m_debuggerBreakpointIdentifierToInspectorBreakpointIdentifier;
JSC::BreakpointID m_continueToLocationBreakpointID;
DebuggerFrontendDispatcher::Reason m_breakReason;
RefPtr<InspectorObject> m_breakAuxData;
bool m_enabled {false};
bool m_javaScriptPauseScheduled {false};
bool m_hasExceptionValue {false};
bool m_didPauseStopwatch {false};
RefPtr<WTF::Stopwatch> m_stopwatch;
};
}
#endif // !defined(InspectorDebuggerAgent_h)