Class DebugSession

Hierarchy (View Summary)

DebugSession
- PluginDebugSession

Implements

CompositeTreeElement

Index

Constructors

Accessors

autoExpandLazyVariables capabilities configuration currentFrame currentThread id label onDidCustomEvent onDidFocusStackFrame onDidFocusThread onDispose options parentSession runningThreads state stoppedThreads threadCount threads visible

Constructors

constructor

new DebugSession(): DebugSession
Returns DebugSession

Properties

`Protected`_capabilities

_capabilities: Capabilities = {}

`Protected`_currentThread

_currentThread: undefined | DebugThread

`Protected`_threads

_threads: Map<number, DebugThread> = ...

`Protected` `Readonly`breakpoints

breakpoints: BreakpointManager

`Protected` `Readonly`childSessions

childSessions: Map<string, DebugSession> = ...

`Protected` `Readonly`commandService

commandService: CommandService

`Protected` `Readonly`debugPreferences

debugPreferences: DebugPreferences

`Protected` `Readonly`deferredOnDidConfigureCapabilities

deferredOnDidConfigureCapabilities: Deferred<void> = ...

`Protected`didReceiveCapabilities

didReceiveCapabilities: Deferred<void> = ...

The send('initialize') request could resolve later than on('initialized') emits the event. Hence, the configure would use the empty object capabilities. Using the empty capabilities could result in missing exception breakpoint filters, as always capabilities.exceptionBreakpointFilters is falsy. This deferred promise works around this timing issue. https://github.com/eclipse-theia/theia/issues/11886

`Protected` `Readonly`editorManager

editorManager: EditorManager

`Protected` `Readonly`fileService

fileService: FileService

`Protected`initialized

initialized: boolean = false

`Protected`isStopping

isStopping: boolean = false

`Protected` `Readonly`labelProvider

labelProvider: LabelProvider

`Protected` `Readonly`messages

messages: MessageClient

`Readonly`onDidChange

onDidChange: Event<void> = ...

`Protected` `Readonly`onDidChangeEmitter

onDidChangeEmitter: Emitter<void> = ...

`Protected` `Readonly`onDidFocusStackFrameEmitter

onDidFocusStackFrameEmitter: Emitter<undefined | DebugStackFrame> = ...

`Protected` `Readonly`onDidFocusThreadEmitter

onDidFocusThreadEmitter: Emitter<undefined | DebugThread> = ...

`Readonly`onDidResolveLazyVariable

onDidResolveLazyVariable: Event<DebugVariable> = ...

`Protected` `Readonly`onDidResolveLazyVariableEmitter

onDidResolveLazyVariableEmitter: Emitter<DebugVariable> = ...

`Protected`pendingThreads

pendingThreads: Promise<void> = ...

`Protected` `Readonly`PROMPT_READY_TIMEOUT_MS

PROMPT_READY_TIMEOUT_MS: 3000

Maximum time to wait for the shell integration prompt before proceeding.

`Protected` `Readonly`scheduleUpdateThreads

scheduleUpdateThreads: (...arguments: []) => Promise<void> = ...

`Protected` `Readonly`sessionManager

sessionManager: DebugSessionManager

`Protected` `Readonly`sources

sources: Map<string, DebugSource> = ...

`Protected` `Readonly`stopTimeout

stopTimeout: number

Number of millis after a stop request times out. It's 5 seconds by default.

`Protected` `Readonly`terminalServer

terminalServer: TerminalService

`Protected` `Readonly`testService

testService: TestService

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly`toDisposeOnCurrentThread

toDisposeOnCurrentThread: DisposableCollection = ...

`Protected`updatingBreakpoints

updatingBreakpoints: boolean = false

`Protected` `Readonly`workspaceService

workspaceService: WorkspaceService

Accessors

autoExpandLazyVariables

get autoExpandLazyVariables(): boolean
Returns boolean
- Defined in packages/debug/src/browser/debug-session.tsx:260

capabilities

get capabilities(): Capabilities
Returns Capabilities
- Defined in packages/debug/src/browser/debug-session.tsx:256

configuration

get configuration(): DebugConfiguration
Returns DebugConfiguration
- Defined in packages/debug/src/browser/debug-session.tsx:251

currentFrame

get currentFrame(): undefined | DebugStackFrame
Returns undefined | DebugStackFrame
- Defined in packages/debug/src/browser/debug-session.tsx:357

currentThread

get currentThread(): undefined | DebugThread
Returns undefined | DebugThread
- Defined in packages/debug/src/browser/debug-session.tsx:363
set currentThread(thread: undefined | DebugThread): void
Parameters
- thread: undefined | DebugThread
Returns void
- Defined in packages/debug/src/browser/debug-session.tsx:366

id

get id(): string
default: parent id + position among siblings

Returns string
Implementation of CompositeTreeElement.id
- Defined in packages/debug/src/browser/debug-session.tsx:160

label

get label(): string
Returns string
- Defined in packages/debug/src/browser/debug-session.tsx:881

onDidCustomEvent

get onDidCustomEvent(): Event<Event>
Returns Event<Event>
- Defined in packages/debug/src/browser/debug-session.tsx:559

onDidFocusStackFrame

get onDidFocusStackFrame(): Event<undefined | DebugStackFrame>
Returns Event<undefined | DebugStackFrame>
- Defined in packages/debug/src/browser/debug-session.tsx:180

onDidFocusThread

get onDidFocusThread(): Event<undefined | DebugThread>
Returns Event<undefined | DebugThread>
- Defined in packages/debug/src/browser/debug-session.tsx:185

onDispose

get onDispose(): Event<void>
Returns Event<void>
- Defined in packages/debug/src/browser/debug-session.tsx:247

options

get options(): DebugConfigurationSessionOptions
Returns DebugConfigurationSessionOptions
- Defined in packages/debug/src/browser/debug-session.tsx:164

parentSession

get parentSession(): undefined | DebugSession
Returns undefined | DebugSession
- Defined in packages/debug/src/browser/debug-session.tsx:168

runningThreads

get runningThreads(): IterableIterator<DebugThread>
Returns IterableIterator<DebugThread>
- Defined in packages/debug/src/browser/debug-session.tsx:321

state

get state(): DebugState
Returns DebugState
- Defined in packages/debug/src/browser/debug-session.tsx:383

stoppedThreads

get stoppedThreads(): IterableIterator<DebugThread>
Returns IterableIterator<DebugThread>
- Defined in packages/debug/src/browser/debug-session.tsx:325

threadCount

get threadCount(): number
Returns number
- Defined in packages/debug/src/browser/debug-session.tsx:309

threads

get threads(): IterableIterator<DebugThread>
Returns IterableIterator<DebugThread>
- Defined in packages/debug/src/browser/debug-session.tsx:305

visible

get visible(): boolean
default: true

Returns boolean
Implementation of CompositeTreeElement.visible
- Defined in packages/debug/src/browser/debug-session.tsx:892

Methods

canRestart

canRestart(): boolean
Returns boolean
- Defined in packages/debug/src/browser/debug-session.tsx:476

canTerminate

canTerminate(): boolean
Returns boolean
- Defined in packages/debug/src/browser/debug-session.tsx:472

`Protected`clearThread

clearThread(threadId: number): void
Parameters
- threadId: number
Returns void
- Defined in packages/debug/src/browser/debug-session.tsx:607

`Protected`clearThreads

clearThreads(): void
Returns void
- Defined in packages/debug/src/browser/debug-session.tsx:600

completions

completions(
    text: string,
    column: number,
    line: number,
): Promise<CompletionItem[]>
Parameters
- text: string
- column: number
- line: number
Returns Promise<CompletionItem[]>
- Defined in packages/debug/src/browser/debug-session.tsx:531

`Protected`configure

configure(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:458

continueAll

continueAll(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:343

disconnect

disconnect(isRestart: boolean, callback: () => void): Promise<void>
Parameters
- isRestart: boolean
- callback: () => void
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:523

`Protected`doCreateTerminal

doCreateTerminal(options: TerminalWidgetOptions): Promise<TerminalWidget>
Parameters
- options: TerminalWidgetOptions
Returns Promise<TerminalWidget>
- Defined in packages/debug/src/browser/debug-session.tsx:570

`Protected`doUpdateThreads

doUpdateThreads(threads: Thread[], stoppedDetails?: StoppedDetails): void
Parameters
- threads: Thread[]
- OptionalstoppedDetails: StoppedDetails
Returns void
- Defined in packages/debug/src/browser/debug-session.tsx:631

evaluate

evaluate(
    expression: string,
    context?: string,
): Promise<
    {
        indexedVariables?: number;
        memoryReference?: string;
        namedVariables?: number;
        presentationHint?: VariablePresentationHint;
        result: string;
        type?: string;
        valueLocationReference?: number;
        variablesReference: number;
    },
>
Parameters
- expression: string
- Optionalcontext: string
Returns Promise<
    {
        indexedVariables?: number;
        memoryReference?: string;
        namedVariables?: number;
        presentationHint?: VariablePresentationHint;
        result: string;
        type?: string;
        valueLocationReference?: number;
        variablesReference: number;
    },
>
- Defined in packages/debug/src/browser/debug-session.tsx:537

`Protected`findBreakpoint

findBreakpoint(
match: (breakpoint: DebugBreakpoint) => boolean,
): undefined | DebugBreakpoint<BaseBreakpoint>
Parameters
- match: (breakpoint: DebugBreakpoint) => boolean
Returns undefined | DebugBreakpoint<BaseBreakpoint>
- Defined in packages/debug/src/browser/debug-session.tsx:715

findConsoleParent

findConsoleParent(): undefined | DebugSession
Returns the top-most parent session that is responsible for the console. If this session uses a separate console or does not have any parent session, undefined is returned.

Returns undefined | DebugSession
- Defined in packages/debug/src/browser/debug-session.tsx:963

`Protected`fireDidChange

fireDidChange(): void
Returns void
- Defined in packages/debug/src/browser/debug-session.tsx:176

`Protected`getAffectedUris

getAffectedUris(uri?: URI): IterableIterator<URI>
Parameters
- Optionaluri: URI
Returns IterableIterator<URI>
- Defined in packages/debug/src/browser/debug-session.tsx:868

getElements

getElements(): IterableIterator<DebugSession | DebugThread>
Returns IterableIterator<DebugSession | DebugThread>
Implementation of CompositeTreeElement.getElements
- Defined in packages/debug/src/browser/debug-session.tsx:910

getScopes

getScopes(): Promise<DebugScope[]>
Returns Promise<DebugScope[]>
- Defined in packages/debug/src/browser/debug-session.tsx:397

`Protected`getSingleChildSession

getSingleChildSession(): undefined | DebugSession
Returns undefined | DebugSession
- Defined in packages/debug/src/browser/debug-session.tsx:920

getSource

getSource(raw: Source): DebugSource
Parameters
- raw: Source
Returns DebugSource
- Defined in packages/debug/src/browser/debug-session.tsx:265

getSourceForUri

getSourceForUri(uri: URI): undefined | DebugSource
Parameters
- uri: URI
Returns undefined | DebugSource
- Defined in packages/debug/src/browser/debug-session.tsx:273

getThreads

getThreads(
filter: (thread: DebugThread) => boolean,
): IterableIterator<DebugThread>
Parameters
- filter: (thread: DebugThread) => boolean
Returns IterableIterator<DebugThread>
- Defined in packages/debug/src/browser/debug-session.tsx:313

`Protected`handleContinued

handleContinued(__namedParameters: ContinuedEvent): Promise<void>
Parameters
- __namedParameters: ContinuedEvent
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:928

`Protected`handleDisconnectError

handleDisconnectError(err: unknown): void
Invoked when sending the disconnect request to the debugger is rejected or timed out.
Parameters
- err: unknown
Returns void
- Defined in packages/debug/src/browser/debug-session.tsx:519

`Protected`handleStopped

handleStopped(__namedParameters: StoppedEvent): Promise<void>
Parameters
- __namedParameters: StoppedEvent
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:936

`Protected`handleTerminateError

handleTerminateError(err: unknown): void
Invoked when sending the terminate request to the debugger is rejected or timed out.
Parameters
- err: unknown
Returns void
- Defined in packages/debug/src/browser/debug-session.tsx:512

`Protected`handleThread

handleThread(__namedParameters: ThreadEvent): Promise<void>
Parameters
- __namedParameters: ThreadEvent
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:944

`Protected`init

init(): void
Returns void
- Defined in packages/debug/src/browser/debug-session.tsx:201

`Protected`initialize

initialize(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:417

`Protected`launchOrAttach

launchOrAttach(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:439

on

on<K extends keyof DebugEventTypes>(
kind: K,
listener: (e: DebugEventTypes[K]) => any,
): Disposable
Type Parameters
- K extends keyof DebugEventTypes
Parameters
- kind: K
- listener: (e: DebugEventTypes[K]) => any
Returns Disposable
- Defined in packages/debug/src/browser/debug-session.tsx:551

pauseAll

pauseAll(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:329

`Protected`registerDebugContributions

registerDebugContributions(
configType: string,
connection: DebugSessionConnection,
): void
Parameters
- configType: string
- connection: DebugSessionConnection
Returns void
- Defined in packages/debug/src/browser/debug-session.tsx:953

render

render(): ReactNode
Returns ReactNode
Implementation of CompositeTreeElement.render
- Defined in packages/debug/src/browser/debug-session.tsx:896

restart

restart(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:480

`Protected`runInTerminal

runInTerminal(
__namedParameters: RunInTerminalRequest,
): Promise<{ processId?: number; shellProcessId?: number }>
Parameters
- __namedParameters: RunInTerminalRequest
Returns Promise<{ processId?: number; shellProcessId?: number }>
- Defined in packages/debug/src/browser/debug-session.tsx:563

sendCustomRequest

sendCustomRequest<T extends Response>(command: string, args?: any): Promise<T>
Type Parameters
- T extends Response
Parameters
- command: string
- Optionalargs: any
Returns Promise<T>
- Defined in packages/debug/src/browser/debug-session.tsx:547

`Protected`sendDataBreakpoints

sendDataBreakpoints(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:852

`Protected`sendExceptionBreakpoints

sendExceptionBreakpoints(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:747

`Protected`sendFunctionBreakpoints

sendFunctionBreakpoints(affectedUri: URI): Promise<void>
Parameters
- affectedUri: URI
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:773

`Protected`sendInstructionBreakpoints

sendInstructionBreakpoints(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:834

sendRequest

sendRequest<K extends keyof DebugRequestTypes>(
    command: K,
    args: DebugRequestTypes[K][0],
    timeout?: number,
): Promise<DebugRequestTypes[K][1]>
Type Parameters
- K extends keyof DebugRequestTypes
Parameters
- command: K
- args: DebugRequestTypes[K][0]
- Optionaltimeout: number
Returns Promise<DebugRequestTypes[K][1]>
- Defined in packages/debug/src/browser/debug-session.tsx:543

`Protected`sendSourceBreakpoints

sendSourceBreakpoints(affectedUri: URI, sourceModified?: boolean): Promise<void>
Parameters
- affectedUri: URI
- OptionalsourceModified: boolean
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:800

showMessage

showMessage(messageType: MessageType, message: string): void
Parameters
- messageType: MessageType
- message: string
Returns void
- Defined in packages/debug/src/browser/debug-session.tsx:402

start

start(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:412

stop

stop(isRestart: boolean, callback: () => void): Promise<void>
Parameters
- isRestart: boolean
- callback: () => void
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:486

toDebugSource

toDebugSource(uri: URI): Promise<Source>
Parameters
- uri: URI
Returns Promise<Source>
- Defined in packages/debug/src/browser/debug-session.tsx:286

toSource

toSource(uri: URI): Promise<DebugSource>
Parameters
- uri: URI
Returns Promise<DebugSource>
- Defined in packages/debug/src/browser/debug-session.tsx:277

`Protected`updateBreakpoint

updateBreakpoint(body: { breakpoint: Breakpoint; reason: string }): void
Parameters
- body: { breakpoint: Breakpoint; reason: string }
  - breakpoint: Breakpoint
    The id attribute is used to find the target breakpoint, the other attributes are used as the new values.
  - reason: string
    The reason for the event. Values: 'changed', 'new', 'removed', etc.
Returns void
- Defined in packages/debug/src/browser/debug-session.tsx:686

`Protected`updateBreakpoints

updateBreakpoints(
options: { sourceModified: boolean; uri?: URI },
): Promise<void>
Parameters
- options: { sourceModified: boolean; uri?: URI }
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:723

`Protected`updateCapabilities

updateCapabilities(capabilities: Capabilities): void
Parameters
- capabilities: Capabilities
Returns void
- Defined in packages/debug/src/browser/debug-session.tsx:679

`Protected`updateCurrentThread

updateCurrentThread(stoppedDetails?: StoppedDetails): void
Parameters
- OptionalstoppedDetails: StoppedDetails
Returns void
- Defined in packages/debug/src/browser/debug-session.tsx:656

`Protected`updateFrames

updateFrames(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:666

updateThreads

updateThreads(stoppedDetails: undefined | StoppedDetails): Promise<void>
Parameters
- stoppedDetails: undefined | StoppedDetails
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:618

waitFor

waitFor<K extends keyof DebugEventTypes>(kind: K, ms: number): Promise<void>
Type Parameters
- K extends keyof DebugEventTypes
Parameters
- kind: K
- ms: number
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-session.tsx:555

`Static`createContainer

createContainer(
    parent: Container,
    data: DebugSessionData,
    connection: DebugSessionConnection,
): Container
Parameters
- parent: Container
- data: DebugSessionData
- connection: DebugSessionConnection
Returns Container
- Defined in packages/debug/src/browser/debug-session.tsx:102

Class DebugSession

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns DebugSession

Properties

Protected_capabilities

Protected_currentThread

Protected_threads

Protected Readonlybreakpoints

Protected ReadonlychildSessions

Protected ReadonlycommandService

Protected Readonlyconnection

Protected Readonlydata

Protected ReadonlydebugContributionProvider

Protected ReadonlydebugPreferences

Protected ReadonlydeferredOnDidConfigureCapabilities

ProtecteddidReceiveCapabilities

Protected ReadonlyeditorManager

Protected ReadonlyfileService

Protectedinitialized

ProtectedisStopping

Protected ReadonlylabelProvider

Protected Readonlymessages

ReadonlyonDidChange

Protected ReadonlyonDidChangeEmitter

Protected ReadonlyonDidFocusStackFrameEmitter

Protected ReadonlyonDidFocusThreadEmitter

ReadonlyonDidResolveLazyVariable

Protected ReadonlyonDidResolveLazyVariableEmitter

ProtectedpendingThreads

Protected ReadonlyPROMPT_READY_TIMEOUT_MS

Protected ReadonlyscheduleUpdateThreads

Protected ReadonlysessionManager

Protected Readonlysources

Protected ReadonlystopTimeout

Protected ReadonlyterminalServer

Protected ReadonlytestService

Protected ReadonlytoDispose

Protected ReadonlytoDisposeOnCurrentThread

ProtectedupdatingBreakpoints

Protected ReadonlyworkspaceService

Accessors

autoExpandLazyVariables

Returns boolean

capabilities

Returns Capabilities

configuration

Returns DebugConfiguration

currentFrame

Returns undefined | DebugStackFrame

currentThread

Returns undefined | DebugThread

Parameters

Returns void

id

Returns string

label

Returns string

onDidCustomEvent

Returns Event<Event>

onDidFocusStackFrame

Returns Event<undefined | DebugStackFrame>

onDidFocusThread

Returns Event<undefined | DebugThread>

onDispose

Returns Event<void>

options

Returns DebugConfigurationSessionOptions

parentSession

Returns undefined | DebugSession

runningThreads

Returns IterableIterator<DebugThread>

state

`Protected`_capabilities

`Protected`_currentThread

`Protected`_threads

`Protected` `Readonly`breakpoints

`Protected` `Readonly`childSessions

`Protected` `Readonly`commandService

`Protected` `Readonly`connection

`Protected` `Readonly`data

`Protected` `Readonly`debugContributionProvider

`Protected` `Readonly`debugPreferences

`Protected` `Readonly`deferredOnDidConfigureCapabilities

`Protected`didReceiveCapabilities

`Protected` `Readonly`editorManager

`Protected` `Readonly`fileService

`Protected`initialized

`Protected`isStopping

`Protected` `Readonly`labelProvider

`Protected` `Readonly`messages

`Readonly`onDidChange

`Protected` `Readonly`onDidChangeEmitter

`Protected` `Readonly`onDidFocusStackFrameEmitter

`Protected` `Readonly`onDidFocusThreadEmitter

`Readonly`onDidResolveLazyVariable

`Protected` `Readonly`onDidResolveLazyVariableEmitter

`Protected`pendingThreads

`Protected` `Readonly`PROMPT_READY_TIMEOUT_MS

`Protected` `Readonly`scheduleUpdateThreads

`Protected` `Readonly`sessionManager

`Protected` `Readonly`sources

`Protected` `Readonly`stopTimeout

`Protected` `Readonly`terminalServer

`Protected` `Readonly`testService

`Protected` `Readonly`toDispose

`Protected` `Readonly`toDisposeOnCurrentThread

`Protected`updatingBreakpoints

`Protected` `Readonly`workspaceService

`Protected`clearThread

`Protected`clearThreads

`Protected`configure

`Protected`doCreateTerminal

`Protected`doUpdateThreads

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

`Protected`findBreakpoint

`Protected`fireDidChange

`Protected`getAffectedUris

`Protected`getSingleChildSession

`Protected`handleContinued

`Protected`handleDisconnectError

`Protected`handleStopped