]> matita.cs.unibo.it Git - helm.git/blob - helm/software/components/extlib/hMarshal.mli
handles bad Appl
[helm.git] / helm / software / components / extlib / hMarshal.mli
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 (** {2 Marshalling with version/consistency checks} *)
27
28 (** {3 File formats}
29  *
30  * Files saved/loaded by this module share a common format:
31  *
32  * | n | Field name  | Field type | Description                           |
33  * +---+-------------+------------+---------------------------------------+
34  * | 1 | format      | integer    | hash value of the 'fmt' parameter     |
35  * | 2 | version     | integer    | 'version' parameter                   |
36  * | 3 | format dsc  | string     | extended 'fmt' parameter              |
37  * | 4 | version dsc | string     | extended 'version' parameter          |
38  * | 5 | checksum    | integer    | hash value of the _field_ below       |
39  * | 6 | data        | raw        | ocaml marshalling of 'data' parameter |
40  *
41  *)
42
43 exception Corrupt_file of string (** checksum mismatch, or file too short *)
44 exception Format_mismatch of string
45 exception Version_mismatch of string
46
47   (** Marhsal some data according to the file format above.
48    * @param fmt format name
49    * @param version version number
50    * @param fname file name to which marshal data
51    * @param data data to be marshalled on disk *)
52 val save: fmt:string -> version:int -> fname:string -> 'a -> unit
53
54   (** parameters as above
55    * @raise Corrupt_file
56    * @raise Format_mismatch
57    * @raise Version_mismatch *)
58 val load: fmt:string -> version:int -> fname:string -> 'a
59