Module `Dm.Document`Source

This file defines operations on the content of a document (text, parsing of sentences, scheduling).

Sourcetype document

The document gathers the text, which is partially validated (parsed into sentences

Sourcetype proof_block_type =

| TheoremKind
| DefinitionType
| InductiveType
| BeginSection
| BeginModule
| End
| Other

Sourcetype proof_step = {

id : Types.sentence_id;
tactic : string;
range : Lsp.Types.Range.t;

}

Sourcetype outline_element = {

id : Types.sentence_id;
name : string;
type_ : proof_block_type;
statement : string;
proof : proof_step list;
range : Lsp.Types.Range.t;

}

Sourcetype outline = outline_element list

Sourcetype parsing_end_info = {

unchanged_id : Types.sentence_id option;
invalid_ids : Types.sentence_id_set;
previous_document : document;
parsed_document : document;

}

Sourcetype event

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

Sourcetype events = event Sel.Event.t list

Sourceval raw_document : document -> RawDocument.t

Sourceval outline : document -> outline

Sourceval create_document : Vernacstate.Synterp.t -> string -> document

create_document init_synterp_state text creates a fresh document with content defined by text under init_synterp_state.

Sourceval validate_document : document -> document * events

validate_document doc triggers the parsing of the document line by line without launching any execution.

Source

val handle_event : 
  document ->
  event ->
  document * events * parsing_end_info option

handle_event dpc ev handles a parsing event for the document. One parsing event parses one line and prepares the next parsing event. Finally once the full parsing is done, the final event returs the id of the bottomost sentence of the prefix which has not changed since the previous validation as well as the set of invalidated sentences.

Sourcetype parsed_ast = {

ast : Synterp.vernac_control_entry;
classification : Vernacextend.vernac_classification;
tokens : Tok.t list;

}

Sourcetype parsing_error = {

start : int;
stop : int;
msg : Pp.t Loc.located;
qf : Quickfix.t list option;
str : string;

}

Sourcetype parse_state

Sourceval parse_errors : document -> parsing_error list

parse_errors doc returns the list of sentences which failed to parse (see validate_document) together with their error message

Sourceval apply_text_edit : document -> Types.text_edit -> document

parse_errors doc returns the list of sentences which failed to parse (see validate_document) together with their error message

apply_text_edits doc edits updates the text of doc with edits. The new text is not parsed or executed.

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

apply_text_edits doc edits updates the text of doc with edits. The new text is not parsed or executed.

Sourcetype sentence_state =

| Error of parsing_error
| Parsed of parsed_ast

Sourcetype sentence = {

parsing_start : int;
start : int;
stop : int;
synterp_state : Vernacstate.Synterp.t;
scheduler_state_before : Scheduler.state;
scheduler_state_after : Scheduler.state;
ast : sentence_state;
id : Types.sentence_id;

}

Sourcetype comment = {

start : int;
stop : int;
content : string;

}

Sourcetype code_line =

| Sentence of sentence
| ParsingError of parsing_error
| Comment of comment

Sourceval sentences : document -> sentence list

Sourceval code_lines_sorted_by_loc : document -> code_line list

Sourceval code_lines_by_end_sorted_by_loc : document -> code_line list

Sourceval sentences_sorted_by_loc : document -> sentence list

Sourceval get_sentence : document -> Types.sentence_id -> sentence option

Sourceval sentences_before : document -> int -> sentence list

Sourceval find_sentence : document -> int -> sentence option

find_sentence pos loc finds the sentence containing the loc

Sourceval find_sentence_before : document -> int -> sentence option

find_sentence_before pos loc finds the last sentence before the loc

Sourceval find_sentence_after : document -> int -> sentence option

find_sentence_after pos loc finds the first sentence after the loc

Sourceval find_next_qed : document -> int -> sentence option

find_next_qed parsed loc finds the next proof end

Sourceval get_first_sentence : document -> sentence option

get_first_sentence doc returns the first parsed sentence

Sourceval get_last_sentence : document -> sentence option

get_last_sentence doc returns the last parsed sentence

Sourceval schedule : document -> Scheduler.schedule

Sourceval range_of_id : document -> Stateid.t -> Lsp.Types.Range.t

range_of_id doc id returns a Range object coressponding to the sentence id given in argument

Sourceval range_of_id_with_blank_space : document -> Stateid.t -> Lsp.Types.Range.t

range_of_id_with_blank_space doc id returns a Range object coressponding to the sentence id given in argument but with the white spaces before (until the previous sentence)

Sourcemodule Internal : sig ... end

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module `Dm.Document`Source

package vscoq-language-server

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module Dm.DocumentSource

Module `Dm.Document`Source