Module Catala_utils.Pos

Source code position

type t

A position in the source code is a file, as well as begin and end location of the form col:line, and optionally, attributes

val compare : t -> t -> int
val equal : t -> t -> bool
type attr = ..
type attr +=
  1. | Law_pos of string list

Constructor and getters

val from_lpos : (Stdlib.Lexing.position * Stdlib.Lexing.position) -> t
val from_info : string -> int -> int -> int -> int -> t
val overwrite_law_info : t -> string list -> t
val get_law_info : t -> string list
val get_start_line : t -> int
val get_start_column : t -> int
val get_end_line : t -> int
val get_end_column : t -> int
val get_file : t -> string
val attrs : t -> attr list
val set_attrs : t -> attr list -> t
val add_attr : t -> attr -> t
val add_attrs : t -> attr list -> t
val rem_attr : t -> attr -> t
val get_attr : t -> (attr -> 'a option) -> 'a option

Raises Invalid_argument if the attribute appears multiple times

val has_attr : t -> attr -> bool
val take_attr : t -> (attr -> 'a option) -> 'a option * t

Removes the found attribute if it is present

val get_attrs : t -> (attr -> 'a option) -> 'a list
val join : t -> t -> t

Returns the smallest range including both supplied ranges. Attributes are merged ; law info is taken from the earliest position.

Void positions (filename = "") are ignored. Raises Invalid_argument if they don't belong to the same file.

module Map : Map.S with type key = t

Formatters

val to_string : t -> string

Formats a position like this:

in file <file>, from <start_line>:<start_col> to <end_line>:<end_col>
val to_string_short : t -> string

Formats a position like this:

<file>;<start_line>:<start_col>--<end_line>:<end_col>

This function is compliant with the GNU coding standards.

val to_string_shorter : t -> string

Like to_string_short, but skips directory names and extension

val format_loc_text : Stdlib.Format.formatter -> t -> unit

Open the file corresponding to the position and retrieves the text concerned by the position

val format_loc_text_parts : t -> (Stdlib.Format.formatter -> unit) * (Stdlib.Format.formatter -> unit) * (Stdlib.Format.formatter -> unit) option

Like format_loc_text, but returns the printing functions in 3 separate parts: the file name header, the line context, and the law headers

val void : t

Placeholder position