]> matita.cs.unibo.it Git - helm.git/blob - helm/ocaml/cic/cicUniv.mli
added contextual menu to act over selected terms
[helm.git] / helm / ocaml / cic / cicUniv.mli
1 (* Copyright (C) 2004, HELM Team.
2  * 
3  * This file is part of HELM, an Hypertextual, Electronic
4  * Library of Mathematics, developed at the Computer Science
5  * Department, University of Bologna, Italy.
6  * 
7  * HELM is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  * 
12  * HELM is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with HELM; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
20  * MA  02111-1307, USA.
21  * 
22  * For details, see the HELM World-Wide-Web page,
23  * http://helm.cs.unibo.it/
24  *)
25
26
27 (*
28   The strings contains an unreadable message
29 *)
30 exception UniverseInconsistency of string
31
32 (*
33   Cic.Type of universe 
34 *)
35 type universe
36
37 (*
38   Opaque data structure you will use to store constraints
39 *)
40 type universe_graph
41
42 (*
43   returns a fresh universe
44 *)
45 val fresh: 
46   ?uri:UriManager.uri ->
47   ?id:int ->
48   unit -> 
49     universe
50
51     (* names a universe if unnamed *)
52 val name_universe: universe -> UriManager.uri -> universe
53     
54 (*
55   really useful at the begin and in all the functions that don't care 
56   of universes
57 *)
58 val empty_ugraph: universe_graph
59
60 (*
61   These are the real functions to add eq/ge/gt constraints 
62   to the passed graph, returning an updated graph or raising
63   UniverseInconsistency
64 *)
65 val add_eq: 
66   ?fast:bool -> universe -> universe -> universe_graph -> universe_graph
67 val add_ge: 
68   ?fast:bool -> universe -> universe -> universe_graph -> universe_graph
69 val add_gt: 
70   ?fast:bool -> universe -> universe -> universe_graph -> universe_graph
71
72 (*
73   debug function to print the graph to standard error
74 *)
75 val print_ugraph: 
76   universe_graph -> unit
77
78 (*
79   does what expected, but I don't remember why this was exported
80 *)
81 val string_of_universe: 
82   universe -> string
83
84 (*
85   given the list of visible universes (see universes_of_obj) returns a
86   cleaned graph (cleaned from the not visible nodes) 
87 *)
88 val clean_ugraph: 
89   universe_graph -> universe list -> universe_graph
90
91 (*
92   Since fresh() can't add the right uri to each node, you
93   must fill empty nodes with the uri before you serialize the graph to xml
94
95   these empty nodes are also filled in the universe list
96 *)
97 val fill_empty_nodes_with_uri:
98   universe_graph -> universe list -> UriManager.uri -> 
99     universe_graph * universe list
100
101 (*
102   makes a union.
103   TODO:
104   - remember already merged uri so that we completely skip already merged
105     graphs, this may include a dependecy graph (not merge a subpart of an
106     already merged graph)
107 *)
108 val merge_ugraphs:
109   universe_graph -> universe_graph -> universe_graph
110
111 (*
112   ugraph to xml file and viceversa
113 *)
114 val write_xml_of_ugraph: 
115   string -> universe_graph -> universe list -> unit
116
117 (*
118   given a filename parses the xml and returns the data structure
119 *)
120 val ugraph_and_univlist_of_xml:
121   string -> universe_graph * universe list
122 val restart_numbering:
123   unit -> unit
124
125 (*
126   returns the universe number (used to save it do xml) 
127 *) 
128 val univno: universe -> int 
129
130   (** re-hash-cons URIs contained in the given universe so that phisicaly
131    * equality could be enforced. Mainly used by
132    * CicEnvironment.restore_from_channel *)
133 val recons_graph: universe_graph -> universe_graph
134
135   (** re-hash-cons a single universe *)
136 val recons_univ: universe -> universe
137
138   (** consistency chek that should be done before committin the graph to the
139    * cache *)
140 val assert_univs_have_uri: universe_graph -> universe list-> unit
141
142   (** asserts the universe is named *)
143 val assert_univ: universe -> unit
144
145 val compare: universe -> universe -> int
146 val eq: universe -> universe -> bool
147
148 (*
149   Benchmarking stuff
150 *)
151 val get_spent_time: unit -> float
152 val reset_spent_time: unit -> unit