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