hphp/hack/src/parser/full_fidelity_source_text.mli

   1 (*
   2  * Copyright (c) 2017, Facebook, Inc.
   3  * All rights reserved.
   4  *
   5  * This source code is licensed under the MIT license found in the
   6  * LICENSE file in the "hack" directory of this source tree.
   7  *
   8  *)
   9
  10 type t = {
  11   file_path: Relative_path.t;
  12   length: int;
  13   text: string;
  14   offset_map: Line_break_map.t;
  15 }
  16 [@@deriving show]
  17
  18 type pos = t * int
  19
  20 val make : Relative_path.t -> string -> t
  21 (** create a new source_text.t with a path and contents *)
  22
  23 val empty : t
  24 (** empty source_text.t located nowhere *)
  25
  26 val from_file : Relative_path.t -> t
  27 (** read a relative path into a source_text.t with the contents at that path *)
  28
  29 val file_path : t -> Relative_path.t
  30 (** get the relative path *)
  31
  32 val length : t -> int
  33 (** get the length of the contents *)
  34
  35 val get : t -> int -> char
  36 (** get the ith character *)
  37
  38 val text : t -> string
  39 (** get the contents as a string *)
  40
  41 val line_text : t -> int -> string
  42 (** get just one line as a string *)
  43
  44 val sub : t -> int -> int -> string
  45 (** get a substring start at the ith char and continuing for length *)
  46
  47 val offset_to_position : t -> int -> int * int
  48 (** convert an absolute offset into a (line number, column) pair *)
  49
  50 val position_to_offset : t -> int * int -> int
  51 (** convert a (line number, column) pair into an absolute offset *)
  52
  53 val relative_pos : Relative_path.t -> t -> int -> int -> Pos.t
  54 (** construct a relative position associated with the source_text.t virtual file *)