aboutsummaryrefslogtreecommitdiff
path: root/doc/xsde-prologue.1
blob: e03f9e51c70e6d689cb157b0af6922e501ff09be (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
165
166
167
168
169
170
171
.\" Process this file with
.\" groff -man -Tascii xsde.1
.\"
.TH XSD/e 1 "September 2011" "XSD/e 3.3.0"
.SH NAME
xsde \- W3C XML Schema to C++ Compiler for Embedded Systems
.\"
.\"
.\"
.\"--------------------------------------------------------------------
.SH SYNOPSIS
.\"--------------------------------------------------------------------
.B xsde
.I command
.B [
.I options
.B ]
.I file
.B [
.I file
.B ...]
.in
.B xsde help
.B [
.I command
.B ]
.in
.B xsde version
.\"
.\"
.\"
.\"--------------------------------------------------------------------
.SH DESCRIPTION
.\"--------------------------------------------------------------------
.B xsde
generates vocabulary-specific, statically-typed C++ mapping from W3C XML
Schema definitions. Particular mapping to produce is selected by a
.IR command .
Each mapping has a number of mapping-specific
.I options
that should appear, if any, after the
.IR command .
Input files should be W3C XML Schema definitions. The exact set of the
generated files depends on the selected mapping and options.
.\"
.\"
.\"
.\"--------------------------------------------------------------------
.SH COMMANDS
.\"--------------------------------------------------------------------
.IP \fBcxx-hybrid\fR
Generate the Embedded C++/Hybrid mapping. For each input file in the
form
.B name.xsd
the following C++ files are generated:
.B name.hxx
(object model header file),
.B name.ixx
(object model inline file, generated only if the
.B --generate-inline
option is specified),
.B name.cxx
(object model source file), and
.B name-fwd.hxx
(object model forward declaration file, generated only if the
.B --generate-forward
option is specified).

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

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

.IP \fBcxx-parser\fR
Generate the Embedded C++/Parser mapping. For each input file in the form
.B name.xsd
the following C++ files are generated:
.B name-pskel.hxx
(parser skeleton header file),
.B name-pskel.ixx
(parser skeleton inline file, generated only if the
.B --generate-inline
option is specified), and
.B name-pskel.cxx
(parser skeleton source file). If the
.B --generate-noop-impl
or
.B --generate-print-impl
option is specified, the following additional sample implementation files
are generated:
.B name-pimpl.hxx
(parser implementation header file) and
.B name-pimpl.cxx
(parser implementation source file). If the
.B --generate-test-driver
option is specified, the additional
.B name-pdriver.cxx
test driver file is generated.

.IP \fBcxx-parser\fR
Generate the Embedded C++/Serializer mapping. For each input file in the form
.B name.xsd
the following C++ files are generated:
.B name-sskel.hxx
(serializer skeleton header file),
.B name-sskel.ixx
(serializer skeleton inline file, generated only if the
.B --generate-inline
option is specified), and
.B name-sskel.cxx
(serializer skeleton source file). If the
.B --generate-empty-impl
option is specified, the following additional sample implementation files
are generated:
.B name-simpl.hxx
(serializer implementation header file) and
.B name-simpl.cxx
(serializer implementation source file). If the
.B --generate-test-driver
option is specified, the additional
.B name-sdriver.cxx
test driver file is generated.

.IP \fBhelp\fR
Print usage information and exit. Use
.PP
.RS
.RS 3
.B xsde help
.I command
.RE
.PP
for command-specific help.
.RE
.IP \fBversion\fR
Print version and exit.
.\"--------------------------------------------------------------------
.SH OPTIONS
.\"--------------------------------------------------------------------
Command-specific
.IR options ,
if any, should appear after the corresponding
.IR command .

.\"
.\" Common options.
.\"
.SS common options