package ppxlib

You can search for identifiers within the package.

in-package search v0.2.0

Standard infrastructure for ppx rewriters

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (22)

Authors

J

Jane Street Group, LLC <opensource@janestreet.com>

Maintainers

O

opensource@janestreet.com

Sources

ppxlib-0.35.0.tbz

sha256=d9d959fc9f84260487e45684dc741898a92fc5506b61a7f5cac65d21832db925

sha512=e428b1e3b89261c7efdaa18016264d1afbf067cb9b0d41124b04796c2487ac7ca8ee9a24a60d56f20d1774cb44aaa9ecf1512f17455812ba8d62d4ef93616ee7

doc/ppxlib/Ppxlib/Location/index.html

Module `Ppxlib.Location`Source

Overrides the Location module of OCaml

There are less functions in this module. However the API should be more stable than the Location module of OCaml.

For a detailled presentation of good practices regarding locations, refer to the section in the manual.

Sourcetype t = Astlib.Location.t = {

loc_start : Lexing.position;
loc_end : Lexing.position;
loc_ghost : bool;

}

Sourceval in_file : string -> t

Return an empty ghost range located in a given file.

Sourceval set_filename : t -> string -> t

Set the pos_fname both in loc_start and loc_end. Leave the rest as is.

Sourceval none : t

An arbitrary value of type t; describes an empty ghost range.

Sourceval init : Lexing.lexbuf -> string -> unit

Set the file name and line number of the lexbuf to be the start of the named file.

Sourceval raise_errorf : ?loc:t -> ('a, Format.formatter, unit, 'b) format4 -> 'a

Raise a located error. Should be avoided as much as possible, in favor of error_extensionf. See the relevant part of the tutorial.

Sourceval of_lexbuf : Lexing.lexbuf -> t

Return the location corresponding to the last matched regular expression

Sourceval report_exception : Format.formatter -> exn -> unit

Report an exception on the given formatter

Sourceval print : Format.formatter -> t -> unit

Prints File "...", line ..., characters ...-...:

Sourcetype nonrec 'a loc = 'a Astlib.Location.loc = {

txt : 'a;
loc : t;

}

Sourceval compare_pos : Lexing.position -> Lexing.position -> int

Sourceval min_pos : Lexing.position -> Lexing.position -> Lexing.position

Sourceval max_pos : Lexing.position -> Lexing.position -> Lexing.position

Sourceval compare : t -> t -> int

Sourcemodule Error : sig ... end

Source

val error_extensionf : 
  loc:t ->
  ('a,
    Format.formatter,
    unit,
    string Astlib.Location.loc * Astlib.Ast_500.Parsetree.payload)
    format4 ->
  'a

Returns an error extension node. When encountered in the AST, the compiler recognizes it and displays the error properly.

For a detailed explanation on error reporting, refer to the relevant part of the tutorial.

Sourceexception Error of Error.t