helm/ocaml/library/librarySync.mli

   1 (* Copyright (C) 2004-2005, 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 exception AlreadyDefined of UriManager.uri
  27
  28 (* adds an object to the library together with all auxiliary lemmas on it *)
  29 (* (e.g. elimination principles, projections, etc.)                       *)
  30 (* it returns the list of the uris of the auxiliary lemmas generated      *)
  31 val add_obj: UriManager.uri -> Cic.obj -> basedir:string -> UriManager.uri list
  32
  33 (* inverse of add_obj;                                                   *)
  34 (* Warning: it does not remove the dependencies on the object and on its *)
  35 (* auxiliary lemmas!                                                     *)
  36 val remove_obj: UriManager.uri -> unit
  37
  38 (* Informs the library that [uri] is a coercion.                         *)
  39 (* This can generate some composite coercions that, if [add_composites]  *)
  40 (* is true are added to the library.                                     *)
  41 (* The list of added objects is returned.                                *)
  42 val add_coercion:
  43   basedir:string -> add_composites:bool -> UriManager.uri ->
  44     UriManager.uri list
  45
  46 (* inverse of add_coercion, removes both the eventually created composite   *)
  47 (* coercions and the information that [uri] and the composites are coercion *)
  48 val remove_coercion: UriManager.uri -> unit
  49
  50 (* mh... *)
  51 val remove_all_coercions: unit -> unit
  52