package dap

  1. Overview
  2. Docs
Debug adapter protocol

Install

dune-project
 Dependency

Authors

Maintainers

Sources

dap-1.1.0.tbz
sha256=0b4cdef2ec61b98f73b686a6cb9cde8dde14404097f52a9367c55f1667441712
sha512=ba1897e3afa66b34ad65911dee0b433c48756a5c81467b6277cc2fc1f4360533af7c707744b87707afa9891886dcdb0f7fa7e1653807903f5bd2c1d36a4d92d0

doc/dap.types/Debug_protocol/Scope/index.html

Module Debug_protocol.ScopeSource

Sourcemodule Presentation_hint : sig ... end
Sourcetype t = {
  1. name : string;
    (*

    Name of the scope such as 'Arguments', 'Locals', or 'Registers'. This string is shown in the UI as is and can be translated.

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

    A hint for how to present this scope in the UI. If this attribute is missing, the scope is shown with a generic UI.

    *)
  3. variables_reference : int;
    (*

    The variables of this scope can be retrieved by passing the value of `variablesReference` to the `variables` request as long as execution remains suspended. See 'Lifetime of Object References' in the Overview section for details.

    *)
  4. named_variables : int option;
    (*

    The number of named variables in this scope. The client can use this information to present the variables in a paged UI and fetch them in chunks.

    *)
  5. indexed_variables : int option;
    (*

    The number of indexed variables in this scope. The client can use this information to present the variables in a paged UI and fetch them in chunks.

    *)
  6. expensive : bool;
    (*

    If true, the number of variables in this scope is large or expensive to retrieve.

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

    The source for this scope.

    *)
  8. line : int option;
    (*

    The start line of the range covered by this scope.

    *)
  9. column : int option;
    (*

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

    *)
  10. end_line : int option;
    (*

    The end line of the range covered by this scope.

    *)
  11. end_column : int option;
    (*

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

    *)
}

A `Scope` is a named container for variables. Optionally a scope can map to a source or a range within a source.

Sourceval make : name:string -> ?presentation_hint:Presentation_hint.t option -> variables_reference:int -> ?named_variables:int option -> ?indexed_variables:int option -> expensive:bool -> ?source:Source.t option -> ?line:int option -> ?column:int option -> ?end_line:int option -> ?end_column:int option -> unit -> t
Sourceval to_yojson : t -> Yojson.Safe.t