helm/ocaml/metadata/metadataDb.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   (** index a Cic.Constant object and insert resulting metadata into the db
  27   * PRE_EVAL(dbd) *)
  28 val index_constant:
  29   dbd:Mysql.dbd ->
  30   uri:UriManager.uri -> body:Cic.term option -> ty:Cic.term ->
  31     unit
  32
  33   (** index a Cic.InductiveDefinition object and insert resulting metadata into
  34   * the db
  35   * PRE_EVAL(dbd) *)
  36 val index_inductive_def:
  37   dbd:Mysql.dbd ->
  38   uri:UriManager.uri -> types:Cic.inductiveType list ->
  39     unit
  40
  41 (* TODO Zack indexing of variables and (perhaps?) incomplete proofs *)
  42
  43   (** remove from the db all metadata pertaining to a given owner
  44   * @return list of uris removed from the db *)
  45 val clean: dbd:Mysql.dbd -> string list
  46