package coq-lsp

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

This module provides facilities for translating language-based locations to protocol-based locations.

After a long discussion (thanks Léo !), we have decided that the best is to have `Lang.Point` to store columns offset in the values that are native to the protocol under consideration, set by the upper layers.

This scheme kind of follows what we have done since the start with coq-lsp.

module Encoding : sig ... end

Future work: support setting protocol enconding

Unicode terminology refresher:

  • character, code point: The real unicode character
  • byte or 16bit offset / code unit: The encoded version
type utf8_string = string
type char = int
type utf8_index = int
type utf16_index = int
val utf16_offset_of_utf8_offset : line:utf8_string -> offset:utf8_index -> utf16_index

UTF-16 offset from UTF-8 offset; line is enconded in UTF-8

val utf8_offset_of_utf16_offset : line:utf8_string -> offset:utf16_index -> utf8_index

Get the byte position of a code point indexed in UTF-16 code units in a UTF-8 encoded utf8_string. Returns the position of the last character if the UTF-16 position was out of bounds.

To UTF-16 offsets

val length_utf16 : utf8_string -> utf16_index

Length in UTF-16 code points

Not used anywhere, remove?

Number of characters in the utf-8-encoded utf8_string.

Converstion from char to UTF-8/16

val utf8_offset_of_char : line:utf8_string -> char:char -> utf8_index option

UTF-8 Char to byte index position; line is enconded in UTF-8

val utf16_offset_of_char : line:utf8_string -> char:int -> utf16_index

Get the utf16 position of a code point indexed in unicode code points in a UTF-8 encoded utf8_string. The position must be in bounds.

Converstion to char from UTF-8/16

val char_of_utf8_offset : line:utf8_string -> offset:utf8_index -> char option

Byte index to character position also called a codepoint, line is encoded in UTF-8

val char_of_utf16_offset : line:utf8_string -> offset:utf16_index -> char

Get the unicode position of a code point indexed in UTF-16 code units in a utf-8 encoded utf8_string. Returns the position of the last character if the utf-16 position was out of bounds.

val next : string -> int -> int

For testing

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