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 val set_object_declaration_hook : (UriManager.uri -> Cic.obj -> unit) -> unit
  29
  30 (* this is a pointer to the function which builds the inversion principle *)
  31 val build_inversion_principle: (UriManager.uri-> Cic.obj -> (UriManager.uri * Cic.obj) list) ref
  32
  33 (* adds an object to the library together with all auxiliary lemmas on it *)
  34 (* (e.g. elimination principles, projections, etc.)                       *)
  35 (* it returns the list of the uris of the auxiliary lemmas generated      *)
  36 val add_obj:
  37   RefinementTool.kit ->
  38   UriManager.uri -> Cic.obj ->
  39     UriManager.uri list
  40
  41 (* inverse of add_obj;                                                   *)
  42 (* Warning: it does not remove the dependencies on the object and on its *)
  43 (* auxiliary lemmas!                                                     *)
  44 val remove_obj: UriManager.uri -> unit
  45
  46 (* Informs the library that [uri] is a coercion.                         *)
  47 (* This can generate some composite coercions that, if [add_composites]  *)
  48 (* is true are added to the library.                                     *)
  49 (* The list of added objects is returned.                                *)
  50 val add_coercion:
  51   add_composites:bool ->
  52   RefinementTool.kit -> UriManager.uri -> int (* arity *) ->
  53    int (* saturations *) -> string (* baseuri *) ->
  54     (UriManager.uri * int * int) list (* URI, arity, saturations *)
  55
  56 (* inverse of add_coercion, removes both the eventually created composite   *)
  57 (* coercions and the information that [uri] and the composites are coercion *)
  58 val remove_coercion: UriManager.uri -> unit
  59
  60 (* this is used when resetting, but the more gracefull push/pop can be used to
  61  * suspend/resume an execution *)
  62 val remove_all_coercions: unit -> unit
  63 val push: unit -> unit
  64 val pop: unit -> unit