helm/ocaml/cic/cicParser2.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 (*                                 24/01/2000                                 *)
  32 (*                                                                            *)
  33 (* This module is the objects level of a parser for cic objects from xml      *)
  34 (* files to the internal representation. It uses the module cicParser3        *)
  35 (* cicParser3 (terms level) and it is used only through cicParser2 (top       *)
  36 (* level).                                                                    *)
  37 (*                                                                            *)
  38 (******************************************************************************)
  39
  40 exception IllFormedXml of int
  41 exception NotImplemented
  42
  43 (* This is the main function and also the only one used directly from *)
  44 (* cicParser. Given the root of the dom tree and, possibly, also the  *)
  45 (* root of the dom tree of the constant body, it returns the internal *)
  46 (* representation of the cic object described in the tree(s).         *)
  47 (* It uses the previous functions and the to_cic_term method defined  *)
  48 (* in cicParser3 (used for subtrees that encode cic terms)            *)
  49 val get_term :
  50   CicParser3.cic_term Pxp_document.node ->
  51   CicParser3.cic_term Pxp_document.node option ->
  52   Cic.annobj