package merlin-lib

  1. Overview
  2. Docs
package merlin-lib
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Ocaml_parsing.LocationSource

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

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

Sourcetype t = Ocaml_utils.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

Rewriting path

Sourceval rewrite_absolute_path : string -> string

rewrite_absolute_path path rewrites path to honor the BUILD_PATH_PREFIX_MAP variable if it is set. It does not check whether path is absolute or not. The result is as follows:

  • If BUILD_PATH_PREFIX_MAP is not set, just return path.
  • otherwise, rewrite using the mapping (and if there are no matching prefixes that will just return path).

See the BUILD_PATH_PREFIX_MAP spec

rewrite_find_first_existing path uses a BUILD_PATH_PREFIX_MAP mapping and tries to find a source in mapping that maps to a result that exists in the file system. There are the following return values:

  • None, means either

    • BUILD_PATH_PREFIX_MAP is not set and path does not exists, or
    • no source prefixes of path in the mapping were found,

  • Some target, means target exists and either

    • BUILD_PATH_PREFIX_MAP is not set and target = path, or
    • target is the first file (in priority order) that path mapped to that exists in the file system.
  • Not_found raised, means some source prefixes in the map were found that matched path, but none of them existed in the file system. The caller should catch this and issue an appropriate error message.

See the BUILD_PATH_PREFIX_MAP spec

rewrite_find_all_existing_dirs dir accumulates a list of existing directories, dirs, that are the result of mapping a potentially abstract directory, dir, over all the mapping pairs in the BUILD_PATH_PREFIX_MAP environment variable, if any. The list dirs will be in priority order (head as highest priority).

The possible results are:

  • [], means either

    • BUILD_PATH_PREFIX_MAP is not set and dir is not an existing directory, or
    • if set, then there were no matching prefixes of dir.

  • Some dirs, means dirs are the directories found. Either

    • BUILD_PATH_PREFIX_MAP is not set and dirs = [dir], or
    • it was set and dirs are the mapped existing directories.
  • Not_found raised, means some source prefixes in the map were found that matched dir, but none of mapping results were existing directories (possibly due to misconfiguration). The caller should catch this and issue an appropriate error message.

See the BUILD_PATH_PREFIX_MAP spec

Sourceval absolute_path : string -> string

absolute_path path first makes an absolute path, s from path, prepending the current working directory if path was relative. Then s is rewritten using rewrite_absolute_path. Finally the result is normalized by eliminating instances of '.' or '..'.

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

Reporting errors and warnings

The type of reports and report printers

Sourceval msg : ?loc:t -> ('a, Merlin_utils.Format_doc.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 error_source =
  1. | Lexer
  2. | Parser
  3. | Typer
  4. | Warning
  5. | Unknown
  6. | Env
  7. | Config
Sourcetype report = {
  1. kind : report_kind;
  2. main : msg;
  3. sub : msg list;
  4. footnote : Merlin_utils.Format_doc.t option;
  5. source : error_source;
}
Sourceval loc_of_report : report -> t
Sourceval print_main : Format.formatter -> report -> unit
Sourceval print_sub_msg : Format.formatter -> msg -> unit
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 -> Merlin_utils.Format_doc.t -> 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 -> Merlin_utils.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

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 -> Ocaml_utils.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 -> Ocaml_utils.Warnings.t -> report option) ref

Hook for intercepting warnings.

Sourceval default_warning_reporter : t -> Ocaml_utils.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 -> Ocaml_utils.Warnings.t -> unit

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

Sourceval prerr_warning_ref : (t -> Ocaml_utils.Warnings.t -> unit) ref
Sourceval prerr_warning : t -> Ocaml_utils.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 -> Ocaml_utils.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 -> Ocaml_utils.Warnings.alert -> report option) ref

Hook for intercepting alerts.

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

Original alert reporter for use in hooks.

Printing alerts

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

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

Sourceval prerr_alert_ref : (t -> Ocaml_utils.Warnings.alert -> unit) ref
Sourceval prerr_alert : t -> Ocaml_utils.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 -> Merlin_utils.Format_doc.t option
Sourceval error : ?loc:t -> ?sub:msg list -> ?footnote:delayed_msg -> ?source:error_source -> string -> error
Sourceval errorf : ?loc:t -> ?sub:msg list -> ?footnote:delayed_msg -> ?source:error_source -> ('a, Merlin_utils.Format_doc.formatter, unit, error) format4 -> 'a
Sourceval error_of_printer : ?loc:t -> ?sub:msg list -> ?footnote:delayed_msg -> ?source:error_source -> (Merlin_utils.Format_doc.formatter -> 'a -> unit) -> 'a -> error
Sourceval error_of_printer_file : ?source:error_source -> (Merlin_utils.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

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

Reraise the exception if it is unknown.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct