/usr/lib/ocaml/batteries/batPrintexc.mli is in libbatteries-ocaml-dev 2.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 | (*
* BatPrintexc - Extended Printexc module
* Copyright (C) 1996 Xavier Leroy
* 2008 David Teller, LIFO, Universite d'Orleans
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version,
* with the special exception on linking described in file LICENSE.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*)
(** Facilities for printing exceptions.
@author Xavier Leroy (Base module)
@author David Teller
*)
val pass : ('a -> 'b) -> 'a -> 'b
(** [Printexc.pass fn x] applies [fn] to [x] and returns the result.
If the evaluation of [fn x] raises any exception, the name of the
exception is printed on standard error output, and the exception
is raised again. The typical use is to catch and report
exceptions that escape a function application. This function is a
renamed version of [Printexc.print] from stdlib.*)
val catch: ('a -> 'b) -> 'a -> 'b
(** [Printexc.catch fn x] is similar to {!Printexc.print}, but aborts
the program with exit code 2 after printing the uncaught exception.
This function is deprecated: the runtime system is now able to
print uncaught exceptions as precisely as [Printexc.catch] does.
Moreover, calling [Printexc.catch] makes it harder to track the
location of the exception using the debugger or the stack backtrace
facility. So, do not use [Printexc.catch] in new code. *)
val to_string: exn -> string
(** [Printexc.to_string e] returns a string representation of the
exception [e]. *)
val print_backtrace: _ BatInnerIO.output -> unit
(** [print_backtrace oc] Prints the an exception backtrace on the
output channel [oc]. The backtrace lists the program locations
where the most-recently raised exception was raised and where it
was propagated through function calls.
@since 1.4.0
*)
val get_backtrace: unit -> string
(** [Printexc.get_backtrace ()] returns a string containing the same
exception backtrace that [Printexc.print_backtrace] would print.
*)
val record_backtrace: bool -> unit
(** [Printexc.record_backtrace b] turns recording of exception
backtraces on (if [b = true]) or off (if [b = false]). Initially,
backtraces are not recorded, unless the [b] flag is given to the
program through the [OCAMLRUNPARAM] variable.
*)
val backtrace_status: unit -> bool
(** [Printexc.backtrace_status()] returns [true] if exception
backtraces are currently recorded, [false] if not.
*)
val register_printer: (exn -> string option) -> unit
(** [Printexc.register_printer fn] registers [fn] as an exception
printer. The printer should return [None] or raise an exception
if it does not know how to convert the passed exception, and [Some
s] with [s] the resulting string if it can convert the passed
exception. Exceptions raised by the printer are ignored.
When converting an exception into a string, the printers will be invoked
in the reverse order of their registrations, until a printer returns
a [Some s] value (if no such printer exists, the runtime will use a
generic printer).
*)
val print : _ BatInnerIO.output -> exn -> unit
(** Print an exception. The stdlib [print] function is now named [!pass].*)
(** {6 Raw backtraces} *)
type raw_backtrace = Printexc.raw_backtrace
(** The abstract type [backtrace] stores exception backtraces in
a low-level format, instead of directly exposing them as string as
the [get_backtrace()] function does.
This allows to pay the performance overhead of representation
conversion and formatting only at printing time, which is useful
if you want to record more backtrace than you actually print.
*)
val get_raw_backtrace: unit -> raw_backtrace
val print_raw_backtrace: out_channel -> raw_backtrace -> unit
val raw_backtrace_to_string: raw_backtrace -> string
(** {6 Current call stack} *)
val get_callstack: int -> raw_backtrace
(** [Printexc.get_callstack n] returns a description of the top of the
call stack on the current program point (for the current thread),
with at most [n] entries. (Note: this function is not related to
exceptions at all, despite being part of the [Printexc] module.)
@since 4.01.0
*)
|