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 virtual status :
  20  object ('self)
  21   inherit NCic.status
  22   method timestamp: timestamp
  23   method set_timestamp: timestamp -> 'self
  24  end
  25
  26 (* it also checks it and add it to the environment *)
  27 val add_obj: #status as 'status -> NCic.obj -> 'status
  28 val add_constraint:
  29   #status as 'status -> NCic.universe -> NCic.universe -> 'status
  30 val aliases_of: NUri.uri -> NReference.reference list
  31 val resolve: string -> NReference.reference list
  32 (*
  33 (* warning: get_obj may raise (NCicEnvironment.ObjectNotFoud l) *)
  34 val get_obj: #NCic.status -> NUri.uri -> NCic.obj (* changes the current timestamp *)
  35 *)
  36
  37 val time_travel: #status -> unit
  38 val replace: #status -> unit
  39
  40 val init: unit -> unit
  41
  42 type obj
  43 type dump
  44
  45 class type g_dumpable_status =
  46  object
  47   method dump: dump
  48  end
  49
  50 class dumpable_status :
  51  object ('self)
  52   inherit g_dumpable_status
  53   method set_dump: dump -> 'self
  54   method set_dumpable_status: #g_dumpable_status -> 'self
  55  end
  56
  57 val get_transitively_included: #dumpable_status -> NUri.uri list
  58 val dump_obj: #dumpable_status as 'status -> obj -> 'status
  59
  60 module type SerializerType =
  61  sig
  62   type dumpable_status
  63
  64   type 'a register_type =
  65    'a ->
  66     refresh_uri_in_universe:(NCic.universe -> NCic.universe) ->
  67     refresh_uri_in_term:(NCic.status -> NCic.term -> NCic.term) ->
  68     refresh_uri_in_reference:(NReference.reference -> NReference.reference) ->
  69     alias_only:bool ->
  70      dumpable_status -> dumpable_status
  71
  72   val register: < run: 'a.  string -> 'a register_type -> ('a -> obj) >
  73   val serialize: baseuri:NUri.uri -> dumpable_status -> unit
  74   val require: baseuri:
  75    NUri.uri -> fname:string -> alias_only:bool ->
  76     dumpable_status -> dumpable_status
  77   val dependencies_of: baseuri:NUri.uri -> string list
  78  end
  79
  80 module Serializer(D: sig type dumpable_s val get: dumpable_s -> dumpable_status  val set: dumpable_s -> dumpable_status -> dumpable_s end) :
  81   SerializerType with type dumpable_status = D.dumpable_s
  82
  83 val refresh_uri: NUri.uri -> NUri.uri
  84
  85 val ng_path_of_baseuri: ?no_suffix:bool -> NUri.uri -> string
  86 (* EOF *)