hphp/hack/src/utils/pos.mli

   1 (*
   2  * Copyright (c) 2015, 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 (* Note: While Pos.string prints out positions as closed intervals, pos_start
  11  * and pos_end actually form a half-open interval (i.e. pos_end points to the
  12  * character *after* the last character of the relevant lexeme.) *)
  13 type 'a pos [@@deriving eq, ord, show]
  14
  15 (** The underlying type used to construct Pos instances.
  16  *
  17  * See "val make: 'a -> b -> 'a pos" *)
  18 type b = Pos_source.t
  19
  20 type t = Relative_path.t pos [@@deriving eq]
  21
  22 val pp : Format.formatter -> t -> unit
  23
  24 type absolute = string pos [@@deriving eq, ord, show]
  25
  26 val none : t
  27
  28 val filename : 'a pos -> 'a
  29
  30 val start_offset : 'a pos -> int
  31
  32 val end_offset : 'a pos -> int
  33
  34 val line : 'a pos -> int
  35
  36 val line_column : 'a pos -> int * int
  37
  38 val end_line : 'a pos -> int
  39
  40 val end_line_column : 'a pos -> int * int
  41
  42 (** Return line number, beginning of line character number and character number of start position. *)
  43 val line_beg_offset : t -> int * int * int
  44
  45 val end_line_beg_offset : t -> int * int * int
  46
  47 (** For spans over just one line, return the line number, start column and end column.
  48     This returns a closed interval.
  49     Undefined for multi-line spans. *)
  50 val info_pos : 'a pos -> int * int * int
  51
  52 (** Return start line, end line, start column and end column.
  53     This returns a closed interval. *)
  54 val info_pos_extended : 'a pos -> int * int * int * int
  55
  56 (** Return start character number and end character number. *)
  57 val info_raw : 'a pos -> int * int
  58
  59 (** Return start line, start column, end line and end column.
  60     This returns a half-open interval. *)
  61 val destruct_range : 'a pos -> int * int * int * int
  62
  63 val length : 'a pos -> int
  64
  65 (* This returns a closed interval. *)
  66 val string : absolute -> string
  67
  68 (* This returns a half-open interval. *)
  69 val multiline_string : absolute -> string
  70
  71 (* This returns a closed interval. *)
  72 val string_no_file : 'a pos -> string
  73
  74 (* This returns a half-open interval. *)
  75 val multiline_string_no_file : 'a pos -> string
  76
  77 (* This returns a closed interval. *)
  78 val json : absolute -> Hh_json.json
  79
  80 val json_no_filename : absolute -> Hh_json.json
  81
  82 (* This returns a half-open interval. *)
  83 val multiline_json : absolute -> Hh_json.json
  84
  85 val multiline_json_no_filename : 'a pos -> Hh_json.json
  86
  87 val inside : 'a pos -> int -> int -> bool
  88
  89 val exactly_matches_range :
  90   'a pos ->
  91   start_line:int ->
  92   start_col:int ->
  93   end_line:int ->
  94   end_col:int ->
  95   bool
  96
  97 val contains : t -> t -> bool
  98
  99 (* Does first position strictly overlap the second position? *)
 100 val overlaps : t -> t -> bool
 101
 102 val make : 'a -> b -> 'a pos
 103
 104 val make_from_lexing_pos : 'a -> Lexing.position -> Lexing.position -> 'a pos
 105
 106 val make_from : 'a -> 'a pos
 107
 108 val btw_nocheck : 'a pos -> 'a pos -> 'a pos
 109
 110 val is_hhi : t -> bool
 111
 112 (** Fill in the gap "between" first position and second position.
 113     Not valid if from different files or second position precedes first *)
 114 val btw : t -> t -> t
 115
 116 (* Symmetric version of above: order doesn't matter *)
 117 val merge : 'a pos -> 'a pos -> 'a pos
 118
 119 val last_char : t -> t
 120
 121 val first_char_of_line : t -> t
 122
 123 val to_absolute : t -> absolute
 124
 125 val to_relative : absolute -> t
 126
 127 val to_relative_string : t -> string pos
 128
 129 val get_text_from_pos : content:string -> 'a pos -> string
 130
 131 (* Advance the ending position by one character *)
 132 val advance_one : 'a pos -> 'a pos
 133
 134 (* Reduce the size of this position element by one character on the left and
 135  * one character on the right.  For example, if you've captured a position
 136  * that includes outside apostrophes, this will shrink it to only the contents
 137  * within the apostrophes. *)
 138 val shrink_by_one_char_both_sides : 'a pos -> 'a pos
 139
 140 (* Compare by filename, then tie-break by start position, and finally by the
 141  * end position *)
 142 val compare : t -> t -> int
 143
 144 val set_file : 'a -> 'b pos -> 'a pos
 145
 146 (* Return a zero-width position that occurs at the start of input position. *)
 147 val shrink_to_start : 'a pos -> 'a pos
 148
 149 val set_col_start : int -> 'a pos -> 'a pos
 150
 151 val set_col_end : int -> 'a pos -> 'a pos
 152
 153 val make_from_lnum_bol_offset :
 154   pos_file:Relative_path.t ->
 155   pos_start:int * int * int ->
 156   pos_end:int * int * int ->
 157   t
 158
 159 module Map : WrappedMap.S with type key = t
 160
 161 module AbsolutePosMap : WrappedMap.S with type key = absolute
 162
 163 module Set : Set.S with type elt = t
 164
 165 val print_verbose_absolute : absolute -> string
 166
 167 val print_verbose_relative : t -> string
 168
 169 val pessimize_enabled : t -> float -> bool
 170
 171 val set_from_reason : 'a pos -> 'a pos
 172
 173 val get_from_reason : 'a pos -> bool