package grace

  1. Overview
  2. Docs
A fancy diagnostics library that allows your compilers to exit with grace

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (5)

Authors

  1. A
    Alistair O'Brien

Maintainers

  1. A
    alistair.obrien@trili.tech

Sources

grace-0.4.0.tbz
sha256=388149857c0fbaf2489b1e396af25aadd6185998847b75570f9198a077ad1ace
sha512=9ffa701f7729f90976594c4ec77b968f15450d8d7a1f0c65fe60d092c136b18f1c8bbd5f5772a651c925dabcdc82ac7023c30a4caa1b94e3e158ef2efa34b85e

doc/grace.source_reader/Grace_source_reader/Line/index.html

Module Grace_source_reader.LineSource

Sourcetype t = {
  1. idx : Grace.Line_index.t;
  2. range : Grace.Range.t;
}

The type of a line.

include Sexplib0.Sexpable.S with type t := t
Sourceval t_of_sexp : Sexplib0.Sexp.t -> t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval of_line_index : Source_descr.t -> Grace.Line_index.t -> t

of_line_index sd idx returns the line at index idx in source sd.

Sourceval of_byte_index : Source_descr.t -> Grace.Byte_index.t -> t

of_byte_index sd idx returns the line containing idx in source sd.

Sourceval column_offset : t -> in_:Source_descr.t -> Grace.Byte_index.t -> int

column_offset line ~in_ idx returns the column offset of idx in line in source in_.

start t returns the byte index of the (inclusive) start position of the line.

stop t returns the byte index of the (exclusive) stop position of the line.

split t returns the pair of byte indices of the line t.

Sourceval last : Source_descr.t -> t

last sd returns the last line in the source sd.

Sourceval slice : t -> sd:Source_descr.t -> string

slice t ~sd reads the slice of bytes defined by the line's range.

  • raises Invalid_argment

    if the source descriptor's underlying source is not equal to the line range's source.