package vscoq-language-server

  1. Overview
  2. Docs
VSCoq language server

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (15)

Authors

  1. E
    Enrico Tassi
  2. M
    Maxime Dénès
  3. R
    Romain Tetley

Maintainers

  1. E
    Enrico Tassi <enrico.tassi@inria.fr>

Sources

vscoq-language-server-2.2.1.tar.gz
md5=06737aa7d96bbf42f89db3c86ef3e4dd
sha512=5118f26e5b687bc918de3409870464702f3fafc0c775ad5fac4835fc7954df66beaf83bc3a413476176160773215aae1d292816c49dc192c94566bba0fbe5a5b

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

Module Dm.DocumentManagerSource

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 observe_id =
  1. | Id of Types.sentence_id
  2. | Top
Sourcetype blocking_error = {
  1. last_range : Protocol.LspWrapper.Range.t;
  2. error_range : Protocol.LspWrapper.Range.t;
}
Sourcetype state
Sourcetype event
Sourceval pp_event : Format.formatter -> event -> unit
Sourcetype events = event Sel.Event.t list
Sourceval init : Vernacstate.t -> opts:Coqargs.injection_command list -> Lsp.Types.DocumentUri.t -> text:string -> observe_id option -> 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.

Sourceval clear_observe_id : state -> state

clear_observe_id state updates the state to make the observe_id None

Sourceval reset_to_top : state -> state

reset_to_top state updates the state to make the observe_id Top

get_next_range st pos get the range of the next sentence relative to pos

get_previous_pos st pos get the range of the previous sentence relative to pos

Sourceval interpret_to_position : state -> Protocol.LspWrapper.Position.t -> should_block_on_error:bool -> state * events * blocking_error option

interpret_to_position state pos should_block navigates to the last sentence ending before or at pos and returns the resulting state, events that need to take place, and a possible blocking error.

Sourceval interpret_to_next_position : state -> Protocol.LspWrapper.Position.t -> should_block_on_error:bool -> state * events * blocking_error option * Protocol.LspWrapper.Position.t

interpret_to_next_position state pos should_block navigates to the first sentence after or at pos (excluding whitespace) and returns the resulting state, events that need to take place, a possible blocking error, and the position of the sentence that was interpreted until.

Sourceval interpret_to_previous : state -> state * events * blocking_error option

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

Sourceval interpret_to_next : state -> should_block_on_error:bool -> state * events * blocking_error option

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

Sourceval interpret_to_end : state -> should_block_on_error:bool -> state * events * blocking_error option

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

Sourceval interpret_in_background : state -> should_block_on_error:bool -> state * events * blocking_error option

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

Sourceval executed_ranges : state -> Types.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 *

returns the messages associated to a given position

returns the Feedback.Info level messages associated to a given position

Sourceval get_document_symbols : state -> Lsp.Types.DocumentSymbol.t 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.

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

handles events and returns a new state if it was updated

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

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

Sourceval check : state -> Protocol.LspWrapper.Position.t -> pattern:string -> (Protocol.Printing.pp, string) Result.t
Sourceval locate : state -> Protocol.LspWrapper.Position.t -> pattern:string -> (Protocol.Printing.pp, string) Result.t
Sourceval print : state -> Protocol.LspWrapper.Position.t -> pattern:string -> (Protocol.Printing.pp, string) Result.t
Sourcemodule Internal : sig ... end