ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/build.xml
Revision: 1.47
Committed: Fri Aug 1 19:34:05 2003 UTC (20 years, 9 months ago) by tim
Content type: text/xml
Branch: MAIN
Changes since 1.46: +32 -15 lines
Log Message:
doccheck target now working with new version 1.2b2

File Contents

# Content
1 <project name="jsr166" default="usage">
2
3 <description>
4 ------------------------------------------------------------------------------
5 Build file for JSR-166
6
7 Usage: ant [target]
8
9 User-specific settings are read from user.properties.
10 See user.properties.sample for an explanation of some useful settings.
11 ------------------------------------------------------------------------------
12 </description>
13
14 <target name="usage" description="Advises user to run with -projecthelp">
15 <echo>Run "ant -projecthelp" for full usage information.</echo>
16 </target>
17
18
19 <!-- User-specific settings -->
20 <property file="user.properties"/>
21
22
23 <!-- Compilation options -->
24 <property name="build.sourcelevel" value="1.5"/>
25 <property name="build.docsourcelevel" value="1.4"/>
26 <property name="build.debug" value="true"/>
27 <property name="build.debuglevel" value="source,lines,vars"/>
28 <property name="build.deprecation" value="false"/>
29
30 <!-- Build locations -->
31 <property name="build.dir" location="build"/>
32 <property name="build.classes.dir" location="${build.dir}/classes"/>
33 <property name="build.emulation.dir" location="${build.dir}/emulation"/>
34 <property name="build.testcases.dir" location="${build.dir}/testcases"/>
35 <property name="build.lib.dir" location="${build.dir}/lib"/>
36 <property name="build.ant.dir" location="${build.dir}/ant"/>
37 <property name="build.javadocs.dir" location="${build.dir}/javadocs"/>
38 <property name="build.stripped.dir" location="${build.dir}/stripped"/>
39 <property name="build.reports.dir" location="${build.dir}/reports"/>
40 <property name="build.doccheck.dir" location="${build.dir}/doccheck"/>
41 <property name="build.filter.src.dir" location="${build.dir}/filtersrc"/>
42 <property name="build.filter.doccheck.dir" location="${build.dir}/filterdocchk"/>
43
44 <!-- Source locations -->
45 <property name="src.dir" location="${basedir}/src/main"/>
46 <property name="emulation.src.dir" location="${basedir}/src/emulation"/>
47 <property name="test.src.dir" location="${basedir}/src/test"/>
48 <property name="ant.src.dir" location="${basedir}/etc/ant"/>
49 <property name="stylesheet.dir" location="${basedir}/etc/xsl"/>
50 <property name="lib.dir" location="${basedir}/lib"/>
51 <property name="dist.dir" location="${basedir}/dist"/>
52
53 <!-- Distribution locations -->
54 <property name="dist.javadocs.dir" location="${dist.dir}/docs"/>
55
56 <!-- Jar locations -->
57 <property name="product.jar" location="${build.lib.dir}/jsr166.jar"/>
58 <property name="junit.jar" location="${lib.dir}/junit.jar"/>
59 <property name="rt.jar" location="${java.home}/lib/rt.jar"/>
60
61
62
63 <!-- Files excluded from dist-docs and emulation jar -->
64 <patternset id="unsafe.exclusion">
65 <exclude name="java/util/Random.*"/>
66 <exclude name="sun/misc/Unsafe.*"/>
67 </patternset>
68
69 <!-- Files excludes from emulation jar -->
70 <patternset id="atomic.exclusion">
71 <exclude name="java/util/concurrent/atomic/AtomicBoolean*"/>
72 <exclude name="java/util/concurrent/atomic/AtomicInteger*"/>
73 <exclude name="java/util/concurrent/atomic/AtomicLong*"/>
74 <exclude name="java/util/concurrent/atomic/AtomicReference*"/>
75 </patternset>
76
77
78
79 <!-- Main targets -->
80
81 <target name="compile"
82 depends="init, configure-compiler, prepare-src"
83 description="Compiles main sources to build folder">
84
85 <property name="prepare.src.dir" value="${src.dir}"/>
86
87 <mkdir dir="${build.classes.dir}"/>
88
89 <!--
90 <echo>javac ${gjc.args}</echo>
91 <echo>bootclasspath=${compile.bootclasspath}</echo>
92 -->
93
94 <javac srcdir="${prepare.src.dir}"
95 destdir="${build.classes.dir}"
96 debug="${build.debug}"
97 debuglevel="${build.debuglevel}"
98 deprecation="${build.deprecation}"
99 source="${build.sourcelevel}"
100 fork="true">
101
102 <compilerarg line="${gjc.args}"/>
103 <bootclasspath refid="compile.bootclasspath"/>
104
105 </javac>
106
107 </target>
108
109
110 <target name="jar"
111 depends="configure-emulation, init-jar, native-jar, emulation-jar"
112 description="Builds library jar from compiled sources"/>
113
114
115 <target name="test"
116 depends="init, configure-tests, report-tests"
117 description="Runs all tests (requires JUnit 3.8.1 in ${ant.home}/lib)" />
118
119
120 <target name="checkstyle"
121 depends="filter-src"
122 description="Reports on style errors in Java source (verbose, mostly chaff)">
123
124 <taskdef resource="checkstyletask.properties"
125 classpath="${lib.dir}/checkstyle-all-2.4.jar"/>
126
127 <checkstyle>
128 <formatter type="plain"/> <!-- also available: type="xml" -->
129 <fileset dir="${build.filter.src.dir}" includes="**/*.java"/>
130 </checkstyle>
131
132 </target>
133
134
135 <target name="doccheck"
136 depends="filter-doccheck"
137 description="Reports on javadoc style errors">
138
139 <delete dir="${build.doccheck.dir}"/>
140 <mkdir dir="${build.doccheck.dir}"/>
141
142 <javadoc doclet="com.sun.tools.doclets.doccheck.DocCheck"
143 docletpath="${lib.dir}/doccheck.jar"
144 destdir="${build.doccheck.dir}">
145 <packageset dir="${build.filter.doccheck.dir}"/>
146 </javadoc>
147
148 </target>
149
150
151 <target name="docs"
152 depends="filter-src"
153 description="Builds javadocs with custom tags to build folder">
154
155 <delete dir="${build.javadocs.dir}"/>
156 <mkdir dir="${build.javadocs.dir}"/>
157
158 <javadoc destdir="${build.javadocs.dir}"
159 link="http://java.sun.com/j2se/1.4.1/docs/api"
160 overview="${src.dir}/intro.html"
161 source="${build.docsourcelevel}">
162
163 <tag name="revised" description="Last revised:"/>
164 <tag name="spec" description="Specified by:"/>
165 <tag name="editor" description="Last edited by:"/>
166 <tag name="fixme" description="FIX ME:"/>
167
168 <packageset dir="${build.filter.src.dir}"/>
169
170 </javadoc>
171
172 </target>
173
174
175 <target name="strip"
176 depends="init, configure-compiler"
177 description="Strip generics from java source (not working yet)">
178
179 <mkdir dir="${build.stripped.dir}"/>
180
181 <!--
182 # javac -s doesn't reliably generate compilable code. It generates
183 # bridge methods (marked as "synthetic") that can have identical
184 # signatures to existing methods except for the return value.
185 -->
186 <javac srcdir="${src.dir}"
187 destdir="${build.stripped.dir}"
188 debug="${build.debug}"
189 debuglevel="${build.debuglevel}"
190 deprecation="${build.deprecation}"
191 source="${build.sourcelevel}"
192 fork="true">
193
194 <compilerarg line="${gjc.args} -s"/>
195 <bootclasspath refid="compile.bootclasspath"/>
196
197 </javac>
198
199 </target>
200
201
202 <target name="dist"
203 depends="init, dist-clean, dist-jar, dist-docs"
204 description="Puts all distributable products in single hierarchy"/>
205
206 <target name="release"
207 depends="dist"
208 description="Puts entire CVS tree, plus distribution productions, in a jar">
209
210 <!--
211 #keep build dir? - dl
212 <delete dir="${build.dir}"/>
213 -->
214 <property name="release.jar" value="dist/jsr166-${version}-dist.jar"/>
215
216 <jar basedir="${basedir}" destfile="${release.jar}">
217 <exclude name="${release.jar}"/>
218 <exclude name="user.properties"/>
219 <exclude name="etc/notes/**"/>
220 <exclude name="lib/gjc/2.1/**"/>
221 <exclude name="**/SyntaxTest.java"/>
222 </jar>
223
224 </target>
225
226 <target name="clean"
227 description="Removes all build products">
228
229 <delete dir="${build.dir}"/>
230 <delete dir="${build.classes.dir}"/>
231 <delete dir="${build.lib.dir}"/>
232
233 </target>
234
235
236 <target name="dist-clean"
237 description="Removes all build and distribution products">
238
239 <delete dir="${dist.dir}"/>
240
241 </target>
242
243
244 <target name="dist-docs"
245 depends="filter-src"
246 description="Builds javadocs without custom tags to dist folder">
247
248 <delete dir="${dist.javadocs.dir}"/>
249 <mkdir dir="${dist.javadocs.dir}"/>
250
251 <javadoc destdir="${dist.javadocs.dir}"
252 link="http://java.sun.com/j2se/1.4.1/docs/api"
253 overview="${src.dir}/intro.html"
254 source="${build.docsourcelevel}">
255
256 <packageset dir="${build.filter.src.dir}"/>
257
258 </javadoc>
259
260 </target>
261
262
263
264 <!-- Internal targets -->
265
266
267 <target name="init">
268
269 <!-- Version is kept in a separate file -->
270 <loadfile property="version" srcFile="version.properties"/>
271 <echo>Building JSR-166 version ${version}</echo>
272
273 </target>
274
275
276 <target name="init-jar">
277
278 <mkdir dir="${build.lib.dir}"/>
279
280 </target>
281
282
283 <target name="native-jar"
284 depends="compile"
285 unless="build.emulation.true">
286
287 <jar destfile="${product.jar}">
288 <fileset dir="${build.classes.dir}"/>
289 </jar>
290
291 </target>
292
293
294 <target name="compile-emulation"
295 depends="init, configure-compiler"
296 if="build.emulation.true">
297
298 <mkdir dir="${build.emulation.dir}"/>
299
300 <javac srcdir="${emulation.src.dir}"
301 destdir="${build.emulation.dir}"
302 debug="${build.debug}"
303 debuglevel="${build.debuglevel}"
304 deprecation="${build.deprecation}"
305 source="${build.sourcelevel}"
306 fork="true">
307
308 <compilerarg line="${gjc.args}"/>
309 <bootclasspath refid="compile.bootclasspath"/>
310
311 </javac>
312
313 </target>
314
315
316 <target name="emulation-jar"
317 depends="compile-emulation"
318 if="build.emulation.true">
319
320
321 <jar destfile="${product.jar}" duplicate="add">
322 <fileset dir="${build.classes.dir}">
323 <patternset refid="atomic.exclusion"/>
324 <patternset refid="unsafe.exclusion"/>
325 </fileset>
326 <fileset dir="${build.emulation.dir}"/>
327 </jar>
328
329 </target>
330
331
332 <target name="dist-jar"
333 depends="clean, jar">
334
335 <copy file="${product.jar}" todir="${dist.dir}"/>
336
337 </target>
338
339
340 <target name="compile-ant-filter"
341 depends="init">
342
343 <mkdir dir="${build.ant.dir}"/>
344
345 <javac srcdir="${ant.src.dir}"
346 destdir="${build.ant.dir}"
347 source="1.4"
348 />
349
350 </target>
351
352
353 <target name="filter-src"
354 depends="compile-ant-filter">
355
356 <mkdir dir="${build.filter.src.dir}"/>
357
358 <copy todir="${build.filter.src.dir}">
359 <fileset dir="${src.dir}">
360 <include name="**/*.html"/>
361 </fileset>
362 </copy>
363
364 <copy todir="${build.filter.src.dir}">
365 <fileset dir="${src.dir}">
366 <exclude name="**/*.html"/>
367 <patternset refid="unsafe.exclusion"/>
368 </fileset>
369 <filterchain>
370
371 <!--
372 # This filter gets rid of angle-bracketed type parameters
373 # so that javadoc can run on the result. The following
374 # heuristic seems to work:
375 #
376 # For all lines not starting with space(s)-asterisk-space(s),
377 # replace <something> with a space, where there may be more
378 # than one right angle bracket at the end, and "something"
379 # must not contain parens or pipes. (This may need some
380 # tweaking.)
381 -->
382
383 <filterreader classname="jsr166.ant.filters.ReplaceFilter"
384 classpath="${build.ant.dir}">
385 <param name="notmatching" value="^\s+\*\s.*$"/>
386 <param name="pattern" value="&lt;[^|>()]+?>+"/>
387 <param name="replacement" value=" "/>
388 </filterreader>
389
390
391 <!--
392 # This filter uncomments lines beginning with "//@" so that
393 # javadoc can see imports that are needed to resolve links
394 # but that shouldn't be in the compiled code.
395 -->
396
397 <filterreader classname="jsr166.ant.filters.ReplaceFilter"
398 classpath="${build.ant.dir}">
399 <param name="matching" value="^//@.*$"/>
400 <param name="pattern" value="^//@"/>
401 <param name="replacement" value=""/>
402 </filterreader>
403 </filterchain>
404 </copy>
405
406 </target>
407
408
409
410
411 <target name="filter-doccheck"
412 depends="filter-src">
413
414 <mkdir dir="${build.filter.doccheck.dir}"/>
415
416 <copy todir="${build.filter.doccheck.dir}">
417 <fileset dir="${build.filter.src.dir}">
418 <include name="**/*.html"/>
419 </fileset>
420 </copy>
421
422 <property name="generic.declarations"
423 value="/** Fake type parameter. */ public interface E {} /** Fake type parameter. */ public interface T {} /** Fake type parameter. */ public interface K {} /** Fake type parameter. */ public interface V {}"
424 />
425
426 <copy todir="${build.filter.doccheck.dir}">
427 <fileset dir="${build.filter.src.dir}">
428 <exclude name="**/*.html"/>
429 </fileset>
430 <filterchain>
431 <!--
432 # These two filters try to make the source look like
433 # something that doccheck can process. The first removes
434 # -source 1.4 assertions and the second adds in a bunch
435 # of single letter public nested marker interfaces so that
436 # the generic type parameters are recognized.
437 -->
438
439 <filterreader classname="jsr166.ant.filters.ReplaceFilter"
440 classpath="${build.ant.dir}">
441 <param name="matching" value="^\s*assert[\s ].*$"/>
442 <param name="pattern" value="assert"/>
443 <param name="replacement" value="//assert"/>
444 </filterreader>
445
446 <filterreader classname="jsr166.ant.filters.ReplaceFilter"
447 classpath="${build.ant.dir}">
448 <param name="matching" value="^([^*]*(class|interface|implements) .*|)\{.*$"/>
449 <param name="pattern" value="$"/>
450 <param name="replacement" value=" ${generic.declarations}"/>
451 </filterreader>
452
453 </filterchain>
454 </copy>
455
456 </target>
457
458
459 <target name="compile-tests"
460 depends="jar">
461
462 <mkdir dir="${build.testcases.dir}"/>
463
464 <!--
465 <echo>javac ${gjc.args}</echo>
466 <echo>bootclasspath=${test.compile.bootclasspath}</echo>
467 <echo>classpath="${test.classpath}"</echo>
468 -->
469
470 <javac srcdir="${test.src.dir}"
471 destdir="${build.testcases.dir}"
472 debug="${build.debug}"
473 debuglevel="${build.debuglevel}"
474 deprecation="${build.deprecation}"
475 source="${build.sourcelevel}"
476 fork="true">
477
478 <compilerarg line="${gjc.args}"/>
479 <bootclasspath refid="test.compile.bootclasspath"/>
480 <classpath refid="test.classpath"/>
481
482 </javac>
483
484 </target>
485
486
487 <target name="run-tests"
488 depends="compile-tests">
489
490 <!-- May be overridden by user.properties -->
491 <property name="testcase" value="*"/>
492
493 <mkdir dir="${build.reports.dir}"/>
494
495 <junit printsummary="true"
496 showoutput="true"
497 errorProperty="junit.failed"
498 failureProperty="junit.failed"
499 dir="${build.reports.dir}"
500 fork="true">
501
502 <jvmarg value="-Xbootclasspath/p:${test.run.bootclasspath}"/>
503
504 <formatter type="xml"/>
505
506 <batchtest todir="${build.reports.dir}">
507 <fileset dir="${test.src.dir}">
508 <include name="**/${testcase}Test.java"/>
509 </fileset>
510 </batchtest>
511
512 </junit>
513
514 </target>
515
516
517 <target name="report-tests"
518 depends="run-tests">
519
520 <!-- Sets junit.report.format to frames if Xalan is present,
521 otherwise sets it to noframes. -->
522 <available property="junit.report.format"
523 value="frames"
524 classname="org.apache.xalan.lib.Redirect"
525 />
526 <property name="junit.report.format" value="noframes"/>
527
528 <junitreport todir="${build.reports.dir}">
529 <fileset dir="${build.reports.dir}">
530 <include name="TEST-*.xml"/>
531 </fileset>
532 <report styledir="${stylesheet.dir}"
533 format="${junit.report.format}"
534 todir="${build.reports.dir}"
535 />
536 </junitreport>
537
538 <fail message="Test Cases Failed" if="junit.failed"/>
539
540 </target>
541
542
543 <target name="configure-compiler">
544
545 <property name="gjc.version"
546 value="2.2"/>
547
548 <condition property="novariance.arg" value="-novariance">
549 <and>
550 <equals arg1="${gjc.version}" arg2="2.0"/>
551 <or>
552 <not><isset property="gjc.novariance"/></not>
553 <istrue value="${gjc.novariance}"/>
554 </or>
555 </and>
556 </condition>
557
558 <property name="novariance.arg"
559 value=""/>
560
561 <property name="gjc.dir"
562 value="${lib.dir}/gjc"/>
563
564 <property name="javac.jar"
565 location="${gjc.dir}/${gjc.version}/javac.jar"/>
566
567 <property name="collect.jar"
568 location="${gjc.dir}/${gjc.version}/collect${novariance.arg}.jar"/>
569
570
571 <condition property="warnunchecked.arg" value="-warnunchecked">
572 <istrue value="${gjc.warnunchecked}"/>
573 </condition>
574
575 <property name="warnunchecked.arg" value=""/>
576
577 <condition property="prepare.src.dir" value="${build.dir}/prepare-src">
578 <istrue value="${build.nothreads}"/>
579 </condition>
580
581
582 <!--
583 ! Bootclasspath munging for source compilation.
584 -->
585
586 <path id="pre.bootclasspath">
587 <pathelement location="${javac.jar}"/>
588 </path>
589
590 <path id="compile.bootclasspath">
591 <pathelement location="${build.classes.dir}"/>
592 <pathelement location="${collect.jar}"/>
593 <pathelement location="${rt.jar}"/>
594 </path>
595
596 <!-- Flatten paths into platform-appropriate strings -->
597 <property name="pre.bootclasspath" refid="pre.bootclasspath"/>
598 <property name="compile.bootclasspath" refid="compile.bootclasspath"/>
599
600
601 <!-- Common options in javac invocations -->
602 <property name="gjc.args"
603 value="-J-Xbootclasspath/p:${pre.bootclasspath} ${warnunchecked.arg} ${novariance.arg}"
604 />
605
606 </target>
607
608
609 <target name="prepare-src"
610 depends="configure-compiler"
611 if="prepare.src.dir">
612
613 <mkdir dir="${prepare.src.dir}"/>
614 <copy todir="${prepare.src.dir}">
615 <fileset dir="${src.dir}">
616 <exclude name="java/lang/**"/>
617 </fileset>
618 </copy>
619
620 </target>
621
622
623 <target name="configure-emulation">
624
625 <condition property="build.emulation.true">
626 <or>
627 <and>
628 <os family="windows"/>
629 <not>
630 <isset property="build.emulation"/>
631 </not>
632 </and>
633 <istrue value="${build.emulation}"/>
634 </or>
635 </condition>
636
637 </target>
638
639
640 <target name="configure-tests"
641 depends="configure-compiler">
642
643 <!-- junit.framework.Protectable is in JUnit 3.8.1 but not in 3.7 -->
644 <available property="junit.available"
645 classname="junit.framework.Protectable"/>
646
647 <fail message="Need JUnit 3.8.1 in ${ant.home}${file.separator}lib to run tests"
648 unless="junit.available"/>
649
650
651 <!--
652 ! Bootclasspath munging for testing, so JUnit can test our local
653 ! modifications to java.*.
654 -->
655
656 <path id="test.classpath">
657 <pathelement location="${product.jar}"/>
658 <pathelement location="${build.testcases.dir}"/>
659 <pathelement location="${junit.jar}"/>
660 </path>
661
662 <path id="test.compile.bootclasspath">
663 <pathelement location="${javac.jar}"/>
664 <pathelement location="${collect.jar}"/>
665 <pathelement location="${rt.jar}"/>
666 </path>
667
668 <path id="test.run.bootclasspath">
669 <pathelement location="${javac.jar}"/>
670 <path refid="test.classpath"/>
671 </path>
672
673 <!-- Flatten test classpaths into platform-appropriate strings -->
674 <property name="test.classpath" refid="test.classpath"/>
675 <property name="test.compile.bootclasspath" refid="test.compile.bootclasspath"/>
676 <property name="test.run.bootclasspath" refid="test.run.bootclasspath"/>
677
678 </target>
679
680
681
682 <!-- Anthill targets -->
683
684 <target name="anthill-build"
685 depends="jar, test, docs, dist-docs"/>
686
687 <target name="anthill-publish">
688
689 <copy todir="${deployDir}/docs/private">
690 <fileset dir="${build.javadocs.dir}"/>
691 </copy>
692
693 <copy todir="${deployDir}/docs/public">
694 <fileset dir="${dist.javadocs.dir}"/>
695 </copy>
696
697 <copy tofile="${deployDir}/index.html"
698 file="${basedir}/etc/anthill-index.html"/>
699
700 <copy todir="${deployDir}/notes">
701 <fileset dir="${basedir}/etc/notes"/>
702 </copy>
703
704 </target>
705
706
707 <target name="ng" depends="test">
708 <java classname="SuperfluousAbstract" fork="true">
709
710 <jvmarg value="-Xbootclasspath/p:${test.run.bootclasspath}"/>
711
712 </java>
713 </target>
714
715
716 </project>