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