summaryrefslogtreecommitdiff
path: root/xsd-examples/cxx/tree/custom/calendar/README
diff options
context:
space:
mode:
Diffstat (limited to 'xsd-examples/cxx/tree/custom/calendar/README')
-rw-r--r--xsd-examples/cxx/tree/custom/calendar/README70
1 files changed, 70 insertions, 0 deletions
diff --git a/xsd-examples/cxx/tree/custom/calendar/README b/xsd-examples/cxx/tree/custom/calendar/README
new file mode 100644
index 0000000..a4297ba
--- /dev/null
+++ b/xsd-examples/cxx/tree/custom/calendar/README
@@ -0,0 +1,70 @@
+This example shows how to customize the XML Schema built-in types by mapping
+xsd:date built-in type to the date class from the Boost date_time library.
+You will need the Boost date_time library[1] installed in order to build
+and run this example. For more information on the C++/Tree mapping
+customization see the C++/Tree Mapping Customization Guide[2].
+
+[1] http://www.boost.org
+[2] http://wiki.codesynthesis.com/Tree/Customization_guide
+
+The example consists of the following files:
+
+calendar.xsd
+ XML Schema definition for a simple calendar format.
+
+calendar.xml
+ Sample XML instance document.
+
+xml-schema.hxx
+ C++ types for XML Schema built-in types.
+
+ This header file is generated by the XSD compiler in the
+ --generate-xml-schema mode using the following command line:
+
+ xsd cxx-tree --generate-xml-schema --custom-type date \
+ --hxx-epilogue '#include "xml-schema-custom.hxx"' xml-schema.xsd
+
+ The --custom-type option is used to customize the xsd:date type.
+
+calendar.hxx
+calendar.ixx
+calendar.cxx
+ C++ types that represent the given vocabulary and a set of parsing
+ functions that convert XML instance documents to a tree-like in-memory
+ object model.
+
+ These files are generated by the XSD compiler from calendar.xsd using the
+ following command line:
+
+ xsd cxx-tree --extern-xml-schema xml-schema.xsd calendar.xsd
+
+ The --extern-xml-schema option is used to include xml-schema.hxx.
+
+xml-schema-custom.hxx
+ Header file which defines our own xml_schema::date class. It is
+ included at the end of xml-schema.hxx using the --hxx-epilogue
+ option.
+
+xml-schema-custom.cxx
+ Source file which contains the implementation of our xml_schema:date
+ class.
+
+driver.cxx
+ Driver for the example. It first calls one of the parsing functions
+ that constructs the object model from the input file. It then prints
+ the calendar events to STDERR.
+
+To compile and link the example manually from the command line we can use
+the following commands (replace 'c++' with your C++ compiler name):
+
+c++ -DXSD_CXX11 -c calendar.cxx
+c++ -DXSD_CXX11 -c xml-schema-custom.cxx
+c++ -DXSD_CXX11 -c driver.cxx
+c++ -o driver driver.o calendar.o xml-schema-custom.o -lxerces-c
+
+Note that we need to define the XSD_CXX11 preprocessor macro since the
+source code includes libxsd headers directly.
+
+To run the example on the sample XML instance document execute:
+
+./driver calendar.xml