package coq-lsp

  1. Overview
  2. Docs
package coq-lsp
Legend:
Library
Module
Module type
Parameter
Class
Class type
module State : sig ... end

Petanque.Agent

module Error : sig ... end

Petanque errors

module R : sig ... end

Petanque results

module Run_opts : sig ... end
module Run_result : sig ... end

Protocol notes:

The idea is that the types of the functions here have a direct translation to the JSON-RPC (or any other) protocol.

Thus, types here correspond to types in the wire, except for cases where the protocol layer performs an implicit mapping on types.

So far, the mappings are:

  • uri <-> Doc.t
  • int <-> State.t

The State.t mapping is easy to do at the protocol level with a simple mapping, however uri -> Doc.t may need to yield to the document manager to build the corresponding doc. This is very convenient for users, but introduces a little bit more machinery.

We could imagine a future where State.t need to be managed asynchronously, then the same approach that we use for Doc.t could happen.

val start : token:Coq.Limits.Token.t -> doc:Fleche.Doc.t -> ?opts:Run_opts.t -> ?pre_commands:string -> thm:string -> unit -> State.t Run_result.t R.t

start ~token ~doc ~pre_commands ~thm start a new proof for theorem thm in file uri under fn. token can be used to interrupt the computation. Returns the proof state or error otherwise. pre_commands is a string of dot-separated Coq commands that will be executed before the proof starts.

val run : token:Coq.Limits.Token.t -> ?opts:Run_opts.t -> st:State.t -> tac:string -> unit -> State.t Run_result.t R.t

run ~token ?memo ~st ~tac tries to run tac over state st. memo (by default true) controls whether the command execution will be memoized in Flèche incremental engine.

val goals : token:Coq.Limits.Token.t -> st:State.t -> string Coq.Goals.reified_pp option R.t

goals ~token ~st return the list of goals for a given st

module Premise : sig ... end
val premises : token:Coq.Limits.Token.t -> st:State.t -> Premise.t list R.t

Return the list of defined constants and inductives for a given state. For now we just return their fully qualified name, but more options are of course possible.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct