Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDebugger

An interface describing an application's visual debugger.

Hierarchy

  • IDebugger

Index

Properties

Methods

Properties

Readonly eventMessage

eventMessage: ISignal<IDebugger, Event>

Signal emitted for debug event messages.

Readonly isStarted

isStarted: boolean

Whether the current debugger is started.

Readonly model

model: IService

The debugger service's model.

session

session: ISession

The current debugger session.

Readonly sessionChanged

sessionChanged: ISignal<IDebugger, ISession>

Signal emitted upon session changed.

Methods

clearBreakpoints

  • clearBreakpoints(): Promise<void>

  • Removes all the breakpoints from the current notebook or console

    Returns Promise<void>

continue

  • continue(): Promise<void>

  • Continues the execution of the current thread.

    Returns Promise<void>

displayDefinedVariables

  • displayDefinedVariables(): Promise<void>

  • Requests all the defined variables and display them in the table view.

    Returns Promise<void>

evaluate

  • evaluate(expression: string): Promise<{ indexedVariables?: number; memoryReference?: string; namedVariables?: number; presentationHint?: VariablePresentationHint; result: string; type?: string; variablesReference: number }>

  • Evaluate an expression.

    Parameters

    • expression: string

    Returns Promise<{ indexedVariables?: number; memoryReference?: string; namedVariables?: number; presentationHint?: VariablePresentationHint; result: string; type?: string; variablesReference: number }>

getCodeId

  • getCodeId(code: string): string

  • Computes an id based on the given code.

    Parameters

    • code: string

    Returns string

getDebuggerState

  • getDebuggerState(): State

  • Get the debugger state

    Returns State

    Debugger state

getSource

  • getSource(source: Source): Promise<Source>

  • Retrieve the content of a source file.

    Parameters

    • source: Source

      The source object containing the path to the file.

    Returns Promise<Source>

hasStoppedThreads

  • hasStoppedThreads(): boolean

  • Whether there exist a thread in stopped state.

    Returns boolean

inspectVariable

  • inspectVariable(variablesReference: number): Promise<Variable[]>

  • Request variables for a given variable reference.

    Parameters

    • variablesReference: number

      The variable reference to request.

    Returns Promise<Variable[]>

isAvailable

  • Request whether debugging is available for the given session connection.

    Parameters

    Returns Promise<boolean>

next

  • next(): Promise<void>

  • Makes the current thread run again for one step.

    Returns Promise<void>

restart

  • restart(): Promise<void>

  • Restart the debugger. Precondition: isStarted

    Returns Promise<void>

restoreDebuggerState

  • restoreDebuggerState(state: State): Promise<boolean>

  • Restore the debugger state

    Parameters

    • state: State

      Debugger state

    Returns Promise<boolean>

    Whether the state has been restored successfully or not

restoreState

  • restoreState(autoStart: boolean): Promise<void>

  • Restore the state of a debug session.

    Parameters

    • autoStart: boolean

      when true, starts the debugger if it has not been started yet.

    Returns Promise<void>

start

  • start(): Promise<void>

  • Starts a debugger. Precondition: !isStarted

    Returns Promise<void>

stepIn

  • stepIn(): Promise<void>

  • Makes the current thread step in a function / method if possible.

    Returns Promise<void>

stepOut

  • stepOut(): Promise<void>

  • Makes the current thread step out a function / method if possible.

    Returns Promise<void>

stop

  • stop(): Promise<void>

  • Stops the debugger. Precondition: isStarted

    Returns Promise<void>

updateBreakpoints

  • updateBreakpoints(code: string, breakpoints: IBreakpoint[], path?: string): Promise<void>

  • Update all breakpoints of a cell at once.

    Parameters

    • code: string

      The code in the cell where the breakpoints are set.

    • breakpoints: IBreakpoint[]

      The list of breakpoints to set.

    • Optional path: string

      Optional path to the file where to set the breakpoints.

    Returns Promise<void>

Generated using TypeDoc