package ocamlformat-lib

  1. Overview
  2. Docs
Auto-formatter for OCaml code

Install 

dune-project
 Dependency

github.com Readme Changelog MIT; LGPL-2.1-only WITH OCaml-LGPL-linking-exception License Edit opam file Versions (6)

Authors

  1. J
    Josh Berdine <jjb@fb.com>

Maintainers

  1. O
    OCamlFormat Team <ocamlformat-dev@lists.ocaml.org>

Sources

ocamlformat-0.25.1.tbz
sha256=dc8f2a330ca3930b36cacb2623bb360ed8bdf6e4a8acd293dbd9e2241a6fd33d
sha512=b28f545425fb5375447c90022d065dc7fd51ed2f66d8c1f65a71a6ad2465d039a8686e8f18249e5ad3a2362fee6149c855ef30eb45fb9d06d743a53d26b3e26f

doc/ocamlformat-lib.ocaml_common/Ocaml_common/Location/index.html

Module Ocaml_common.LocationSource

Source code locations (ranges of positions), used in parsetree.

Warning: this module is unstable and part of compiler-libs.

Sourcetype t = Warnings.loc = {
  1. loc_start : Lexing.position;
  2. loc_end : Lexing.position;
  3. 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.

Sourceval none : t

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

Sourceval is_none : t -> bool

True for Location.none, false any other location

Sourceval in_file : string -> t

Return an empty ghost range located in a given file.

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 curr : Lexing.lexbuf -> t

Get the location of the current token from the lexbuf.

Sourceval symbol_rloc : unit -> t
Sourceval symbol_gloc : unit -> t
Sourceval rhs_loc : int -> t

rhs_loc n returns the location of the symbol at position n, starting at 1, in the current parser rule.

Sourceval rhs_interval : int -> int -> t
Sourceval get_pos_info : Lexing.position -> string * int * int

file, line, char

Sourcetype 'a loc = {
  1. txt : 'a;
  2. loc : t;
}
Sourceval mknoloc : 'a -> 'a loc
Sourceval mkloc : 'a -> t -> 'a loc

Input info

Sourceval input_name : string ref
Sourceval input_lexbuf : Lexing.lexbuf option ref
Sourceval input_phrase_buffer : Buffer.t option ref

Toplevel-specific functions

Sourceval echo_eof : unit -> unit
Sourceval reset : unit -> unit

Printing locations

Sourceval rewrite_absolute_path : string -> string

