From c2e92b31856632faa104d9d1a93c7e1480aa8b92 Mon Sep 17 00:00:00 2001 From: Stefan Bodewig Date: Wed, 1 Aug 2001 09:08:56 +0000 Subject: [PATCH] Add / elements to and friends, thus allowing for more than one file of each type. Submitted by: Mark Womack Add pointer to "Directory Based Tasks" in the documentation of patternsets where patterns are actually defined. git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@269419 13f79535-47bb-0310-9956-ffa450edef68 --- WHATSNEW | 4 + docs/manual/CoreTypes/fileset.html | 11 +- docs/manual/CoreTypes/patternset.html | 61 +++++++--- docs/manual/dirtasks.html | 2 +- .../tools/ant/taskdefs/MatchingTask.java | 14 +++ .../org/apache/tools/ant/types/FileSet.java | 20 ++++ .../apache/tools/ant/types/PatternSet.java | 107 +++++++++++------- .../apache/tools/ant/types/FileSetTest.java | 14 +++ .../tools/ant/types/PatternSetTest.java | 14 +++ 9 files changed, 185 insertions(+), 62 deletions(-) diff --git a/WHATSNEW b/WHATSNEW index 622073e6c..96324cebc 100644 --- a/WHATSNEW +++ b/WHATSNEW @@ -131,6 +131,10 @@ Other changes: defaults to true. If set to false, files that are newer than the files in the archive will not be replaced. +* and now support nested + elements - using these you can have more than one in/excludes file + per . + Fixed bugs: ----------- diff --git a/docs/manual/CoreTypes/fileset.html b/docs/manual/CoreTypes/fileset.html index 934c088b3..91bafd598 100644 --- a/docs/manual/CoreTypes/fileset.html +++ b/docs/manual/CoreTypes/fileset.html @@ -15,11 +15,12 @@ href="patternset.html">PatternSets. FileSets can appear inside tasks that support this feature or at the same level as target - i.e., as children of project.

PatternSets can be specified as nested -<patternset> -elements. In addition, FileSet holds an implicit PatternSet and -supports the nested <include> and -<exclude> elements of PatternSet directly, as well -as PatternSet's attributes.

+<patternset> elements. In addition, FileSet holds +an implicit PatternSet and supports the nested +<include>, <includesfile>, +<exclude> and <excludesfile> +elements of PatternSet directly, as well as PatternSet's +attributes.

diff --git a/docs/manual/CoreTypes/patternset.html b/docs/manual/CoreTypes/patternset.html index 491a62f08..2f49b61fa 100644 --- a/docs/manual/CoreTypes/patternset.html +++ b/docs/manual/CoreTypes/patternset.html @@ -8,15 +8,17 @@

PatternSet

-

Patterns can be grouped to sets and later be referenced by their -id -attribute. They are defined via a patternset element, -which can appear nested into a FileSet or a -directory-based task that constitutes an implicit FileSet. In addition, -patternsets can be defined at the same level as -target — i.e., as children of project.

-

Patterns can be specified by nested <include> or -<exclude> elements or the following attributes.

+

Patterns can be grouped to +sets and later be referenced by their id attribute. They +are defined via a patternset element, which can appear +nested into a FileSet or a directory-based +task that constitutes an implicit FileSet. In addition, +patternsets can be defined as a stand alone element at +the same level as target — i.e., as children of +project as well as as children of +target.

Patterns can be specified by nested +<include>, or <exclude> elements +or the following attributes.

Attribute
@@ -30,7 +32,8 @@ directory-based task that constitutes an implicit FileSet. In addition, + taken to be an include pattern. You can specify more than one + include file by using a nested includesfile elements. @@ -40,7 +43,8 @@ directory-based task that constitutes an implicit FileSet. In addition, + taken to be an exclude pattern. You can specify more than one + exclude file by using a nested excludesfile elements.
Attribute
includesfile the name of a file; each line of this file is - taken to be an include pattern.
excludes
excludesfile the name of a file; each line of this file is - taken to be an exclude pattern.
@@ -61,9 +65,9 @@ by tasks that support this feature, or by FileSets.

multiple elements separated by commas or spaces, the nested <include> and <exclude> elements expect their name attribute to hold a single pattern.

-

The nested <include> and <exclude> elements allow you to use -if and unless arguments to specify that the element should only be used if a -property is set, or that it should be used only if a property is not set.

+

The nested elements allow you to use if and unless arguments to +specify that the element should only be used if a property is set, or +that it should be used only if a property is not set.

For example

 <patternset id="sources" >
@@ -74,7 +78,34 @@ property is set, or that it should be used only if a property is not set.

will only include the files in the sub-directory prof if the property professional is set to some value.

- +

If you want to list the files to include or exclude external to +your build file, you should use the includesfile/excludesfile +attributes or elements. Using the attribute, you can only specify a +single file of each type, while the nested elements can be specified +more than once - the nested elements also support if/unless attributes +you can use to test the existance of a property. For example:

+
+<patternset includesfile="some-file" />
+
+

