ocaml 3.09 transition

[helm.git] / helm / ocaml / cic / cicParser.mli

diff --git a/helm/ocaml/cic/cicParser.mli b/helm/ocaml/cic/cicParser.mli
index 1eb5a043b8a9405aa045ce5adfd8c499cd84f43b..9472b4c54606bd35a67c71c0b9766d73e8dd1fa1 100644 (file)
--- a/helm/ocaml/cic/cicParser.mli
+++ b/helm/ocaml/cic/cicParser.mli
@@ -1,4 +1,4 @@
-(* Copyright (C) 2000, HELM Team.
+(* Copyright (C) 2000-2005, HELM Team.
  * 
  * This file is part of HELM, an Hypertextual, Electronic
  * Library of Mathematics, developed at the Computer Science
@@ -23,23 +23,24 @@
  * http://cs.unibo.it/helm/.
  *)
 
-(******************************************************************************)
-(*                                                                            *)
-(*                               PROJECT HELM                                 *)
-(*                                                                            *)
-(*                Claudio Sacerdoti Coen <sacerdot@cs.unibo.it>               *)
-(*                                 22/03/2000                                 *)
-(*                                                                            *)
-(* This is the main (top level) module of a parser for cic objects from xml   *)
-(* files to the internal representation. It uses the modules cicParser2       *)
-(* (objects level) and cicParser3 (terms level)                               *)
-(*                                                                            *)
-(******************************************************************************)
+  (** raised for exception received by the getter (i.e. embedded in the source
+   * XML document). Arguments are values of "helm:exception" and
+   * "helm:exception_arg" attributes *)
+exception Getter_failure of string * string
 
-(* given the filename of an xml file of a cic object and it's uri, it returns *)
-(* its internal annotated representation.                                     *)
-val annobj_of_xml : string -> UriManager.uri -> Cic.annobj
+  (** generic parser failure *)
+exception Parser_failure of string
+
+  (* given the filename of an xml file of a cic object, it returns
+   * its internal annotated representation. In the case of constants (whose
+   * type is splitted from the body), a second xml file (for the body) must be
+   * provided.
+   * Both files are assumed to be gzipped. *)
+val annobj_of_xml: UriManager.uri -> string -> string option -> Cic.annobj
+
+  (* given the filename of an xml file of a cic object, it returns its internal
+   * logical representation. In the case of constants (whose type is splitted
+   * from the body), a second xml file (for the body) must be provided.
+   * Both files are assumed to be gzipped. *)
+val obj_of_xml : UriManager.uri -> string -> string option -> Cic.obj
 
-(* given the filename of an xml file of a cic object and it's uri, it returns *)
-(* its internal logical representation.                                       *)
-val obj_of_xml : string -> UriManager.uri -> Cic.obj