com.github.kklisura.cdt.protocol.commands

Interface Debugger

public interface Debugger

Debugger domain exposes JavaScript debugging capabilities. It allows setting and removing breakpoints, stepping through execution, exploring stack traces, etc.

Method Summary

Modifier and Type	Method and Description
void	continueToLocation(Location location) Continues execution until specific location is reached.
void	continueToLocation(Location location, ContinueToLocationTargetCallFrames targetCallFrames) Continues execution until specific location is reached.
void	disable() Disables debugger for given page.
String	enable() Enables debugger for the given page.
String	enable(Double maxScriptsCacheSize) Enables debugger for the given page.
EvaluateOnCallFrame	evaluateOnCallFrame(String callFrameId, String expression) Evaluates expression on a given call frame.
EvaluateOnCallFrame	evaluateOnCallFrame(String callFrameId, String expression, String objectGroup, Boolean includeCommandLineAPI, Boolean silent, Boolean returnByValue, Boolean generatePreview, Boolean throwOnSideEffect, Double timeout) Evaluates expression on a given call frame.
List<BreakLocation>	getPossibleBreakpoints(Location start) Returns possible locations for breakpoint.
List<BreakLocation>	getPossibleBreakpoints(Location start, Location end, Boolean restrictToFunction) Returns possible locations for breakpoint.
ScriptSource	getScriptSource(String scriptId) Returns source for the script with given id.
StackTrace	getStackTrace(StackTraceId stackTraceId) Returns stack trace with given `stackTraceId`.
String	getWasmBytecode(String scriptId) Deprecated.
EventListener	onBreakpointResolved(EventHandler<BreakpointResolved> eventListener) Fired when breakpoint is resolved to an actual script and location.
EventListener	onPaused(EventHandler<Paused> eventListener) Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.
EventListener	onResumed(EventHandler<Resumed> eventListener) Fired when the virtual machine resumed execution.
EventListener	onScriptFailedToParse(EventHandler<ScriptFailedToParse> eventListener) Fired when virtual machine fails to parse the script.
EventListener	onScriptParsed(EventHandler<ScriptParsed> eventListener) Fired when virtual machine parses script.
void	pause() Stops on the next JavaScript statement.
void	pauseOnAsyncCall(StackTraceId parentStackTraceId) Deprecated.
void	removeBreakpoint(String breakpointId) Removes JavaScript breakpoint.
RestartFrame	restartFrame(String callFrameId) Restarts particular call frame from the beginning.
void	resume() Resumes JavaScript execution.
void	resume(Boolean terminateOnResume) Resumes JavaScript execution.
List<SearchMatch>	searchInContent(String scriptId, String query) Searches for given string in script content.
List<SearchMatch>	searchInContent(String scriptId, String query, Boolean caseSensitive, Boolean isRegex) Searches for given string in script content.
void	setAsyncCallStackDepth(Integer maxDepth) Enables or disables async call stacks tracking.
void	setBlackboxedRanges(String scriptId, List<ScriptPosition> positions) Makes backend skip steps in the script in blackboxed ranges.
void	setBlackboxPatterns(List<String> patterns) Replace previous blackbox patterns with passed ones.
SetBreakpoint	setBreakpoint(Location location) Sets JavaScript breakpoint at a given location.
SetBreakpoint	setBreakpoint(Location location, String condition) Sets JavaScript breakpoint at a given location.
SetBreakpointByUrl	setBreakpointByUrl(Integer lineNumber) Sets JavaScript breakpoint at given location specified either by URL or URL regex.
SetBreakpointByUrl	setBreakpointByUrl(Integer lineNumber, String url, String urlRegex, String scriptHash, Integer columnNumber, String condition) Sets JavaScript breakpoint at given location specified either by URL or URL regex.
String	setBreakpointOnFunctionCall(String objectId) Sets JavaScript breakpoint before each call to the given function.
String	setBreakpointOnFunctionCall(String objectId, String condition) Sets JavaScript breakpoint before each call to the given function.
void	setBreakpointsActive(Boolean active) Activates / deactivates all breakpoints on the page.
String	setInstrumentationBreakpoint(SetInstrumentationBreakpointInstrumentation instrumentation) Sets instrumentation breakpoint.
void	setPauseOnExceptions(SetPauseOnExceptionsState state) Defines pause on exceptions state.
void	setReturnValue(CallArgument newValue) Changes return value in top frame.
SetScriptSource	setScriptSource(String scriptId, String scriptSource) Edits JavaScript source live.
SetScriptSource	setScriptSource(String scriptId, String scriptSource, Boolean dryRun) Edits JavaScript source live.
void	setSkipAllPauses(Boolean skip) Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc).
void	setVariableValue(Integer scopeNumber, String variableName, CallArgument newValue, String callFrameId) Changes value of variable in a callframe.
void	stepInto() Steps into the function call.
void	stepInto(Boolean breakOnAsyncCall, List<LocationRange> skipList) Steps into the function call.
void	stepOut() Steps out of the function call.
void	stepOver() Steps over the statement.
void	stepOver(List<LocationRange> skipList) Steps over the statement.

