helm/ocaml/xml/xml.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 (*                     A tactic to print Coq objects in XML                   *)
  31 (*                                                                            *)
  32 (*                Claudio Sacerdoti Coen <sacerdot@cs.unibo.it>               *)
  33 (*                                 18/10/2000                                 *)
  34 (*                                                                            *)
  35 (* This module defines a pretty-printer and the stream of commands to the pp  *)
  36 (*                                                                            *)
  37 (******************************************************************************)
  38
  39 (* Tokens for XML cdata, empty elements and not-empty elements           *)
  40 (* Usage:                                                                *)
  41 (*  Str cdata                                                            *)
  42 (*  Empty (element_name, [attrname1, value1 ; ... ; attrnamen, valuen]   *)
  43 (*  NEmpty (element_name, [attrname1, value2 ; ... ; attrnamen, valuen], *)
  44 (*          content                                                      *)
  45 type token =
  46   | Str of string
  47   | Empty of string * (string * string) list
  48   | NEmpty of string * (string * string) list * token Stream.t
  49
  50 (* currified versions of the token constructors make the code more readable *)
  51 val xml_empty : string -> (string * string) list -> token Stream.t
  52 val xml_nempty :
  53   string -> (string * string) list -> token Stream.t -> token Stream.t
  54 val xml_cdata : string -> token Stream.t
  55
  56 (* The pretty printer for streams of token                                  *)
  57 (* Usage:                                                                   *)
  58 (*  pp tokens None     pretty prints the output on stdout                   *)
  59 (*  pp tokens (Some filename) pretty prints the output on the file filename *)
  60 val pp : ?quiet:bool -> token Stream.t -> string option -> unit