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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--Converted with LaTeX2HTML 2002-2-1 (1.70)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Generated versus Original SIDL files</TITLE>
<META NAME="description" CONTENT="Generated versus Original SIDL files">
<META NAME="keywords" CONTENT="users_guide">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2002-2-1">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="users_guide.css">
<LINK REL="next" HREF="node175.html">
<LINK REL="previous" HREF="node173.html">
<LINK REL="up" HREF="node171.html">
<LINK REL="next" HREF="node175.html">
</HEAD>
<BODY >
<DIV CLASS="navigation"><!--Navigation Panel-->
<A NAME="tex2html3300"
HREF="node175.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html3294"
HREF="node171.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html3288"
HREF="node173.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html3296"
HREF="node14.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<A NAME="tex2html3298"
HREF="node317.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html3301"
HREF="node175.html">XML File Comparison</A>
<B> Up:</B> <A NAME="tex2html3295"
HREF="node171.html">SIDL Backend</A>
<B> Previous:</B> <A NAME="tex2html3289"
HREF="node173.html">Purpose</A>
<B> <A NAME="tex2html3297"
HREF="node14.html">Contents</A></B>
<B> <A NAME="tex2html3299"
HREF="node317.html">Index</A></B>
<BR>
<BR></DIV>
<!--End of Navigation Panel-->
<H1><A NAME="SECTION03730000000000000000"></A>
<A NAME="10772"></A>
<BR>
Generated versus Original SIDL files
</H1>
Generated SIDL files may differ from their original SIDL files in several
respects in terms of content as well as layout. These differences are
summarized below.
<P>
<DL>
<DT><STRONG>Packages.</STRONG></DT>
<DD>The code generation is limited to one high-level package
per generated file. In fact, the name of the generated file is currently
defined to be the concatenation of the name of the highest-level package and
.sidl.
<P>
</DD>
<DT><STRONG>Versioning.</STRONG></DT>
<DD>The generation of requires statements is inferred from the
symbols that actually appear in the associated interface descriptions. The
intent is to provide a requires statement for only the highest level package
needed of a given version. Consequently, requires and imports statements that
were not necessary for resolving symbols will not appear. Also, fully
qualified names will be shortened in the generated files due to the automatic
generation of the associated requires statement(s). Finally, since an import
and require statement can be used in a SIDL file and no distinction is made in
the XML, only a require statement will appear in the generated file.
<P>
</DD>
<DT><STRONG>Implements.</STRONG></DT>
<DD>Since there is no distinction between <TT><I CLASS="slanted">implements-all</I></TT>
and <TT><I CLASS="slanted">implements</I></TT> in the XML version of the interfaces, the generated code
outputs <TT><I CLASS="slanted">implements</I></TT> along with the inherited methods.
<P>
</DD>
<DT><STRONG>Comments.</STRONG></DT>
<DD>Babel preserves only document, or doc, comments so any
comments that do not conform will not appear in the generated file
<A NAME="tex2html44"
HREF="footnode.html#foot10804"><SUP><SPAN CLASS="arabic">13</SPAN>.<SPAN CLASS="arabic">1</SPAN></SUP></A>.
<P>
</DD>
<DT><STRONG>Whitespace.</STRONG></DT>
<DD>Obviously there may be whitespace differences in the
generated file. These include indentation, blank spaces and lines, and brace
placement.
<P>
</DD>
</DL>
<P>
As an example, suppose we have a package in the file <TT>foo.sidl</TT>. The
original file's contents are:
<P>
<BR>
<PRE CLASS="verbatim">package foo version 1.0 {
class A {}
package bar version 2.0 {
class B {}
}
}
</PRE></td></tr></table></blockquote>
<P>
The resulting contents of the generated SIDL file are:
<P>
<BR>
<PRE CLASS="verbatim">package foo version 1.0 {
class A {
}
package bar version 2.0 {
class B {
}
}
}
</PRE></td></tr></table></blockquote>
<P>
Notice the differences in white space. To illustrate more features, further
suppose we have a package in the file <TT>fooTest.sidl</TT>. The original file's
contents are:
<P>
<BR>
<PRE CLASS="verbatim">// An ignored comment
require foo version 1.0;
require foo.bar version 2.0;
/**
* Test of doc comment with XML special characters < & >.
*/
package fooTest version 0.1 {
/**
* Another doc comment for an empty class.
*/
class A extends foo.bar.B {}
class B extends foo.A {}
}
</PRE></td></tr></table></blockquote>
<P>
The resulting contents of the generated SIDL file are:
<P>
<BR>
<PRE CLASS="verbatim">require foo version 1.0;
require foo.bar version 2.0;
/**
* Test of doc comment with XML special characters < & >.
*/
package fooTest version 0.1 {
/**
* Another doc comment for an empty class.
*/
class A extends foo.bar.B {
}
class B extends foo.A {
}
}
</PRE></td></tr></table></blockquote>
<P>
Here we see the exclusion of non-document comments and the retention of
document comments. Refer to Section <A HREF="node49.html#s:basics_sidl">5.2</A> and Appendix
<A HREF="node220.html#c:xml">C</A> for more information about document comments.
<P>
<DIV CLASS="navigation"><HR>
<!--Navigation Panel-->
<A NAME="tex2html3300"
HREF="node175.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html3294"
HREF="node171.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html3288"
HREF="node173.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html3296"
HREF="node14.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<A NAME="tex2html3298"
HREF="node317.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html3301"
HREF="node175.html">XML File Comparison</A>
<B> Up:</B> <A NAME="tex2html3295"
HREF="node171.html">SIDL Backend</A>
<B> Previous:</B> <A NAME="tex2html3289"
HREF="node173.html">Purpose</A>
<B> <A NAME="tex2html3297"
HREF="node14.html">Contents</A></B>
<B> <A NAME="tex2html3299"
HREF="node317.html">Index</A></B> </DIV>
<!--End of Navigation Panel-->
<ADDRESS>
<br><br>babel-0.10.2<br>users_guide Last Modified 2005-03-23<br><br><a href="http://www.llnl.gov/CASC/components">http://www.llnl.gov/CASC/components</a><br><a href="mailto:components@llnl.gov">components@llnl.gov</a>
</ADDRESS>
</BODY>
</HTML>
|
