package ocamlformat-mlx-lib

You can search for identifiers within the package.

in-package search v0.2.0

OCaml .mlx Code Formatter

Install

Dune Dependency

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

Authors

Maintainers

A

Andrey Popp <me@andreypopp.com>

Sources

ocamlformat-mlx-0.27.0.tbz

sha256=6a40faa182faee55f32bc92387b7e7f97818e160e0f4ef0e0032c0b8b70b86d1

sha512=7df487ebdcddff3529886e034fa9d5476c765c60926b11b8d86fb0e42bea3ee41f693c898e7f95bfc19ca9fa0116825c040a3e027c1e3b7505ebe6c6508540ec

doc/ocamlformat-mlx-lib.ocaml_common/Ocamlformat_ocaml_common/Location/index.html

Module `Ocamlformat_ocaml_common.Location`Source

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

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

Sourcetype t = Warnings.loc = {

loc_start : Lexing.position;
loc_end : 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.

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_info : 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 = {

txt : 'a;
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

Rewriting path

Printing locations

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

Sourceval separate_new_message : Format.formatter -> unit

Sourcemodule Doc : sig ... end

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 = Ocamlformat_parser_shims.Format_doc.t loc

Source

val msg : 
  ?loc:t ->
  ('a, Ocamlformat_parser_shims.Format_doc.formatter, unit, msg) format4 ->
  'a

Sourcetype report_kind =

| Report_error
| Report_warning of string
| Report_warning_as_error of string
| Report_alert of string
| Report_alert_as_error of string

Sourcetype report = {

kind : report_kind;
main : msg;
sub : msg list;
footnote : Ocamlformat_parser_shims.Format_doc.t option;

}

Sourcetype report_printer = {

pp : report_printer -> Format.formatter -> report -> unit;
pp_report_kind : report_printer -> report -> Format.formatter -> report_kind -> unit;
pp_main_loc : report_printer -> report -> Format.formatter -> t -> unit;
pp_main_txt : report_printer -> report -> Format.formatter -> Ocamlformat_parser_shims.Format_doc.t -> unit;
pp_submsgs : report_printer -> report -> Format.formatter -> msg list -> unit;
pp_submsg : report_printer -> report -> Format.formatter -> msg -> unit;
pp_submsg_loc : report_printer -> report -> Format.formatter -> t -> unit;
pp_submsg_txt : report_printer -> report -> Format.formatter -> Ocamlformat_parser_shims.Format_doc.t -> 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.

Sourceval auto_include_alert : string -> unit

Prints an alert that -I +lib has been automatically added to the load path

Sourceval deprecated_script_alert : string -> unit

deprecated_script_alert command prints an alert that command foo has been deprecated in favour of command ./foo

Reporting errors

Sourcetype error = report

An error is a report which report_kind must be Report_error.

Sourcetype delayed_msg = unit -> Ocamlformat_parser_shims.Format_doc.t option

Sourceval error : ?loc:t -> ?sub:msg list -> ?footnote:delayed_msg -> string -> error

Source

val errorf : 
  ?loc:t ->
  ?sub:msg list ->
  ?footnote:delayed_msg ->
  ('a, Ocamlformat_parser_shims.Format_doc.formatter, unit, error) format4 ->
  'a

Source

val error_of_printer : 
  ?loc:t ->
  ?sub:msg list ->
  ?footnote:delayed_msg ->
  (Ocamlformat_parser_shims.Format_doc.formatter -> 'a -> unit) ->
  'a ->
  error

Source

val error_of_printer_file : 
  (Ocamlformat_parser_shims.Format_doc.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

Source

val raise_errorf : 
  ?loc:t ->
  ?sub:msg list ->
  ?footnote:delayed_msg ->
  ('a, Ocamlformat_parser_shims.Format_doc.formatter, unit, 'b) format4 ->
  'a

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

Reraise the exception if it is unknown.

On This Page

Input info
Toplevel-specific functions
Rewriting path
Printing locations
Toplevel-specific location highlighting
Reporting errors and warnings
Reporting warnings
1. Converting a Warnings.t into a report
2. Printing warnings
Reporting alerts
1. Converting an Alert.t into a report
2. Printing alerts
Reporting errors
Automatically reporting errors for raised exceptions

package ocamlformat-mlx-lib

Install

Dune Dependency

Authors

Maintainers

Sources

doc/ocamlformat-mlx-lib.ocaml_common/Ocamlformat_ocaml_common/Location/index.html

Module Ocamlformat_ocaml_common.LocationSource

Input info

Toplevel-specific functions

Rewriting path

Printing locations

Toplevel-specific location highlighting

Reporting errors and warnings

The type of reports and report printers

Report printers used in the compiler

Printing a report

Reporting warnings

Converting a Warnings.t into a report

Printing warnings

Reporting alerts

Converting an Alert.t into a report

Printing alerts

Reporting errors

Automatically reporting errors for raised exceptions

Module `Ocamlformat_ocaml_common.Location`Source

Printing a `report`

Converting a `Warnings.t` into a `report`

Converting an `Alert.t` into a `report`