File: userWarn.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 (41 lines) | stat: -rw-r--r-- 1,824 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
38
39
40
41
(************************************************************************)
(*         *      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)         *)
(************************************************************************)

(** This is about warnings triggered from user .v code ("warn" attibute).
    See cWarnings.mli for the generic warning interface. *)

type warn = private { note : string; cats : string }
(** note and comma separated list of categories *)

type t = { depr : Deprecation.t option; warn : warn list }
type 'a with_qf = { depr_qf : 'a Deprecation.with_qf option; warn_qf : warn list }

val drop_qf : 'a with_qf -> t
val with_empty_qf : t -> 'a with_qf
val map_qf : ('a -> 'b) -> 'a with_qf -> 'b with_qf

val is_empty : t -> bool
val is_empty_qf : _ with_qf -> bool
val empty : t

val make_warn : note:string -> ?cats:string -> unit -> warn

val create_warning : ?default:CWarnings.status -> warning_name_if_no_cats:string ->
  unit -> ?loc:Loc.t -> warn -> unit

val create_depr_and_user_warnings : ?default:CWarnings.status ->
  object_name:string -> warning_name_base:string ->
  ('a -> Pp.t) -> unit ->
  ?loc:Loc.t -> 'a -> t -> unit

val create_depr_and_user_warnings_qf : ?default:CWarnings.status ->
  object_name:string -> warning_name_base:string ->
  pp_qf:('qf -> Pp.t) -> ('a -> Pp.t) -> unit ->
  ?loc:Loc.t -> 'a -> 'qf with_qf -> unit