package catala

  1. Overview
  2. Docs
Compiler and library for the literate programming language for tax code specification

Install 

dune-project
 Dependency

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

Authors

  1. V
    Vincent Botbol
  2. N
    Nicolas Chataing
  3. A
    Alain Delaët-Tixeuil
  4. L
    Louis Gesbert
  5. A
    Aymeric Fromherz
  6. D
    Denis Merigoux
  7. R
    Raphaël Monat
  8. R
    Romain Primet
  9. E
    Emile Rolley

Maintainers

  1. C
    contact@catala-lang.org

Sources

1.3.0.tar.gz
md5=59d0dd01df52c38a4d793b594f067d14
sha512=944b755f8b47cb14920994f03f022cc3ba6cdf5def1ae8ffda00a196fa97dcc5b57baf642a03068b79e949df2a98d5f0218e3358e549be1ff0f1cddda1e5f848

doc/catala.catala_utils/Catala_utils/Pos/index.html

Module Catala_utils.PosSource

Source code position

Sourcetype 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

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

Constructor and getters

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

Raises Invalid_argument if the attribute appears multiple times

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

Removes the found attribute if it is present

Sourceval get_attrs : t -> (attr -> 'a option) -> 'a list
Sourceval 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.

Sourcemodule Set : Set.S with type elt = t
Sourcemodule Map : Map.S with type key = t

Formatters

Sourceval to_string : t -> string

Formats a position like this:

in file <file>, from <start_line>:<start_col> to <end_line>:<end_col>
Sourceval 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.

Sourceval to_string_shorter : t -> string

Like to_string_short, but skips directory names and extension

Sourceval format_loc_text : ?pp_file:(Format.formatter -> t -> unit) -> unit -> Format.formatter -> t -> unit

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

Sourceval format_loc_text_parts : ?pp_file:(Format.formatter -> t -> unit) -> t -> (Format.formatter -> unit) * (Format.formatter -> unit) * (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

Sourceval void : t

Placeholder position