Module `Grace.Source`Source

Source is a file-like abstraction.

Grace provides the abstraction of a file called a 'source'.

There are several benefits with providing a in-memory abstraction of a sources:

Virtual files: It is often useful to invent temporary files (e.g. test input, command line input, REPL input). By providing a in-memory abstraction, Grace provides the ability to create virtual files.
Caching: Caching sources is useful in many situations (e.g. LSP semantic analysis, reporting multiple errors in a single file in a diagnostic reporter, etc).

Sourcetype reader = {

id : int;
(*
The unique identifier of the reader. Equality, comparison, hashing are all performed on this identifier.
*)
name : string option;
(*
The name of the reader. The diagnostic render can use the name of the reader in place of a file path.
*)
length : int;
(*
The length (in bytes) of the source.
*)
unsafe_get : int -> char;
(*
unsafe_get i reads the ith byte without performing bounds checks.
*)

}

A reader denotes an arbitrary byte source (potentially backed by a file, buffer, socket, etc).

Sourceval equal_reader : reader -> reader -> bool

Sourceval compare_reader : reader -> reader -> int

Source

val hash_fold_reader : 
  Ppx_hash_lib.Std.Hash.state ->
  reader ->
  Ppx_hash_lib.Std.Hash.state

Sourceval hash_reader : reader -> Ppx_hash_lib.Std.Hash.hash_value

Sourceval sexp_of_reader : reader -> Sexplib0.Sexp.t

Sourceval reader_of_sexp : Sexplib0.Sexp.t -> reader

Sourceval reader_name : reader -> string

reader_name reader returns the name of the reader. If reader.name is None, then identifier reader.id (converted to a string) is returned.

Sourcetype string_source = {

name : string option;
(*
The name of a string source. The diagnostic render can use the name of a string source in place of a file path.
*)
content : string;
(*
The content of a string source
*)

}

An in-memory string source.

Sourceval equal_string_source : string_source -> string_source -> bool

Sourceval compare_string_source : string_source -> string_source -> int

Source

val hash_fold_string_source : 
  Ppx_hash_lib.Std.Hash.state ->
  string_source ->
  Ppx_hash_lib.Std.Hash.state

Sourceval hash_string_source : string_source -> Ppx_hash_lib.Std.Hash.hash_value

Sourceval sexp_of_string_source : string_source -> Sexplib0.Sexp.t

Sourceval string_source_of_sexp : Sexplib0.Sexp.t -> string_source

Sourcetype t = [

| `File of string
(*
A file source specified by its filename.
*)
| `String of string_source
(*
A in-memory string source.
*)
| `Reader of reader
(*
A reader-backed source.
*)

]

The type of sources.

Sourceval equal : t -> t -> bool

Sourceval compare : t -> t -> int

include Ppx_hash_lib.Hashable.S with type t := t

Sourceval hash_fold_t : Base.Hash.state -> t -> Base.Hash.state

Sourceval hash : t -> Base.Hash.hash_value

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

Sourceval t_of_sexp : Sexplib0.Sexp.t -> t

Sourceval __t_of_sexp__ : Sexplib0.Sexp.t -> t

Sourceval name : t -> string option

name src returns the name of the source if it exists.

Sourceval length : t -> int

length src returns the length or size in bytes of src. Interpreted as a byte_index, this is known as the end-of-source position.

raises Invalid_argument
if the file size is larger than an OCaml 63-bit integer.

Install

Dune Dependency

Authors

Maintainers

Sources

doc/grace/Grace/Source/index.html

Module `Grace.Source`Source

package grace

Install

Dune Dependency

Authors

Maintainers

Sources

doc/grace/Grace/Source/index.html

Module Grace.SourceSource

Module `Grace.Source`Source