matita/components/ng_library/nCicLibrary.mli

   1 (*
   2     ||M||  This file is part of HELM, an Hypertextual, Electronic
   3     ||A||  Library of Mathematics, developed at the Computer Science
   4     ||T||  Department, University of Bologna, Italy.
   5     ||I||
   6     ||T||  HELM is free software; you can redistribute it and/or
   7     ||A||  modify it under the terms of the GNU General Public License
   8     \   /  version 2 or (at your option) any later version.
   9      \ /   This software is distributed as is, NO WARRANTY.
  10       V_______________________________________________________________ *)
  11
  12 (* $Id$ *)
  13
  14 exception LibraryOutOfSync of string Lazy.t
  15 exception IncludedFileNotCompiled of string * string
  16
  17 type timestamp
  18
  19 class status :
  20  object ('self)
  21   method timestamp: timestamp
  22   method set_timestamp: timestamp -> 'self
  23  end
  24
  25 (* it also checks it and add it to the environment *)
  26 val add_obj: #status as 'status -> NCic.obj -> 'status
  27 val add_constraint:
  28   #status as 'status -> NCic.universe -> NCic.universe -> 'status
  29 val aliases_of: NUri.uri -> NReference.reference list
  30 val resolve: string -> NReference.reference list
  31 (* warning: get_obj may raise (NCicEnvironment.ObjectNotFoud l) *)
  32 val get_obj: NUri.uri -> NCic.obj (* changes the current timestamp *)
  33
  34 val clear_cache : unit -> unit
  35
  36 val time_travel: #status -> unit
  37 val decompile: baseuri:NUri.uri -> unit
  38
  39 val init: unit -> unit
  40
  41 type obj
  42
  43 module type SerializerType =
  44  sig
  45   type dumpable_status
  46
  47   type 'a register_type =
  48    'a ->
  49     refresh_uri_in_universe:(NCic.universe -> NCic.universe) ->
  50     refresh_uri_in_term:(NCic.term -> NCic.term) ->
  51      dumpable_status -> dumpable_status
  52
  53   val register: < run: 'a.  string -> 'a register_type -> ('a -> obj) >
  54   val serialize: baseuri:NUri.uri -> obj list -> unit
  55    (* the obj is the "include" command to be added to the dump list *)
  56   val require: baseuri:NUri.uri -> dumpable_status -> dumpable_status * obj
  57  end
  58
  59 module Serializer(D: sig type dumpable_status end) :
  60   SerializerType with type dumpable_status = D.dumpable_status
  61
  62 class dumpable_status :
  63  object ('self)
  64   method dump: obj list
  65   method set_dump: obj list -> 'self
  66  end
  67
  68 (* CSC: only required during old-to-NG phase, to be deleted *)
  69 val refresh_uri: NUri.uri -> NUri.uri
  70
  71 (* EOF *)