helm/ocaml/cic/cicParser.mli

   1 (* Copyright (C) 2000, 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://cs.unibo.it/helm/.
  24  *)
  25
  26 (******************************************************************************)
  27 (*                                                                            *)
  28 (*                               PROJECT HELM                                 *)
  29 (*                                                                            *)
  30 (*                Claudio Sacerdoti Coen <sacerdot@cs.unibo.it>               *)
  31 (*                                 22/03/2000                                 *)
  32 (*                                                                            *)
  33 (* This is the main (top level) module of a parser for cic objects from xml   *)
  34 (* files to the internal representation. It uses the modules cicParser2       *)
  35 (* (objects level) and cicParser3 (terms level)                               *)
  36 (*                                                                            *)
  37 (******************************************************************************)
  38
  39   (** raised for exception received by the getter (i.e. embedded in the source
  40   * XML document). Arguments are values of "helm:exception" and
  41   * "helm:exception_arg" attributes *)
  42 exception Getter_failure of string * string
  43
  44   (** generic parser failure *)
  45 exception Parser_failure of string
  46
  47 (* given the filename of an xml file of a cic object, it returns              *)
  48 (* its internal annotated representation. In the case of constants (whose     *)
  49 (* type is splitted from the body), a second xml file (for the body) must be  *)
  50 (* provided.                                                                  *)
  51 val annobj_of_xml : string -> string option -> Cic.annobj
  52
  53 (* given the filename of an xml file of a cic object, it returns              *)
  54 (* its internal logical representation. In the case of constants (whose       *)
  55 (* type is splitted from the body), a second xml file (for the body) must be  *)
  56 (* provided.                                                                  *)
  57 val obj_of_xml : string -> string option -> Cic.obj