package coq-lsp

  1. Overview
  2. Docs
Language Server Protocol native server for Coq

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (35)

Authors

  1. E
    Emilio Jesús Gallego Arias <e@x80.org>
  2. A
    Ali Caglayan <alizter@gmail.com>
  3. S
    Shachar Itzhaky <shachari@cs.technion.ac.il>
  4. R
    Ramkumar Ramachandra <r@artagnon.com>

Maintainers

  1. E
    e@x80.org

Sources

coq-lsp-0.2.4.9.1.tbz
sha256=667908bdd88f0bb1b75d2fa76a483006d600c9422a2a15297a172e62c0415cad
sha512=42f8e5ad308702f77c9dc40243acd2e656b16bdb94c302306dbb87387cc36941deccd5f52c18d1a045467030ddf86528b22819522a647eee5b9e1ac25f4a9560

doc/coq-lsp.fleche/Fleche/Doc/index.html

Module Fleche.DocSource

Sourcemodule Node : sig ... end
Sourcemodule Completion : sig ... end
Sourcemodule Env : sig ... end

Enviroment external to the document, this includes for now the init Coq state and the workspace, which are used to build the first state of the document, usually by importing the prelude and other libs implicitly.

Sourcetype t = private {
  1. uri : Lang.LUri.File.t;
    (*

    uri of the document

    *)
  2. languageId : string;
    (*

    languageId of the document

    *)
  3. version : int;
    (*

    version of the document

    *)
  4. contents : Contents.t;
    (*

    contents of the document

    *)
  5. nodes : Node.t list;
    (*

    List of document nodes

    *)
  6. completed : Completion.t;
    (*

    Status of the document, usually either completed, suspended, or waiting for some IO / external event

    *)
  7. toc : Node.t CString.Map.t;
    (*

    table of contents

    *)
  8. env : Env.t;
    (*

    External document enviroment

    *)
  9. root : Coq.State.t;
    (*

    root contains the first state document state, obtained by applying a workspace to Coq's initial state

    *)
  10. diags_dirty : bool;
    (*

    internal field

    *)
}

A Flèche document is basically a node list, which is a crude form of a meta-data map Range.t -> data, where for now data is the contents of Node.t.

Sourceval asts : t -> Node.Ast.t list

Return the list of all asts in the doc

Sourceval lines : t -> string Array.t

Return the lines for conversion in request

Sourceval diags : t -> Lang.Diagnostic.t list

Return the list of all diags in the doc

Sourceval create : token:Coq.Limits.Token.t -> env:Env.t -> uri:Lang.LUri.File.t -> languageId:string -> version:int -> raw:string -> t

Create a new Coq document, this is cached! Note that this operation always suceeds, but the document could be created in a `Failed` state if problems arise.

Sourceval bump_version : token:Coq.Limits.Token.t -> version:int -> raw:string -> t -> t

Update the contents of a document, updating the right structures for incremental checking. If the operation fails, the document will be left in `Failed` state.

Sourcemodule Target : sig ... end

Checking targets, this specifies what we expect check to reach

Sourceval check : io:Io.CallBack.t -> token:Coq.Limits.Token.t -> target:Target.t -> doc:t -> unit -> t

check ~io ~target ~doc (), check document doc, target will have Flèche stop after the point specified there has been reached. Output functions are in the io record, used to send partial updates.

Sourceval save : token:Coq.Limits.Token.t -> doc:t -> (unit, Loc.t) Coq.Protect.E.t

save ~doc will save doc .vo file. It will fail if proofs are open, or if the document completion status is not Yes

Sourceval run : token:Coq.Limits.Token.t -> ?loc:Loc.t -> ?memo:bool -> st:Coq.State.t -> string -> (Coq.State.t, Loc.t) Coq.Protect.E.t

run ~token ?loc ?memo ~st cmds run commands cmds starting on state st, without commiting changes to the document. loc can be used to seed an initial location if desired, if not the locations will be considered relative to the initial location. memo controls if the execution is memoized, by default true.

This API is experimental, used for speculative execution petanque and goals, the API is expected to change as to better adapt to users.