package logtk

  1. Overview
  2. Docs
package logtk
Legend:
Library
Module
Module type
Parameter
Class
Class type

Location in a file

A location is a range of characters in file, used for messages (error messages, warning, etc.).

The range is delimited by a start position (line,column) and an end position (line, column) + an optional file name.

type t = {
  1. file : string;
  2. start_line : int;
  3. start_column : int;
  4. stop_line : int;
  5. stop_column : int;
}
val mk : string -> int -> int -> int -> int -> t
val mk_pair : string -> (int * int) -> (int * int) -> t
val mk_pos : Stdlib.Lexing.position -> Stdlib.Lexing.position -> t
val eq : t -> t -> bool
val hash : t -> int
val combine : t -> t -> t

Position that spans the two given positions. The file is assumed to be the same in both case, and is chosen from one of the two positions.

val combine_list : t list -> t

N-ary version of combine.

  • raises Invalid_argument

    if the list is empty

val smaller : t -> t -> bool

smaller p1 p2 is true if p1 is included in p2, ie p1 is a sub-location of p2 (interval inclusion)

module Infix : sig ... end
include module type of Infix
val (<+>) : t option -> t option -> t option

Combine two optional locations. Left has priority

include Interfaces.PRINT with type t := t
val to_string : t -> string
val pp_opt : t option CCFormat.printer

Lexbuf

val set_file : Stdlib.Lexing.lexbuf -> string -> unit

Change the file name used for positions in this lexbuf

val of_lexbuf : Stdlib.Lexing.lexbuf -> t

Recover a position from a lexbuf

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