aboutsummaryrefslogtreecommitdiffhomepage
path: root/toplevel/locality.mli
blob: b63378ed14566ef41f96e87efe8079e77ab657a9 (plain)
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
(************************************************************************)
(*  v      *   The Coq Proof Assistant  /  The Coq Development Team     *)
(* <O___,, *   INRIA - CNRS - LIX - LRI - PPS - Copyright 1999-2012     *)
(*   \VV/  **************************************************************)
(*    //   *      This file is distributed under the terms of the       *)
(*         *       GNU Lesser General Public License Version 2.1        *)
(************************************************************************)

(** * Managing locality *)

val locality_flag : (Loc.t * bool) option ref
val check_locality : unit -> unit

(** * Extracting the locality flag *)

(** Commands which supported an inlined Local flag *)

val enforce_locality_full : bool -> bool option

(** Commands which did not supported an inlined Local flag
    (synonym of [enforce_locality_full false]) *)

val use_locality_full : unit -> bool option

(** * Positioning locality for commands supporting discharging and export
    outside of modules *)

(** For commands whose default is to discharge and export:
    Global is the default and is neutral;
    Local in a section deactivates discharge,
    Local not in a section deactivates export *)

val make_locality : bool option -> bool
val use_locality : unit -> bool
val use_locality_exp : unit -> Decl_kinds.locality
val enforce_locality : bool -> bool
val enforce_locality_exp : bool -> Decl_kinds.locality

(** For commands whose default is not to discharge and not to export:
    Global forces discharge and export;
    Local is the default and is neutral *)

val use_non_locality : unit -> bool

(** For commands whose default is to not discharge but to export:
    Global in sections forces discharge, Global not in section is the default;
    Local in sections is the default, Local not in section forces non-export *)

val make_section_locality : bool option -> bool
val use_section_locality : unit -> bool
val enforce_section_locality : bool -> bool

(** * Positioning locality for commands supporting export but not discharge *)

(** For commands whose default is to export (if not in section):
    Global in sections is forbidden, Global not in section is neutral;
    Local in sections is the default, Local not in section forces non-export *)

val make_module_locality : bool option -> bool
val use_module_locality : unit -> bool
val enforce_module_locality : bool -> bool