diff options
| author | Pierre Letouzey | 2016-06-27 11:03:43 +0200 |
|---|---|---|
| committer | Maxime Dénès | 2016-07-03 12:08:03 +0200 |
| commit | f14b6f1a17652566f0cbc00ce81421ba0684dad5 (patch) | |
| tree | 8a331593d0d1b518e8764c92ac54e3b11c222358 /lib/errors.mli | |
| parent | 500d38d0887febb614ddcadebaef81e0c7942584 (diff) | |
errors.ml renamed into cErrors.ml (avoid clash with an OCaml compiler-lib module)
For the moment, there is an Error module in compilers-lib/ocamlbytecomp.cm(x)a
Diffstat (limited to 'lib/errors.mli')
| -rw-r--r-- | lib/errors.mli | 99 |
1 files changed, 0 insertions, 99 deletions
diff --git a/lib/errors.mli b/lib/errors.mli deleted file mode 100644 index e5dad93fd0..0000000000 --- a/lib/errors.mli +++ /dev/null @@ -1,99 +0,0 @@ -(***********************************************************************) -(* v * The Coq Proof Assistant / The Coq Development Team *) -(* <O___,, * INRIA-Rocquencourt & LRI-CNRS-Orsay *) -(* \VV/ *************************************************************) -(* // * This file is distributed under the terms of the *) -(* * GNU Lesser General Public License Version 2.1 *) -(***********************************************************************) - -open Pp - -(** This modules implements basic manipulations of errors for use - throughout Coq's code. *) - -(** {6 Error handling} *) - -val push : exn -> Exninfo.iexn -(** Alias for [Backtrace.add_backtrace]. *) - -(** {6 Generic errors.} - - [Anomaly] is used for system errors and [UserError] for the - user's ones. *) - -val make_anomaly : ?label:string -> std_ppcmds -> exn -(** Create an anomaly. *) - -val anomaly : ?loc:Loc.t -> ?label:string -> std_ppcmds -> 'a -(** Raise an anomaly, with an optional location and an optional - label identifying the anomaly. *) - -val is_anomaly : exn -> bool -(** Check whether a given exception is an anomaly. - This is mostly provided for compatibility. Please avoid doing specific - tricks with anomalies thanks to it. See rather [noncritical] below. *) - -exception UserError of string * std_ppcmds -val error : string -> 'a -val errorlabstrm : string -> std_ppcmds -> 'a -val user_err_loc : Loc.t * string * std_ppcmds -> 'a - -exception AlreadyDeclared of std_ppcmds -val alreadydeclared : std_ppcmds -> 'a - -val invalid_arg_loc : Loc.t * string -> 'a - -(** [todo] is for running of an incomplete code its implementation is - "do nothing" (or print a message), but this function should not be - used in a released code *) - -val todo : string -> unit - -exception Timeout -exception Drop -exception Quit - -(** [register_handler h] registers [h] as a handler. - When an expression is printed with [print e], it - goes through all registered handles (the most - recent first) until a handle deals with it. - - Handles signal that they don't deal with some exception - by raising [Unhandled]. - - Handles can raise exceptions themselves, in which - case, the exception is passed to the handles which - were registered before. - - The exception that are considered anomalies should not be - handled by registered handlers. -*) - -exception Unhandled - -val register_handler : (exn -> Pp.std_ppcmds) -> unit - -(** The standard exception printer *) -val print : ?info:Exninfo.info -> exn -> Pp.std_ppcmds -val iprint : Exninfo.iexn -> Pp.std_ppcmds - -(** Same as [print], except that the "Please report" part of an anomaly - isn't printed (used in Ltac debugging). *) -val print_no_report : exn -> Pp.std_ppcmds -val iprint_no_report : Exninfo.iexn -> Pp.std_ppcmds - -(** Critical exceptions should not be caught and ignored by mistake - by inner functions during a [vernacinterp]. They should be handled - only in [Toplevel.do_vernac] (or Ideslave), to be displayed to the user. - Typical example: [Sys.Break], [Assert_failure], [Anomaly] ... -*) -val noncritical : exn -> bool - -(** Check whether an exception is handled by some toplevel printer. The - [Anomaly] exception is never handled. *) -val handled : exn -> bool - -(** Prints info which is either an error or - an anomaly and then exits with the appropriate - error code *) -val fatal_error : Pp.std_ppcmds -> bool -> 'a |