rewrite absolute path to honor the BUILD_PATH_PREFIX_MAP variable (https://reproducible-builds.org/specs/build-path-prefix-map/) if it is set.

Sourceval absolute_path : string -> string
Sourceval show_filename : string -> string

In -absname mode, return the absolute path for this filename. Otherwise, returns the filename unchanged.

Sourceval print_filename : Format.formatter -> string -> unit
Sourceval print_loc : Format.formatter -> t -> unit
Sourceval print_locs : Format.formatter -> t list -> unit

Toplevel-specific location highlighting

Sourceval highlight_terminfo : Lexing.lexbuf -> Format.formatter -> t list -> unit

Reporting errors and warnings

The type of reports and report printers

Sourcetype msg = (Format.formatter -> unit) loc
Sourceval msg : ?loc:t -> ('a, Format.formatter, unit, msg) format4 -> 'a
Sourcetype report_kind =
  1. | Report_error
  2. | Report_warning of string
  3. | Report_warning_as_error of string
  4. | Report_alert of string
  5. | Report_alert_as_error of string
Sourcetype report = {
  1. kind : report_kind;
  2. main : msg;
  3. sub : msg list;
}
Sourcetype report_printer = {
  1. pp : report_printer -> Format.formatter -> report -> unit;
  2. pp_report_kind : report_printer -> report -> Format.formatter -> report_kind -> unit;
  3. pp_main_loc : report_printer -> report -> Format.formatter -> t -> unit;
  4. pp_main_txt : report_printer -> report -> Format.formatter -> (Format.formatter -> unit) -> unit;
  5. pp_submsgs : report_printer -> report -> Format.formatter -> msg list -> unit;
  6. pp_submsg : report_printer -> report -> Format.formatter -> msg -> unit;
  7. pp_submsg_loc : report_printer -> report -> Format.formatter -> t -> unit;
  8. pp_submsg_txt : report_printer -> report -> Format.formatter -> (Format.formatter -> unit) -> unit;
}

A 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.

Report printers used in the compiler

Sourceval batch_mode_printer : report_printer
Sourceval terminfo_toplevel_printer : Lexing.lexbuf -> report_printer
Sourceval best_toplevel_printer : unit -> report_printer

Detects the terminal capabilities and selects an adequate printer

Printing a report

Sourceval print_report : Format.formatter -> report -> unit

Display an error or warning report.

Sourceval report_printer : (unit -> report_printer) ref

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.

Sourceval default_report_printer : unit -> report_printer

Original report printer for use in hooks.

Reporting warnings

Converting a Warnings.t into a report

Sourceval report_warning : t -> Warnings.t -> report option

report_warning loc w produces a report for the given warning w, or None if the warning is not to be printed.

Sourceval warning_reporter : (t -> Warnings.t -> report option) ref

Hook for intercepting warnings.

Sourceval default_warning_reporter : t -> Warnings.t -> report option

Original warning reporter for use in hooks.

Printing warnings

Sourceval formatter_for_warnings : Format.formatter ref
Sourceval print_warning : t -> Format.formatter -> Warnings.t -> unit

Prints a warning. This is simply the composition of report_warning and print_report.

Sourceval prerr_warning : t -> Warnings.t -> unit

Same as print_warning, but uses !formatter_for_warnings as output formatter.

Reporting alerts

Converting an Alert.t into a report

Sourceval report_alert : t -> Warnings.alert -> report option

report_alert loc w produces a report for the given alert w, or None if the alert is not to be printed.

Sourceval alert_reporter : (t -> Warnings.alert -> report option) ref

Hook for intercepting alerts.

Sourceval default_alert_reporter : t -> Warnings.alert -> report option

Original alert reporter for use in hooks.

Printing alerts

Sourceval print_alert : t -> Format.formatter -> Warnings.alert -> unit

Prints an alert. This is simply the composition of report_alert and print_report.

Sourceval prerr_alert : t -> Warnings.alert -> unit

Same as print_alert, but uses !formatter_for_warnings as output formatter.

Sourceval deprecated : ?def:t -> ?use:t -> t -> string -> unit

Prints a deprecation alert.

Sourceval alert : ?def:t -> ?use:t -> kind:string -> t -> string -> unit

Prints an arbitrary alert.

Reporting errors

Sourcetype error = report

An error is a report which report_kind must be Report_error.

Sourceval error : ?loc:t -> ?sub:msg list -> string -> error
Sourceval errorf : ?loc:t -> ?sub:msg list -> ('a, Format.formatter, unit, error) format4 -> 'a
Sourceval error_of_printer : ?loc:t -> ?sub:msg list -> (Format.formatter -> 'a -> unit) -> 'a -> error
Sourceval error_of_printer_file : (Format.formatter -> 'a -> unit) -> 'a -> error

Automatically reporting errors for raised exceptions

Sourceval register_error_of_exn : (exn -> error option) -> unit

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).

Sourceval error_of_exn : exn -> [ `Ok of error | `Already_displayed ] option
Sourceexception Error of error

Raising Error e signals an error e; the exception will be caught and the error will be printed.

Sourceexception 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

Sourceval raise_errorf : ?loc:t -> ?sub:msg list -> ('a, Format.formatter, unit, 'b) format4 -> 'a
Sourceval report_exception : Format.formatter -> exn -> unit

Reraise the exception if it is unknown.