Theia API Documentation v1.65.0
    Preparing search index...

    Class PluginDebugSession

    FIXME: make injectable to allow easily inject services

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _breakpoints _capabilities _currentThread _threads breakpoints childSessions connection debugContributionProvider deferredOnDidConfigureCapabilities didReceiveCapabilities editorManager fileService id initialized isStopping labelProvider messages onDidChange onDidChangeBreakpoints onDidChangeBreakpointsEmitter onDidChangeEmitter onDidFocusStackFrameEmitter onDidFocusThreadEmitter options parentSession pendingThreads scheduleUpdateThreads sources stopTimeout terminalOptionsExt terminalServer toDispose toDisposeOnCurrentThread updatingBreakpoints workspaceService

    Accessors

    breakpointUris capabilities configuration currentFrame currentThread label onDidCustomEvent onDidFocusStackFrame onDidFocusThread onDispose runningThreads state stoppedThreads threadCount threads visible

    Methods

    asDebugBreakpointOptions canRestart canTerminate clearBreakpoints clearThread clearThreads completions configure continueAll dedupSourceBreakpoints disconnect doCreateTerminal doUpdateThreads evaluate findBreakpoint findConsoleParent fireDidChange fireDidChangeBreakpoints getAffectedUris getBreakpoint getBreakpoints getElements getFunctionBreakpoints getInstructionBreakpoints getScopes getSingleChildSession getSource getSourceBreakpoints getSourceForUri getThreads handleContinued handleDisconnectError handleStopped handleTerminateError handleThread initialize launchOrAttach on pauseAll registerDebugContributions render restart runInTerminal sendCustomRequest sendExceptionBreakpoints sendFunctionBreakpoints sendInstructionBreakpoints sendRequest sendSourceBreakpoints setBreakpoints setSourceBreakpoints showMessage start stop toDebugSource toSource updateBreakpoint updateBreakpoints updateCapabilities updateCurrentThread updateFrames updateThreads waitFor

    Constructors

    Properties

    Protected Readonly_breakpoints

    _breakpoints: Map<string, DebugBreakpoint<BaseBreakpoint>[]>

    Protected_capabilities

    _capabilities: Capabilities

    Protected_currentThread

    _currentThread: undefined | DebugThread

    Protected_threads

    _threads: Map<number, DebugThread>
    breakpoints: BreakpointManager
    childSessions: Map<string, DebugSession>
    connection: DebugSessionConnection
    debugContributionProvider: ContributionProvider<DebugContribution>
    deferredOnDidConfigureCapabilities: Deferred<void>
    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

    editorManager: EditorManager
    fileService: FileService
    id: string

    default: parent id + position among siblings

    initialized: boolean
    isStopping: boolean
    labelProvider: LabelProvider
    messages: MessageClient
    onDidChange: Event<void>
    onDidChangeBreakpoints: Event<URI>
    onDidChangeBreakpointsEmitter: Emitter<URI>
    onDidChangeEmitter: Emitter<void>
    onDidFocusStackFrameEmitter: Emitter<undefined | DebugStackFrame>
    onDidFocusThreadEmitter: Emitter<undefined | DebugThread>
    options: DebugConfigurationSessionOptions
    parentSession: undefined | DebugSession
    pendingThreads: Promise<void>
    scheduleUpdateThreads: () => Promise<void>
    sources: Map<string, DebugSource>
    stopTimeout: number

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

    terminalOptionsExt: undefined | TerminalOptionsExt
    terminalServer: TerminalService
    toDispose: DisposableCollection
    toDisposeOnCurrentThread: DisposableCollection
    updatingBreakpoints: boolean
    workspaceService: WorkspaceService

    Accessors

    • get breakpointUris(): IterableIterator<string>

      Returns IterableIterator<string>

    • get capabilities(): Capabilities

      Returns Capabilities

    • get currentFrame(): undefined | DebugStackFrame

      Returns undefined | DebugStackFrame

    • get currentThread(): undefined | DebugThread

      Returns undefined | DebugThread

    • set currentThread(thread: undefined | DebugThread): void

      Parameters

      Returns void

    • get label(): string

      Returns string

    • get onDidCustomEvent(): Event<Event>

      Returns Event<Event>

    • get onDidFocusStackFrame(): Event<undefined | DebugStackFrame>

      Returns Event<undefined | DebugStackFrame>

    • get onDidFocusThread(): Event<undefined | DebugThread>

      Returns Event<undefined | DebugThread>

    • get onDispose(): Event<void>

      Returns Event<void>

    • get runningThreads(): IterableIterator<DebugThread>

      Returns IterableIterator<DebugThread>

    • get state(): DebugState

      Returns DebugState

    • get stoppedThreads(): IterableIterator<DebugThread>

      Returns IterableIterator<DebugThread>

    • get threadCount(): number

      Returns number

    • get threads(): IterableIterator<DebugThread>

      Returns IterableIterator<DebugThread>

    • get visible(): boolean

      default: true

      Returns boolean

    Methods

    • Returns boolean

    • Returns boolean

    • Returns void

    • Parameters

      • threadId: number

      Returns void

    • Returns void

    • Parameters

      • text: string
      • column: number
      • line: number

      Returns Promise<CompletionItem[]>

    • Returns Promise<void>

    • Returns Promise<void>

    • Parameters

      • isRestart: boolean
      • callback: () => void

      Returns Promise<void>

    • Parameters

      • expression: string
      • Optionalcontext: string

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

    • Returns the top-most parent session that is responsible for the console. If this session uses a DebugConsoleMode.Separate separate console or does not have any parent session, undefined is returned.

      Returns undefined | DebugSession

    • Returns void

    • Parameters

      • Optionaluri: URI

      Returns IterableIterator<URI>

    • Parameters

      • __namedParameters: ContinuedEvent

      Returns Promise<void>

    • Invoked when sending the disconnect request to the debugger is rejected or timed out.

      Parameters

      • err: unknown

      Returns void

    • Parameters

      • __namedParameters: StoppedEvent

      Returns Promise<void>

    • Invoked when sending the terminate request to the debugger is rejected or timed out.

      Parameters

      • err: unknown

      Returns void

    • Parameters

      • __namedParameters: ThreadEvent

      Returns Promise<void>

    • Returns Promise<void>

    • Returns Promise<void>

    • Returns Promise<void>

    • Returns ReactNode

    • Returns Promise<void>

    • Parameters

      • __namedParameters: RunInTerminalRequest

      Returns Promise<{ processId?: number; shellProcessId?: number }>

    • Type Parameters

      • T extends Response

      Parameters

      • command: string
      • Optionalargs: any

      Returns Promise<T>

    • Parameters

      • affectedUri: URI

      Returns Promise<void>

    • Parameters

      • affectedUri: URI
      • OptionalsourceModified: boolean

      Returns Promise<void>

    • Returns Promise<void>

    • Parameters

      • isRestart: boolean
      • callback: () => void

      Returns Promise<void>

    • Parameters

      Returns Promise<Source>

    • 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

    • Parameters

      • options: { sourceModified: boolean; uri?: URI }

      Returns Promise<void>

    • Parameters

      • capabilities: Capabilities

      Returns void

    • Returns Promise<void>

    • Type Parameters

      Parameters

      • kind: K
      • ms: number

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    asDebugBreakpointOptionscanRestartcanTerminateclearBreakpointsclearThreadclearThreadscompletionsconfigurecontinueAlldedupSourceBreakpointsdisconnectdoCreateTerminaldoUpdateThreadsevaluatefindBreakpointfindConsoleParentfireDidChangefireDidChangeBreakpointsgetAffectedUrisgetBreakpointgetBreakpointsgetElementsgetFunctionBreakpointsgetInstructionBreakpointsgetScopesgetSingleChildSessiongetSourcegetSourceBreakpointsgetSourceForUrigetThreadshandleContinuedhandleDisconnectErrorhandleStoppedhandleTerminateErrorhandleThreadinitializelaunchOrAttachonpauseAllregisterDebugContributionsrenderrestartrunInTerminalsendCustomRequestsendExceptionBreakpointssendFunctionBreakpointssendInstructionBreakpointssendRequestsendSourceBreakpointssetBreakpointssetSourceBreakpointsshowMessagestartstoptoDebugSourcetoSourceupdateBreakpointupdateBreakpointsupdateCapabilitiesupdateCurrentThreadupdateFramesupdateThreadswaitFor