aboutsummaryrefslogtreecommitdiff
path: root/doc/xsde-prologue.xhtml
blob: 5aa28734751a1f4ea471cc6ca8ecb4008a234834 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<?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="&#169; $copyright$"/>
  <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 {
    margin: 1em 0 1em 0;
  }

  .options dt {
    margin: 1em 0 0 0;
  }

  .options dd {
    margin: .1em 0 0 4.5em;
  }

</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>