Class DebugExtImpl

Implements

DebugExt

Index

Constructors

Accessors

activeStackItem breakpoints onDidChangeActiveDebugSession onDidChangeActiveStackItem onDidChangeBreakpoints onDidCreateDebugSession onDidReceiveDebugSessionCustomEvent onDidStartDebugSession onDidTerminateDebugSession

Constructors

constructor

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

Properties

_activeStackItem

_activeStackItem: undefined | DebugThread | DebugStackFrame

`Private` `Readonly` _breakpoints

_breakpoints: Map<string, Breakpoint> = ...

activeDebugConsole

activeDebugConsole: DebugConsole

activeDebugSession

activeDebugSession: undefined | DebugSession

`Private` backendAdapterCreator

backendAdapterCreator: NodeDebugAdapterCreator = ...

`Private` commandRegistryExt

commandRegistryExt: CommandRegistryImpl

`Private` configurationProviderHandleGenerator

configurationProviderHandleGenerator: number

`Private` configurationProviders

configurationProviders: ConfigurationProviderRecord[]

`Private` connectionExt

connectionExt: ConnectionImpl

`Private` contributionPaths

contributionPaths: Map<string, string> = ...

`Private` contributionTypes

contributionTypes: Map<string, PluginType> = ...

`Private` debuggersContributions

debuggersContributions: Map<string, PluginPackageDebuggersContribution> = ...

Only use internally, don't send it to the frontend. It's expensive! It's already there as a part of the plugin metadata.

`Private` descriptorFactories

descriptorFactories: Map<string, DebugAdapterDescriptorFactory> = ...

`Private` frontendAdapterCreator

frontendAdapterCreator: PluginDebugAdapterCreator = ...

`Private` `Readonly` onDidChangeActiveDebugSessionEmitter

onDidChangeActiveDebugSessionEmitter: Emitter<undefined | DebugSession> = ...

`Private` `Readonly` onDidChangeActiveStackItemEmitter

onDidChangeActiveStackItemEmitter: Emitter<undefined | DebugThread | DebugStackFrame> = ...

`Private` `Readonly` onDidChangeBreakpointsEmitter

onDidChangeBreakpointsEmitter: Emitter<BreakpointsChangeEvent> = ...

`Private` `Readonly` onDidCreateDebugSessionEmitter

onDidCreateDebugSessionEmitter: Emitter<DebugSession> = ...

`Private` `Readonly` onDidReceiveDebugSessionCustomEmitter

onDidReceiveDebugSessionCustomEmitter: Emitter<DebugSessionCustomEvent> = ...

`Private` `Readonly` onDidStartDebugSessionEmitter

onDidStartDebugSessionEmitter: Emitter<DebugSession> = ...

`Private` `Readonly` onDidTerminateDebugSessionEmitter

onDidTerminateDebugSessionEmitter: Emitter<DebugSession> = ...

`Private` proxy

proxy: DebugMain

`Protected` `Readonly` rpc

rpc: RPCProtocol

`Private` sessions

sessions: Map<string, PluginDebugAdapterSession> = ...

`Private` trackerFactories

trackerFactories: [string, DebugAdapterTrackerFactory][] = []

Accessors

Methods

$breakpointsDidChange

$breakpointsDidChange(added, removed, changed): 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:349

$createDebugSession

$createDebugSession(debugConfiguration, workspaceFolderUri): 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:397

$getTerminalCreationOptions

$getTerminalCreationOptions(debugType): 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:438

$onDidChangeActiveFrame

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

$onDidChangeActiveThread

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

$onSessionCustomEvent

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

$provideDebugConfigurationsByHandle

$provideDebugConfigurationsByHandle(handle, workspaceFolderUri): 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:458

$resolveDebugConfigurationByHandle

