Source file `library_info.ml`

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
(************************************************************************)
(*         *   The Coq Proof Assistant / The Coq 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 handles attributes associated to a library file *)

(*i*)
open Names
(*i*)

type t = UserWarn.t

let warn_library_deprecated =
  Deprecation.create_warning ~object_name:"Library File"
    ~warning_name_if_no_since:"deprecated-library-file"
    (fun dp -> DirPath.print dp)

let warn_library_warn =
  UserWarn.create_warning ~warning_name_if_no_cats:"warn-library-file" ()

let warn_library_deprecated_transitive =
  Deprecation.create_warning ~object_name:"Library File (transitively required)"
    ~warning_name_if_no_since:"deprecated-transitive-library-file"
    ~default:CWarnings.Disabled
    (fun dp -> DirPath.print dp)

let warn_library_warn_transitive =
  UserWarn.create_warning
    ~warning_name_if_no_cats:"warn-transitive-library-file"
    ~default:CWarnings.Disabled ()

let warn_library_info ?loc ?(transitive=false) dp infos =
  let open UserWarn in
  if transitive then begin
    Option.iter (fun depr ->
        warn_library_deprecated_transitive ?loc (dp, depr)) infos.depr;
    List.iter (fun warn -> warn_library_warn_transitive ?loc warn) infos.warn
  end else begin
    Option.iter (fun depr ->
        warn_library_deprecated ?loc (dp, depr)) infos.depr;
    List.iter (fun warn -> warn_library_warn ?loc warn) infos.warn
  end