helm/software/components/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 type coercion_decl =
  29   UriManager.uri -> int (* arity *) ->
  30    int (* saturations *) -> string (* baseuri *) ->
  31     UriManager.uri list (* lemmas (new objs) *)
  32
  33 (* the add_single_obj fun passed to the callback can raise AlreadyDefined *)
  34 val add_object_declaration_hook :
  35   (add_obj:(UriManager.uri -> Cic.obj -> UriManager.uri list) ->
  36    add_coercion:coercion_decl ->
  37     UriManager.uri -> Cic.obj -> UriManager.uri list) -> unit
  38
  39 (* adds an object to the library together with all auxiliary lemmas on it *)
  40 (* (e.g. elimination principles, projections, etc.)                       *)
  41 (* it returns the list of the uris of the auxiliary lemmas generated      *)
  42 val add_obj:
  43   UriManager.uri -> Cic.obj -> pack_coercion_obj:(Cic.obj -> Cic.obj) ->
  44     UriManager.uri list
  45
  46 (* removes an object (does not remove its associated lemmas) *)
  47 val remove_obj: UriManager.uri -> unit
  48
  49 (* Informs the library that [uri] is a coercion.                         *)
  50 (* This can generate some composite coercions that, if [add_composites]  *)
  51 (* is true are added to the library.                                     *)
  52 (* The list of added objects is returned.                                *)
  53 val add_coercion:
  54   add_composites:bool -> pack_coercion_obj:(Cic.obj -> Cic.obj) -> coercion_decl
  55
  56 (* these just push/pop the coercions database, since the library is not
  57  * pushable/poppable *)
  58 val push: unit -> unit
  59 val pop: unit -> unit