From 3939c9a6ceebbb237d8bdc041fd11f90ffc3b7ea Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Tue, 25 Feb 2014 09:22:06 +0200 Subject: Rename documentation/ to doc/ --- doc/xsde-prologue.xhtml | 162 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 162 insertions(+) create mode 100644 doc/xsde-prologue.xhtml (limited to 'doc/xsde-prologue.xhtml') diff --git a/doc/xsde-prologue.xhtml b/doc/xsde-prologue.xhtml new file mode 100644 index 0000000..c88f65b --- /dev/null +++ b/doc/xsde-prologue.xhtml @@ -0,0 +1,162 @@ + + + + + + XSD/e 3.3.0 Compiler Command Line Manual + + + + + + + + + + + +
+
+ +

NAME

+ +

xsde - W3C XML Schema to C++ Compiler for Embedded Systems

+ +

SYNOPSIS

+ +
+
xsde command [options] file [file ...]
+
xsde help [command]
+
xsde version
+
+ +

DESCRIPTION

+ +

xsde generates vocabulary-specific, statically-typed + C++ mapping from W3C XML Schema definitions. Particular mapping to + produce is selected by a command. Each mapping has + a number of mapping-specific options that should + appear, if any, after the command. Input files should + be W3C XML Schema definitions. The exact set of the generated files + depends on the selected mapping and options.

+ +

COMMANDS

+ +
+
cxx-hybrid
+
Generate the Embedded C++/Hybrid mapping. For each input file in the + form name.xsd the following C++ files are generated: + name.hxx (object model header file), + name.ixx (object model inline file, generated only + if the --generate-inline option is specified), + name.cxx (object model source file), and + name-fwd.hxx (object model forward declaration + file, generated only if the --generate-forward + option is specified). + +

If the --generate-parser option is specified, + the Embedded C++/Parser mapping is invoked and the + name-pskel.hxx, + name-pskel.ixx, and + name-pskel.cxx parser skeleton files are + generated, as described below. Additionally, the following parser + implementation files are generated: + name-pimpl.hxx (parser implementation header + file) and + name-pimpl.cxx (parser implementation source + file).

+ +

If the --generate-serializer option is + specified, the Embedded C++/Serializer mapping is invoked and the + name-sskel.hxx, + name-sskel.ixx, and + name-sskel.cxx serializer skeleton files are + generated, as described below. Additionally, the following serializer + implementation files are generated: + name-simpl.hxx (serializer implementation header + file) and + name-simpl.cxx (serializer implementation source + file).

+
+ +
cxx-parser
+
Generate the Embedded C++/Parser mapping. For each input file in the + form name.xsd the following C++ files are generated: + name-pskel.hxx (parser skeleton header file), + name-pskel.ixx (parser skeleton inline file, + generated only if the --generate-inline + option is specified), and + name-pskel.cxx (parser skeleton source file). + If the --generate-noop-impl or + --generate-print-impl option is specified, + the following additional sample implementation files are generated: + name-pimpl.hxx (parser implementation header + file) and + name-pimpl.cxx (parser implementation source + file). If the --generate-test-driver option + is specified, the additional name-pdriver.cxx + test driver file is generated.
+ +
cxx-serializer
+
Generate the Embedded C++/Serializer mapping. For each input file + in the form name.xsd the following C++ files + are generated: name-sskel.hxx (serializer + skeleton header file), name-sskel.ixx (serializer + skeleton inline file, generated only if the + --generate-inline option is specified), and + name-sskel.cxx (serializer skeleton source file). + If the --generate-empty-impl option is specified, + the following additional sample implementation files are generated: + name-simpl.hxx (serializer implementation header + file) and name-simpl.cxx (serializer + implementation source file). If the --generate-test-driver + option is specified, the additional name-sdriver.cxx + test driver file is generated. +
+ +
help
+
Print usage information and exit. Use +

xsde help command

+ for command-specific help. +
+ +
version
+
Print version and exit.
+
+ +

OPTIONS

+ +

Command-specific options, if any, should appear + after the corresponding command.

+ +

COMMON OPTIONS

-- cgit v1.1