package dap

  1. Overview
  2. Docs

Module Debug_protocol.Stack_frameSource

Sourcemodule Presentation_hint : sig ... end
Sourcetype t = {
  1. id : int;
    (*

    An identifier for the stack frame. It must be unique across all threads. This id can be used to retrieve the scopes of the frame with the `scopes` request or to restart the execution of a stack frame.

    *)
  2. name : string;
    (*

    The name of the stack frame, typically a method name.

    *)
  3. source : Source.t option;
    (*

    The source of the frame.

    *)
  4. line : int;
    (*

    The line within the source of the frame. If the source attribute is missing or doesn't exist, `line` is 0 and should be ignored by the client.

    *)
  5. column : int;
    (*

    Start position of the range covered by the stack frame. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based. If attribute `source` is missing or doesn't exist, `column` is 0 and should be ignored by the client.

    *)
  6. end_line : int option;
    (*

    The end line of the range covered by the stack frame.

    *)
  7. end_column : int option;
    (*

    End position of the range covered by the stack frame. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based.

    *)
  8. can_restart : bool option;
    (*

    Indicates whether this frame can be restarted with the `restartFrame` request. Clients should only use this if the debug adapter supports the `restart` request and the corresponding capability `supportsRestartFrame` is true. If a debug adapter has this capability, then `canRestart` defaults to `true` if the property is absent.

    *)
  9. instruction_pointer_reference : string option;
    (*

    A memory reference for the current instruction pointer in this frame.

    *)
  10. module_id : Int_or_string.t option;
    (*

    The module associated with this frame, if any.

    *)
  11. presentation_hint : Presentation_hint.t option;
    (*

    A hint for how to present this frame in the UI. A value of `label` can be used to indicate that the frame is an artificial frame that is used as a visual label or separator. A value of `subtle` can be used to change the appearance of a frame in a 'subtle' way.

    *)
}

A Stackframe contains the source location.

Sourceval make : id:int -> name:string -> ?source:Source.t option -> line:int -> column:int -> ?end_line:int option -> ?end_column:int option -> ?can_restart:bool option -> ?instruction_pointer_reference:string option -> ?module_id:Int_or_string.t option -> ?presentation_hint:Presentation_hint.t option -> unit -> t
Sourceval to_yojson : t -> Yojson.Safe.t