blob: 0dc82c1c3f9789f1edafb014ab36dfdc5a417fbf (
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
|
(************************************************************************)
(* * 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 Constr
open Environ
open Pattern
(** {6 Search facilities. } *)
type glob_search_about_item =
| GlobSearchSubPattern of constr_pattern
| GlobSearchString of string
type filter_function = GlobRef.t -> env -> constr -> bool
type display_function = GlobRef.t -> env -> constr -> unit
(** {6 Generic filter functions} *)
val blacklist_filter : filter_function
(** Check whether a reference is blacklisted. *)
val module_filter : DirPath.t list * bool -> filter_function
(** Check whether a reference pertains or not to a set of modules *)
val search_about_filter : glob_search_about_item -> filter_function
(** Check whether a reference matches a SearchAbout query. *)
(** {6 Specialized search functions}
[search_xxx gl pattern modinout] searches the hypothesis of the [gl]th
goal and the global environment for things matching [pattern] and
satisfying module exclude/include clauses of [modinout]. *)
val search_by_head : int option -> constr_pattern -> DirPath.t list * bool
-> display_function -> unit
val search_rewrite : int option -> constr_pattern -> DirPath.t list * bool
-> display_function -> unit
val search_pattern : int option -> constr_pattern -> DirPath.t list * bool
-> display_function -> unit
val search_about : int option -> (bool * glob_search_about_item) list
-> DirPath.t list * bool -> display_function -> unit
type search_constraint =
(** Whether the name satisfies a regexp (uses Ocaml Str syntax) *)
| Name_Pattern of Str.regexp
(** Whether the object type satisfies a pattern *)
| Type_Pattern of Pattern.constr_pattern
(** Whether some subtype of object type satisfies a pattern *)
| SubType_Pattern of Pattern.constr_pattern
(** Whether the object pertains to a module *)
| In_Module of Names.DirPath.t
(** Bypass the Search blacklist *)
| Include_Blacklist
type 'a coq_object = {
coq_object_prefix : string list;
coq_object_qualid : string list;
coq_object_object : 'a;
}
val interface_search : ?glnum:int -> (search_constraint * bool) list ->
constr coq_object list
(** {6 Generic search function} *)
val generic_search : int option -> display_function -> unit
(** This function iterates over all hypothesis of the goal numbered
[glnum] (if present) and all known declarations. *)
(** {6 Search function modifiers} *)
val prioritize_search : (display_function -> unit) -> display_function -> unit
(** [prioritize_search iter] iterates over the values of [iter] (seen
as a sequence of declarations), in a relevance order. This requires to
perform the entire iteration of [iter] before starting streaming. So
[prioritize_search] should not be used for low-latency streaming. *)
|
