Apache/ant
1
0
Fork 0
mirror of https://github.com/apache/ant.git synced 2025-05-18 22:14:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
ant/docs/manual/OptionalTasks/netrexxc.html
Stefan Bodewig b6a3e9df36 License police on documentation files: 
(1) Make sure there is a Copyright notice on all visible files.

(2) Make sure all years in which the file has been modified are
listed.

(3) Make sure the format is consistent, i.e. separate consecutive
years with a dash, not a comma.

When Stephane changed starteam.html it has been 2001 in France but
2002 in Australia - does that mean we add 2002 to the Copyright line
or not?  ;-)


git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@270652 13f79535-47bb-0310-9956-ffa450edef68
2002-01-10 08:48:33 +00:00

278 lines
9.9 KiB
HTML
Raw Blame History

<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<title>Apache Ant User Manual</title>
</head>
<body>
<h2><a name="netrexxc">NetRexxC</a></h2>
<h3>Description</h3>
<p>Compiles a <a href="http://www2.hursley.ibm.com/netrexx" target="_top">NetRexx</a>
source tree within the running (Ant) VM.</p>
<p>The source and destination directory will be recursively scanned for
NetRexx source files to compile. Only NetRexx files that have no corresponding
class file or where the class file is older than the java file will be compiled.</p>
<p>Files in the source tree are copied to the destination directory,
allowing support files to be located properly in the classpath. The source
files are copied because the NetRexx compiler cannot produce class files in a
specific directory via parameters</p>
<p>The directory structure of the source tree should follow the package
hierarchy.</p>
<p>It is possible to refine the set of files that are being compiled/copied.
This can be done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and
<i>defaultexcludes</i> attributes. With the <i>includes</i> or <i>includesfile</i> attribute you
specify the files you want to have included by using patterns. The
<i>exclude</i> or <i>excludesfile</i> attribute is used to specify the files you want to have
excluded. This is also done with patterns. And finally with the
<i>defaultexcludes</i> attribute, you can specify whether you
want to use default exclusions or not. See the section on <a
href="../dirtasks.html#directorybasedtasks">directory based tasks</a>, on how the
inclusion/exclusion of files works, and how to write patterns.</p>
<p>This task forms an implicit <a href="../CoreTypes/fileset.html">FileSet</a> and
supports all attributes of <code>&lt;fileset&gt;</code>
(<code>dir</code> becomes <code>srcdir</code>) as well as the nested
<code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and
<code>&lt;patternset&gt;</code> elements.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">binary</td>
<td valign="top">Whether literals are treated as the java binary
type rather than the NetRexx types</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">classpath</td>
<td valign="top">The classpath to use during compilation</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">comments</td>
<td valign="top">Whether comments are passed through to the
generated java source</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">compact</td>
<td valign="top">Whether error messages come out in compact or
verbose format</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">compile</td>
<td valign="top">Whether the NetRexx compiler should compile the
generated java code</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">console</td>
<td valign="top">Whether or not messages should be displayed on the
'console'</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">crossref</td>
<td valign="top">Whether variable cross references are generated</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">decimal</td>
<td valign="top">Whether decimal arithmetic should be used for the
NetRexx code</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">defaultexcludes</td>
<td valign="top">indicates whether default excludes should be used or not
(&quot;yes&quot;/&quot;no&quot;). Default excludes are used when
omitted.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">destDir</td>
<td valign="top">the destination directory into which the NetRexx
source files should be copied and then compiled</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">diag</td>
<td valign="top">Whether diagnostic information about the compile is
generated</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">excludes</td>
<td valign="top">comma separated list of patterns of files that must be
excluded. No files (except default excludes) are excluded when
omitted.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">excludesfile</td>
<td valign="top">the name of a file. Each line of this file is
taken to be an exclude pattern</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">explicit</td>
<td valign="top">Whether variables must be declared explicitly
before use</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">format</td>
<td valign="top">Whether the generated java code is formatted nicely
or left to match NetRexx line numbers for call stack debugging</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">includes</td>
<td valign="top">comma separated list of patterns of files that must be
included. All files are included when omitted.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">includesfile</td>
<td valign="top">the name of a file. Each line of this file is
taken to be an include pattern</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">java</td>
<td valign="top">Whether the generated java code is produced</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">keep</td>
<td valign="top">Sets whether the generated java source file should be kept
after compilation. The generated files will have an extension of
.java.keep, <b>not</b> .java</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">logo</td>
<td valign="top">Whether the compiler text logo is displayed when
compiling</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">replace</td>
<td valign="top">Whether the generated .java file should be replaced
when compiling</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">savelog</td>
<td valign="top">Whether the compiler messages will be written to
NetRexxC.log as well as to the console</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">sourcedir</td>
<td valign="top">Tells the NetRexx compiler to store the class files in the
same directory as the source files. The alternative is the working
directory</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">srcDir</td>
<td valign="top">Set the source dir to find the source NetRexx
files</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">strictargs</td>
<td valign="top">Tells the NetRexx compiler that method calls always
need parentheses, even if no arguments are needed, e.g.
<code>aStringVar.getBytes</code> vs.
<code>aStringVar.getBytes()</code></td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">strictassign</td>
<td valign="top">Tells the NetRexx compile that assignments must
match exactly on type</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">strictcase</td>
<td valign="top">Specifies whether the NetRexx compiler should be
case sensitive or not</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">strictimport</td>
<td valign="top">Whether classes need to be imported explicitly using an
<code>import</code> statement. By default the NetRexx compiler will
import certain packages automatically</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">strictprops</td>
<td valign="top">Whether local properties need to be qualified
explicitly using <code>this</code></td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">strictsignal</td>
<td valign="top">Whether the compiler should force catching of
exceptions by explicitly named types</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">symbols</td>
<td valign="top">Whether debug symbols should be generated into the
class file</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">time</td>
<td valign="top">Asks the NetRexx compiler to print compilation
times to the console</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">trace</td>
<td valign="top">Turns on or off tracing and directs the resultant
trace output</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">utf8</td>
<td valign="top">Tells the NetRexx compiler that the source is in UTF8</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td valign="top">Whether lots of warnings and error messages should
be generated</td>
<td valign="top" align="center">Yes</td>
</tr>
</table>
<h3>Examples</h3>
<blockquote>
<p><code>&lt;netrexxc srcDir=&quot;/source/project&quot;
includes=&quot;vnr/util/*&quot;
destDir=&quot;/source/project/build&quot;
classpath=&quot;/source/project2/proj.jar&quot;
comments=&quot;true&quot;
crossref=&quot;false&quot; replace=&quot;true&quot;
keep=&quot;true&quot;/&gt;</code>
</p>
</blockquote>
<hr>
<p align="center">Copyright &copy; 2001 Apache Software Foundation. All rights
Reserved.</p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink