]> matita.cs.unibo.it Git - helm.git/blob - helm/software/components/metadata/metadataDeps.mli
more pps
[helm.git] / helm / software / components / metadata / metadataDeps.mli
1 (* Copyright (C) 2006, 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   (** @return the one step direct dependencies of an object, specified by URI
27    * (that is, the list of objects on which an given one depends) *)
28 val direct_deps:
29   dbd:HSql.dbd ->
30   UriManager.uri -> (UriManager.uri * MetadataTypes.position) list
31
32   (** @return the one step inverse dependencies of an objects, specified by URI
33    * (that is, the list of objects which depends on a given object) *)
34 val inverse_deps:
35   dbd:HSql.dbd ->
36   UriManager.uri -> (UriManager.uri * MetadataTypes.position) list
37
38 val topological_sort:
39   dbd:HSql.dbd -> UriManager.uri list -> UriManager.uri list
40
41 val sorted_uris_of_baseuri:
42    dbd:HSql.dbd -> string -> UriManager.uri list
43
44   (** Representation of a (lazy) dependency graph.
45    * Imperative data structure. *)
46 module DepGraph:
47 sig
48   type t
49
50   val dummy: t
51
52   val expand: UriManager.uri -> t -> unit   (** ignores uri not found *)
53   val collapse: UriManager.uri -> t -> unit (** ignores uri not found *)
54   val render: Format.formatter -> t -> unit
55
56     (** @return the transitive closure of direct_deps *)
57   val direct_deps: dbd:HSql.dbd -> UriManager.uri -> t
58
59     (** @return the transitive closure of inverse_deps *)
60   val inverse_deps: dbd:HSql.dbd -> UriManager.uri -> t
61 end
62