added helm-metadata module

[helm.git] / helm / ocaml / metadata / metadataDb.mli

diff --git a/helm/ocaml/metadata/metadataDb.mli b/helm/ocaml/metadata/metadataDb.mli
new file mode 100644 (file)
index 0000000..074ff72
--- /dev/null
+++ b/helm/ocaml/metadata/metadataDb.mli
@@ -0,0 +1,47 @@
+(* Copyright (C) 2004, 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://helm.cs.unibo.it/
+ *)
+
+  (** index a Cic.Constant object and insert resulting metadata into the db
+  * PRE_EVAL(dbh) *)
+val index_constant:
+  dbh:Dbi.connection ->
+  owner:string ->
+  uri:UriManager.uri -> body:Cic.term option -> ty:Cic.term ->
+    unit
+
+  (** index a Cic.InductiveDefinition object and insert resulting metadata into
+  * the db
+  * PRE_EVAL(dbh) *)
+val index_inductive_def:
+  dbh:Dbi.connection ->
+  owner:string ->
+  uri:UriManager.uri -> types:Cic.inductiveType list ->
+    unit
+
+(* TODO Zack indexing of variables and (perhaps?) incomplete proofs *)
+
+  (** remove from the db all metadata pertaining to a given owner *)
+val clean: dbh:Dbi.connection -> owner:string -> unit
+