2006-09-11 04:19:00 +00:00
|
|
|
<!--
|
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
|
the License. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
|
limitations under the License.
|
|
|
|
|
-->
|
2003-10-02 00:38:03 +00:00
|
|
|
<html>
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
2005-04-29 18:58:16 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
2003-10-02 00:38:03 +00:00
|
|
|
<title>Scriptdef Task</title>
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
2018-01-22 23:52:21 +01:00
|
|
|
<h2 id="script">Scriptdef</h2>
|
2003-10-02 00:38:03 +00:00
|
|
|
<h3>Description</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p><code>Scriptdef</code> can be used to define an Apache Ant task using a scripting language. Ant
|
|
|
|
|
scripting languages supported by <a href="https://jakarta.apache.org/bsf" target="_top">Apache
|
2018-03-08 07:43:53 +01:00
|
|
|
BSF</a> or <a href="https://jcp.org/aboutJava/communityprocess/maintenance/jsr223/223ChangeLog.html"
|
|
|
|
|
target="_top">JSR 223</a> may be used to define the script. <code>Scriptdef</code> provides a
|
|
|
|
|
mechanism to encapsulate control logic from a build within an Ant task minimizing the need for
|
|
|
|
|
providing control style tasks in Ant itself. Complex logic can be made available while retaining the
|
|
|
|
|
simple structure of an Ant build file. <code>Scriptdef</code> is also useful for prototyping new
|
|
|
|
|
custom tasks. Certainly as the complexity of the script increases it would be better to migrate the
|
|
|
|
|
task definition into a Java based custom task.</p>
|
2018-02-28 07:58:59 +01:00
|
|
|
|
|
|
|
|
<p><strong>Note</strong>: This task depends on external libraries not included in the Ant
|
|
|
|
|
distribution. See <a href="../install.html#librarydependencies">Library Dependencies</a> for more
|
|
|
|
|
information.</p>
|
2006-06-20 21:44:32 +00:00
|
|
|
|
2003-10-02 00:38:03 +00:00
|
|
|
<p>The attributes and nested elements supported by the task may be defined
|
2004-11-19 09:07:12 +00:00
|
|
|
using <code><attribute></code> and <code><element></code> nested elements. These are
|
2018-02-28 07:58:59 +01:00
|
|
|
available to the script that implements the task as two collection style script
|
2018-03-10 20:17:33 +01:00
|
|
|
variables <code class="code">attributes</code> and <code class="code">elements</code>. The elements
|
|
|
|
|
in the <code class="code">attributes</code> collection may be accessed by the attribute
|
|
|
|
|
name. The <code class="code">elements</code> collection is accessed by the nested element name. This
|
|
|
|
|
will return a list of all instances of the nested element. The instances in this list may be
|
|
|
|
|
accessed by an integer index.</p>
|
2018-02-28 07:58:59 +01:00
|
|
|
|
|
|
|
|
<p><strong>Note</strong>: Ant will turn all attribute and element names into all lowercase names, so
|
|
|
|
|
even if you use <var>name</var>=<q>SomeAttribute</q>, you'll have to use <q>someattribute</q> to
|
2018-03-10 20:17:33 +01:00
|
|
|
retrieve the attribute's value from the <code class="code">attributes</code> collection.</p>
|
2018-02-28 07:58:59 +01:00
|
|
|
|
2018-03-10 20:17:33 +01:00
|
|
|
<p>The name <code class="code">self</code> (<em>since Ant 1.6.3</em>) is a pre-defined reference to
|
2018-02-28 07:58:59 +01:00
|
|
|
the <code>scriptdef</code> task instance. It can be used for logging, or for integration with the
|
2018-03-10 20:17:33 +01:00
|
|
|
rest of Ant. The <code class="code">self.text</code> attribute contains any nested text passed to
|
|
|
|
|
the script</p>
|
2018-02-28 07:58:59 +01:00
|
|
|
|
2018-03-10 20:17:33 +01:00
|
|
|
<p>If an attribute or element is not passed in, then <code class="code">attributes.get()</code>
|
|
|
|
|
or <code class="code">elements.get()</code> will return null. It is up to the script to perform any
|
|
|
|
|
checks and validation. <code class="code">self.fail(String message)</code>can be used to raise
|
2018-02-28 07:58:59 +01:00
|
|
|
a <code>BuildException</code>.</p>
|
|
|
|
|
|
2018-03-10 20:17:33 +01:00
|
|
|
<p>The name <code class="code">project</code> is a pre-defined reference to the Ant Project. For
|
|
|
|
|
more information on writing scripts, please refer to
|
|
|
|
|
the <a href="script.html"><code><script></code></a> task.</p>
|
2004-07-07 08:32:02 +00:00
|
|
|
|
2003-10-02 00:38:03 +00:00
|
|
|
<h3>Parameters</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2003-10-02 00:38:03 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
2003-10-02 00:38:03 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>name</td>
|
|
|
|
|
<td>the name of the task to be created using the script</td>
|
|
|
|
|
<td>Yes</td>
|
2003-10-02 00:38:03 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>language</td>
|
|
|
|
|
<td>The programming language the script is written in. Must be a supported Apache BSF or JSR
|
|
|
|
|
223 language</td>
|
|
|
|
|
<td>Yes</td>
|
2003-10-02 00:38:03 +00:00
|
|
|
</tr>
|
2006-12-12 21:47:56 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>manager</td>
|
|
|
|
|
<td>The script engine manager to use. See the <a href="../Tasks/script.html">script</a> task
|
|
|
|
|
for using this attribute.</td>
|
|
|
|
|
<td>No; default is <q>auto</q></td>
|
2006-12-12 21:47:56 +00:00
|
|
|
</tr>
|
2003-10-02 00:38:03 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>src</td>
|
|
|
|
|
<td>The location of the script as a file, if not inline</td>
|
|
|
|
|
<td>No</td>
|
2003-10-02 00:38:03 +00:00
|
|
|
</tr>
|
Enhanced JavaxScriptRunner, Junit, docs, Javadoc
JavaxScriptRunner:
- Better compiled script reference name to avoid reference name
collision, project wide : execName + ".compiled." +
getScript().hashCode() + "." + getProject().hashCode();
ScriptDef:
- Fixed Javadoc + use of 3rd person
[(oracle style
guideline)](http://www.oracle.com/technetwork/articles/java/index-137868.html#styleguide)
Task manual: documentation for `encoding` and `compiled` options.
- `encoding` : script.html, scriptdef.html, conditions.html,
selectors.html, mapper.html, filterchain.html
- `compiled` : scriptdef.html
Added source file `encoding` option on:
- org.apache.tools.ant.taskdefs.optional.Script
- org.apache.tools.ant.types.optional.AbstractScriptComponent
(inherited by ScriptCondition, ScriptMapper)
- org.apache.tools.ant.types.optional.ScriptFilter
- org.apache.tools.ant.types.optional.ScriptSelector
Test units :
- org.apache.tools.ant.taskdefs.optional.script.ScriptDefTest,
script.xml : src + encoding
- org.apache.tools.ant.taskdefs.optional.RhinoScriptDefTest,
scriptdef.xml : src + encoding, compiled
- new file: src/etc/testcases/taskdefs/optional/script/heavy-script.js
2017-01-20 16:33:35 +01:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>encoding</td>
|
|
|
|
|
<td>The encoding of the script as a file. <em>since Ant 1.10.2</em>.</td>
|
|
|
|
|
<td>No; defaults to default JVM character encoding</td>
|
Enhanced JavaxScriptRunner, Junit, docs, Javadoc
JavaxScriptRunner:
- Better compiled script reference name to avoid reference name
collision, project wide : execName + ".compiled." +
getScript().hashCode() + "." + getProject().hashCode();
ScriptDef:
- Fixed Javadoc + use of 3rd person
[(oracle style
guideline)](http://www.oracle.com/technetwork/articles/java/index-137868.html#styleguide)
Task manual: documentation for `encoding` and `compiled` options.
- `encoding` : script.html, scriptdef.html, conditions.html,
selectors.html, mapper.html, filterchain.html
- `compiled` : scriptdef.html
Added source file `encoding` option on:
- org.apache.tools.ant.taskdefs.optional.Script
- org.apache.tools.ant.types.optional.AbstractScriptComponent
(inherited by ScriptCondition, ScriptMapper)
- org.apache.tools.ant.types.optional.ScriptFilter
- org.apache.tools.ant.types.optional.ScriptSelector
Test units :
- org.apache.tools.ant.taskdefs.optional.script.ScriptDefTest,
script.xml : src + encoding
- org.apache.tools.ant.taskdefs.optional.RhinoScriptDefTest,
scriptdef.xml : src + encoding, compiled
- new file: src/etc/testcases/taskdefs/optional/script/heavy-script.js
2017-01-20 16:33:35 +01:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>compiled</td>
|
|
|
|
|
<td>If true, the script is compiled before the first evaluation for faster multiple executions,
|
|
|
|
|
on the condition that the <var>manager</var> is <q>javax</q> and the target engine
|
|
|
|
|
implements <code>javax.script.Compilable</code>. Note that the <q>bsf</q> manager may
|
|
|
|
|
automatically compile the script. <em>since Ant 1.10.2</em>.</td>
|
|
|
|
|
<td>No; defaults to <q>false</q></td>
|
Enhanced JavaxScriptRunner, Junit, docs, Javadoc
JavaxScriptRunner:
- Better compiled script reference name to avoid reference name
collision, project wide : execName + ".compiled." +
getScript().hashCode() + "." + getProject().hashCode();
ScriptDef:
- Fixed Javadoc + use of 3rd person
[(oracle style
guideline)](http://www.oracle.com/technetwork/articles/java/index-137868.html#styleguide)
Task manual: documentation for `encoding` and `compiled` options.
- `encoding` : script.html, scriptdef.html, conditions.html,
selectors.html, mapper.html, filterchain.html
- `compiled` : scriptdef.html
Added source file `encoding` option on:
- org.apache.tools.ant.taskdefs.optional.Script
- org.apache.tools.ant.types.optional.AbstractScriptComponent
(inherited by ScriptCondition, ScriptMapper)
- org.apache.tools.ant.types.optional.ScriptFilter
- org.apache.tools.ant.types.optional.ScriptSelector
Test units :
- org.apache.tools.ant.taskdefs.optional.script.ScriptDefTest,
script.xml : src + encoding
- org.apache.tools.ant.taskdefs.optional.RhinoScriptDefTest,
scriptdef.xml : src + encoding, compiled
- new file: src/etc/testcases/taskdefs/optional/script/heavy-script.js
2017-01-20 16:33:35 +01:00
|
|
|
</tr>
|
2005-03-07 12:21:43 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>uri</td>
|
|
|
|
|
<td>The XML namespace uri that this definition should live in.</td>
|
|
|
|
|
<td>No</td>
|
2005-03-07 12:21:43 +00:00
|
|
|
</tr>
|
2006-12-12 21:47:56 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>classpath</td>
|
|
|
|
|
<td>The classpath to pass into the script.</td>
|
|
|
|
|
<td>No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>classpathref</td>
|
|
|
|
|
<td>The classpath to use, given as a <a href="../using.html#references">reference</a> to a path
|
|
|
|
|
defined elsewhere.
|
|
|
|
|
<td>No</td>
|
2006-12-12 21:47:56 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>loaderRef</td>
|
|
|
|
|
<td>the name of the loader that is used to load the script, constructed from the specified
|
|
|
|
|
classpath. This allows multiple script definitions to reuse the same class loader.
|
|
|
|
|
</td>
|
|
|
|
|
<td>No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
2003-10-02 00:38:03 +00:00
|
|
|
|
2018-03-05 17:35:30 +01:00
|
|
|
<h3>Parameters specified as nested elements</h3>
|
2003-10-02 00:38:03 +00:00
|
|
|
<h4>attribute</h4>
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2003-10-02 00:38:03 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
2003-10-02 00:38:03 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>name</td>
|
|
|
|
|
<td>the name of the attribute</td>
|
|
|
|
|
<td>Yes</td>
|
2003-10-02 00:38:03 +00:00
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<h4>element</h4>
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2003-10-02 00:38:03 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
2003-10-02 00:38:03 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>name</td>
|
|
|
|
|
<td>the name of the nested element to be supported by the task defined by the script</td>
|
|
|
|
|
<td>Yes</td>
|
2003-10-02 00:38:03 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>classname</td>
|
|
|
|
|
<td>the classname of the class to be used for the nested element. This specifies the class
|
|
|
|
|
directly and is an alternative to specifying the Ant type name.</td>
|
|
|
|
|
<td>No</td>
|
2003-10-02 00:38:03 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>type</td>
|
|
|
|
|
<td>This is the name of an Ant task or type which is to be used when this element is to be
|
|
|
|
|
created. This is an alternative to specifying the class name directly. If the type is in a
|
|
|
|
|
namespace, the URI and a <q>:</q> must be prefixed to the type. For
|
|
|
|
|
example <var>type</var>=<q>antlib:example.org:newtype</q></td>
|
|
|
|
|
<td>No</td>
|
2003-10-02 00:38:03 +00:00
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<h4>classpath</h4>
|
|
|
|
|
<p>See the <a href="../Tasks/script.html">script</a> task for using this nested element.</p>
|
2007-04-27 14:37:56 +00:00
|
|
|
|
2018-03-04 22:42:01 +01:00
|
|
|
<h4>any resource collection</h4>
|
|
|
|
|
<p><em>Since Ant 1.7.1</em></p>
|
|
|
|
|
<p>This task can load scripts from any resource supplied as a nested element.</p>
|
|
|
|
|
|
2003-10-02 00:38:03 +00:00
|
|
|
<h3>Examples</h3>
|
|
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>The following definition creates a task which supports an attribute called <var>attr</var> and
|
|
|
|
|
two nested elements, one being a fileset and the other a path. When executed, the resulting task
|
|
|
|
|
logs the value of the attribute and the <var>basedir</var> of the first fileset.</p>
|
2003-10-02 00:38:03 +00:00
|
|
|
|
|
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<scriptdef name="scripttest" language="javascript">
|
|
|
|
|
<attribute name="attr1"/>
|
|
|
|
|
<element name="fileset" type="fileset"/>
|
|
|
|
|
<element name="path" type="path"/>
|
|
|
|
|
<![CDATA[
|
|
|
|
|
|
|
|
|
|
self.log("Hello from script");
|
|
|
|
|
self.log("Attribute attr1 = " + attributes.get("attr1"));
|
|
|
|
|
self.log("First fileset basedir = "
|
|
|
|
|
+ elements.get("fileset").get(0).getDir(project));
|
|
|
|
|
|
|
|
|
|
]]>
|
|
|
|
|
</scriptdef>
|
|
|
|
|
|
|
|
|
|
<scripttest attr1="test">
|
|
|
|
|
<path>
|
|
|
|
|
<pathelement location="src"/>
|
|
|
|
|
</path>
|
|
|
|
|
<fileset dir="src"/>
|
|
|
|
|
<fileset dir="main"/>
|
|
|
|
|
</scripttest></pre>
|
|
|
|
|
|
|
|
|
|
<p>The following variation on the above script lists the number of fileset elements and iterates
|
|
|
|
|
through them</p>
|
2003-10-02 00:38:03 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<scriptdef name="scripttest2" language="javascript">
|
|
|
|
|
<element name="fileset" type="fileset"/>
|
|
|
|
|
<![CDATA[
|
|
|
|
|
filesets = elements.get("fileset");
|
|
|
|
|
self.log("Number of filesets = " + filesets.size());
|
|
|
|
|
for (i = 0; i < filesets.size(); ++i) {
|
|
|
|
|
self.log("fileset " + i + " basedir = "
|
|
|
|
|
+ filesets.get(i).getDir(project));
|
|
|
|
|
}
|
|
|
|
|
]]>
|
|
|
|
|
</scriptdef>
|
|
|
|
|
|
|
|
|
|
<scripttest2>
|
|
|
|
|
<fileset dir="src"/>
|
|
|
|
|
<fileset dir="main"/>
|
|
|
|
|
</scripttest2></pre>
|
|
|
|
|
|
|
|
|
|
<p>When a script has a syntax error, the <code>scriptdef</code> name will be listed in the
|
|
|
|
|
error. For example in the above script, removing the closing curly bracket would result in this
|
|
|
|
|
error</p>
|
2003-10-02 00:38:03 +00:00
|
|
|
|
2018-03-10 20:17:33 +01:00
|
|
|
<pre class="output">build.xml:15: SyntaxError: missing } in compound
|
|
|
|
|
statement (scriptdef <scripttest2>; line 10)</pre>
|
2003-10-02 00:38:03 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Script errors are only detected when a <code>script</code> task is actually executed.</p>
|
|
|
|
|
<p>The next example does uses nested text in Jython. It also declares the script in a new xml
|
|
|
|
|
namespace, which must be used to refer to the task. Declaring scripts in a new namespace guarantees
|
|
|
|
|
that Ant will not create a task of the same (namespace,localname) name pair.</p>
|
2006-06-20 21:44:32 +00:00
|
|
|
|
|
|
|
|
<pre>
|
2006-12-12 21:47:56 +00:00
|
|
|
<target name="echo-task-jython">
|
2006-06-20 21:44:32 +00:00
|
|
|
<scriptdef language="jython"
|
2018-02-28 07:58:59 +01:00
|
|
|
name="echo"
|
|
|
|
|
uri="http://example.org/script">
|
2006-06-20 21:44:32 +00:00
|
|
|
<![CDATA[
|
|
|
|
|
self.log("text: " +self.text)
|
2018-02-28 07:58:59 +01:00
|
|
|
]]>
|
2006-06-20 21:44:32 +00:00
|
|
|
</scriptdef>
|
|
|
|
|
</target>
|
|
|
|
|
|
|
|
|
|
<target name="testEcho" depends="echo-task-jython"
|
2018-02-28 07:58:59 +01:00
|
|
|
xmlns:s="http://example.org/script">
|
2006-06-20 21:44:32 +00:00
|
|
|
<s:echo>nested text</s:echo>
|
2018-02-28 07:58:59 +01:00
|
|
|
</target></pre>
|
2006-06-20 21:44:32 +00:00
|
|
|
|
2018-05-15 09:51:58 +02:00
|
|
|
<p>The next example shows the use of <code><classpath></code> and <var>loaderref</var> to get
|
|
|
|
|
access to the beanshell jar.</p>
|
2006-12-12 21:47:56 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<scriptdef name="b1" language="beanshell"
|
|
|
|
|
loaderref="beanshell-ref">
|
|
|
|
|
<attribute name="a"/>
|
|
|
|
|
<classpath path="${user.home}/scripting/beanshell/bsh-1.3b1.jar"/>
|
|
|
|
|
self.log("attribute a is " + attributes.get("a"));
|
|
|
|
|
</scriptdef>
|
|
|
|
|
|
|
|
|
|
<scriptdef name="b2" language="beanshell"
|
|
|
|
|
loaderref="beanshell-ref">
|
|
|
|
|
<attribute name="a2"/>
|
|
|
|
|
self.log("attribute a2 is " + attributes.get("a2"));
|
|
|
|
|
</scriptdef>
|
|
|
|
|
|
|
|
|
|
<b1 a="this is an 'a'"/>
|
|
|
|
|
<b2 a2="this is an 'a2' for b2"/></pre>
|
2006-12-12 21:47:56 +00:00
|
|
|
|
2018-03-05 21:01:42 +01:00
|
|
|
<h3>Testing scripts</h3>
|
2006-06-20 21:44:32 +00:00
|
|
|
|
2018-03-08 07:43:53 +01:00
|
|
|
<p>The easiest way to test scripts is to use the <a href="https://ant.apache.org/antlibs/antunit/"
|
|
|
|
|
target="_top">AntUnit</a> Ant library. This will run all targets in a script that begin
|
|
|
|
|
with <q>test</q> (and their dependencies).</p>
|
2003-10-02 00:38:03 +00:00
|
|
|
|
|
|
|
|
</body>
|
2004-07-07 08:32:02 +00:00
|
|
|
</html>
|
