helm/ocaml/grafite/grafiteMarshal.ml

   1 (* Copyright (C) 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 Checksum_failure of string
  27 exception Corrupt_moo of string
  28 exception Version_mismatch of string
  29
  30 type ast_command = (CicNotationPt.term, CicNotationPt.obj) GrafiteAst.command
  31 type moo = ast_command list * GrafiteAst.metadata list  (** <moo, metadata> *)
  32
  33 let marshal_flags = []
  34
  35 (** .moo file format
  36  * - an integer -- magic number -- denoting the version of the dumped data
  37  *   structure. Different magic numbers stand for incompatible data structures
  38  * - an integer -- checksum -- denoting the hash value (computed with
  39  *   Hashtbl.hash) of the string representation of the dumped data structur
  40  * - marshalled pair: first component is a list of GrafiteAst.command (real moo
  41  *   content), second component is a list of GrafiteAst.metadata
  42  *)
  43
  44 let save_moo ~fname (moo, metadata) =
  45  let oc = open_out fname in
  46  let marshalled =
  47    Marshal.to_string (List.rev moo, List.rev metadata) marshal_flags
  48  in
  49  let checksum = Hashtbl.hash marshalled in
  50  output_binary_int oc GrafiteAst.magic;
  51  output_binary_int oc checksum;
  52  output_string oc marshalled;
  53  close_out oc
  54
  55 let load_moo ~fname =
  56   let ic = open_in fname in
  57   HExtlib.finally
  58     (fun () -> close_in ic)
  59     (fun () ->
  60       try
  61         let moo_magic = input_binary_int ic in
  62         if moo_magic <> GrafiteAst.magic then raise (Version_mismatch fname);
  63         let moo_checksum = input_binary_int ic in
  64         let marshalled = HExtlib.input_all ic in
  65         let checksum = Hashtbl.hash marshalled in
  66         if checksum <> moo_checksum then raise (Checksum_failure fname);
  67         let (moo:moo) =
  68           Marshal.from_string marshalled 0
  69         in
  70         moo
  71       with End_of_file -> raise (Corrupt_moo fname))
  72     ()
  73