Melange_compiler_libs.Location
Source code locations (ranges of positions), used in parsetree.
Warning: this module is unstable and part of compiler-libs.
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.
val none : t
An arbitrary value of type t
; describes an empty ghost range.
val is_none : t -> bool
True for Location.none
, false any other location
val in_file : string -> t
Return an empty ghost range located in a given file.
Set 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
val rhs_loc : int -> 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 mknoloc : 'a -> 'a loc
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:
path
.path
).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
path
does not exists, orpath
in the mapping were found,Some target
, means target
exists and either
target
= path
, ortarget
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.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
dir
is not an existing directory, ordir
.Some dirs
, means dirs are the directories found. Either
dirs = [dir]
, ordirs
are the mapped existing directories.dir
, but none of mapping results were existing directories (possibly due to misconfiguration). The caller should catch this and issue an appropriate error message.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 '..'
.
In -absname mode, return the absolute path for this filename. Otherwise, returns the filename unchanged.
val print_loc : Stdlib.Format.formatter -> t -> unit
val print_locs : Stdlib.Format.formatter -> t list -> unit
val highlight_terminfo :
Stdlib.Lexing.lexbuf ->
Stdlib.Format.formatter ->
t list ->
unit
type msg = (Stdlib.Format.formatter -> unit) loc
type report_printer = Melange_wrapper.Location.report_printer = {
pp : report_printer -> Stdlib.Format.formatter -> report -> unit;
pp_report_kind : report_printer ->
report ->
Stdlib.Format.formatter ->
report_kind ->
unit;
pp_main_loc : report_printer -> report -> Stdlib.Format.formatter -> t -> unit;
pp_main_txt : report_printer ->
report ->
Stdlib.Format.formatter ->
(Stdlib.Format.formatter -> unit) ->
unit;
pp_submsgs : report_printer ->
report ->
Stdlib.Format.formatter ->
msg list ->
unit;
pp_submsg : report_printer -> report -> Stdlib.Format.formatter -> msg -> unit;
pp_submsg_loc : report_printer ->
report ->
Stdlib.Format.formatter ->
t ->
unit;
pp_submsg_txt : report_printer ->
report ->
Stdlib.Format.formatter ->
(Stdlib.Format.formatter -> unit) ->
unit;
}
A printer for report
s, defined using open-recursion. The goal is to make it easy to define new printers by re-using code from existing ones.
val batch_mode_printer : report_printer
val terminfo_toplevel_printer : Stdlib.Lexing.lexbuf -> report_printer
val best_toplevel_printer : unit -> report_printer
Detects the terminal capabilities and selects an adequate printer
report
val print_report : Stdlib.Format.formatter -> report -> unit
Display an error or warning report.
val report_printer : (unit -> report_printer) Stdlib.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.
val default_report_printer : unit -> report_printer
Original report printer for use in hooks.
Warnings.t
into a report
val 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.
val warning_reporter : (t -> Warnings.t -> report option) Stdlib.ref
Hook for intercepting warnings.
val default_warning_reporter : t -> Warnings.t -> report option
Original warning reporter for use in hooks.
val print_warning : t -> Stdlib.Format.formatter -> Warnings.t -> unit
Prints a warning. This is simply the composition of report_warning
and print_report
.
val prerr_warning : t -> Warnings.t -> unit
Same as print_warning
, but uses !formatter_for_warnings
as output formatter.
Alert.t
into a report
val 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.
val alert_reporter : (t -> Warnings.alert -> report option) Stdlib.ref
Hook for intercepting alerts.
val default_alert_reporter : t -> Warnings.alert -> report option
Original alert reporter for use in hooks.
val print_alert : t -> Stdlib.Format.formatter -> Warnings.alert -> unit
Prints an alert. This is simply the composition of report_alert
and print_report
.
val prerr_alert : t -> Warnings.alert -> unit
Same as print_alert
, but uses !formatter_for_warnings
as output formatter.
Prints an alert that -I +lib has been automatically added to the load path
deprecated_script_alert command
prints an alert that command foo
has been deprecated in favour of command ./foo
type error = report
An error
is a report
which report_kind
must be Report_error
.
val error_of_printer_file :
(Stdlib.Format.formatter -> 'a -> unit) ->
'a ->
error
val 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).
val error_of_exn : exn -> [ `Ok of error | `Already_displayed ] option
exception Error of error
Raising Error e
signals an error e
; the exception will be caught and the error will be printed.
Raising Already_displayed_error
signals an error which has already been printed. The exception will be caught, but nothing will be printed