components/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 (prefix, element_name,                                      *)
  43 (*   [prefix1, attrname1, value1 ; ... ; prefixn, attrnamen, valuen]  *)
  44 (*  NEmpty (prefix, element_name,                                     *)
  45 (*   [prefix1, attrname1, value1 ; ... ; prefixn, attrnamen, valuen], *)
  46 (*    content                                                         *)
  47 type token =
  48    Str of string
  49  | Empty of string option * string * (string option * string * string) list
  50  | NEmpty of string option * string * (string option * string * string) list *
  51     token Stream.t
  52 ;;
  53
  54 (* currified versions of the token constructors make the code more readable *)
  55 val xml_empty :
  56  ?prefix:string -> string -> (string option * string * string) list ->
  57    token Stream.t
  58 val xml_nempty :
  59  ?prefix:string -> string -> (string option * string * string) list ->
  60    token Stream.t -> token Stream.t
  61 val xml_cdata : string -> token Stream.t
  62
  63 (* The pretty printer for streams of token                                  *)
  64 (* Usage:                                                                   *)
  65 (*  pp tokens None     pretty prints the output on stdout                   *)
  66 (*  pp tokens (Some filename) pretty prints the output on the file filename
  67 * @param gzip if set to true files are gzipped. Defaults to false *)
  68 val pp : ?gzip:bool -> token Stream.t -> string option -> unit
  69 val pp_to_outchan : token Stream.t -> out_channel -> unit
  70 val pp_to_string : token Stream.t -> string
  71
  72 val add_xml_declaration: token Stream.t -> token Stream.t
  73
  74 val strip_xml_headings: string -> string
  75