helm/interface/cicCache.mli

   1 (* Copyright (C) 2000, 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://cs.unibo.it/helm/.
  24  *)
  25
  26 (******************************************************************************)
  27 (*                                                                            *)
  28 (*                               PROJECT HELM                                 *)
  29 (*                                                                            *)
  30 (*                Claudio Sacerdoti Coen <sacerdot@cs.unibo.it>               *)
  31 (*                                 24/01/2000                                 *)
  32 (*                                                                            *)
  33 (* This module implements a trival cache system (an hash-table) for cic       *)(* objects. Uses the getter (getter.ml) and the parser (cicParser.ml)         *)(*                                                                            *)
  34 (******************************************************************************)
  35
  36 exception CircularDependency of string;;
  37
  38 (* get_obj uri                                                                *)
  39 (* returns the cic object whose uri is uri. If the term is not just in cache, *)
  40 (* then it is parsed via CicParser.term_of_xml from the file whose name is    *)
  41 (* the result of Getter.get uri                                               *)
  42 val get_obj : UriManager.uri -> Cic.obj
  43
  44 (* get_annobj uri                                                             *)
  45 (* returns the cic object whose uri is uri either in annotated and in         *)
  46 (* deannotated form. It returns also the map from ids to annotation targets.  *)
  47 (* The term is put in cache if it's not there yet.                            *)
  48 (* The functions raise CircularDependency if asked to retrieve a Frozen object*)
  49 val get_annobj :
  50  UriManager.uri -> Cic.annobj * (Cic.id, Cic.anntarget) Hashtbl.t * Cic.obj
  51
  52 (* DANGEROUS!!!                                *)
  53 (* USEFUL ONLY DURING THE FIXING OF THE FILES  *)
  54 (* change_obj uri (Some newobj)                *)
  55 (*  maps uri to newobj in cache.               *)
  56 (* change_obj uri None                         *)
  57 (*  maps uri to a freeze dummy-object.         *)
  58 val change_obj : UriManager.uri -> Cic.obj option -> unit
  59
  60 type type_checked_obj =
  61    CheckedObj of Cic.obj    (* cooked obj *)
  62  | UncheckedObj of Cic.obj  (* uncooked obj *)
  63
  64 (* is_type_checked uri cookingsno                                   *)
  65 (*CSC commento falso ed obsoleto *)
  66 (* returns (true,object) if the object has been type-checked        *)
  67 (* otherwise it returns (false,object) and freeze the object for    *)
  68 (* type-checking                                                    *)
  69 (* set_type_checking_info must be called to unfreeze the object     *)
  70 val is_type_checked : UriManager.uri -> int -> type_checked_obj
  71
  72 (* set_type_checking_info uri                                         *)
  73 (* must be called once the type-checking of uri is finished           *)
  74 (* The object whose uri is uri is unfreezed and won't be type-checked *)
  75 (* again in the future (is_type_checked will return true)             *)
  76 val set_type_checking_info : UriManager.uri -> unit
  77
  78 (* get_cooked_obj uri cookingsno *)
  79 val get_cooked_obj : UriManager.uri -> int -> Cic.obj
  80
  81 val cook_obj : (Cic.obj -> UriManager.uri -> (int * Cic.obj) list) ref