1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<!-- Documenting T:NAnt.Core.Types.FileSet-->
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title><fileset> Type</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a href="http://nant.sourceforge.net">
<b>NAnt</b>
</a>
<img alt="->" src="../images/arrow.gif" />
<a href="../index.html">Help</a>
<img alt="->" src="../images/arrow.gif" />
<a href="../types/index.html">Type Reference</a>
<img alt="->" src="../images/arrow.gif" /> <fileset></td>
<td class="NavBar-Cell" align="right">
v0.85</td>
</tr>
</table>
<h1><fileset></h1>
<p> Filesets are groups of files. These files can be found in a directory tree starting in a base directory and are matched by patterns taken from a number of patterns. Filesets can appear inside tasks that support this feature or at the project level, i.e., as children of <code><project></code>. </p>
<h3>Patterns</h3>
<p> As described earlier, patterns are used for the inclusion and exclusion. These patterns look very much like the patterns used in DOS and UNIX: </p>
<ul style="list-style-type: disc;">
<li>
<p>'<code>*</code>' matches zero or more characters</p>
<p>For example:</p>
<p>
<code>*.cs</code> matches <code>.cs</code>, <code>x.cs</code> and <code>FooBar.cs</code>, but not <code>FooBar.xml</code> (does not end with <code>.cs</code>). </p>
</li>
<li>
<p>'<code>?</code>' matches one character</p>
<p>For example:</p>
<p>
<code>?.cs</code> matches <code>x.cs</code>, <code>A.cs</code>, but not <code>.cs</code> or <code>xyz.cs</code> (both don't have one character before <code>.cs</code>). </p>
</li>
</ul>
<p> Combinations of <code>*</code>'s and <code>?</code>'s are allowed. </p>
<p> Matching is done per-directory. This means that first the first directory in the pattern is matched against the first directory in the path to match. Then the second directory is matched, and so on. For example, when we have the pattern <code>/?abc/*/*.cs</code> and the path <code>/xabc/foobar/test.cs</code>, the first <code>?abc</code> is matched with <code>xabc</code>, then <code>*</code> is matched with <code>foobar</code>, and finally <code>*.cs</code> is matched with <code>test.cs</code>. They all match, so the path matches the pattern. </p>
<p> To make things a bit more flexible, we added one extra feature, which makes it possible to match multiple directory levels. This can be used to match a complete directory tree, or a file anywhere in the directory tree. To do this, <code>**</code> must be used as the name of a directory. When <code>**</code> is used as the name of a directory in the pattern, it matches zero or more directories. For example: <code>/test/**</code> matches all files/directories under <code>/test/</code>, such as <code>/test/x.cs</code>, or <code>/test/foo/bar/xyz.html</code>, but not <code>/xyz.xml</code>. </p>
<p> There is one "shorthand" - if a pattern ends with <code>/</code> or <code>\</code>, then <code>**</code> is appended. For example, <code>mypackage/test/</code> is interpreted as if it were <code>mypackage/test/**</code>. </p>
<h3>Default Excludes</h3>
<p> There are a set of definitions that are excluded by default from all tasks that use filesets. They are: </p>
<ul style="list-style-type: disc;">
<li> **/*~ </li>
<li> **/#*# </li>
<li> **/.#* </li>
<li> **/%*% </li>
<li> **/CVS </li>
<li> **/CVS/** </li>
<li> **/.cvsignore </li>
<li> **/.svn </li>
<li> **/.svn/** </li>
<li> **/_svn </li>
<li> **/_svn/** </li>
<li> **/SCCS </li>
<li> **/SCCS/** </li>
<li> **/vssver.scc </li>
<li> **/_vti_cnf/** </li>
</ul>
<p> If you do not want these default excludes applied, you may disable them by setting <code>defaultexcludes</code> to <b>false</b>. </p>
<h3>Parameters</h3>
<div class="table">
<table>
<tr>
<th>Attribute</th>
<th style="text-align: center;">Type</th>
<th>Description</th>
<th style="text-align: center;">Required</th>
</tr>
<tr>
<td valign="top">basedir</td>
<td style="text-align: center;">directory</td>
<td> The base of the directory of this fileset. The default is the project base directory. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">defaultexcludes</td>
<td style="text-align: center;">bool</td>
<td> Indicates whether default excludes should be used or not. The default is <b>true</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">failonempty</td>
<td style="text-align: center;">bool</td>
<td> When set to <b>true</b>, causes the fileset element to throw a <a href="../../sdk/NAnt.Core.ValidationException.html">ValidationException</a> when no files match the includes and excludes criteria. The default is <b>false</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">id</td>
<td style="text-align: center;">string</td>
<td> The ID used to be referenced later. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">refid</td>
<td style="text-align: center;">string</td>
<td> The ID to use as the reference. </td>
<td style="text-align: center;">False</td>
</tr>
</table>
</div>
<h3>Nested Elements:</h3>
<!--Array-->
<!--NestedElementArray=T:NAnt.Core.Types.FileSet.Include-->
<h4>
<a id="includes">
</a>
<includes>
</h4>
<div class="nested-element">
<i>Deprecated.</i> The items to include in the fileset. <p></p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to include. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file name will be added to the <a href="../types/fileset.html"><fileset></a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file will be searched for on the path. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the pattern will be included; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Opposite of <code>if</code>. If <b>false</b> then the pattern will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div>
<h4>
<a id="includes">
</a>
</includes>
</h4>
<!--Array-->
<!--NestedElementArray=T:NAnt.Core.Types.FileSet.Include-->
<h4>
<a id="include">
</a>
<include>
</h4>
<div class="nested-element"> The items to include in the fileset. <p></p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to include. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file name will be added to the <a href="../types/fileset.html"><fileset></a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file will be searched for on the path. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the pattern will be included; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Opposite of <code>if</code>. If <b>false</b> then the pattern will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div>
<h4>
<a id="include">
</a>
</include>
</h4>
<!--Array-->
<!--NestedElementArray=T:NAnt.Core.Types.FileSet.Exclude-->
<h4>
<a id="excludes">
</a>
<excludes>
</h4>
<div class="nested-element">
<i>Deprecated.</i> The items to exclude from the fileset. <p></p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to exclude. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the pattern will be excluded; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Opposite of <code>if</code>. If <b>false</b> then the pattern will be excluded; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div>
<h4>
<a id="excludes">
</a>
</excludes>
</h4>
<!--Array-->
<!--NestedElementArray=T:NAnt.Core.Types.FileSet.Exclude-->
<h4>
<a id="exclude">
</a>
<exclude>
</h4>
<div class="nested-element"> The items to exclude from the fileset. <p></p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to exclude. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the pattern will be excluded; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Opposite of <code>if</code>. If <b>false</b> then the pattern will be excluded; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div>
<h4>
<a id="exclude">
</a>
</exclude>
</h4>
<!--Array-->
<!--NestedElementArray=T:NAnt.Core.Types.FileSet.IncludesFile-->
<h4>
<a id="includesList">
</a>
<includesList>
</h4>
<div class="nested-element">
<i>Deprecated.</i> The files from which a list of patterns or files to include should be obtained. <p></p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be added to the <a href="../types/fileset.html"><fileset></a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be searched for on the path. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns will be included; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Opposite of <code>if</code>. If <b>false</b> then the patterns will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">file</td><td> The name of a file; each line of this file is taken to be a pattern. </td><td style="text-align: center;">True</td></tr></table></div></div>
<h4>
<a id="includesList">
</a>
</includesList>
</h4>
<!--Array-->
<!--NestedElementArray=T:NAnt.Core.Types.FileSet.IncludesFile-->
<h4>
<a id="includesfile">
</a>
<includesfile>
</h4>
<div class="nested-element"> The files from which a list of patterns or files to include should be obtained. <p></p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be added to the <a href="../types/fileset.html"><fileset></a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be searched for on the path. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns will be included; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Opposite of <code>if</code>. If <b>false</b> then the patterns will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">file</td><td> The name of a file; each line of this file is taken to be a pattern. </td><td style="text-align: center;">True</td></tr></table></div></div>
<h4>
<a id="includesfile">
</a>
</includesfile>
</h4>
<!--Array-->
<!--NestedElementArray=T:NAnt.Core.Types.FileSet.ExcludesFile-->
<h4>
<a id="excludesfile">
</a>
<excludesfile>
</h4>
<div class="nested-element"> The files from which a list of patterns or files to exclude should be obtained. <p></p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">file</td><td> The name of a file; each line of this file is taken to be a pattern. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns will be excluded; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Opposite of <code>if</code>. If <b>false</b> then the patterns will be excluded; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div>
<h4>
<a id="excludesfile">
</a>
</excludesfile>
</h4>
<h3>Examples</h3>
<ul class="examples">
<li>
<div class="table">
<table>
<tr>
<th>Pattern</th>
<th>Match</th>
</tr>
<tr>
<td>
<code>**/CVS/*</code>
</td>
<td>
<p> Matches all files in <code>CVS</code> directories that can be located anywhere in the directory tree. </p>
<p>Matches:</p>
<ul style="list-style-type: disc;">
<li>CVS/Repository</li>
<li>org/apache/CVS/Entries</li>
<li>org/apache/jakarta/tools/ant/CVS/Entries</li>
</ul>
<p>But not:</p>
<ul style="list-style-type: disc;">
<li>org/apache/CVS/foo/bar/Entries (<code>foo/bar/</code> part does not match)</li>
</ul>
</td>
</tr>
<tr>
<td>
<code>org/apache/jakarta/**</code>
</td>
<td>
<p> Matches all files in the <code>org/apache/jakarta</code> directory tree. </p>
<p>Matches:</p>
<ul style="list-style-type: disc;">
<li>org/apache/jakarta/tools/ant/docs/index.html</li>
<li>org/apache/jakarta/test.xml</li>
</ul>
<p>But not:</p>
<ul style="list-style-type: disc;">
<li>org/apache/xyz.java (<code>jakarta/</code> part is missing)</li>
</ul>
</td>
</tr>
<tr>
<td>
<code>org/apache/**/CVS/*</code>
</td>
<td>
<p> Matches all files in <code>CVS</code> directories that are located anywhere in the directory tree under <code>org/apache</code>. </p>
<p>Matches:</p>
<ul style="list-style-type: disc;">
<li>org/apache/CVS/Entries</li>
<li>org/apache/jakarta/tools/ant/CVS/Entries</li>
</ul>
<p>But not:</p>
<ul style="list-style-type: disc;">
<li>org/apache/CVS/foo/bar/Entries (<code>foo/bar/</code> part does not match)</li>
</ul>
</td>
</tr>
<tr>
<td>
<code>**/test/**</code>
</td>
<td>
<p> Matches all files that have a <code>test</code> element in their path, including <code>test</code> as a filename. </p>
</td>
</tr>
</table>
</div>
</li>
</ul>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
</div>
</body>
</html>
|