Method Detail

continueToLocation

void continueToLocation(Location location)

Continues execution until specific location is reached.

Parameters:

location - Location to continue to.

continueToLocation

void continueToLocation(Location location,
                        ContinueToLocationTargetCallFrames targetCallFrames)

Continues execution until specific location is reached.

Parameters:

location - Location to continue to.

targetCallFrames -

disable

void disable()

Disables debugger for given page.

enable

String enable()

Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received.

enable

String enable(Double maxScriptsCacheSize)

Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received.

Parameters:

maxScriptsCacheSize - The maximum size in bytes of collected scripts (not referenced by other heap objects) the debugger can hold. Puts no limit if paramter is omitted.

evaluateOnCallFrame

EvaluateOnCallFrame evaluateOnCallFrame(String callFrameId,
                                        String expression)

Evaluates expression on a given call frame.

Parameters:

callFrameId - Call frame identifier to evaluate on.

expression - Expression to evaluate.

evaluateOnCallFrame

EvaluateOnCallFrame evaluateOnCallFrame(String callFrameId,
                                        String expression,
                                        String objectGroup,
                                        Boolean includeCommandLineAPI,
                                        Boolean silent,
                                        Boolean returnByValue,
                                        Boolean generatePreview,
                                        Boolean throwOnSideEffect,
                                        Double timeout)

Evaluates expression on a given call frame.

Parameters:

callFrameId - Call frame identifier to evaluate on.

expression - Expression to evaluate.

objectGroup - String object group name to put result into (allows rapid releasing resulting object handles using `releaseObjectGroup`).

includeCommandLineAPI - Specifies whether command line API should be available to the evaluated expression, defaults to false.

silent - In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides `setPauseOnException` state.

returnByValue - Whether the result is expected to be a JSON object that should be sent by value.

generatePreview - Whether preview should be generated for the result.

throwOnSideEffect - Whether to throw an exception if side effect cannot be ruled out during evaluation.

timeout - Terminate execution after timing out (number of milliseconds).

getPossibleBreakpoints

List<BreakLocation> getPossibleBreakpoints(Location start)

Returns possible locations for breakpoint. scriptId in start and end range locations should be the same.

Parameters:

start - Start of range to search possible breakpoint locations in.

getPossibleBreakpoints

List<BreakLocation> getPossibleBreakpoints(Location start,
                                           Location end,
                                           Boolean restrictToFunction)

Returns possible locations for breakpoint. scriptId in start and end range locations should be the same.

Parameters:

start - Start of range to search possible breakpoint locations in.

end - End of range to search possible breakpoint locations in (excluding). When not specified, end of scripts is used as end of range.

restrictToFunction - Only consider locations which are in the same (non-nested) function as start.

getScriptSource

ScriptSource getScriptSource(String scriptId)

Returns source for the script with given id.

Parameters:

scriptId - Id of the script to get source for.

getWasmBytecode

@Deprecated
String getWasmBytecode(String scriptId)

Deprecated.

This command is deprecated. Use getScriptSource instead.

Parameters:

scriptId - Id of the Wasm script to get source for.

getStackTrace

