helm/DEVEL/pxp/pxp/pxp_codewriter.mli

   1 (* $Id$
   2  * ----------------------------------------------------------------------
   3  * PXP: The polymorphic XML parser for Objective Caml.
   4  * Copyright by Gerd Stolpmann. See LICENSE for details.
   5  *)
   6
   7 open Pxp_document
   8 open Pxp_yacc
   9 open Pxp_dtd
  10
  11 val write_document : out_channel -> 'ext document -> unit
  12     (* Writes O'Caml code to the out_channel that is a top-level function
  13      * creating a fresh document which is equal to the passed document:
  14      *
  15      * "let create_document warner spec = ...;;"
  16      *
  17      * If you compile the code and call "create_document warner map"  the
  18      * function creates a document tree which is (almost) equal to the
  19      * passed document.
  20      *
  21      * The following properties may not be equal:
  22      * - Parsed entities
  23      * - Whether a declaration occurs in an external entity or not
  24      *
  25      * 'warner': a collect_warnings object
  26      * 'spec': a Pxp_document.spec
  27      *)
  28
  29
  30 val write_dtd : out_channel -> dtd -> unit
  31     (* Writes O'Caml code to the out_channel that is a top-level function
  32      * creating a fresh DTD which is equal to the passed DTD:
  33      *
  34      * "let create_dtd warner = ...;;"
  35      *
  36      * If you compile the code and call "create_dtd warner"  the
  37      * function creates a DTD object which is (almost) equal to the
  38      * passed object.
  39      *
  40      * The following properties may not be equal:
  41      * - Parsed entities
  42      * - Whether a declaration occurs in an external entity or not
  43      *
  44      * 'warner': a collect_warnings object
  45      *)
  46
  47 val write_subtree : out_channel -> 'ext node -> unit
  48     (* Writes O'Caml code to the out_channel that is a top-level function
  49      * creating a fresh node tree which is equal to the passed tree:
  50      *
  51      * "let create_subtree dtd map = ...;;"
  52      *
  53      * If you compile the code and call "create_subtree dtd map"  the
  54      * function creates a DTD object which is equal to the passed object.
  55      *
  56      * 'dtd': a DTD object
  57      * 'map': a domspec
  58      *)
  59
  60
  61
  62
  63 (* ======================================================================
  64  * History:
  65  *
  66  * $Log$
  67  * Revision 1.1  2000/11/17 09:57:29  lpadovan
  68  * Initial revision
  69  *
  70  * Revision 1.2  2000/07/09 00:30:14  gerd
  71  *      Updated.
  72  *
  73  * Revision 1.1  2000/05/29 23:48:38  gerd
  74  *      Changed module names:
  75  *              Markup_aux          into Pxp_aux
  76  *              Markup_codewriter   into Pxp_codewriter
  77  *              Markup_document     into Pxp_document
  78  *              Markup_dtd          into Pxp_dtd
  79  *              Markup_entity       into Pxp_entity
  80  *              Markup_lexer_types  into Pxp_lexer_types
  81  *              Markup_reader       into Pxp_reader
  82  *              Markup_types        into Pxp_types
  83  *              Markup_yacc         into Pxp_yacc
  84  * See directory "compatibility" for (almost) compatible wrappers emulating
  85  * Markup_document, Markup_dtd, Markup_reader, Markup_types, and Markup_yacc.
  86  *
  87  * ======================================================================
  88  * Old logs from markup_codewriter.mli:
  89  *
  90  * Revision 1.1  2000/03/11 22:57:28  gerd
  91  *      Initial revision.
  92  *
  93  *
  94  *)