diff options
Diffstat (limited to 'documentation/xsde-prologue.xhtml')
| -rw-r--r-- | documentation/xsde-prologue.xhtml | 162 |
1 files changed, 162 insertions, 0 deletions
diff --git a/documentation/xsde-prologue.xhtml b/documentation/xsde-prologue.xhtml new file mode 100644 index 0000000..c88f65b --- /dev/null +++ b/documentation/xsde-prologue.xhtml @@ -0,0 +1,162 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> + +<head> + <title>XSD/e 3.3.0 Compiler Command Line Manual</title> + + <meta name="copyright" content="© 2005-2011 Code Synthesis Tools CC"/> + <meta name="keywords" content="xsd,xml,schema,c++,mapping,data,binding,code,generator,manual,man,page"/> + <meta name="description" content="XSD/e Compiler Command Line Manual"/> + + <link rel="stylesheet" type="text/css" href="default.css" /> + +<style type="text/css"> + + #synopsis { + list-style-type: none; + } + + #synopsis li { + padding-top : 0.0em; + padding-bottom : 0.0em; + } + + #commands dt { + padding-top : 0.4em; + } + + #commands dd { + padding-bottom : 0.4em; + padding-left : 2em; + } + + .options dt { + padding-top : 0.4em; + } + + .options dd { + padding-top : 0.1em; + padding-bottom : 0.4em; + padding-left : 1.4em; + } + +</style> +</head> + +<body> +<div id="container"> + <div id="content"> + + <h1>NAME</h1> + + <p>xsde - W3C XML Schema to C++ Compiler for Embedded Systems</p> + + <h1>SYNOPSIS</h1> + + <dl id="synopsis"> + <dt><code><b>xsde</b> <i>command</i> [<i>options</i>] <i>file</i> [<i>file</i> ...]</code></dt> + <dt><code><b>xsde help</b> [<i>command</i>]</code></dt> + <dt><code><b>xsde version</b></code></dt> + </dl> + + <h1>DESCRIPTION</h1> + + <p><code><b>xsde</b></code> generates vocabulary-specific, statically-typed + C++ mapping from W3C XML Schema definitions. Particular mapping to + produce is selected by a <code><i>command</i></code>. Each mapping has + a number of mapping-specific <code><i>options</i></code> that should + appear, if any, after the <code><i>command</i></code>. Input files should + be W3C XML Schema definitions. The exact set of the generated files + depends on the selected mapping and options.</p> + + <h1>COMMANDS</h1> + + <dl id="commands"> + <dt><code><b>cxx-hybrid</b></code></dt> + <dd>Generate the Embedded C++/Hybrid mapping. For each input file in the + form <code><b>name.xsd</b></code> the following C++ files are generated: + <code><b>name.hxx</b></code> (object model header file), + <code><b>name.ixx</b></code> (object model inline file, generated only + if the <code><b>--generate-inline</b></code> option is specified), + <code><b>name.cxx</b></code> (object model source file), and + <code><b>name-fwd.hxx</b></code> (object model forward declaration + file, generated only if the <code><b>--generate-forward</b></code> + option is specified). + + <p>If the <code><b>--generate-parser</b></code> option is specified, + the Embedded C++/Parser mapping is invoked and the + <code><b>name-pskel.hxx</b></code>, + <code><b>name-pskel.ixx</b></code>, and + <code><b>name-pskel.cxx</b></code> parser skeleton files are + generated, as described below. Additionally, the following parser + implementation files are generated: + <code><b>name-pimpl.hxx</b></code> (parser implementation header + file) and + <code><b>name-pimpl.cxx</b></code> (parser implementation source + file).</p> + + <p>If the <code><b>--generate-serializer</b></code> option is + specified, the Embedded C++/Serializer mapping is invoked and the + <code><b>name-sskel.hxx</b></code>, + <code><b>name-sskel.ixx</b></code>, and + <code><b>name-sskel.cxx</b></code> serializer skeleton files are + generated, as described below. Additionally, the following serializer + implementation files are generated: + <code><b>name-simpl.hxx</b></code> (serializer implementation header + file) and + <code><b>name-simpl.cxx</b></code> (serializer implementation source + file).</p> + </dd> + + <dt><code><b>cxx-parser</b></code></dt> + <dd>Generate the Embedded C++/Parser mapping. For each input file in the + form <code><b>name.xsd</b></code> the following C++ files are generated: + <code><b>name-pskel.hxx</b></code> (parser skeleton header file), + <code><b>name-pskel.ixx</b></code> (parser skeleton inline file, + generated only if the <code><b>--generate-inline</b></code> + option is specified), and + <code><b>name-pskel.cxx</b></code> (parser skeleton source file). + If the <code><b>--generate-noop-impl</b></code> or + <code><b>--generate-print-impl</b></code> option is specified, + the following additional sample implementation files are generated: + <code><b>name-pimpl.hxx</b></code> (parser implementation header + file) and + <code><b>name-pimpl.cxx</b></code> (parser implementation source + file). If the <code><b>--generate-test-driver</b></code> option + is specified, the additional <code><b>name-pdriver.cxx</b></code> + test driver file is generated.</dd> + + <dt><code><b>cxx-serializer</b></code></dt> + <dd>Generate the Embedded C++/Serializer mapping. For each input file + in the form <code><b>name.xsd</b></code> the following C++ files + are generated: <code><b>name-sskel.hxx</b></code> (serializer + skeleton header file), <code><b>name-sskel.ixx</b></code> (serializer + skeleton inline file, generated only if the + <code><b>--generate-inline</b></code> option is specified), and + <code><b>name-sskel.cxx</b></code> (serializer skeleton source file). + If the <code><b>--generate-empty-impl</b></code> option is specified, + the following additional sample implementation files are generated: + <code><b>name-simpl.hxx</b></code> (serializer implementation header + file) and <code><b>name-simpl.cxx</b></code> (serializer + implementation source file). If the <code><b>--generate-test-driver</b></code> + option is specified, the additional <code><b>name-sdriver.cxx</b></code> + test driver file is generated. + </dd> + + <dt><code><b>help</b></code></dt> + <dd>Print usage information and exit. Use + <p><code><b>xsde help</b> <i>command</i></code></p> + for command-specific help. + </dd> + + <dt><code><b>version</b></code></dt> + <dd>Print version and exit.</dd> + </dl> + + <h1>OPTIONS</h1> + + <p>Command-specific <code><i>options</i></code>, if any, should appear + after the corresponding <code><i>command</i></code>.</p> + + <h2>COMMON OPTIONS</h2> |