package dap

  1. Overview
  2. Docs
Debug adapter protocol

Install 

dune-project
 Dependency

github.com Edit opam file Versions (8)

Authors

  1. æ
    文宇祥 <hackwaly@qq.com>

Maintainers

  1. æ
    文宇祥 <hackwaly@qq.com>

Sources

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

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

Module Debug_protocol.SourceSource

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

    The short name of the source. Every source returned from the debug adapter has a name. When sending a source to the debug adapter this name is optional.

    *)
  2. path : string option;
    (*

    The path of the source to be shown in the UI. It is only used to locate and load the content of the source if no `sourceReference` is specified (or its value is 0).

    *)
  3. source_reference : int option;
    (*

    If the value > 0 the contents of the source must be retrieved through the `source` request (even if a path is specified). Since a `sourceReference` is only valid for a session, it can not be used to persist a source. The value should be less than or equal to 2147483647 (2^31-1).

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

    A hint for how to present the source in the UI. A value of `deemphasize` can be used to indicate that the source is not available or that it is skipped on stepping.

    *)
  5. origin : string option;
    (*

    The origin of this source. For example, 'internal module', 'inlined content from source map', etc.

    *)
  6. sources : t list option;
    (*

    A list of sources that are related to this source. These may be the source that generated this source.

    *)
  7. adapter_data : Any.t option;
    (*

    Additional data that a debug adapter might want to loop through the client. The client should leave the data intact and persist it across sessions. The client should not interpret the data.

    *)
  8. checksums : Checksum.t list option;
    (*

    The checksums associated with this file.

    *)
}

A `Source` is a descriptor for source code. It is returned from the debug adapter as part of a `StackFrame` and it is used by clients when specifying breakpoints.

Sourceval make : ?name:string option -> ?path:string option -> ?source_reference:int option -> ?presentation_hint:Presentation_hint.t option -> ?origin:string option -> ?sources:t list option -> ?adapter_data:Any.t option -> ?checksums:Checksum.t list option -> unit -> t
Sourceval to_yojson : t -> Yojson.Safe.t