$resolveDebugConfigurationByHandle(handle, workspaceFolderUri, 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:477

$resolveDebugConfigurationWithSubstitutedVariablesByHandle

$resolveDebugConfigurationWithSubstitutedVariablesByHandle(handle, workspaceFolderUri, 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:489

$sessionDidChange

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

$sessionDidCreate

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

$sessionDidDestroy

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

$sessionDidStart

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

$terminateDebugSession

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

addBreakpoints

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

asDebugSourceUri

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

assistedInject

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

`Protected` createDebugAdapter

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

`Protected` createDebugAdapterTracker

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

doGetTerminalCreationOptions

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

`Private` getAdapterCreator

getAdapterCreator(debugConfiguration): PluginDebugAdapterCreator
Parameters
- debugConfiguration: DebugConfiguration
Returns PluginDebugAdapterCreator
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:545

`Private` getConfigurationProviderRecord

getConfigurationProviderRecord(handle): {
provider: DebugConfigurationProvider;
type: string;
}
Parameters
- handle: number
Returns {
provider: DebugConfigurationProvider;
type: string;
}
- provider: DebugConfigurationProvider
- type: string
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:446

`Private` getDebugSourceUri

getDebugSourceUri(raw, sessionId?): Uri
Parameters
- raw: Source
- Optional sessionId: string
Returns Uri
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:225

initialize

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

registerDebugAdapterDescriptorFactory

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

registerDebugAdapterTrackerFactory

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

registerDebugConfigurationProvider

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

registerDebuggersContributions

registerDebuggersContributions(pluginFolder, pluginType, contributions): 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:123

removeBreakpoints

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

`Protected` resolveDebugAdapterExecutable

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

startDebugging

startDebugging(folder, nameOrConfiguration, options): 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:196

stopDebugging

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

`Protected` toBreakpointExt

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

`Private` toWorkspaceFolder

toWorkspaceFolder(folder): undefined | WorkspaceFolder
Parameters
- folder: undefined | string
Returns undefined | WorkspaceFolder
- Defined in packages/plugin-ext/src/plugin/debug/debug-ext.ts:531

Class DebugExtImpl

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns DebugExtImpl

Properties

_activeStackItem

Private Readonly _breakpoints

activeDebugConsole

activeDebugSession

Private backendAdapterCreator

Private commandRegistryExt

Private configurationProviderHandleGenerator

Private configurationProviders

Private connectionExt

Private contributionPaths

Private contributionTypes

Private debuggersContributions

Private descriptorFactories

Private frontendAdapterCreator

Private Readonly onDidChangeActiveDebugSessionEmitter

Private Readonly onDidChangeActiveStackItemEmitter

Private Readonly onDidChangeBreakpointsEmitter

Private Readonly onDidCreateDebugSessionEmitter

Private Readonly onDidReceiveDebugSessionCustomEmitter

Private Readonly onDidStartDebugSessionEmitter

Private Readonly onDidTerminateDebugSessionEmitter

Private proxy

Protected Readonly rpc

Private sessions

Private trackerFactories

Accessors

activeStackItem

Returns undefined | DebugThread | DebugStackFrame

Parameters

Returns void

breakpoints

Returns Breakpoint[]

onDidChangeActiveDebugSession

Returns Event<undefined | DebugSession>

onDidChangeActiveStackItem

Returns Event<undefined | DebugThread | DebugStackFrame>

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

`Private` `Readonly` _breakpoints

`Private` backendAdapterCreator

`Private` commandRegistryExt

`Private` configurationProviderHandleGenerator

`Private` configurationProviders

`Private` connectionExt

`Private` contributionPaths

`Private` contributionTypes

`Private` debuggersContributions

`Private` descriptorFactories

`Private` frontendAdapterCreator

`Private` `Readonly` onDidChangeActiveDebugSessionEmitter

`Private` `Readonly` onDidChangeActiveStackItemEmitter

`Private` `Readonly` onDidChangeBreakpointsEmitter

`Private` `Readonly` onDidCreateDebugSessionEmitter

`Private` `Readonly` onDidReceiveDebugSessionCustomEmitter

`Private` `Readonly` onDidStartDebugSessionEmitter

`Private` `Readonly` onDidTerminateDebugSessionEmitter

`Private` proxy

`Protected` `Readonly` rpc

`Private` sessions

`Private` trackerFactories

`Protected` createDebugAdapter

`Protected` createDebugAdapterTracker

`Private` getAdapterCreator

`Private` getConfigurationProviderRecord

Returns {
provider: DebugConfigurationProvider;
type: string;
}

`Private` getDebugSourceUri

`Protected` resolveDebugAdapterExecutable