StackTrace getStackTrace(StackTraceId stackTraceId)

Returns stack trace with given `stackTraceId`.

Parameters:

stackTraceId -

pause

void pause()

Stops on the next JavaScript statement.

pauseOnAsyncCall

@Deprecated
void pauseOnAsyncCall(StackTraceId parentStackTraceId)

Deprecated.

Parameters:

parentStackTraceId - Debugger will pause when async call with given stack trace is started.

removeBreakpoint

void removeBreakpoint(String breakpointId)

Removes JavaScript breakpoint.

Parameters:

breakpointId -

restartFrame

RestartFrame restartFrame(String callFrameId)

Restarts particular call frame from the beginning.

Parameters:

callFrameId - Call frame identifier to evaluate on.

resume

void resume()

Resumes JavaScript execution.

resume

void resume(Boolean terminateOnResume)

Resumes JavaScript execution.

Parameters:

terminateOnResume - Set to true to terminate execution upon resuming execution. In contrast to Runtime.terminateExecution, this will allows to execute further JavaScript (i.e. via evaluation) until execution of the paused code is actually resumed, at which point termination is triggered. If execution is currently not paused, this parameter has no effect.

searchInContent

List<SearchMatch> searchInContent(String scriptId,
                                  String query)

Searches for given string in script content.

Parameters:

scriptId - Id of the script to search in.

query - String to search for.

searchInContent

List<SearchMatch> searchInContent(String scriptId,
                                  String query,
                                  Boolean caseSensitive,
                                  Boolean isRegex)

Searches for given string in script content.

Parameters:

scriptId - Id of the script to search in.

query - String to search for.

caseSensitive - If true, search is case sensitive.

isRegex - If true, treats string parameter as regex.

setAsyncCallStackDepth

void setAsyncCallStackDepth(Integer maxDepth)

Enables or disables async call stacks tracking.

Parameters:

maxDepth - Maximum depth of async call stacks. Setting to `0` will effectively disable collecting async call stacks (default).

setBlackboxPatterns

void setBlackboxPatterns(List<String> patterns)

Replace previous blackbox patterns with passed ones. Forces backend to skip stepping/pausing in scripts with url matching one of the patterns. VM will try to leave blackboxed script by performing 'step in' several times, finally resorting to 'step out' if unsuccessful.

Parameters:

patterns - Array of regexps that will be used to check script url for blackbox state.

setBlackboxedRanges

void setBlackboxedRanges(String scriptId,
                         List<ScriptPosition> positions)

Makes backend skip steps in the script in blackboxed ranges. VM will try leave blacklisted scripts by performing 'step in' several times, finally resorting to 'step out' if unsuccessful. Positions array contains positions where blackbox state is changed. First interval isn't blackboxed. Array should be sorted.

Parameters:

scriptId - Id of the script.

positions -

setBreakpoint

SetBreakpoint setBreakpoint(Location location)

Sets JavaScript breakpoint at a given location.

Parameters:

location - Location to set breakpoint in.

setBreakpoint

SetBreakpoint setBreakpoint(Location location,
                            String condition)

Sets JavaScript breakpoint at a given location.

Parameters:

location - Location to set breakpoint in.

condition - Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true.

setInstrumentationBreakpoint

String setInstrumentationBreakpoint(SetInstrumentationBreakpointInstrumentation instrumentation)

Sets instrumentation breakpoint.

Parameters:

instrumentation - Instrumentation name.

setBreakpointByUrl

SetBreakpointByUrl setBreakpointByUrl(Integer lineNumber)

Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in `locations` property. Further matching script parsing will result in subsequent `breakpointResolved` events issued. This logical breakpoint will survive page reloads.

Parameters:

lineNumber - Line number to set breakpoint at.

setBreakpointByUrl

SetBreakpointByUrl setBreakpointByUrl(Integer lineNumber,
                                      String url,
                                      String urlRegex,
                                      String scriptHash,
                                      Integer columnNumber,
                                      String condition)

Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in `locations` property. Further matching script parsing will result in subsequent `breakpointResolved` events issued. This logical breakpoint will survive page reloads.

