Documentation
ocamlformat.ocaml_common lib
Ocaml_common
. Location
Module
Source code locations (ranges of positions), used in parsetree.
Warning: this module is unstable and part of compiler-libs .
type t = Warnings.loc = { loc_start : Stdlib .Lexing.position; loc_end : Stdlib .Lexing.position; loc_ghost : bool; } Note on the use of Lexing.position in this module. If pos_fname = "", then use !input_name instead. If pos_lnum = -1, then pos_bol = 0. Use pos_cnum and re-parse the file to get the line and character numbers. Else all fields are correct.
An arbitrary value of type t; describes an empty ghost range.
True for Location.none, false any other location
val in_file : string -> t Return an empty ghost range located in a given file.
val init : Stdlib .Lexing.lexbuf -> string -> unitSet the file name and line number of the lexbuf to be the start of the named file.
val curr : Stdlib .Lexing.lexbuf -> t Get the location of the current token from the lexbuf.
val symbol_rloc : unit -> t val symbol_gloc : unit -> t rhs_loc n returns the location of the symbol at position n, starting at 1, in the current parser rule.
val rhs_interval : int -> int -> t val get_pos_info : Stdlib .Lexing.position -> type 'a loc = { txt : 'a ; loc : t ; } val mknoloc : 'a -> 'a loc val mkloc : 'a -> t -> 'a loc val echo_eof : unit -> unitval rewrite_absolute_path : string -> stringrewrite absolute path to honor the BUILD_PATH_PREFIX_MAP variable (https://reproducible-builds.org/specs/build-path-prefix-map/) if it is set.
val absolute_path : string -> stringval show_filename : string -> stringIn -absname mode, return the absolute path for this filename. Otherwise, returns the filename unchanged.
val print_filename : Stdlib .Format.formatter -> string -> unitval print_loc : Stdlib .Format.formatter -> t -> val print_locs : Stdlib .Format.formatter -> t list-> val highlight_terminfo :
Stdlib .Lexing.lexbuf -> Stdlib .Format.formatter -> t list-> type msg = (Stdlib .Format.formatter -> loc val msg :
?loc :t -> ('a , Stdlib .Format.formatter, unit, msg ) Stdlib .format4-> 'a type report_kind = | Report_error | Report_warning of string| Report_warning_as_error of string| Report_alert of string| Report_alert_as_error of stringA printer for reports, defined using open-recursion. The goal is to make it easy to define new printers by re-using code from existing ones.
val terminfo_toplevel_printer : Stdlib .Lexing.lexbuf -> report_printer Detects the terminal capabilities and selects an adequate printer
reportval print_report : Stdlib .Format.formatter -> report -> Display an error or warning report.
Hook for redefining the printer of reports.
The hook is a unit -> report_printer and not simply a report_printer: this is useful so that it can detect the type of the output (a file, a terminal, ...) and select a printer accordingly.
Original report printer for use in hooks.
Warnings.t into a reportreport_warning loc w produces a report for the given warning w, or None if the warning is not to be printed.
Hook for intercepting warnings.
Original warning reporter for use in hooks.
val print_warning : t -> Stdlib .Format.formatter -> Warnings.t -> Prints a warning. This is simply the composition of report_warning and print_report.
Same as print_warning, but uses !formatter_for_warnings as output formatter.
Alert.t into a reportreport_alert loc w produces a report for the given alert w, or None if the alert is not to be printed.
Hook for intercepting alerts.
Original alert reporter for use in hooks.
Prints an alert. This is simply the composition of report_alert and print_report.
Same as print_alert, but uses !formatter_for_warnings as output formatter.
val deprecated : ?def :t -> ?use :t -> t -> string -> unitPrints a deprecation alert.
val alert : ?def :t -> ?use :t -> kind :string -> t -> string -> unitPrints an arbitrary alert.
An error is a report which report_kind must be Report_error.
val error : ?loc :t -> ?sub :msg list-> string -> error val errorf :
?loc :t -> ?sub :msg list-> ('a , Stdlib .Format.formatter, unit, error ) Stdlib .format4-> 'a val error_of_printer :
?loc :t -> ?sub :msg list-> (Stdlib .Format.formatter -> 'a -> -> 'a -> error val error_of_printer_file :
(Stdlib .Format.formatter -> 'a -> -> 'a -> error val register_error_of_exn : (exn -> error option -> Each compiler module which defines a custom type of exception which can surface as a user-visible error should register a "printer" for this exception using register_error_of_exn. The result of the printer is an error value containing a location, a message, and optionally sub-messages (each of them being located as well).
val error_of_exn : exn -> [ `Ok of error | `Already_displayed ] optionRaising Error e signals an error e; the exception will be caught and the error will be printed.
exception Already_displayed_error Raising Already_displayed_error signals an error which has already been printed. The exception will be caught, but nothing will be printed
val raise_errorf :
?loc :t -> ?sub :msg list-> ('a , Stdlib .Format.formatter, unit, 'b ) Stdlib .format4-> 'a val report_exception : Stdlib .Format.formatter -> exn -> unitReraise the exception if it is unknown.