and

+
+<patternset>
+  <includesfile name="some-file" /> 
+<patternset/>
+
+

are identical. The include patterns will be read from the file +some-file, one pattern per line.

+
+<patternset>
+  <includesfile name="some-file" /> 
+  <includesfile name="${some-other-file}" 
+                if="some-other-file"
+  /> 
+<patternset/>
+
+

will also read include patterns from the file the property +some-other-file points to, if a property of that name has +been defined.

Copyright © 2000,2001 Apache Software Foundation. All rights Reserved.

diff --git a/docs/manual/dirtasks.html b/docs/manual/dirtasks.html index fd3baf87f..053f8ee37 100644 --- a/docs/manual/dirtasks.html +++ b/docs/manual/dirtasks.html @@ -28,7 +28,7 @@ the include patterns, and don't match the exclude patterns, are used.

nested elements and via external files. Each line of the external file is taken as a pattern that is added to the list of include or exclude patterns.

-

Patterns

+

Patterns

As described earlier, patterns are used for the inclusion and exclusion. These patterns look very much like the patterns used in DOS and UNIX:

'*' matches zero or more characters, '?' matches one character.

diff --git a/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java b/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java index 08da31073..126c7a123 100644 --- a/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java @@ -83,6 +83,13 @@ public abstract class MatchingTask extends Task { return fileset.createInclude(); } + /** + * add a name entry on the include files list + */ + public PatternSet.NameEntry createIncludesFile() { + return fileset.createIncludesFile(); + } + /** * add a name entry on the exclude list */ @@ -90,6 +97,13 @@ public abstract class MatchingTask extends Task { return fileset.createExclude(); } + /** + * add a name entry on the include files list + */ + public PatternSet.NameEntry createExcludesFile() { + return fileset.createExcludesFile(); + } + /** * add a set of patterns */ diff --git a/src/main/org/apache/tools/ant/types/FileSet.java b/src/main/org/apache/tools/ant/types/FileSet.java index 4d6aee690..85868e419 100644 --- a/src/main/org/apache/tools/ant/types/FileSet.java +++ b/src/main/org/apache/tools/ant/types/FileSet.java @@ -145,6 +145,16 @@ public class FileSet extends DataType { return defaultPatterns.createInclude(); } + /** + * add a name entry on the include files list + */ + public PatternSet.NameEntry createIncludesFile() { + if (isReference()) { + throw noChildrenAllowed(); + } + return defaultPatterns.createIncludesFile(); + } + /** * add a name entry on the exclude list */ @@ -155,6 +165,16 @@ public class FileSet extends DataType { return defaultPatterns.createExclude(); } + /** + * add a name entry on the include files list + */ + public PatternSet.NameEntry createExcludesFile() { + if (isReference()) { + throw noChildrenAllowed(); + } + return defaultPatterns.createExcludesFile(); + } + /** * Sets the set of include patterns. Patterns may be separated by a comma * or a space. diff --git a/src/main/org/apache/tools/ant/types/PatternSet.java b/src/main/org/apache/tools/ant/types/PatternSet.java index 59e68e9a9..1a29f99d1 100644 --- a/src/main/org/apache/tools/ant/types/PatternSet.java +++ b/src/main/org/apache/tools/ant/types/PatternSet.java @@ -79,9 +79,8 @@ import java.util.Vector; public class PatternSet extends DataType { private Vector includeList = new Vector(); private Vector excludeList = new Vector(); - - private File incl = null; - private File excl = null; + private Vector includesFileList = new Vector(); + private Vector excludesFileList = new Vector(); /** * inner class to hold a name on list. "If" and "Unless" attributes @@ -122,23 +121,18 @@ public class PatternSet extends DataType { return true; } - public String toString() - { - StringBuffer buf = new StringBuffer(); - buf.append( name ); - if ((ifCond != null) || (unlessCond != null)) - { + public String toString() { + StringBuffer buf = new StringBuffer(name); + if ((ifCond != null) || (unlessCond != null)) { buf.append(":"); String connector = ""; - if (ifCond != null) - { + if (ifCond != null) { buf.append("if->"); buf.append(ifCond); connector = ";"; } - if (unlessCond != null) - { + if (unlessCond != null) { buf.append(connector); buf.append("unless->"); buf.append(unlessCond); @@ -176,6 +170,16 @@ public class PatternSet extends DataType { } return addPatternToList(includeList); } + + /** + * add a name entry on the include files list + */ + public NameEntry createIncludesFile() { + if (isReference()) { + throw noChildrenAllowed(); + } + return addPatternToList(includesFileList); + } /** * add a name entry on the exclude list @@ -186,6 +190,16 @@ public class PatternSet extends DataType { } return addPatternToList(excludeList); } + + /** + * add a name entry on the exclude files list + */ + public NameEntry createExcludesFile() { + if (isReference()) { + throw noChildrenAllowed(); + } + return addPatternToList(excludesFileList); + } /** * Sets the set of include patterns. Patterns may be separated by a comma @@ -235,33 +249,25 @@ public class PatternSet extends DataType { /** * Sets the name of the file containing the includes patterns. * - * @param incl The file to fetch the include patterns from. + * @param includesFile The file to fetch the include patterns from. */ - public void setIncludesfile(File incl) throws BuildException { + public void setIncludesfile(File includesFile) throws BuildException { if (isReference()) { throw tooManyAttributes(); } - if (!incl.exists()) { - throw new BuildException("Includesfile "+incl.getAbsolutePath() - +" not found."); - } - this.incl = incl; + createIncludesFile().setName(includesFile.getAbsolutePath()); } /** * Sets the name of the file containing the excludes patterns. * - * @param excl The file to fetch the exclude patterns from. + * @param excludesFile The file to fetch the exclude patterns from. */ - public void setExcludesfile(File excl) throws BuildException { + public void setExcludesfile(File excludesFile) throws BuildException { if (isReference()) { throw tooManyAttributes(); } - if (!excl.exists()) { - throw new BuildException("Excludesfile "+excl.getAbsolutePath() - +" not found."); - } - this.excl = excl; + createExcludesFile().setName(excludesFile.getAbsolutePath()); } /** @@ -345,7 +351,7 @@ public class PatternSet extends DataType { * helper for FileSet. */ boolean hasPatterns() { - return incl != null || excl != null + return includesFileList.size() > 0 || excludesFileList.size() > 0 || includeList.size() > 0 || excludeList.size() > 0; } @@ -390,23 +396,42 @@ public class PatternSet extends DataType { } /** - * Read includefile ot excludefile if not already done so. + * Read includesfile ot excludesfile if not already done so. */ private void readFiles(Project p) { - if (incl != null) { - readPatterns(incl, includeList, p); - incl = null; - } - if (excl != null) { - readPatterns(excl, excludeList, p); - excl = null; + if (includesFileList.size() > 0) { + Enumeration e = includesFileList.elements(); + while (e.hasMoreElements()) { + NameEntry ne = (NameEntry)e.nextElement(); + String fileName = ne.evalName(p); + if (fileName != null) { + File inclFile = p.resolveFile(fileName); + if (!inclFile.exists()) + throw new BuildException("Includesfile " + + inclFile.getAbsolutePath() + + " not found."); + readPatterns(inclFile, includeList, p); + } + } + includesFileList.clear(); } - } - public String toString() - { - return "patternSet{ includes: " + includeList + - " excludes: " + excludeList + " }"; + if (excludesFileList.size() > 0) { + Enumeration e = includesFileList.elements(); + while (e.hasMoreElements()) { + NameEntry ne = (NameEntry)e.nextElement(); + String fileName = ne.evalName(p); + if (fileName != null) { + File exclFile = p.resolveFile(fileName); + if (!exclFile.exists()) + throw new BuildException("Excludesfile " + + exclFile.getAbsolutePath() + + " not found."); + readPatterns(exclFile, excludeList, p); + } + } + excludesFileList.clear(); + } } } diff --git a/src/testcases/org/apache/tools/ant/types/FileSetTest.java b/src/testcases/org/apache/tools/ant/types/FileSetTest.java index a7cfc6e15..b1edbe453 100644 --- a/src/testcases/org/apache/tools/ant/types/FileSetTest.java +++ b/src/testcases/org/apache/tools/ant/types/FileSetTest.java @@ -165,6 +165,20 @@ public class FileSetTest extends TestCase { assertEquals("You must not specify nested elements when using refid", be.getMessage()); } + try { + f.createIncludesFile(); + fail("Can add nested includesfile in FileSet that is a reference."); + } catch (BuildException be) { + assertEquals("You must not specify nested elements when using refid", + be.getMessage()); + } + try { + f.createExcludesFile(); + fail("Can add nested excludesfile in FileSet that is a reference."); + } catch (BuildException be) { + assertEquals("You must not specify nested elements when using refid", + be.getMessage()); + } try { f.createPatternSet(); fail("Can add nested patternset in FileSet that is a reference."); diff --git a/src/testcases/org/apache/tools/ant/types/PatternSetTest.java b/src/testcases/org/apache/tools/ant/types/PatternSetTest.java index 1a81687b8..25d944e26 100644 --- a/src/testcases/org/apache/tools/ant/types/PatternSetTest.java +++ b/src/testcases/org/apache/tools/ant/types/PatternSetTest.java @@ -141,6 +141,20 @@ public class PatternSetTest extends TestCase { assertEquals("You must not specify nested elements when using refid", be.getMessage()); } + try { + p.createIncludesFile(); + fail("Can add nested includesfile in PatternSet that is a reference."); + } catch (BuildException be) { + assertEquals("You must not specify nested elements when using refid", + be.getMessage()); + } + try { + p.createExcludesFile(); + fail("Can add nested excludesfile in PatternSet that is a reference."); + } catch (BuildException be) { + assertEquals("You must not specify nested elements when using refid", + be.getMessage()); + } } public void testCircularReferenceCheck() {