Parameters:

lineNumber - Line number to set breakpoint at.

url - URL of the resources to set breakpoint on.

urlRegex - Regex pattern for the URLs of the resources to set breakpoints on. Either `url` or `urlRegex` must be specified.

scriptHash - Script hash of the resources to set breakpoint on.

columnNumber - Offset in the line to set breakpoint at.

condition - Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true.

setBreakpointOnFunctionCall

String setBreakpointOnFunctionCall(String objectId)

Sets JavaScript breakpoint before each call to the given function. If another function was created from the same source as a given one, calling it will also trigger the breakpoint.

Parameters:

objectId - Function object id.

setBreakpointOnFunctionCall

String setBreakpointOnFunctionCall(String objectId,
                                   String condition)

Sets JavaScript breakpoint before each call to the given function. If another function was created from the same source as a given one, calling it will also trigger the breakpoint.

Parameters:

objectId - Function object id.

condition - Expression to use as a breakpoint condition. When specified, debugger will stop on the breakpoint if this expression evaluates to true.

setBreakpointsActive

void setBreakpointsActive(Boolean active)

Activates / deactivates all breakpoints on the page.

Parameters:

active - New value for breakpoints active state.

setPauseOnExceptions

void setPauseOnExceptions(SetPauseOnExceptionsState state)

Defines pause on exceptions state. Can be set to stop on all exceptions, uncaught exceptions or no exceptions. Initial pause on exceptions state is `none`.

Parameters:

state - Pause on exceptions mode.

setReturnValue

void setReturnValue(CallArgument newValue)

Changes return value in top frame. Available only at return break position.

Parameters:

newValue - New return value.

setScriptSource

SetScriptSource setScriptSource(String scriptId,
                                String scriptSource)

Edits JavaScript source live.

Parameters:

scriptId - Id of the script to edit.

scriptSource - New content of the script.

setScriptSource

SetScriptSource setScriptSource(String scriptId,
                                String scriptSource,
                                Boolean dryRun)

Edits JavaScript source live.

Parameters:

scriptId - Id of the script to edit.

scriptSource - New content of the script.

dryRun - If true the change will not actually be applied. Dry run may be used to get result description without actually modifying the code.

setSkipAllPauses

void setSkipAllPauses(Boolean skip)

Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc).

Parameters:

skip - New value for skip pauses state.

setVariableValue

void setVariableValue(Integer scopeNumber,
                      String variableName,
                      CallArgument newValue,
                      String callFrameId)

Changes value of variable in a callframe. Object-based scopes are not supported and must be mutated manually.

Parameters:

scopeNumber - 0-based number of scope as was listed in scope chain. Only 'local', 'closure' and 'catch' scope types are allowed. Other scopes could be manipulated manually.

variableName - Variable name.

newValue - New variable value.

callFrameId - Id of callframe that holds variable.

stepInto

void stepInto()

Steps into the function call.

stepInto

void stepInto(Boolean breakOnAsyncCall,
              List<LocationRange> skipList)

Steps into the function call.

Parameters:

breakOnAsyncCall - Debugger will pause on the execution of the first async task which was scheduled before next pause.

skipList - The skipList specifies location ranges that should be skipped on step into.

stepOut

void stepOut()

Steps out of the function call.

stepOver

void stepOver()

Steps over the statement.

stepOver

void stepOver(List<LocationRange> skipList)

Steps over the statement.

Parameters:

skipList - The skipList specifies location ranges that should be skipped on step over.

onBreakpointResolved

EventListener onBreakpointResolved(EventHandler<BreakpointResolved> eventListener)

Fired when breakpoint is resolved to an actual script and location.

onPaused

EventListener onPaused(EventHandler<Paused> eventListener)

Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.

onResumed

EventListener onResumed(EventHandler<Resumed> eventListener)

Fired when the virtual machine resumed execution.

onScriptFailedToParse

EventListener onScriptFailedToParse(EventHandler<ScriptFailedToParse> eventListener)

Fired when virtual machine fails to parse the script.

onScriptParsed

EventListener onScriptParsed(EventHandler<ScriptParsed> eventListener)

Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger.