Class DebugExtImpl

eslint-disable @typescript-eslint/no-explicit-any

Implements

DebugExt

Index

Constructors

constructor

new DebugExtImpl(): DebugExtImpl
Returns DebugExtImpl
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:97

Properties

_activeStackItem

_activeStackItem: undefined | DebugStackFrame | DebugThread

activeDebugConsole

activeDebugConsole: DebugConsole

activeDebugSession

activeDebugSession: undefined | DebugSession

`Protected` `Readonly`rpc

rpc: RPCProtocol

Accessors

activeStackItem

get activeStackItem(): undefined | DebugStackFrame | DebugThread
Returns undefined | DebugStackFrame | DebugThread
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:292
set activeStackItem(stackItem: undefined | DebugStackFrame | DebugThread): void
Parameters
- stackItem: undefined | DebugStackFrame | DebugThread
Returns void
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:284

breakpoints

get breakpoints(): Breakpoint[]
Returns Breakpoint[]
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:93

onDidChangeActiveDebugSession

get onDidChangeActiveDebugSession(): Event<undefined | DebugSession>
Returns Event<undefined | DebugSession>
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:143

onDidChangeActiveStackItem

get onDidChangeActiveStackItem(): Event<
    undefined
    | DebugStackFrame
    | DebugThread,
>
Returns Event<undefined | DebugStackFrame | DebugThread>
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:159

onDidChangeBreakpoints

get onDidChangeBreakpoints(): Event<BreakpointsChangeEvent>
Returns Event<BreakpointsChangeEvent>
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:163

onDidCreateDebugSession

get onDidCreateDebugSession(): Event<DebugSession>
Returns Event<DebugSession>
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:151

onDidReceiveDebugSessionCustomEvent

get onDidReceiveDebugSessionCustomEvent(): Event<DebugSessionCustomEvent>
Returns Event<DebugSessionCustomEvent>
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:139

onDidStartDebugSession

get onDidStartDebugSession(): Event<DebugSession>
Returns Event<DebugSession>
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:155

onDidTerminateDebugSession

get onDidTerminateDebugSession(): Event<DebugSession>
Returns Event<DebugSession>
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:147

Methods

$breakpointsDidChange

$breakpointsDidChange(
    added: Breakpoint[],
    removed: string[],
    changed: Breakpoint[],
): Promise<void>
Parameters
- added: Breakpoint[]
- removed: string[]
- changed: Breakpoint[]
Returns Promise<void>
Implementation of DebugExt.$breakpointsDidChange
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:352

$createDebugSession

$createDebugSession(
debugConfiguration: DebugConfiguration,
workspaceFolderUri: undefined | string,
): Promise<string>
Parameters
- debugConfiguration: DebugConfiguration
- workspaceFolderUri: undefined | string
Returns Promise<string>
Implementation of DebugExt.$createDebugSession
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:400

$getTerminalCreationOptions

$getTerminalCreationOptions(
debugType: string,
): Promise<undefined | TerminalOptionsExt>
Parameters
- debugType: string
Returns Promise<undefined | TerminalOptionsExt>
Implementation of DebugExt.$getTerminalCreationOptions
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:441

$onDidChangeActiveFrame

$onDidChangeActiveFrame(
debugFrame: undefined | DebugStackFrameDTO,
): Promise<void>
Parameters
- debugFrame: undefined | DebugStackFrameDTO
Returns Promise<void>
Implementation of DebugExt.$onDidChangeActiveFrame
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:307

$onDidChangeActiveThread

$onDidChangeActiveThread(debugThread: undefined | DebugThreadDTO): Promise<void>
Parameters
- debugThread: undefined | DebugThreadDTO
Returns Promise<void>
Implementation of DebugExt.$onDidChangeActiveThread
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:296

$onSessionCustomEvent

$onSessionCustomEvent(
    sessionId: string,
    event: string,
    body?: any,
): Promise<void>
Parameters
- sessionId: string
- event: string
- Optionalbody: any
Returns Promise<void>
Implementation of DebugExt.$onSessionCustomEvent
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:318

$provideDebugConfigurationsByHandle

$provideDebugConfigurationsByHandle(
handle: number,
workspaceFolderUri: undefined | string,
): Promise<DebugConfiguration[]>
Parameters
- handle: number
- workspaceFolderUri: undefined | string
Returns Promise<DebugConfiguration[]>
Implementation of DebugExt.$provideDebugConfigurationsByHandle
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:461

$resolveDebugConfigurationByHandle

$resolveDebugConfigurationByHandle(
    handle: number,
    workspaceFolderUri: undefined | string,
    debugConfiguration: DebugConfiguration,
): Promise<undefined | null | DebugConfiguration>
Parameters
- handle: number
- workspaceFolderUri: undefined | string
- debugConfiguration: DebugConfiguration
Returns Promise<undefined | null | DebugConfiguration>
Implementation of DebugExt.$resolveDebugConfigurationByHandle
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:480

$resolveDebugConfigurationWithSubstitutedVariablesByHandle

$resolveDebugConfigurationWithSubstitutedVariablesByHandle(
    handle: number,
    workspaceFolderUri: undefined | string,
    debugConfiguration: DebugConfiguration,
): Promise<undefined | null | DebugConfiguration>
Parameters
- handle: number
- workspaceFolderUri: undefined | string
- debugConfiguration: DebugConfiguration
Returns Promise<undefined | null | DebugConfiguration>
Implementation of DebugExt.$resolveDebugConfigurationWithSubstitutedVariablesByHandle
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:492

$sessionDidChange

$sessionDidChange(sessionId: undefined | string): Promise<void>
Parameters
- sessionId: undefined | string
Returns Promise<void>
Implementation of DebugExt.$sessionDidChange
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:347

$sessionDidCreate

$sessionDidCreate(sessionId: string): Promise<void>
Parameters
- sessionId: string
Returns Promise<void>
Implementation of DebugExt.$sessionDidCreate
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:325

$sessionDidDestroy

$sessionDidDestroy(sessionId: string): Promise<void>
Parameters
- sessionId: string
Returns Promise<void>
Implementation of DebugExt.$sessionDidDestroy
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:339

$sessionDidStart

$sessionDidStart(sessionId: string): Promise<void>
Parameters
- sessionId: string
Returns Promise<void>
Implementation of DebugExt.$sessionDidStart
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:332

$terminateDebugSession

$terminateDebugSession(sessionId: string): Promise<void>
Parameters
- sessionId: string
Returns Promise<void>
Implementation of DebugExt.$terminateDebugSession
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:434

addBreakpoints

addBreakpoints(breakpoints: readonly Breakpoint[]): void
Parameters
- breakpoints: readonly Breakpoint[]
Returns void
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:167

asDebugSourceUri

asDebugSourceUri(source: DebugProtocolSource, session?: DebugSession): Uri
Parameters
- source: DebugProtocolSource
- Optionalsession: DebugSession
Returns Uri
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:224

assistedInject

assistedInject(
connectionExt: ConnectionImpl,
commandRegistryExt: CommandRegistryImpl,
): void
Sets dependencies.
Parameters
- connectionExt: ConnectionImpl
- commandRegistryExt: CommandRegistryImpl
Returns void
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:115

`Protected`createDebugAdapter

createDebugAdapter(
session: DebugSession,
debugConfiguration: DebugConfiguration,
): Promise<DebugAdapter>
Parameters
- session: DebugSession
- debugConfiguration: DebugConfiguration
Returns Promise<DebugAdapter>
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:508

`Protected`createDebugAdapterTracker

createDebugAdapterTracker(session: DebugSession): Promise<DebugAdapterTracker>
Parameters
- session: DebugSession
Returns Promise<DebugAdapterTracker>
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:504

doGetTerminalCreationOptions

doGetTerminalCreationOptions(
debugType: string,
): Promise<undefined | TerminalOptionsExt>
Parameters
- debugType: string
Returns Promise<undefined | TerminalOptionsExt>
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:445

initialize

initialize(): void
Returns void
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:107

registerDebugAdapterDescriptorFactory

registerDebugAdapterDescriptorFactory(
debugType: string,
factory: DebugAdapterDescriptorFactory,
): Disposable
Parameters
- debugType: string
- factory: DebugAdapterDescriptorFactory
Returns Disposable
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:245

registerDebugAdapterTrackerFactory

registerDebugAdapterTrackerFactory(
debugType: string,
factory: DebugAdapterTrackerFactory,
): Disposable
Parameters
- debugType: string
- factory: DebugAdapterTrackerFactory
Returns Disposable
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:253

registerDebugConfigurationProvider

registerDebugConfigurationProvider(
    debugType: string,
    provider: DebugConfigurationProvider,
    trigger: DebugConfigurationProviderTriggerKind,
): Disposable
Parameters
- debugType: string
- provider: DebugConfigurationProvider
- trigger: DebugConfigurationProviderTriggerKind
Returns Disposable
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:264

registerDebuggersContributions

registerDebuggersContributions(
    pluginFolder: string,
    pluginType: PluginType,
    contributions: PluginPackageDebuggersContribution[],
): void
Registers contributions.
Parameters
- pluginFolder: string
  plugin folder path
- pluginType: PluginType
  plugin type
- contributions: PluginPackageDebuggersContribution[]
  available debuggers contributions
Returns void
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:126

removeBreakpoints

removeBreakpoints(breakpoints: readonly Breakpoint[]): void
Parameters
- breakpoints: readonly Breakpoint[]
Returns void
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:182

`Protected`resolveDebugAdapterExecutable

resolveDebugAdapterExecutable(
debugConfiguration: DebugConfiguration,
): Promise<undefined | DebugAdapterExecutable>
Parameters
- debugConfiguration: DebugConfiguration
Returns Promise<undefined | DebugAdapterExecutable>
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:514

startDebugging

startDebugging(
    folder: undefined | WorkspaceFolder,
    nameOrConfiguration: string | DebugConfiguration,
    options: DebugSessionOptions,
): PromiseLike<boolean>
Parameters
- folder: undefined | WorkspaceFolder
- nameOrConfiguration: string | DebugConfiguration
- options: DebugSessionOptions
Returns PromiseLike<boolean>
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:199

stopDebugging

stopDebugging(session?: DebugSession): PromiseLike<void>
Parameters
- Optionalsession: DebugSession
Returns PromiseLike<void>
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:220

`Protected`toBreakpointExt

toBreakpointExt(__namedParameters: Breakpoint): undefined | Breakpoint
Parameters
- __namedParameters: Breakpoint
Returns undefined | Breakpoint
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:389

Class DebugExtImpl

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns DebugExtImpl

Properties

_activeStackItem

activeDebugConsole

activeDebugSession

Protected Readonlyrpc

Accessors

activeStackItem

Returns undefined | DebugStackFrame | DebugThread

Parameters

Returns void

breakpoints

Returns Breakpoint[]

onDidChangeActiveDebugSession

Returns Event<undefined | DebugSession>

onDidChangeActiveStackItem

Returns Event<undefined | DebugStackFrame | DebugThread>

onDidChangeBreakpoints

Returns Event<BreakpointsChangeEvent>

onDidCreateDebugSession

Returns Event<DebugSession>

onDidReceiveDebugSessionCustomEvent

Returns Event<DebugSessionCustomEvent>

onDidStartDebugSession

Returns Event<DebugSession>

onDidTerminateDebugSession

Returns Event<DebugSession>

Methods

$breakpointsDidChange

Parameters

Returns Promise<void>

$createDebugSession

Parameters

Returns Promise<string>

$getTerminalCreationOptions

Parameters

Returns Promise<undefined | TerminalOptionsExt>

$onDidChangeActiveFrame

Parameters

Returns Promise<void>

$onDidChangeActiveThread

Parameters

Returns Promise<void>

$onSessionCustomEvent

Parameters

Returns Promise<void>

$provideDebugConfigurationsByHandle

Parameters

Returns Promise<DebugConfiguration[]>

$resolveDebugConfigurationByHandle

Parameters

Returns Promise<undefined | null | DebugConfiguration>

$resolveDebugConfigurationWithSubstitutedVariablesByHandle

Parameters

Returns Promise<undefined | null | DebugConfiguration>

$sessionDidChange

Parameters

Returns Promise<void>

$sessionDidCreate

Parameters

Returns Promise<void>

$sessionDidDestroy

Parameters

Returns Promise<void>

$sessionDidStart

Parameters

Returns Promise<void>

$terminateDebugSession

Parameters

Returns Promise<void>

addBreakpoints

`Protected` `Readonly`rpc

`Protected`createDebugAdapter

`Protected`createDebugAdapterTracker

`Protected`resolveDebugAdapterExecutable

`Protected`toBreakpointExt