source: release-kits/lirk3/bin/ant-installer/web/manual1.6.2/manual/OptionalTasks/netrexxc.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 11.6 KB
Line 
1<html>
2
3<head>
4<meta http-equiv="Content-Language" content="en-us">
5<title>NetRexxC Task</title>
6<link rel="stylesheet" type="text/css" href="../stylesheets/antmanual.css">
7</head>
8
9<body>
10
11<h2><a name="netrexxc">NetRexxC</a></h2>
12<h3>Description</h3>
13<p>Compiles a <a href="http://www2.hursley.ibm.com/netrexx" target="_top">NetRexx</a>
14source tree within the running (Ant) VM.</p>
15<p>The source and destination directory will be recursively scanned for
16NetRexx source files to compile. Only NetRexx files that have no corresponding
17class file or where the class file is older than the java file will be compiled.</p>
18<p>Files in the source tree are copied to the destination directory,
19allowing support files to be located properly in the classpath. The source
20files are copied because the NetRexx compiler cannot produce class files in a
21specific directory via parameters</p>
22<p>The directory structure of the source tree should follow the package
23hierarchy.</p>
24<p>It is possible to refine the set of files that are being compiled/copied.
25This can be done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and
26<i>defaultexcludes</i> attributes. With the <i>includes</i> or <i>includesfile</i> attribute you
27specify the files you want to have included by using patterns. The
28<i>exclude</i> or <i>excludesfile</i> attribute is used to specify the files you want to have
29excluded. This is also done with patterns. And finally with the
30<i>defaultexcludes</i> attribute, you can specify whether you
31want to use default exclusions or not. See the section on <a
32href="../dirtasks.html#directorybasedtasks">directory based tasks</a>, on how the
33inclusion/exclusion of files works, and how to write patterns.</p>
34<p>This task forms an implicit <a href="../CoreTypes/fileset.html">FileSet</a> and
35supports all attributes of <code>&lt;fileset&gt;</code>
36(<code>dir</code> becomes <code>srcdir</code>) as well as the nested
37<code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and
38<code>&lt;patternset&gt;</code> elements.</p>
39<p>All properties except classpath, srcdir and destDir are also available as properties in the form
40<code>ant.netrexxc.<i>attributename</i></code>, eg.<br>
41<code>&lt;property name="ant.netrexxc.verbose" value="noverbose"/&gt;</code><br>
42or from the command line as<br>
43<code>ant -Dant.netrexxc.verbose=noverbose ...</code>
44</p>
45
46<h3>Parameters</h3>
47<table border="1" cellpadding="2" cellspacing="0">
48 <tr>
49 <td valign="top"><b>Attribute</b></td>
50 <td valign="top"><b>Description</b></td>
51 <td align="center" valign="top"><b>Required</b></td>
52 </tr>
53 <tr>
54 <td valign="top">binary</td>
55 <td valign="top">Whether literals are treated as the java binary
56 type rather than the NetRexx types</td>
57 <td valign="top" align="center">No</td>
58 </tr>
59 <tr>
60 <td valign="top">classpath</td>
61 <td valign="top">The classpath to use during compilation</td>
62 <td valign="top" align="center">No</td>
63 </tr>
64 <tr>
65 <td valign="top">comments</td>
66 <td valign="top">Whether comments are passed through to the
67 generated java source</td>
68 <td valign="top" align="center">No</td>
69 </tr>
70 <tr>
71 <td valign="top">compact</td>
72 <td valign="top">Whether error messages come out in compact or
73 verbose format. Default is the compact format.</td>
74 <td valign="top" align="center">No</td>
75 </tr>
76 <tr>
77 <td valign="top">compile</td>
78 <td valign="top">Whether the NetRexx compiler should compile the
79 generated java code</td>
80 <td valign="top" align="center">No</td>
81 </tr>
82 <tr>
83 <td valign="top">console</td>
84 <td valign="top">Whether or not messages should be displayed on the
85 'console'</td>
86 <td valign="top" align="center">No</td>
87 </tr>
88 <tr>
89 <td valign="top">crossref</td>
90 <td valign="top">Whether variable cross references are generated</td>
91 <td valign="top" align="center">No</td>
92 </tr>
93 <tr>
94 <td valign="top">decimal</td>
95 <td valign="top">Whether decimal arithmetic should be used for the
96 NetRexx code</td>
97 <td valign="top" align="center">No</td>
98 </tr>
99 <tr>
100 <td valign="top">defaultexcludes</td>
101 <td valign="top">indicates whether default excludes should be used or not
102 (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when
103 omitted.</td>
104 <td valign="top" align="center">No</td>
105 </tr>
106 <tr>
107 <td valign="top">destDir</td>
108 <td valign="top">the destination directory into which the NetRexx
109 source files should be copied and then compiled</td>
110 <td valign="top" align="center">Yes</td>
111 </tr>
112 <tr>
113 <td valign="top">diag</td>
114 <td valign="top">Whether diagnostic information about the compile is
115 generated</td>
116 <td valign="top" align="center">No</td>
117 </tr>
118 <tr>
119 <td valign="top">excludes</td>
120 <td valign="top">comma- or space-separated list of patterns of files that must be
121 excluded. No files (except default excludes) are excluded when
122 omitted.</td>
123 <td valign="top" align="center">No</td>
124 </tr>
125 <tr>
126 <td valign="top">excludesfile</td>
127 <td valign="top">the name of a file. Each line of this file is
128 taken to be an exclude pattern</td>
129 <td valign="top" align="center">No</td>
130 </tr>
131 <tr>
132 <td valign="top">explicit</td>
133 <td valign="top">Whether variables must be declared explicitly
134 before use</td>
135 <td valign="top" align="center">No</td>
136 </tr>
137 <tr>
138 <td valign="top">format</td>
139 <td valign="top">Whether the generated java code is formatted nicely
140 or left to match NetRexx line numbers for call stack debugging</td>
141 <td valign="top" align="center">No</td>
142 </tr>
143 <tr>
144 <td valign="top">includes</td>
145 <td valign="top">comma- or space-separated list of patterns of files that must be
146 included. All files are included when omitted.</td>
147 <td valign="top" align="center">No</td>
148 </tr>
149 <tr>
150 <td valign="top">includesfile</td>
151 <td valign="top">the name of a file. Each line of this file is
152 taken to be an include pattern</td>
153 <td valign="top" align="center">No</td>
154 </tr>
155 <tr>
156 <td valign="top">java</td>
157 <td valign="top">Whether the generated java code is produced</td>
158 <td valign="top" align="center">No</td>
159 </tr>
160 <tr>
161 <td valign="top">keep</td>
162 <td valign="top">Sets whether the generated java source file should be kept
163 after compilation. The generated files will have an extension of
164 .java.keep, <b>not</b> .java</td>
165 <td valign="top" align="center">No</td>
166 </tr>
167 <tr>
168 <td valign="top">logo</td>
169 <td valign="top">Whether the compiler text logo is displayed when
170 compiling</td>
171 <td valign="top" align="center">No</td>
172 </tr>
173 <tr>
174 <td valign="top">replace</td>
175 <td valign="top">Whether the generated .java file should be replaced
176 when compiling</td>
177 <td valign="top" align="center">No</td>
178 </tr>
179 <tr>
180 <td valign="top">savelog</td>
181 <td valign="top">Whether the compiler messages will be written to
182 NetRexxC.log as well as to the console</td>
183 <td valign="top" align="center">No</td>
184 </tr>
185 <tr>
186 <td valign="top">sourcedir</td>
187 <td valign="top">Tells the NetRexx compiler to store the class files in the
188 same directory as the source files. The alternative is the working
189 directory</td>
190 <td valign="top" align="center">No</td>
191 </tr>
192 <tr>
193 <td valign="top">srcDir</td>
194 <td valign="top">Set the source dir to find the source NetRexx
195 files</td>
196 <td valign="top" align="center">Yes</td>
197 </tr>
198 <tr>
199 <td valign="top">strictargs</td>
200 <td valign="top">Tells the NetRexx compiler that method calls always
201 need parentheses, even if no arguments are needed, e.g.
202 <code>aStringVar.getBytes</code> vs.
203 <code>aStringVar.getBytes()</code></td>
204 <td valign="top" align="center">No</td>
205 </tr>
206 <tr>
207 <td valign="top">strictassign</td>
208 <td valign="top">Tells the NetRexx compile that assignments must
209 match exactly on type</td>
210 <td valign="top" align="center">No</td>
211 </tr>
212 <tr>
213 <td valign="top">strictcase</td>
214 <td valign="top">Specifies whether the NetRexx compiler should be
215 case sensitive or not</td>
216 <td valign="top" align="center">No</td>
217 </tr>
218 <tr>
219 <td valign="top">strictimport</td>
220 <td valign="top">Whether classes need to be imported explicitly using an
221 <code>import</code> statement. By default the NetRexx compiler will
222 import certain packages automatically</td>
223 <td valign="top" align="center">No</td>
224 </tr>
225 <tr>
226 <td valign="top">strictprops</td>
227 <td valign="top">Whether local properties need to be qualified
228 explicitly using <code>this</code></td>
229 <td valign="top" align="center">No</td>
230 </tr>
231 <tr>
232 <td valign="top">strictsignal</td>
233 <td valign="top">Whether the compiler should force catching of
234 exceptions by explicitly named types</td>
235 <td valign="top" align="center">No</td>
236 </tr>
237 <tr>
238 <td valign="top">symbols</td>
239 <td valign="top">Whether debug symbols should be generated into the
240 class file</td>
241 <td valign="top" align="center">No</td>
242 </tr>
243 <tr>
244 <td valign="top">time</td>
245 <td valign="top">Asks the NetRexx compiler to print compilation
246 times to the console</td>
247 <td valign="top" align="center">No</td>
248 </tr>
249 <tr>
250 <td valign="top">trace</td>
251 <td valign="top">Turns on or off tracing and directs the resultant
252 trace output</td>
253 <td valign="top" align="center">No</td>
254 </tr>
255 <tr>
256 <td valign="top">utf8</td>
257 <td valign="top">Tells the NetRexx compiler that the source is in UTF8</td>
258 <td valign="top" align="center">No</td>
259 </tr>
260 <tr>
261 <td valign="top">verbose</td>
262 <td valign="top">Whether lots of warnings and error messages should
263 be generated</td>
264 <td valign="top" align="center">No</td>
265 </tr>
266 <tr>
267 <td valign="top">suppressMethodArgumentNotUsed</td>
268 <td valign="top">Tells whether we should filter out the
269 &amp;Method argument not used&amp; messages in strictargs mode.</td>
270 <td valign="top" align="center">no</td>
271 </tr>
272 <tr>
273 <td valign="top">suppressPrivatePropertyNotUsed</td>
274 <td valign="top">Tells whether we should filter out the
275 &amp;Private Property defined, but not used&amp; messages in strictargs mode.</td>
276 <td valign="top" align="center">no</td>
277 </tr>
278 <tr>
279 <td valign="top">suppressVariableNotUsed</td>
280 <td valign="top">Tells whether we should filter out the
281 &amp;Variable set but not used&amp; messages in strictargs mode.
282 Please be careful with this one, as you can hide errors behind it!</td>
283 <td valign="top" align="center">no</td>
284 </tr>
285 <tr>
286 <td valign="top">suppressExceptionNotSignalled</td>
287 <td valign="top">Tells whether we should filter out the
288 &amp;Exception is declared, but not signalled within the method&amp;
289 messages in strictsignal mode.</td>
290 <td valign="top" align="center">no</td>
291 </tr>
292 <tr>
293 <td valign="top">suppressDeprecation</td>
294 <td valign="top">Tells wether we should filter out any deprecation-messages
295 of the compiler out.</td>
296 <td valign="top" align="center">no</td>
297 </tr>
298</table>
299<h3>Examples</h3>
300<blockquote>
301 <p><code>&lt;netrexxc srcDir=&quot;/source/project&quot;
302 includes=&quot;vnr/util/*&quot;
303 destDir=&quot;/source/project/build&quot;
304 classpath=&quot;/source/project2/proj.jar&quot;
305 comments=&quot;true&quot;
306 crossref=&quot;false&quot; replace=&quot;true&quot;
307 keep=&quot;true&quot;/&gt;</code>
308 </p>
309</blockquote>
310<hr>
311<p align="center">Copyright &copy; 2000-2002,2004 The Apache Software Foundation. All rights
312Reserved.</p>
313
314</body>
315</html>
316
Note: See TracBrowser for help on using the repository browser.