A source reader maintains a global table mapping source descriptors to their contents and their line starts.
module Source_descr : sig ... endA source descriptor is a handle for an open source
module Line_starts : sig ... endexception Error of errorval init : ?line_starts_fn:Line_starts.fn -> unit -> unitinit () initializes the global source reader table.
the line starts function used for computing line starts.
Source_reader.Error if the reader is already initialized.
val with_reader : ?line_starts_fn:Line_starts.fn -> (unit -> 'a) -> 'awith_reader f runs f with an initialized reader table, clearing it once f returns.
the line starts function used for computing line starts.
Source_reader.Error if the reader is already initialized.
val open_source : Grace.Source.t -> Source_descr.topen_source src opens the source, returning its descriptor.
Source_reader.Error if the reader is not initialized.
val line_starts : Source_descr.t -> Line_starts.tline_starts sd returns the (possibly cached) line starts of the source sd.
Source_reader.Error if the reader is not initialized.
val length : Source_descr.t -> intlength sd returns the length or size in bytes of src.
It is semantically equivalent to Source.length src.
val unsafe_get : Source_descr.t -> int -> charunsafe_get sd i reads the ith byte of the source without performing any bounds checks on i.
val slice : Source_descr.t -> Grace.Range.t -> stringslice sd range reads the slice of bytes defined by range.
Invalid_argment if the source descriptor's underlying source is not equal to the range's source.
val slicei :
Source_descr.t ->
Grace.Byte_index.t ->
Grace.Byte_index.t ->
stringmodule Line : sig ... endval lines : Source_descr.t -> Line.t Iter.tlines sd returns an iterator over lines in source sd.
val lines_in_range : Source_descr.t -> Grace.Range.t -> Line.t Iter.tlines_in_range sd range returns an iterator over lines in the range in sd.
Invalid_argment if the source descriptor's underlying source is not equal to the line range's source.