HELM OCaml libraries with findlib support.

[helm.git] / helm / ocaml / urimanager / uriManager.mli

diff --git a/helm/ocaml/urimanager/uriManager.mli b/helm/ocaml/urimanager/uriManager.mli
new file mode 100644 (file)
index 0000000..2cdd27e
--- /dev/null
+++ b/helm/ocaml/urimanager/uriManager.mli
@@ -0,0 +1,51 @@
+(* Copyright (C) 2000, HELM Team.
+ * 
+ * This file is part of HELM, an Hypertextual, Electronic
+ * Library of Mathematics, developed at the Computer Science
+ * Department, University of Bologna, Italy.
+ * 
+ * HELM is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ * 
+ * HELM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with HELM; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+ * MA  02111-1307, USA.
+ * 
+ * For details, see the HELM World-Wide-Web page,
+ * http://cs.unibo.it/helm/.
+ *)
+
+type uri
+
+val eq : uri -> uri -> bool
+
+val uri_of_string : string -> uri
+
+val string_of_uri : uri -> string  (* complete uri *)
+val name_of_uri   : uri -> string  (* name only (without extension)*)
+val buri_of_uri   : uri -> string  (* base uri only *)
+val depth_of_uri  : uri -> int     (* length of the path *)
+
+(* relative_depth curi uri cookingsno                                        *)
+(* is the number of times to cook uri to use it when the current uri is curi *)
+(* cooked cookingsno times                                                   *)
+val relative_depth : uri -> uri -> int -> int
+
+(* given an uri, returns the uri of the corresponding cic file, *)
+(* i.e. removes the [.types][.ann] suffix                       *)
+val cicuri_of_uri : uri -> uri
+
+(* given an uri, returns the uri of the corresponding annotation file, *)
+(* i.e. adds the .ann suffix if not already present                    *)
+val annuri_of_uri : uri -> uri
+
+(* given an uri, tells if it refers to an annotation *)
+val uri_is_annuri : uri -> bool