Add support for ordered types, mixed content

5 files changed, 374 insertions, 0 deletions

diff --git a/examples/cxx/tree/order/element/README b/examples/cxx/tree/order/element/README
new file mode 100644
index 0000000..19f2381
--- /dev/null
+++ b/examples/cxx/tree/order/element/README
@@ -0,0 +1,35 @@
+This example shows how to use ordered types to capture and maintain
+element order, including element wildcards.
+
+The example consists of the following files:
+
+transactions.xsd
+  XML Schema which describes various bank transactions. A batch of
+  transactions can contain any number of different transactions in
+  any order but the order of transaction in the batch is significant.
+
+library.xml
+  Sample XML instance document.
+
+transactions.hxx
+transactions.cxx
+  C++ types that represent the given vocabulary as well as a set of
+  parsing and serialization functions. These are generated by XSD
+  from transactions.xsd. Note that the --ordered-type option is
+  used to indicate to the XSD compiler that the batch type is
+  ordered. We also use the --generate-wildcard option to enable
+  wildcard support. An element wildcard is used in the batch to
+  allow transaction extensions.
+
+driver.cxx
+  Driver for the example. It first calls one of the parsing functions
+  that constructs the object model from the input XML file. It then
+  iterates over transactions in the batch using the content order
+  sequence. The driver then performs various modifications of the
+  object model while showing how to maintain the content order.
+  Finally, it saves the modified transaction batch back to XML to
+  verify that the content order is preserved in the output document.
+
+To run the example on the sample XML instance document simply execute:
+
+$ ./driver transactions.xml
diff --git a/examples/cxx/tree/order/element/driver.cxx b/examples/cxx/tree/order/element/driver.cxx
new file mode 100644
index 0000000..0ea6d6f
--- /dev/null
+++ b/examples/cxx/tree/order/element/driver.cxx
@@ -0,0 +1,147 @@
+// file      : examples/cxx/tree/order/element/driver.cxx
+// copyright : not copyrighted - public domain
+
+#include <memory>   // std::auto_ptr
+#include <cassert>
+#include <iostream>
+
+#include <xercesc/dom/DOM.hpp>
+#include <xercesc/util/PlatformUtils.hpp>
+
+#include "transactions.hxx"
+
+// The following string class keeps us sane when working with Xerces.
+// Include it after the generated header in order to get only char or
+// wchar_t version depending on how you compiled your schemas.
+//
+#include <xsd/cxx/xml/string.hxx>
+
+using std::cerr;
+using std::endl;
+
+int
+main (int argc, char* argv[])
+{
+  if (argc != 2)
+  {
+    cerr << "usage: " << argv[0] << " transactions.xml" << endl;
+    return 1;
+  }
+
+  using namespace xercesc;
+
+  int r (0);
+
+  // The Xerces-C++ DOM objects that will be used to store the
+  // content matched by the wildcard "out-lives" the call to the
+  // parsing function. Therefore we need to initialize the
+  // Xerces-C++ runtime ourselves.
+  //
+  XMLPlatformUtils::Initialize ();
+
+  try
+  {
+    using namespace transactions;
+
+    // Parse the batch.
+    //
+    std::auto_ptr<batch> b (
+      batch_ (argv[1], xml_schema::flags::dont_initialize));
+
+    // Print what we've got in content order.
+    //
+    for (batch::content_order_const_iterator i (b->content_order ().begin ());
+         i != b->content_order ().end ();
+         ++i)
+    {
+      switch (i->id)
+      {
+      case batch::balance_id:
+        {
+          const balance& t (b->balance ()[i->index]);
+          cerr << t.account () << " balance" << endl;
+          break;
+        }
+      case batch::withdraw_id:
+        {
+          const withdraw& t (b->withdraw ()[i->index]);
+          cerr << t.account () << " withdraw " << t.amount () << endl;
+          break;
+        }
+      case batch::deposit_id:
+        {
+          const deposit& t (b->deposit ()[i->index]);
+          cerr << t.account () << " deposit " << t.amount () << endl;
+          break;
+        }
+      case batch::any_id:
+        {
+          namespace xml = xsd::cxx::xml;
+
+          const DOMElement& e (b->any ()[i->index]);
+          cerr << xml::transcode<char> (e.getLocalName ()) << endl;
+          break;
+        }
+      default:
+        {
+          assert (false); // Unknown content id.
+        }
+      }
+    }
+
+    cerr << endl;
+
+    // Modify the transaction batch. First remove the last transaction.
+    // Note that we have to update both the content itself and content
+    // order sequences.
+    //
+    batch::content_order_sequence& co (b->content_order ());
+
+    co.pop_back ();
+    b->withdraw ().pop_back ();
+
+    // Now add a few more transactions. Again we have to add both the
+    // content and its ordering. The order information consists of the
+    // content id and, in case of a sequence, the index.
+    //
+    b->deposit ().push_back (deposit (123456789, 100000));
+    co.push_back (
+      batch::content_order_type (
+        batch::deposit_id, b->deposit ().size () - 1));
+
+    // The next transaction we add at the beginning of the batch.
+    //
+    b->balance ().push_back (balance (123456789));
+    co.insert (co.begin (),
+               batch::content_order_type (
+                 batch::balance_id, b->balance ().size () - 1));
+
+    // Note also that when we merely modify the content of one
+    // of the elements in place, we don't need to update its
+    // order. For example:
+    //
+    b->deposit ()[0].amount (2000000);
+
+    // Serialize the modified transaction batch back to XML.
+    //
+    xml_schema::namespace_infomap map;
+
+    map[""].name = "http://www.codesynthesis.com/transactions";
+    map[""].schema = "transactions.xsd";
+    map["te"].name = "http://www.codesynthesis.com/transactions-extras";
+
+    batch_ (std::cout,
+            *b,
+            map,
+            "UTF-8",
+            xml_schema::flags::dont_initialize);
+  }
+  catch (const xml_schema::exception& e)
+  {
+    cerr << e << endl;
+    r = 1;
+  }
+
+  XMLPlatformUtils::Terminate ();
+  return r;
+}
diff --git a/examples/cxx/tree/order/element/makefile b/examples/cxx/tree/order/element/makefile
new file mode 100644
index 0000000..49478fc
--- /dev/null
+++ b/examples/cxx/tree/order/element/makefile
@@ -0,0 +1,100 @@
+# file      : examples/cxx/tree/order/element/makefile
+# copyright : Copyright (c) 2005-2014 Code Synthesis Tools CC
+# license   : GNU GPL v2 + exceptions; see accompanying LICENSE file
+
+include $(dir $(lastword $(MAKEFILE_LIST)))../../../../../build/bootstrap.make
+
+xsd := transactions.xsd
+cxx := driver.cxx
+
+obj := $(addprefix $(out_base)/,$(cxx:.cxx=.o) $(xsd:.xsd=.o))
+dep := $(obj:.o=.o.d)
+
+driver   := $(out_base)/driver
+install  := $(out_base)/.install
+dist     := $(out_base)/.dist
+dist-win := $(out_base)/.dist-win
+clean    := $(out_base)/.clean
+
+# Import.
+#
+$(call import,\
+  $(scf_root)/import/libxerces-c/stub.make,\
+  l: xerces_c.l,cpp-options: xerces_c.l.cpp-options)
+
+# Build.
+#
+$(driver): $(obj) $(xerces_c.l) -lnsl
+
+$(obj) $(dep): cpp_options := -I$(out_base) -I$(src_base) -I$(src_root)/libxsd
+$(obj) $(dep): $(xerces_c.l.cpp-options)
+
+genf := $(xsd:.xsd=.hxx) $(xsd:.xsd=.ixx) $(xsd:.xsd=.cxx)
+gen  := $(addprefix $(out_base)/,$(genf))
+
+$(gen): xsd := $(out_root)/xsd/xsd
+$(gen): xsd_options += --generate-serialization --generate-wildcard \
+--ordered-type batch
+$(gen): $(out_root)/xsd/xsd
+
+$(call include-dep,$(dep),$(obj),$(gen))
+
+# Convenience alias for default target.
+#
+$(out_base)/: $(driver)
+
+
+# Install & Dist.
+#
+dist-common := $(out_base)/.dist-common
+
+$(install) $(dist) $(dist-win) $(dist-common): path := $(subst $(src_root)/,,$(src_base))
+
+$(install):
+	$(call install-data,$(src_base)/README,$(install_doc_dir)/xsd/$(path)/README)
+	$(call install-data,$(src_base)/driver.cxx,$(install_doc_dir)/xsd/$(path)/driver.cxx)
+	$(call install-data,$(src_base)/transactions.xsd,$(install_doc_dir)/xsd/$(path)/transactions.xsd)
+	$(call install-data,$(src_base)/transactions.xml,$(install_doc_dir)/xsd/$(path)/transactions.xml)
+
+$(dist-common):
+	$(call install-data,$(src_base)/driver.cxx,$(dist_prefix)/$(path)/driver.cxx)
+	$(call install-data,$(src_base)/transactions.xsd,$(dist_prefix)/$(path)/transactions.xsd)
+	$(call install-data,$(src_base)/transactions.xml,$(dist_prefix)/$(path)/transactions.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.
+#
+$(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)/xsd/tree/xsd-cxx.make)
+
+# Dependencies.
+#
+$(call import,$(src_root)/xsd/makefile)
diff --git a/examples/cxx/tree/order/element/transactions.xml b/examples/cxx/tree/order/element/transactions.xml
new file mode 100644
index 0000000..5435980
--- /dev/null
+++ b/examples/cxx/tree/order/element/transactions.xml
@@ -0,0 +1,33 @@
+<?xml version="1.0"?>
+
+<!--
+
+file      : examples/cxx/tree/order/element/transactions.xml
+author    : Boris Kolpackov <boris@codesynthesis.com>
+copyright : not copyrighted - public domain
+
+-->
+
+<batch xmlns="http://www.codesynthesis.com/transactions"
+       xmlns:te="http://www.codesynthesis.com/transactions-extras"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:schemaLocation="http://www.codesynthesis.com/transactions transactions.xsd">
+  <deposit>
+    <account>123456789</account>
+    <amount>1000000</amount>
+  </deposit>
+
+  <balance>
+    <account>123456789</account>
+  </balance>
+
+  <te:block>
+    <account>123456789</account>
+    <amount>500000</amount>
+  </te:block>
+
+  <withdraw>
+    <account>123456789</account>
+    <amount>500000</amount>
+  </withdraw>
+</batch>
diff --git a/examples/cxx/tree/order/element/transactions.xsd b/examples/cxx/tree/order/element/transactions.xsd
new file mode 100644
index 0000000..54e9cc2
--- /dev/null
+++ b/examples/cxx/tree/order/element/transactions.xsd
@@ -0,0 +1,59 @@
+<?xml version="1.0"?>
+
+<!--
+
+file      : examples/cxx/tree/order/element/transactions.xsd
+author    : Boris Kolpackov <boris@codesynthesis.com>
+copyright : not copyrighted - public domain
+
+-->
+
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+            xmlns:t="http://www.codesynthesis.com/transactions"
+            targetNamespace="http://www.codesynthesis.com/transactions"
+            elementFormDefault="qualified">
+
+  <xsd:complexType name="transaction">
+    <xsd:sequence>
+      <xsd:element name="account" type="xsd:unsignedInt"/>
+    </xsd:sequence>
+  </xsd:complexType>
+
+  <xsd:complexType name="balance">
+    <xsd:complexContent>
+      <xsd:extension base="t:transaction"/>
+    </xsd:complexContent>
+  </xsd:complexType>
+
+  <xsd:complexType name="withdraw">
+    <xsd:complexContent>
+      <xsd:extension base="t:transaction">
+        <xsd:sequence>
+          <xsd:element name="amount" type="xsd:unsignedInt"/>
+        </xsd:sequence>
+      </xsd:extension>
+    </xsd:complexContent>
+  </xsd:complexType>
+
+  <xsd:complexType name="deposit">
+    <xsd:complexContent>
+      <xsd:extension base="t:transaction">
+        <xsd:sequence>
+          <xsd:element name="amount" type="xsd:unsignedInt"/>
+        </xsd:sequence>
+      </xsd:extension>
+    </xsd:complexContent>
+  </xsd:complexType>
+
+  <xsd:complexType name="batch">
+    <xsd:choice minOccurs="0" maxOccurs="unbounded">
+      <xsd:element name="balance" type="t:balance"/>
+      <xsd:element name="withdraw" type="t:withdraw"/>
+      <xsd:element name="deposit" type="t:deposit"/>
+      <xsd:any namespace="##other" processContents="lax"/>
+    </xsd:choice>
+  </xsd:complexType>
+
+  <xsd:element name="batch" type="t:batch"/>
+
+</xsd:schema>