Module `Dm.DocumentManager`Source

The document manager holds the view that Coq has of the currently open states. It makes it easy for IDEs to handle text edits, navigate and get feedback. Note that it does not require IDEs to parse vernacular sentences.

Sourcetype state

Sourcetype event

Sourceval pp_event : Format.formatter -> event -> unit

Sourcetype events = event Sel.Event.t list

Source

val init : 
  Vernacstate.t ->
  opts:Coqargs.injection_command list ->
  Lsp.Types.DocumentUri.t ->
  text:string ->
  state * events

init st opts uri text initializes the document manager with initial vernac state st on which command line opts will be set.

Sourceval apply_text_edits : state -> Types.text_edit list -> state

apply_text_edits doc edits updates the text of doc with edits. The new document is parsed, outdated executions states are invalidated, and the observe id is updated.

Source

val interpret_to_position : 
  stateful:bool ->
  state ->
  Protocol.LspWrapper.Position.t ->
  state * events

interpret_to_position stateful doc pos navigates to the last sentence ending before or at pos and returns the resulting state. The stateful flag determines if we record the resulting position in the state.

Sourceval interpret_to_previous : state -> state * events

interpret_to_previous doc navigates to the previous sentence in doc and returns the resulting state.

Sourceval interpret_to_next : state -> state * events

interpret_to_next doc navigates to the next sentence in doc and returns the resulting state.

Sourceval interpret_to_end : state -> state * events

interpret_to_end doc navigates to the last sentence in doc and returns the resulting state.

Sourceval interpret_in_background : state -> state * events

interpret_in_background doc same as interpret_to_end but computation is done in background (with lower priority)

Sourceval reset : state -> state * events

resets Coq

Sourcetype exec_overview = {

parsed : Protocol.LspWrapper.Range.t list;
checked : Protocol.LspWrapper.Range.t list;
checked_by_delegate : Protocol.LspWrapper.Range.t list;
legacy_highlight : Protocol.LspWrapper.Range.t list;

}

Sourceval executed_ranges : state -> exec_overview

returns the ranges corresponding to the sentences that have been executed and remotely executes

Sourceval observe_id_range : state -> Protocol.LspWrapper.Range.t option

returns the range of the sentence referenced by observe_id *

Source

val get_messages : 
  state ->
  Protocol.LspWrapper.Position.t option ->
  (Protocol.LspWrapper.DiagnosticSeverity.t * Protocol.Printing.pp) list

Sourceval all_diagnostics : state -> Lsp.Types.Diagnostic.t list

all_diagnostics doc returns the diagnostics corresponding to the sentences that have been executed in doc.

Source

val get_proof : 
  state ->
  Protocol.Settings.Goals.Diff.Mode.t ->
  Protocol.LspWrapper.Position.t option ->
  Protocol.ProofState.t option

Source

val get_completions : 
  state ->
  Protocol.LspWrapper.Position.t ->
  (CompletionItems.completion_item list, string) Result.t

Sourceval handle_event : event -> state -> state option * events

handles events and returns a new state if it was updated

Source

val search : 
  state ->
  id:string ->
  Protocol.LspWrapper.Position.t ->
  string ->
  Protocol.LspWrapper.notification Sel.Event.t list

Source

val about : 
  state ->
  Protocol.LspWrapper.Position.t ->
  pattern:string ->
  (Protocol.Printing.pp, string) Result.t

Source

val hover : 
  state ->
  Protocol.LspWrapper.Position.t ->
  Lsp.Types.MarkupContent.t option

Returns an optional Result: if None, the position did not have a word, if Some, an Ok/Error result is returned.

Source

val check : 
  state ->
  Protocol.LspWrapper.Position.t ->
  pattern:string ->
  (Protocol.Printing.pp, string) Result.t

Source

val locate : 
  state ->
  Protocol.LspWrapper.Position.t ->
  pattern:string ->
  (Protocol.Printing.pp, string) Result.t

Source

val print : 
  state ->
  Protocol.LspWrapper.Position.t ->
  pattern:string ->
  (Protocol.Printing.pp, string) Result.t

Sourcemodule Internal : sig ... end

Install

Dune Dependency

Authors

Maintainers

Sources

doc/vscoq-language-server.dm/Dm/DocumentManager/index.html

Module `Dm.DocumentManager`Source

package vscoq-language-server

Install

Dune Dependency

Authors

Maintainers

Sources

doc/vscoq-language-server.dm/Dm/DocumentManager/index.html

Module Dm.DocumentManagerSource

Module `Dm.DocumentManager`Source