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

    Interface BPSessionData

    interface BPSessionData {
        column?: number;
        endColumn?: number;
        endLine?: number;
        id?: number;
        instructionReference?: string;
        line?: number;
        message?: string;
        offset?: number;
        reason?: "pending" | "failed";
        sessionId: string;
        source?: Source;
        supportsConditionalBreakpoints: boolean;
        supportsDataBreakpoints: boolean;
        supportsFunctionBreakpoints: boolean;
        supportsHitConditionalBreakpoints: boolean;
        supportsInstructionBreakpoints: boolean;
        supportsLogPoints: boolean;
        verified: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    column? endColumn? endLine? id? instructionReference? line? message? offset? reason? sessionId source? supportsConditionalBreakpoints supportsDataBreakpoints supportsFunctionBreakpoints supportsHitConditionalBreakpoints supportsInstructionBreakpoints supportsLogPoints verified

    Properties

    column?: number

    Start position of the source range covered by the breakpoint. It is measured in UTF-16 code units and the client capability columnsStartAt1 determines whether it is 0- or 1-based.

    endColumn?: number

    End position of the source range covered by the breakpoint. It is measured in UTF-16 code units and the client capability columnsStartAt1 determines whether it is 0- or 1-based. If no end line is given, then the end column is assumed to be in the start line.

    endLine?: number

    The end line of the actual range covered by the breakpoint.

    id?: number

    The identifier for the breakpoint. It is needed if breakpoint events are used to update or remove breakpoints.

    instructionReference?: string

    A memory reference to where the breakpoint is set.

    line?: number

    The start line of the actual range covered by the breakpoint.

    message?: string

    A message about the state of the breakpoint. This is shown to the user and can be used to explain why a breakpoint could not be verified.

    offset?: number

    The offset from the instruction reference. This can be negative.

    reason?: "pending" | "failed"

    A machine-readable explanation of why a breakpoint may not be verified. If a breakpoint is verified or a specific reason is not known, the adapter should omit this property. Possible values include:

    • pending: Indicates a breakpoint might be verified in the future, but the adapter cannot verify it in the current state.
    • failed: Indicates a breakpoint was not able to be verified, and the adapter does not believe it can be verified without intervention.
    sessionId: string
    source?: Source

    The source where the breakpoint is located.

    supportsConditionalBreakpoints: boolean

    The debug adapter supports conditional breakpoints.

    supportsDataBreakpoints: boolean

    The debug adapter supports data breakpoints.

    supportsFunctionBreakpoints: boolean

    The debug adapter supports function breakpoints.

    supportsHitConditionalBreakpoints: boolean

    The debug adapter supports breakpoints that break execution after a specified number of hits.

    supportsInstructionBreakpoints: boolean

    The debug adapter supports adding breakpoints based on instruction references.

    supportsLogPoints: boolean

    The debug adapter supports log points by interpreting the logMessage attribute of the SourceBreakpoint.

    verified: boolean

    If true, the breakpoint could be set (but not necessarily at the desired location).

    Settings

    Member Visibility

    On This Page

    Properties