Add support for binary representations

xsde/cxx/hybrid/insertion-*: insertion operators generator
xsde/cxx/hybrid/extraction-*: extraction operators generator
libxsde/xsde/cxx/hybrid/cdr/: CDR support code
libxsde/xsde/cxx/hybrid/xdr/: XDR support code
tests/cxx/hybrid/binary/: new tests
examples/cxx/hybrid/binary/: new examples
documentation/cxx/hybrid/guide/: new chapter

5 files changed, 480 insertions, 0 deletions

diff --git a/examples/cxx/hybrid/binary/xdr/README b/examples/cxx/hybrid/binary/xdr/README
new file mode 100644
index 0000000..e81a149
--- /dev/null
+++ b/examples/cxx/hybrid/binary/xdr/README
@@ -0,0 +1,50 @@
+This example shows how to save/load the C++/Hybrid object model to/from
+XDR (eXternal Data Representation) binary format using XDR streams. The
+XDR API is available out of the box on most POSIX systems as part of Sun
+RPC. On other platforms you may need to install a third-party library
+which provides the XDR API.
+
+The example consists of the following files:
+
+library.xsd
+  XML Schema which describes a library of books.
+
+library.xml
+  Sample XML instance document.
+
+library.hxx
+library.cxx
+
+library-pskel.hxx
+library-pskel.cxx
+library-pimpl.hxx
+library-pimpl.cxx
+
+library-pskel.hxx
+library-pskel.cxx
+library-pimpl.hxx
+library-pimpl.cxx
+  Object model (the first pair of files), parser skeletons (the
+  second pair), parser implementations (the third pair), serializer
+  skeletons (the fourth pair), and serializer implementations (the
+  fifth pair). These files are generated by the XSD/e compiler from
+  library.xsd. The --generate-parser, --generate-serializer, and 
+  --generate-aggregate options were used to request the generation
+  of the parsing and serialization code. The --generate-insertion and
+  --generate-extraction options were used to generate the insertion
+  and extraction operations for the XDR streams.
+
+driver.cxx
+  Driver for the example. It first calls the parser that constructs
+  the object model from the input XML file. It then saves the object
+  model to the XDR representation and loads it back. Finally, the
+  driver calls the serializer to serialize the loaded object model
+  back to XML.
+
+To run the example on the sample XML instance document simply execute:
+
+$ ./driver library.xml
+
+The example reads from STDIN if input file is not specified:
+
+$ ./driver <library.xml
diff --git a/examples/cxx/hybrid/binary/xdr/driver.cxx b/examples/cxx/hybrid/binary/xdr/driver.cxx
new file mode 100644
index 0000000..e629849
--- /dev/null
+++ b/examples/cxx/hybrid/binary/xdr/driver.cxx
@@ -0,0 +1,196 @@
+// file      : examples/cxx/hybrid/binary/xdr/driver.cxx
+// author    : Boris Kolpackov <boris@codesynthesis.com>
+// copyright : not copyrighted - public domain
+
+#include <stddef.h>  // size_t
+#include <string.h>  // memcpy
+#include <rpc/xdr.h>
+
+#include <memory>    // std::auto_ptr
+#include <iostream>
+
+#include "library.hxx"
+
+#include "library-pimpl.hxx"
+#include "library-simpl.hxx"
+
+using std::cerr;
+using std::endl;
+
+// XDR output functions. Their implementations are provided after main().
+//
+struct underflow_info
+{
+  xml_schema::buffer* buf;
+  size_t pos;
+};
+
+extern "C" int
+overflow (void* user_data, char* buf, int n);
+
+extern "C" int
+underflow (void* user_data, char* buf, int n);
+
+// The xdrrec_create function (used below) has slightly different
+// prototypes on different platforms. To make this example portable
+// we will need to cast the actual function to the following common
+// prototype.
+//
+extern "C"
+typedef  void (*xdrrec_create_p) (
+  XDR*,
+  unsigned int write_size,
+  unsigned int read_size,
+  void* user_data,
+  int (*read) (void* user_data, char* buf, int n),
+  int (*write) (void* user_data, char* buf, int n));
+
+int
+main (int argc, char* argv[])
+{
+  const char* input;
+
+  if (argc < 2)
+  {
+    input = "STDIN";
+    cerr << "XML file not specified, reading from STDIN" << endl;
+  }
+  else
+    input = argv[1];
+
+  try
+  {
+    using namespace library;
+
+    // Parse.
+    //
+    catalog_paggr catalog_p;
+
+    xml_schema::document_pimpl doc_p (
+      catalog_p.root_parser (),
+      catalog_p.root_namespace (),
+      catalog_p.root_name ());
+
+    catalog_p.pre ();
+
+    if (argc < 2)
+      doc_p.parse (std::cin);
+    else
+      doc_p.parse (argv[1]);
+
+    std::auto_ptr<catalog> c (catalog_p.post ());
+
+    // Save the object model to an XDR stream.
+    //
+    xdrrec_create_p xdrrec_create_ =
+      reinterpret_cast<xdrrec_create_p> (::xdrrec_create);
+
+    XDR xdr;
+    xml_schema::buffer buf;
+
+    xdrrec_create_ (&xdr, 0, 0, reinterpret_cast<char*> (&buf), 0, &overflow);
+    xdr.x_op = XDR_ENCODE;
+    xml_schema::oxdrstream oxdr (xdr);
+
+    oxdr << *c;
+
+    xdrrec_endofrecord (&xdr, true); // Flush the data.
+    xdr_destroy (&xdr);
+
+    // The binary representation is now in the memory buffer 'buf'.
+    // To get to the raw data use buf.data() and buf.size().
+    //
+    cerr << "binary representation size: " << buf.size () << endl
+         << endl;
+
+    // Load the object model from an XDR stream.
+    //
+    underflow_info ui;
+    ui.buf = &buf;
+    ui.pos = 0;
+
+    xdrrec_create_ (&xdr, 0, 0, reinterpret_cast<char*> (&ui), &underflow, 0);
+    xdr.x_op = XDR_DECODE;
+    xdrrec_skiprecord (&xdr);
+    xml_schema::ixdrstream ixdr (xdr);
+
+    std::auto_ptr<catalog> copy (new catalog);
+    ixdr >> *copy;
+
+    xdr_destroy (&xdr);
+
+    // Serialize the copy back to XML.
+    //
+    catalog_saggr catalog_s;
+
+    xml_schema::document_simpl doc_s (
+      catalog_s.root_serializer (),
+      catalog_s.root_namespace (),
+      catalog_s.root_name ());
+
+    doc_s.add_prefix ("lib", "http://www.codesynthesis.com/library");
+    doc_s.add_schema ("http://www.codesynthesis.com/library", "library.xsd");
+
+    catalog_s.pre (*c);
+    doc_s.serialize (std::cout);
+    catalog_s.post ();
+  }
+  catch (const xml_schema::xdr_exception&)
+  {
+    cerr << "XDR operation failed" << endl;
+    return 1;
+  }
+  catch (const xml_schema::parser_exception& e)
+  {
+    cerr << input << ":" << e.line () << ":" << e.column () << ": "
+         << e.text () << endl;
+    return 1;
+  }
+  catch (const xml_schema::serializer_exception& e)
+  {
+    cerr << "error: " << e.text () << endl;
+    return 1;
+  }
+  catch (const std::ios_base::failure&)
+  {
+    cerr << input << ": unable to open or read/write failure" << endl;
+    return 1;
+  }
+
+  return 0;
+}
+
+extern "C" int
+overflow (void* p, char* buf, int n_)
+{
+  xml_schema::buffer* dst (reinterpret_cast<xml_schema::buffer*> (p));
+  size_t n (static_cast<size_t> (n_));
+
+  size_t size (dst->size ());
+  size_t capacity (dst->capacity ());
+
+  // Implement exponential growth.
+  //
+  if (size + n > capacity && size + n < capacity * 2)
+    dst->capacity (capacity * 2);
+
+  dst->size (size + n);
+  memcpy (dst->data () + size, buf, n);
+
+  return n;
+}
+
+extern "C" int
+underflow (void* p, char* buf, int n_)
+{
+  underflow_info* ui (reinterpret_cast<underflow_info*> (p));
+  size_t n (static_cast<size_t> (n_));
+
+  size_t size (ui->buf->size () - ui->pos);
+  n = size > n ? n : size;
+
+  memcpy (buf, ui->buf->data () + ui->pos, n);
+  ui->pos += n;
+
+  return n;
+}
diff --git a/examples/cxx/hybrid/binary/xdr/library.xml b/examples/cxx/hybrid/binary/xdr/library.xml
new file mode 100644
index 0000000..ee5f771
--- /dev/null
+++ b/examples/cxx/hybrid/binary/xdr/library.xml
@@ -0,0 +1,53 @@
+<?xml version="1.0"?>
+
+<!--
+
+file      : examples/cxx/hybrid/binary/xdr/library.xml
+author    : Boris Kolpackov <boris@codesynthesis.com>
+copyright : not copyrighted - public domain
+
+-->
+
+<lib:catalog xmlns:lib="http://www.codesynthesis.com/library"
+             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	     xsi:schemaLocation="http://www.codesynthesis.com/library library.xsd">
+
+  <book available="false">
+    <isbn>0679760806</isbn>
+    <title>The Master and Margarita</title>
+    <genre>fiction</genre>
+
+    <author>
+      <name>Mikhail Bulgakov</name>
+      <born>1891-05-15</born>
+      <died>1940-03-10</died>
+    </author>
+  </book>
+
+
+  <book available="true" >
+    <isbn>0679600841</isbn>
+    <title>War and Peace</title>
+    <genre>history</genre>
+
+    <author>
+      <name>Leo Tolstoy</name>
+      <born>1828-09-09</born>
+      <died>1910-11-20</died>
+    </author>
+  </book>
+
+
+  <book available="false">
+    <isbn>0679420290</isbn>
+    <title>Crime and Punishment</title>
+    <genre>philosophy</genre>
+
+    <author>
+      <name>Fyodor Dostoevsky</name>
+      <born>1821-11-11</born>
+      <died>1881-02-09</died>
+    </author>
+  </book>
+
+</lib:catalog>
diff --git a/examples/cxx/hybrid/binary/xdr/library.xsd b/examples/cxx/hybrid/binary/xdr/library.xsd
new file mode 100644
index 0000000..5e411d9
--- /dev/null
+++ b/examples/cxx/hybrid/binary/xdr/library.xsd
@@ -0,0 +1,69 @@
+<?xml version="1.0"?>
+
+<!--
+
+file      : examples/cxx/hybrid/binary/xdr/library.xsd
+author    : Boris Kolpackov <boris@codesynthesis.com>
+copyright : not copyrighted - public domain
+
+-->
+
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+            xmlns:lib="http://www.codesynthesis.com/library"
+            targetNamespace="http://www.codesynthesis.com/library">
+
+  <xsd:simpleType name="isbn">
+    <xsd:restriction base="xsd:unsignedInt"/>
+  </xsd:simpleType>
+
+
+  <xsd:complexType name="title">
+    <xsd:simpleContent>
+      <xsd:extension base="xsd:string">
+        <xsd:attribute name="lang" type="xsd:string"/>
+      </xsd:extension>
+    </xsd:simpleContent>
+  </xsd:complexType>
+
+
+  <xsd:simpleType name="genre">
+    <xsd:restriction base="xsd:string">
+      <xsd:enumeration value="romance"/>
+      <xsd:enumeration value="fiction"/>
+      <xsd:enumeration value="horror"/>
+      <xsd:enumeration value="history"/>
+      <xsd:enumeration value="philosophy"/>
+    </xsd:restriction>
+  </xsd:simpleType>
+
+
+  <xsd:complexType name="author">
+    <xsd:sequence>
+      <xsd:element name="name" type="xsd:string"/>
+      <xsd:element name="born" type="xsd:date"/>
+      <xsd:element name="died" type="xsd:date" minOccurs="0"/>
+    </xsd:sequence>
+  </xsd:complexType>
+
+
+  <xsd:complexType name="book">
+    <xsd:sequence>
+      <xsd:element name="isbn" type="lib:isbn"/>
+      <xsd:element name="title" type="lib:title"/>
+      <xsd:element name="genre" type="lib:genre"/>
+      <xsd:element name="author" type="lib:author" maxOccurs="unbounded"/>
+    </xsd:sequence>
+    <xsd:attribute name="available" type="xsd:boolean" use="required"/>
+  </xsd:complexType>
+
+
+  <xsd:complexType name="catalog">
+    <xsd:sequence>
+      <xsd:element name="book" type="lib:book" maxOccurs="unbounded"/>
+    </xsd:sequence>
+  </xsd:complexType>
+
+
+  <xsd:element name="catalog" type="lib:catalog"/>
+
+</xsd:schema>
diff --git a/examples/cxx/hybrid/binary/xdr/makefile b/examples/cxx/hybrid/binary/xdr/makefile
new file mode 100644
index 0000000..0cff972
--- /dev/null
+++ b/examples/cxx/hybrid/binary/xdr/makefile
@@ -0,0 +1,112 @@
+# file      : examples/cxx/hybrid/binary/xdr/makefile
+# author    : Boris Kolpackov <boris@codesynthesis.com>
+# copyright : Copyright (c) 2005-2009 Code Synthesis Tools CC
+# license   : GNU GPL v2 + exceptions; see accompanying LICENSE file
+
+include $(dir $(lastword $(MAKEFILE_LIST)))../../../../../build/bootstrap.make
+
+xsd := library.xsd
+cxx := driver.cxx
+
+obj := $(addprefix $(out_base)/,\
+$(cxx:.cxx=.o)       \
+$(xsd:.xsd=.o)       \
+$(xsd:.xsd=-pskel.o) \
+$(xsd:.xsd=-pimpl.o) \
+$(xsd:.xsd=-sskel.o) \
+$(xsd:.xsd=-simpl.o))
+
+dep := $(obj:.o=.o.d)
+
+xsde.l             := $(out_root)/libxsde/xsde/xsde.l
+xsde.l.cpp-options := $(out_root)/libxsde/xsde/xsde.l.cpp-options
+
+driver   := $(out_base)/driver
+dist     := $(out_base)/.dist
+dist-win := $(out_base)/.dist-win
+clean    := $(out_base)/.clean
+
+# Build.
+#
+$(driver): $(obj) $(xsde.l)
+
+$(obj) $(dep): $(xsde.l.cpp-options)
+
+genf := $(xsd:.xsd=.hxx) $(xsd:.xsd=.cxx) \
+        $(xsd:.xsd=-pskel.hxx) $(xsd:.xsd=-pskel.cxx) \
+        $(xsd:.xsd=-pimpl.hxx) $(xsd:.xsd=-pimpl.cxx) \
+        $(xsd:.xsd=-sskel.hxx) $(xsd:.xsd=-sskel.cxx) \
+        $(xsd:.xsd=-simpl.hxx) $(xsd:.xsd=-simpl.cxx)
+
+gen := $(addprefix $(out_base)/,$(genf))
+
+$(gen): $(out_root)/xsde/xsde
+$(gen): xsde := $(out_root)/xsde/xsde
+$(gen): xsde_options += --generate-parser --generate-serializer \
+--generate-aggregate --generate-insertion XDR --generate-extraction XDR
+
+$(call include-dep,$(dep))
+
+# Convenience alias for default target.
+#
+.PHONY: $(out_base)/
+$(out_base)/: $(driver)
+
+
+# Dist.
+#
+dist-common := $(out_base)/.dist-common
+
+.PHONY: $(dist) $(dist-win) $(dist-common)
+
+$(dist) $(dist-win) $(dist-common): path := $(subst $(src_root)/,,$(src_base))
+
+$(dist-common):
+	$(call install-data,$(src_base)/driver.cxx,$(dist_prefix)/$(path)/driver.cxx)
+	$(call install-data,$(src_base)/library.xsd,$(dist_prefix)/$(path)/library.xsd)
+	$(call install-data,$(src_base)/library.xml,$(dist_prefix)/$(path)/library.xml)
+
+$(dist): $(dist-common)
+	$(call install-data,$(src_base)/README,$(dist_prefix)/$(path)/README)
+
+$(dist-win): $(dist-common)
+	$(call install-data,$(src_base)/README,$(dist_prefix)/$(path)/README.txt)
+	$(call message,,unix2dos $(dist_prefix)/$(path)/README.txt)
+
+
+# Clean.
+#
+.PHONY: $(clean)
+
+$(clean): $(driver).o.clean                                \
+  $(addsuffix .cxx.clean,$(obj))                           \
+  $(addsuffix .cxx.clean,$(dep))                           \
+  $(addprefix $(out_base)/,$(xsd:.xsd=.cxx.xsd.clean))
+
+
+# Generated .gitignore.
+#
+ifeq ($(out_base),$(src_base))
+$(gen): | $(out_base)/.gitignore
+$(driver): | $(out_base)/.gitignore
+
+$(out_base)/.gitignore: files := driver $(genf)
+$(clean): $(out_base)/.gitignore.clean
+
+$(call include,$(bld_root)/git/gitignore.make)
+endif
+
+
+# How to.
+#
+$(call include,$(bld_root)/cxx/o-e.make)
+$(call include,$(bld_root)/cxx/cxx-o.make)
+$(call include,$(bld_root)/cxx/cxx-d.make)
+$(call include,$(bld_root)/install.make)
+$(call include,$(scf_root)/xsde/hybrid/xsd-cxx.make)
+
+
+# Dependencies.
+#
+$(call import,$(src_root)/xsde/makefile)
+$(call import,$(src_root)/libxsde/xsde/makefile)