mirror of
https://github.com/apache/ant.git
synced 2025-05-18 14:04:48 +00:00
6aba7c5074
use of DynamicConfigurator. Fix the doc and the code to at least make this consistent. PR: 25687 Obtained from: Geoffrey Wiseman git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@275830 13f79535-47bb-0310-9956-ffa450edef68
190 lines
5.8 KiB
HTML
190 lines
5.8 KiB
HTML
<html>
|
|
|
|
<head>
|
|
<meta http-equiv="Content-Language" content="en-us"></meta>
|
|
<title>MacroDef Task</title>
|
|
<style type="text/css">
|
|
<!--
|
|
.code { background: #EFEFEF; margin-top: }
|
|
-->
|
|
</style>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<h2><a name="macrodef">MacroDef</a></h2>
|
|
<h3>Description</h3>
|
|
<p>
|
|
This defines a new task using a <sequential>
|
|
nested task as a template. Nested elements <attribute> and
|
|
<element> are used to specify attributes and elements of
|
|
the new task. These get substituted into the <sequential>
|
|
task when the new task is run.
|
|
</p>
|
|
<p>
|
|
<em>since Ant 1.6</em>
|
|
</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">name</td>
|
|
<td valign="top">The name of the new definition</td>
|
|
<td valign="top" align="center">Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">uri</td>
|
|
<td valign="top">
|
|
The uri that this definition should live in.
|
|
</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
</table>
|
|
<h3>Parameters specified as nested elements</h3>
|
|
<h4>attribute</h4>
|
|
<p>
|
|
This is used to specify attributes of the new task. The values
|
|
of the attributes get substituted into the templated task.
|
|
The attributes will be required attributes unless a default
|
|
value has been set.
|
|
</p>
|
|
<p>
|
|
This attribute is placed in the body of the templated
|
|
task using a notation similar to the ant property notation
|
|
- @{attribute name}. (May be remembered as "put the substitution
|
|
AT this location").
|
|
The escape sequence @@{x} is used to allow @{x} to be
|
|
placed in the text without substitution of x.
|
|
This corresponds to the $${x} escape sequence for properties.
|
|
</p>
|
|
<p>
|
|
The case of the attribute is ignored, so @{myAttribute} is treated the
|
|
same as @{MyAttribute}.
|
|
</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">name</td>
|
|
<td valign="top">The name of the new attribute</td>
|
|
<td valign="top" align="center">Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">default</td>
|
|
<td valign="top">
|
|
The default value of the attribute.
|
|
</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
</table>
|
|
<h4>element</h4>
|
|
<p>
|
|
This is used to specify nested elements of the new task.
|
|
The contents of the nested elements of the task instance
|
|
are placed in the templated task at the tag name.
|
|
</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">name</td>
|
|
<td valign="top">The name of the new attribute</td>
|
|
<td valign="top" align="center">Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">optional</td>
|
|
<td valign="top">
|
|
If true this nested element is optional. Default is
|
|
false - i.e the nested element is required in
|
|
the new task.
|
|
</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Examples</h3>
|
|
<p>
|
|
The following example defined a task called testing and
|
|
runs it.
|
|
</p>
|
|
<blockquote>
|
|
<pre class=code>
|
|
<macrodef name="testing">
|
|
<attribute name="v" default="NOT SET"/>
|
|
<element name="some-tasks" optional="yes"/>
|
|
<sequential>
|
|
<echo>v is @{v}</echo>
|
|
<some-tasks/>
|
|
</sequential>
|
|
</macrodef>
|
|
|
|
<testing v="This is v">
|
|
<some-tasks>
|
|
<echo>this is a test</echo>
|
|
</some-tasks>
|
|
</testing>
|
|
</pre>
|
|
</blockquote>
|
|
<p>
|
|
The following fragment defines a task called <call-cc> which
|
|
take the attributes "target", "link" and "target.dir" and the
|
|
nested element "cc-elements". The body of the task
|
|
uses the <cc> task from the
|
|
<a href="http://ant-contrib.sourceforge.net/">ant-contrib</a> project.
|
|
</p>
|
|
<blockquote>
|
|
<pre class="code">
|
|
<macrodef name="call-cc">
|
|
<attribute name="target"/>
|
|
<attribute name="link"/>
|
|
<attribute name="target.dir"/>
|
|
<element name="cc-elements"/>
|
|
<sequential>
|
|
<mkdir dir="${obj.dir}/@{target}"/>
|
|
<mkdir dir="@{target.dir}"/>
|
|
<cc link="@{link}" objdir="${obj.dir}/@{target}"
|
|
outfile="@{target.dir}/@{target}">
|
|
<compiler refid="compiler.options"/>
|
|
<cc-elements/>
|
|
</cc>
|
|
</sequential>
|
|
</macrodef>
|
|
</pre>
|
|
</blockquote>
|
|
<p>
|
|
This then can be used as follows:
|
|
</p>
|
|
<blockquote>
|
|
<pre class="code">
|
|
<call-cc target="unittests" link="executable"
|
|
target.dir="${build.bin.dir}">
|
|
<cc-elements>
|
|
<includepath location="${gen.dir}"/>
|
|
<includepath location="test"/>
|
|
<fileset dir="test/unittest" includes = "**/*.cpp"/>
|
|
<fileset dir="${gen.dir}" includes = "*.cpp"/>
|
|
<linker refid="linker-libs"/>
|
|
</cc-elements>
|
|
</call-cc>
|
|
</pre>
|
|
</blockquote>
|
|
<hr>
|
|
<p align="center">Copyright © 2003 Apache Software
|
|
Foundation. All rights Reserved.</p>
|
|
|
|
</body>
|
|
</html>
|
|
|