File: quickfix.mli

package info (click to toggle)
coq 9.1.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 35,964 kB
  • sloc: ml: 239,908; sh: 4,355; python: 2,985; ansic: 2,644; makefile: 874; lisp: 171; javascript: 63; xml: 24; sed: 2
file content (37 lines) | stat: -rw-r--r-- 1,379 bytes parent folder | download
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
(************************************************************************)
(*         *      The Rocq Prover / The Rocq Development Team           *)
(*  v      *         Copyright INRIA, CNRS and contributors             *)
(* <O___,, * (see version control and CREDITS file for authors & dates) *)
(*   \VV/  **************************************************************)
(*    //   *    This file is distributed under the terms of the         *)
(*         *     GNU Lesser General Public License Version 2.1          *)
(*         *     (see LICENSE file for the text of the license)         *)
(************************************************************************)

type t

val make : loc:Loc.t -> Pp.t -> t

val pp : t -> Pp.t

val loc : t -> Loc.t

(** [register h] registers [h] as a quickfix generator.
    When an error is generated the toplevel can check if there is
    quick fix for it.

    Quickfix generators signal that they don't deal with some exception
    by returning []. Raising any other exception is
    forbidden.

    Exceptions that are considered anomalies should not be
    handled by Quickfix generators.
*)

val register : (exn -> t list) -> unit

(** computes all the quickfixes for a given exception *)
val from_exception : exn -> (t list, Exninfo.iexn) result

(** Prints all the quickfixes in a vertical box *)
val print : t list -> Pp.t