aboutsummaryrefslogtreecommitdiff
path: root/vernac/classes.mli
blob: 8d5f3e3a0678ced087d9397207c0d5cd3b57e626 (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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
(************************************************************************)
(*         *   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)         *)
(************************************************************************)

open Names
open Environ
open Constrexpr
open Typeclasses
open Libnames

(** Errors *)

val mismatched_params : env -> constr_expr list -> Constr.rel_context -> 'a

val mismatched_props : env -> constr_expr list -> Constr.rel_context -> 'a

(** Instance declaration *)

val declare_instance : ?warn:bool -> env -> Evd.evar_map ->
                       hint_info option -> bool -> GlobRef.t -> unit
(** Declares the given global reference as an instance of its type.
    Does nothing — or emit a “not-a-class” warning if the [warn] argument is set —
    when said type is not a registered type class. *)

val existing_instance : bool -> qualid -> Hints.hint_info_expr option -> unit
(** globality, reference, optional priority and pattern information *)

val declare_instance_constant :
  typeclass ->
  Hints.hint_info_expr (** priority *) ->
  bool (** globality *) ->
  Impargs.manual_explicitation list (** implicits *) ->
  ?hook:(GlobRef.t -> unit) ->
  Id.t (** name *) ->
  UState.universe_decl ->
  bool (** polymorphic *) ->
  Evd.evar_map (** Universes *) ->
  Constr.t (** body *) ->
  Constr.types (** type *) ->
  unit

val new_instance :
  pstate:Proof_global.t option
  -> ?global:bool (** Not global by default. *)
  -> program_mode:bool
  -> Decl_kinds.polymorphic
  -> name_decl
  -> local_binder_expr list
  -> constr_expr
  -> (bool * constr_expr) option
  -> ?generalize:bool
  -> ?tac:unit Proofview.tactic
  -> ?hook:(GlobRef.t -> unit)
  -> Hints.hint_info_expr
  -> Id.t * Proof_global.t option (* May open a proof *)

val declare_new_instance
  : ?global:bool (** Not global by default. *)
  -> program_mode:bool
  -> Decl_kinds.polymorphic
  -> ident_decl
  -> local_binder_expr list
  -> constr_expr
  -> Hints.hint_info_expr
  -> unit

(** {6 Low level interface used by Add Morphism, do not use } *)
val mk_instance : typeclass -> hint_info -> bool -> GlobRef.t -> instance
val add_instance : instance -> unit

val add_class : env -> Evd.evar_map -> typeclass -> unit

(** Setting opacity *)

val set_typeclass_transparency : evaluable_global_reference -> bool -> bool -> unit

(** For generation on names based on classes only *)

val id_of_class : typeclass -> Id.t