From 884dea7531962b17ef843ac2175faa050e8b0758 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Thu, 10 Apr 2014 12:57:06 +0200 Subject: Add support for ordered types, mixed content --- examples/cxx/tree/README | 8 +- examples/cxx/tree/makefile | 7 +- examples/cxx/tree/mixed/README | 6 +- examples/cxx/tree/mixed/text.xml | 2 +- examples/cxx/tree/order/README | 11 ++ examples/cxx/tree/order/element/README | 35 ++++++ examples/cxx/tree/order/element/driver.cxx | 147 +++++++++++++++++++++++ examples/cxx/tree/order/element/makefile | 100 +++++++++++++++ examples/cxx/tree/order/element/transactions.xml | 33 +++++ examples/cxx/tree/order/element/transactions.xsd | 59 +++++++++ examples/cxx/tree/order/makefile | 44 +++++++ examples/cxx/tree/order/mixed/README | 45 +++++++ examples/cxx/tree/order/mixed/driver.cxx | 89 ++++++++++++++ examples/cxx/tree/order/mixed/makefile | 99 +++++++++++++++ examples/cxx/tree/order/mixed/text.xml | 18 +++ examples/cxx/tree/order/mixed/text.xsd | 29 +++++ 16 files changed, 724 insertions(+), 8 deletions(-) create mode 100644 examples/cxx/tree/order/README create mode 100644 examples/cxx/tree/order/element/README create mode 100644 examples/cxx/tree/order/element/driver.cxx create mode 100644 examples/cxx/tree/order/element/makefile create mode 100644 examples/cxx/tree/order/element/transactions.xml create mode 100644 examples/cxx/tree/order/element/transactions.xsd create mode 100644 examples/cxx/tree/order/makefile create mode 100644 examples/cxx/tree/order/mixed/README create mode 100644 examples/cxx/tree/order/mixed/driver.cxx create mode 100644 examples/cxx/tree/order/mixed/makefile create mode 100644 examples/cxx/tree/order/mixed/text.xml create mode 100644 examples/cxx/tree/order/mixed/text.xsd (limited to 'examples') diff --git a/examples/cxx/tree/README b/examples/cxx/tree/README index ee91b43..569bf11 100644 --- a/examples/cxx/tree/README +++ b/examples/cxx/tree/README @@ -17,6 +17,10 @@ polymorphism Shows how to use XML Schema polymorphism features such as the xsi:type attribute and substitution groups. +order/ + A collection of examples that show how to use ordered types to + capture and maintain content order. + xpath Shows how to use the C++/Tree mapping together with XPath. @@ -45,7 +49,7 @@ caching embedded Shows how to embed the binary representation of the schema grammar - into an application and then use it with the C++/Tree mapping to + into an application and then use it with the C++/Tree mapping to parse and validate XML documents. performance @@ -68,7 +72,7 @@ streaming that are too large to fit into memory. compression - Shows how to compress an XML document during serialization and decompress + Shows how to compress an XML document during serialization and decompress it during parsing using the zlib library. binary/ diff --git a/examples/cxx/tree/makefile b/examples/cxx/tree/makefile index 728860b..688dfd5 100644 --- a/examples/cxx/tree/makefile +++ b/examples/cxx/tree/makefile @@ -5,12 +5,11 @@ include $(dir $(lastword $(MAKEFILE_LIST)))../../../build/bootstrap.make all_examples := binary caching embedded custom hello library messaging \ -mixed multiroot performance polymorphism streaming wildcard compression \ -xpath - +mixed multiroot order performance polymorphism streaming wildcard \ +compression xpath build_examples := binary caching embedded custom hello library messaging \ -mixed multiroot performance polymorphism streaming wildcard +mixed multiroot order performance polymorphism streaming wildcard ifeq ($(xsd_with_zlib),y) build_examples += compression diff --git a/examples/cxx/tree/mixed/README b/examples/cxx/tree/mixed/README index 9ab3309..fc23faa 100644 --- a/examples/cxx/tree/mixed/README +++ b/examples/cxx/tree/mixed/README @@ -1,8 +1,12 @@ This example shows how to access the underlying DOM nodes in the C++/Tree mapping in order to handle raw, "type-less content" such as mixed content models, anyType/anySimpleType, and any/anyAttribute. + +For an alternative (and recommended) approach that employs ordered +types see the order/mixed example. + For an alternative approach that employes type customization see -examples in the custom/ directory, in particular, custom/mixed and +examples in the custom/ directory, in particular, custom/mixed and custom/wildcard. In this example we use mixed content model to describe text with diff --git a/examples/cxx/tree/mixed/text.xml b/examples/cxx/tree/mixed/text.xml index 69abe8f..9d70397 100644 --- a/examples/cxx/tree/mixed/text.xml +++ b/examples/cxx/tree/mixed/text.xml @@ -2,7 +2,7 @@ + + + + 123456789 + 1000000 + + + + 123456789 + + + + 123456789 + 500000 + + + + 123456789 + 500000 + + 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 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/examples/cxx/tree/order/makefile b/examples/cxx/tree/order/makefile new file mode 100644 index 0000000..63f1f3a --- /dev/null +++ b/examples/cxx/tree/order/makefile @@ -0,0 +1,44 @@ +# file : examples/cxx/tree/order/makefile +# copyright : Copyright (c) 2006-2014 Code Synthesis Tools CC +# license : GNU GPL v2 + exceptions; see accompanying LICENSE file + +include $(dir $(lastword $(MAKEFILE_LIST)))../../../../build/bootstrap.make + +all_examples := element mixed +build_examples := element mixed + +default := $(out_base)/ +install := $(out_base)/.install +dist := $(out_base)/.dist +dist-win := $(out_base)/.dist-win +clean := $(out_base)/.clean + +# Build. +# +$(default): $(addprefix $(out_base)/,$(addsuffix /,$(build_examples))) + +# Install & Dist. +# +$(install) $(dist) $(dist-win): path := $(subst $(src_root)/,,$(src_base)) + +$(install): $(addprefix $(out_base)/,$(addsuffix /.install,$(all_examples))) + $(call install-data,$(src_base)/README,$(install_doc_dir)/xsd/$(path)/README) + +$(dist): $(addprefix $(out_base)/,$(addsuffix /.dist,$(all_examples))) + $(call install-data,$(src_base)/README,$(dist_prefix)/$(path)/README) + +$(dist-win): $(addprefix $(out_base)/,$(addsuffix /.dist-win,$(all_examples))) + $(call install-data,$(src_base)/README,$(dist_prefix)/$(path)/README.txt) + $(call message,,unix2dos $(dist_prefix)/$(path)/README.txt) + +# Clean. +# +$(clean): $(addprefix $(out_base)/,$(addsuffix /.clean,$(build_examples))) + +$(call include,$(bld_root)/install.make) + +ifneq ($(filter $(MAKECMDGOALS),dist dist-win install),) +$(foreach e,$(all_examples),$(call import,$(src_base)/$e/makefile)) +else +$(foreach e,$(build_examples),$(call import,$(src_base)/$e/makefile)) +endif diff --git a/examples/cxx/tree/order/mixed/README b/examples/cxx/tree/order/mixed/README new file mode 100644 index 0000000..e66c1ad --- /dev/null +++ b/examples/cxx/tree/order/mixed/README @@ -0,0 +1,45 @@ +This example shows how to use ordered types to capture mixed content +text and to maintain order information between elements and text. + +In this example we use mixed content model to describe text with +embedded links in the form: + + This paragraph talks about time. + +The example transforms such text into plain text with references in +the form: + + This paragraph talks about time[uri]. + +It also saves the modified text back to XML in order to verify the +element and text order. + +The example consists of the following files: + +text.xsd + XML Schema which describes "text with links" instance documents. + +text.xml + Sample XML instance document. + +text.hxx +text.cxx + C++ types that represent the given vocabulary as well as a set of + parsing and serialization functions. These are generated by XSD + from text.xsd. Note that the --ordered-type-mixed option is used + to indicate to the XSD compiler that all types with mixed content + should be automatically treated as ordered. + +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 the text and elements in the content order to convert + the document to its plain text representation. The driver then adds + another paragraph of text and a link to the object model while showing + how to maintain the content order. Finally, it saves the modified + text 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 text.xml diff --git a/examples/cxx/tree/order/mixed/driver.cxx b/examples/cxx/tree/order/mixed/driver.cxx new file mode 100644 index 0000000..9606b67 --- /dev/null +++ b/examples/cxx/tree/order/mixed/driver.cxx @@ -0,0 +1,89 @@ +// file : examples/cxx/tree/order/mixed/driver.cxx +// copyright : not copyrighted - public domain + +#include // std::auto_ptr +#include +#include + +#include "text.hxx" + +using std::cerr; +using std::endl; + +int +main (int argc, char* argv[]) +{ + if (argc != 2) + { + cerr << "usage: " << argv[0] << " text.xml" << endl; + return 1; + } + + try + { + std::auto_ptr t (text_ (argv[1])); + + // Print what we've got in content order. + // + for (text::content_order_const_iterator i (t->content_order ().begin ()); + i != t->content_order ().end (); + ++i) + { + switch (i->id) + { + case text::a_id: + { + const anchor& a (t->a ()[i->index]); + cerr << a << "[" << a.href () << "]"; + break; + } + case text::text_content_id: + { + const xml_schema::string& s (t->text_content ()[i->index]); + cerr << s; + break; + } + default: + { + assert (false); // Unknown content id. + } + } + } + + cerr << endl; + + // Modify the document. Note that we have to update both the content + // itself and content order sequences. + // + typedef text::content_order_type order_type; + + text::content_order_sequence& co (t->content_order ()); + text::text_content_sequence& tc (t->text_content ()); + + tc.push_back ("The last paragraph doesn't talk about "); + co.push_back (order_type (text::text_content_id, tc.size () - 1)); + + t->a ().push_back (anchor ("anything", "http://en.wikipedia.org")); + co.push_back (order_type (text::a_id, t->a ().size () - 1)); + + tc.push_back (" in particular.\n\n"); + co.push_back (order_type (text::text_content_id, tc.size () - 1)); + + // Serialize the modified document back to XML. + // + xml_schema::namespace_infomap map; + + map[""].schema = "text.xsd"; + + text_ (std::cout, + *t, + map, + "UTF-8", + xml_schema::flags::dont_pretty_print); + } + catch (const xml_schema::exception& e) + { + cerr << e << endl; + return 1; + } +} diff --git a/examples/cxx/tree/order/mixed/makefile b/examples/cxx/tree/order/mixed/makefile new file mode 100644 index 0000000..3e3eb30 --- /dev/null +++ b/examples/cxx/tree/order/mixed/makefile @@ -0,0 +1,99 @@ +# file : examples/cxx/tree/order/mixed/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 := text.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 --ordered-type-mixed +$(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)/text.xsd,$(install_doc_dir)/xsd/$(path)/text.xsd) + $(call install-data,$(src_base)/text.xml,$(install_doc_dir)/xsd/$(path)/text.xml) + +$(dist-common): + $(call install-data,$(src_base)/driver.cxx,$(dist_prefix)/$(path)/driver.cxx) + $(call install-data,$(src_base)/text.xsd,$(dist_prefix)/$(path)/text.xsd) + $(call install-data,$(src_base)/text.xml,$(dist_prefix)/$(path)/text.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/mixed/text.xml b/examples/cxx/tree/order/mixed/text.xml new file mode 100644 index 0000000..815b76e --- /dev/null +++ b/examples/cxx/tree/order/mixed/text.xml @@ -0,0 +1,18 @@ + + + + + + +The first paragraph of this text talks about time. + +And this paragraph talks about space. + + diff --git a/examples/cxx/tree/order/mixed/text.xsd b/examples/cxx/tree/order/mixed/text.xsd new file mode 100644 index 0000000..bfb868e --- /dev/null +++ b/examples/cxx/tree/order/mixed/text.xsd @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + -- cgit v1.1