blob: 67abd34dd64e4e9861c5930ccd5dfdfaf2e5ce31 (
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
|
(************************************************************************)
(* * The Coq Proof Assistant / The Coq Development Team *)
(* v * INRIA, CNRS and contributors - Copyright 1999-2018 *)
(* <O___,, * (see CREDITS file for the list of authors) *)
(* \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 module centralizes the notions of hooks. Hooks are pointers that are to
be set at runtime exactly once. *)
type 'a t
(** The type of hooks containing ['a]. Hooks can only be set. *)
type 'a value
(** The content part of a hook. *)
val make : ?default:'a -> unit -> ('a value * 'a t)
(** Create a new hook together with a way to retrieve its runtime value. *)
val get : 'a value -> 'a
(** Access the content of a hook. If it was not set yet, try to recover the
default value if there is one.
@raise Assert_failure if undefined. *)
val set : 'a t -> 'a -> unit
(** Register a hook. Assertion failure if already registered. *)
|
