build.xml revision 1503:22e417cdddee
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 Copyright (c) 2007, 2012, Oracle and/or its affiliates. All rights reserved.
4 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5
6 This code is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License version 2 only, as
8 published by the Free Software Foundation.  Oracle designates this
9 particular file as subject to the "Classpath" exception as provided
10 by Oracle in the LICENSE file that accompanied this code.
11
12 This code is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 version 2 for more details (a copy is included in the LICENSE file that
16 accompanied this code).
17
18 You should have received a copy of the GNU General Public License version
19 2 along with this work; if not, write to the Free Software Foundation,
20 Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
21
22 Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
23 or visit www.oracle.com if you need additional information or have any
24 questions.
25-->
26
27<!--
28 This is the main build file for the complete langtools repository.
29 It is used when building JDK (in which case it is invoked from the
30 Makefile), and it can be used when working on the tools themselves,
31 in an IDE such as NetBeans.
32
33 External dependencies are specified via properties. These can be given
34 on the command line, or by providing a local build.properties file.
35 (They can also be edited into make/build.properties, although that is not
36 recommended.)  At a minimum, boot.java.home must be set to the installed
37 location of the version of JDK used to build this repository. Additional
38 properties may be required, depending on the targets that are built.
39 For example, to run any of the jtreg tests you must set jtreg.home,
40 to run findbugs on the code you must set findbugs.home, and so on.
41
42 For the most part, javac can be built using the previous version of JDK.
43 However, a small number of javac files require access to the latest JDK,
44 which may not yet have been compiled. To compile these files, you can do
45 one of the following:
46 - Set boot.java.home to a recent build of the latest version of JDK.
47 - Set import.jdk to either a recent build (containing jre/lib/rt.jar)
48   or to jdk source repository.  In the latter case, stub files will
49   automatically be generated and used for the required API, to avoid
50   unnecessary compilation of the source repository.
51 If you do neither, the relevant files will not be built.
52
53 The main build happens in two phases:
54 - First, javac and other tools as needed are built using ${boot.java.home}.
55   (This implies a constraint on the source code that they can be compiled
56   with the previous version of JDK.
57 - Second, all required classes are compiled with the latest javac, created
58   in the previous step.
59 The first phase is called the bootstrap phase. All targets, properties and
60 tasks that are specific to that phase have "bootstrap" in their name.
61
62 For more details on the JDK build, see
63    http://blogs.sun.com/kto/entry/anatomy_of_the_jdk_build
64    http://openjdk.java.net/groups/build/
65 For more details on the stub generator, see
66    http://blogs.sun.com/jjg/entry/building_javac_for_jdk7
67
68 Internal details ...
69
70 Interim build products are created in the build/ directory.
71 Final build products are created in the dist/ directory.
72 When building JDK, the dist/directory will contain:
73 - A bootstrap compiler suitable for running with ${boot.java.home}
74   suitable for compiling downstream parts of JDK
75 - Source files and class files for inclusion in the JDK being built
76 When building standalone, the dist/directory will contain:
77 - Separate jar files for each of the separate langtools components
78 - Simple scripts to invoke the tools by executing the corresponding
79   jar files.
80 These jar files and scripts are "for developer use only".
81
82 This file is organized into sections as follows:
83 - global property definitions
84 - general top level targets
85 - general diagnostic/debugging targets
86 - groups of targets for each tool: javac, javadoc, doclets, javah, javap
87    Within each group, the following targets are provided, where applicable
88      build-bootstrap-TOOL      build the bootstrap version of the tool
89      build-classes-TOOL        build the classes for the tool
90      build-TOOL                build the jar file and script for the tool
91      jtreg-TOOL                build the tool and run the appropriate tests
92      findbugs-TOOL             run findbugs on the tool's source oode
93      TOOL                      build the tool, run the tests, and run findbugs
94 - utility definitions
95 -->
96
97<project name="langtools" default="build" basedir="..">
98    <!--
99    **** Global property definitions.
100    -->
101
102    <!-- Force full debuginfo for javac if the debug.classfiles
103    property is set.  This must be BEFORE the include of
104    build.properties because it sets javac.debuglevel.  -->
105    <condition property="javac.debuglevel" value="source,lines,vars">
106        <equals arg1="${debug.classfiles}" arg2="true"/>
107    </condition>
108
109    <!-- The following locations can be used to override default property values. -->
110
111    <!-- Use this location for customizations specific to this instance of this workspace -->
112    <property file="build.properties"/>
113
114    <!-- Use this location for customizations common to all OpenJDK langtools workspaces -->
115    <property file="${user.home}/.openjdk/${ant.project.name}-build.properties"/>
116
117    <!-- Use this location for customizations common to all OpenJDK workspaces -->
118    <property file="${user.home}/.openjdk/build.properties"/>
119
120    <!-- Convenient shorthands for standard locations within the workspace. -->
121    <property name="build.dir" location="build"/>
122    <property name="build.bootstrap.dir" location="${build.dir}/bootstrap"/>
123    <property name="build.coverage.dir" location="${build.dir}/coverage"/>
124    <property name="build.classes.dir" location="${build.dir}/classes"/>
125    <property name="build.gensrc.dir" location="${build.dir}/gensrc"/>
126    <property name="build.genstubs.dir" location="${build.dir}/genstubs"/>
127    <property name="build.javadoc.dir" location="${build.dir}/javadoc"/>
128    <property name="build.jtreg.dir" location="${build.dir}/jtreg"/>
129    <property name="build.toolclasses.dir" location="${build.dir}/toolclasses"/>
130    <property name="dist.dir" location="dist"/>
131    <property name="dist.bin.dir" location="${dist.dir}/bin"/>
132    <property name="dist.coverage.dir" location="${dist.dir}/coverage"/>
133    <property name="dist.findbugs.dir" location="${dist.dir}/findbugs"/>
134    <property name="dist.checkstyle.dir" location="${dist.dir}/checkstyle"/>
135    <property name="dist.lib.dir" location="${dist.dir}/lib"/>
136    <property name="make.dir" location="make"/>
137    <property name="make.conf.dir" location="${make.dir}/conf"/>
138    <property name="make.tools.dir" location="${make.dir}/tools"/>
139    <property name="src.dir" location="src"/>
140    <property name="src.bin.dir" location="${src.dir}/share/bin"/>
141    <property name="src.classes.dir" location="${src.dir}/share/classes"/>
142    <property name="test.dir" location="test"/>
143
144    <!-- java.marker is set to a marker file to check for within a Java install dir.
145         The best file to check for across Solaris/Linux/Windows/MacOS is one of the
146         executables; regrettably, that is OS-specific. -->
147    <condition property="java.marker" value="bin/java">
148        <os family="unix"/>
149    </condition>
150    <condition property="java.marker" value="bin/java.exe">
151        <os family="windows"/>
152    </condition>
153
154    <!-- Standard property values, if not overriden by earlier settings. -->
155    <property file="${make.dir}/build.properties"/>
156
157    <!-- launcher.java is used in the launcher scripts provided to run
158        the tools' jar files.  If it has not already been set, then
159        default it to use ${target.java.home}, if available, otherwise
160        quietly default to simply use "java". -->
161    <condition property="launcher.java"
162        value="${target.java.home}/bin/java" else="java">
163        <isset property="target.java.home"/>
164    </condition>
165
166    <!-- Logic for handling access import jdk classes, if available.
167        import.jdk should be unset, or set to jdk home (to use rt.jar)
168        or to jdk repo (to use src/share/classes).
169        Based on the value, if any, set up default values for javac's sourcepath,
170        classpath and bootclasspath. Note: the default values are overridden
171        in the build-bootstrap-classes macro. -->
172
173    <available property="import.jdk.src.dir" value="${import.jdk}/src/share/classes"
174        filepath="${import.jdk}/src/share/classes" file="java/nio/file/Path.java"/>
175    <available property="import.jdk.jar" value="${import.jdk}/jre/lib/rt.jar"
176        ignoresystemclasses="true"
177        classpath="${import.jdk}/jre/lib/rt.jar" classname="java.nio.file.Path"/>
178
179    <!-- Set the default bootclasspath option used for javac.
180        Note that different variants of the option are used, meaning we can't just
181        define the value for the option.
182        Note the explicit use of the standard property ${path.separator} in the following.
183        This is because Ant is not clever enough to handle direct use of : or ; -->
184    <condition property="javac.bootclasspath.opt"
185            value="-Xbootclasspath:${build.classes.dir}${path.separator}${import.jdk.jar}"
186            else="-Xbootclasspath/p:${build.classes.dir}">
187        <isset property="import.jdk.jar"/>
188    </condition>
189
190    <condition property="boot.java.provides.latest.jdk">
191        <available
192            ignoresystemclasses="true"
193            classpath="${boot.java.home}/jre/lib/rt.jar" classname="java.nio.file.Path"/>
194    </condition>
195
196    <condition property="bootstrap.exclude.files" value="" else="${require.latest.jdk.files}">
197        <isset property="boot.java.provides.latest.jdk"/>
198    </condition>
199
200    <condition property="exclude.files" value="" else="${require.latest.jdk.files}">
201        <or>
202            <isset property="boot.java.provides.latest.jdk"/>
203            <isset property="import.jdk"/>
204        </or>
205    </condition>
206
207    <condition property="require.import.jdk.stubs">
208        <and>
209            <not>
210                <isset property="boot.java.provides.latest.jdk"/>
211            </not>
212            <isset property="import.jdk.src.dir"/>
213        </and>
214    </condition>
215
216    <!-- Set the default value of the sourcepath used for javac. -->
217    <condition property="javac.sourcepath" value="${build.genstubs.dir}" else="">
218        <isset property="require.import.jdk.stubs"/>
219    </condition>
220
221    <!-- Set the default value of the classpath used for javac. -->
222    <property name="javac.classpath" value=""/>
223
224
225    <!--
226    **** General top level targets.
227    -->
228
229    <!-- Standard target to build deliverables for JDK build. -->
230
231    <target name="build" depends="build-bootstrap-tools,build-all-classes">
232        <copy todir="${dist.dir}/bootstrap">
233            <fileset dir="${build.bootstrap.dir}" includes="bin/,lib/"/>
234        </copy>
235        <chmod dir="${dist.dir}/bootstrap/bin" perm="ugo+rx">
236            <include name="*"/>
237        </chmod>
238        <mkdir dir="${dist.lib.dir}"/>
239        <jar file="${dist.lib.dir}/classes.jar" basedir="${build.classes.dir}"/>
240        <zip file="${dist.lib.dir}/src.zip" basedir="${src.classes.dir}"/>
241    </target>
242
243    <target name="build-bootstrap-tools"
244        depends="build-bootstrap-javac,build-bootstrap-javadoc,build-bootstrap-doclets,build-bootstrap-javah,build-bootstrap-sjavac"
245    />
246
247    <target name="build-all-tools"
248        depends="build-javac,build-javadoc,build-doclets,build-javah,build-javap,build-sjavac"
249    />
250
251    <target name="build-all-classes" depends="build-bootstrap-javac,-create-import-jdk-stubs">
252        <build-classes includes="${javac.includes} ${javadoc.includes} ${doclets.includes} ${javah.includes} ${javap.includes} ${sjavac.includes}"/>
253    </target>
254
255    <!-- clean -->
256
257    <target name="clean" description="Delete all generated files">
258        <delete dir="${build.dir}"/>
259        <delete dir="${dist.dir}"/>
260    </target>
261
262    <!-- Additional targets for running tools on the build -->
263
264    <target name="jtreg" depends="build-all-tools,-def-jtreg">
265        <jtreg-tool name="all" tests="${jtreg.tests}"/>
266    </target>
267
268    <target name="checkstyle" depends="-def-checkstyle"
269        description="Generates reports for code convention violations.">
270        <mkdir dir="${dist.checkstyle.dir}"/>
271        <checkstyle config="${make.conf.dir}/checkstyle-langtools.xml"
272              failureProperty="checkstyle.failure"
273              failOnViolation="false">
274            <formatter type="xml" tofile="${dist.checkstyle.dir}/checkstyle_report.xml"/>
275            <fileset dir="src" includes="**/*.java, **/*.properties"/>
276        </checkstyle>
277        <!-- transform the output to a simple html -->
278        <xslt  in="${dist.checkstyle.dir}/checkstyle_report.xml"
279               out="${dist.checkstyle.dir}/checkstyle_report.html"
280               style="${checkstyle.home}/contrib/checkstyle-simple.xsl"/>
281        <!-- transform the output to a very simple emacs friendly text file -->
282        <xslt  in="${dist.checkstyle.dir}/checkstyle_report.xml"
283               out="${dist.checkstyle.dir}/checkstyle_report.tmp"
284               style="${make.conf.dir}/checkstyle-emacs.xsl"/>
285        <!-- beautify remove extra lines -->
286        <move file="${dist.checkstyle.dir}/checkstyle_report.tmp"
287             toFile="${dist.checkstyle.dir}/checkstyle_report.emacs.txt">
288            <filterchain>
289                <ignoreblank/>
290                <replaceregex byline="true" pattern="^File:" replace="${line.separator}File:"/>
291            </filterchain>
292        </move>
293    </target>
294    <!-- target can be invoked from an ide, the output of which can be used
295         to access and fix the errors directly.
296     -->
297    <target name="checkstyle-ide" depends="checkstyle">
298        <concat>
299            <fileset file="${dist.checkstyle.dir}/checkstyle_report.emacs.txt"/>
300        </concat>
301    </target>
302
303    <target name="findbugs" depends="-def-findbugs,build-all-tools">
304        <property name="findbugs.reportLevel" value="medium"/>
305        <mkdir dir="${dist.findbugs.dir}"/>
306        <findbugs
307            home="${findbugs.home}"
308            projectName="JDK langtools ${full.version}"
309            output="xml"
310            outputFile="${dist.findbugs.dir}/findbugs.xml"
311            reportLevel="${findbugs.reportLevel}"
312            failOnError="false"
313            errorProperty="findbugs.all.errors"
314            warningsProperty="findbugs.all.warnings"
315            jvm="${target.java.home}/bin/java"
316            jvmargs="-Xmx512M">
317            <class location="${build.classes.dir}"/>
318            <sourcePath>
319                <pathelement location="${src.classes.dir}"/>
320            </sourcePath>
321        </findbugs>
322        <exec executable="sh">
323            <arg value="${findbugs.home}/bin/convertXmlToText"/>
324            <arg value="-longBugCodes"/>
325            <arg value="-html:${findbugs.home}/src/xsl/fancy.xsl"/>
326            <arg value="${dist.findbugs.dir}/findbugs.xml"/>
327            <redirector output="${dist.findbugs.dir}/findbugs.html"/>
328        </exec>
329    </target>
330
331    <target name="coverage" depends="-def-cobertura,build-all-classes,instrument-classes,jtreg,coverage-report"/>
332
333    <target name="instrument-classes" depends="-def-cobertura">
334        <!-- only define the following property when we want coverage info -->
335        <path id="coverage.classpath">
336            <pathelement location="${build.coverage.dir}/classes"/>
337            <path refid="cobertura.classpath"/>
338        </path>
339        <property name="coverage.options" value="-Dnet.sourceforge.cobertura.datafile=${build.coverage.dir}/cobertura.ser"/>
340        <property name="coverage.classpath" refid="coverage.classpath"/>
341        <mkdir dir="${build.coverage.dir}/classes"/>
342        <delete file="${build.coverage.dir}/cobertura.ser"/>
343        <cobertura-instrument todir="${build.coverage.dir}/classes"
344            datafile="${build.coverage.dir}/cobertura.ser">
345            <fileset dir="${build.classes.dir}"
346               includes="**/*.class" excludes="**/resources/*.class"/>
347        </cobertura-instrument>
348    </target>
349
350    <target name="coverage-report" depends="-def-cobertura">
351        <mkdir dir="${dist.coverage.dir}"/>
352        <cobertura-report
353            srcdir="${src.classes.dir}"
354            destdir="${dist.coverage.dir}"
355            datafile="${build.coverage.dir}/cobertura.ser"/>
356        <cobertura-report
357            format="xml"
358            srcdir="${src.classes.dir}"
359            destdir="${dist.coverage.dir}"
360            datafile="${build.coverage.dir}/cobertura.ser"/>
361    </target>
362
363    <target name="diags-examples" depends="build-javac">
364        <!-- can override the following on the command line if desired. -->
365        <property name="diags.examples.out" location="${build.dir}/diag-examples/diags-examples.html"/>
366        <mkdir dir="${build.dir}/diag-examples/classes"/>
367        <javac fork="true"
368            executable="${dist.bin.dir}/javac"
369            srcdir="test/tools/javac/diags"
370            destdir="${build.dir}/diag-examples/classes"
371            includes="ArgTypeCompilerFactory.java,Example.java,FileManager.java,HTMLWriter.java,RunExamples.java,DocCommentProcessor.java"
372            sourcepath=""
373            classpath="${dist.lib.dir}/javac.jar"
374            includeAntRuntime="no"
375            debug="${javac.debug}"
376            debuglevel="${javac.debuglevel}">
377            <compilerarg line="${javac.lint.opts}"/>
378        </javac>
379        <java fork="true"
380            jvm="${target.java.home}/bin/java"
381            dir="test/tools/javac/diags"
382            classpath="${build.dir}/diag-examples/classes;${dist.lib.dir}/javac.jar"
383            classname="RunExamples">
384            <jvmarg value="-Dtest.classes=${build.dir}/diag-examples/classes"/>
385            <arg value="-examples"/>
386            <arg value="examples"/>
387            <arg value="-o"/>
388            <arg file="${diags.examples.out}"/>
389            <arg value="-showFiles"/>
390            <arg value="-title"/>
391            <arg value="Examples of javac diagnostics"/>
392        </java>
393    </target>
394
395    <!-- a patching facility to speed up incorporating the langtools' classfiles
396         into a jdk of your choice. Either target.java.home or patch.jdk can be
397         set on the command line; setting target.java.home has the advantage of
398         patching the jdk used for jtreg and other tests.
399    -->
400    <target name="patch" depends="build-all-classes">
401        <condition property="patch.jdk" value="${target.java.home}">
402            <available file="${target.java.home}" type="dir"/>
403        </condition>
404        <fail message="patch.jdk or target.java.home is not set, please set target.java.home, or patch.jdk for an alternate jdk image to patch">
405            <condition>
406                <not>
407                    <isset property="patch.jdk"/>
408                </not>
409            </condition>
410        </fail>
411        <property name="patch.tools.jar" location="${patch.jdk}/lib/tools.jar"/>
412        <property name="patch.rt.jar" location="${patch.jdk}/jre/lib/rt.jar"/>
413        <fail message="patch.jdk or target.java.home must point to a valid jdk image: missing tools.jar">
414            <condition>
415                <not>
416                    <available file="${patch.tools.jar}" type="file"/>
417                </not>
418            </condition>
419        </fail>
420        <fail message="patch.jdk or target.java.home must point to a valid jdk image: missing rt.jar">
421            <condition>
422                <not>
423                    <available file="${patch.rt.jar}" type="file"/>
424                </not>
425            </condition>
426        </fail>
427        <zip zipfile="${patch.tools.jar}" update="true">
428            <zipfileset dir="${build.classes.dir}" includes="com/**"/>
429        </zip>
430        <zip zipfile="${patch.rt.jar}" update="true">
431            <zipfileset dir="${build.classes.dir}" includes="javax/**"/>
432        </zip>
433    </target>
434
435    <!--
436    **** Debugging/diagnostic targets.
437    -->
438
439    <!-- standard JDK target -->
440    <target name="sanity"
441        description="display settings of configuration values">
442        <echo level="info">ant.home = ${ant.home}</echo>
443        <echo level="info">boot.java.home = ${boot.java.home}</echo>
444        <echo level="info">target.java.home = ${target.java.home}</echo>
445        <echo level="info">jtreg.home = ${jtreg.home}</echo>
446        <echo level="info">findbugs.home = ${findbugs.home}</echo>
447        <echo level="info">checkstyle.home = ${checkstyle.home}</echo>
448    </target>
449
450    <target name="post-sanity" depends="-def-jtreg,sanity,build"
451        description="perform basic validation after a standard build">
452        <jtreg
453            dir="make/test"
454            workDir="${build.jtreg.dir}/post-sanity/work"
455            reportDir="${build.jtreg.dir}/post-sanity/report"
456            jdk="${target.java.home}"
457            verbose="summary"
458            failonerror="false" resultproperty="jtreg.post-sanity.result">
459        </jtreg>
460    </target>
461
462    <!-- use vizant tool to generate graphical image of this Ant file.-->
463    <target name="vizant" depends="-def-vizant">
464        <mkdir dir="${build.dir}"/>
465        <echo message="Generating ${build.dir}/build.dot"/>
466        <vizant antfile="${make.dir}/build.xml" outfile="${build.dir}/build.dot"/>
467        <echo message="Generating ${build.dir}/build.png"/>
468        <exec executable="${dot}" >
469            <arg value="-Tpng"/>
470            <arg value="-o"/>
471            <arg file="${build.dir}/build.png"/>
472            <arg file="${build.dir}/build.dot"/>
473        </exec>
474    </target>
475
476    <target name="check-import.jdk">
477        <echo message="import.jdk: ${import.jdk}"/>
478        <echo message="import.jdk.jar: ${import.jdk.jar}"/>
479        <echo message="import.jdk.src.dir: ${import.jdk.src.dir}"/>
480    </target>
481
482    <target name="diagnostics">
483        <diagnostics/>
484    </target>
485
486
487    <!--
488    **** javac targets.
489    -->
490
491    <target name="build-bootstrap-javac"
492            depends="-def-build-bootstrap-classes,-def-build-bootstrap-jar,-def-build-bootstrap-tool">
493        <build-bootstrap-classes includes="${javac.includes}"/>
494        <build-bootstrap-jar     name="javac" includes="${javac.includes}"/>
495        <build-bootstrap-tool    name="javac"/>
496    </target>
497
498    <target name="build-classes-javac" depends="build-bootstrap-javac,-create-import-jdk-stubs">
499        <build-classes includes="${javac.includes}"/>
500    </target>
501
502    <target name="build-javac" depends="build-classes-javac">
503        <build-jar  name="javac" includes="${javac.includes}"/>
504        <build-tool name="javac"/>
505    </target>
506
507    <target name="javadoc-javac" depends="build-javac,-def-javadoc-tool">
508        <javadoc-tool name="javac" includes="${javac.includes}" options="${javadoc.jls.option}"/>
509    </target>
510
511    <target name="jtreg-javac" depends="build-javac,build-javap,-def-jtreg">
512        <jtreg-tool name="javac" tests="${javac.tests}"/>
513    </target>
514
515    <target name="findbugs-javac" depends="build-javac,-def-findbugs">
516        <findbugs-tool name="javac"/>
517    </target>
518
519    <target name="javac" depends="build-javac,jtreg-javac,findbugs-javac"/>
520
521
522    <!--
523    **** javadoc targets.
524    -->
525
526    <target name="build-bootstrap-javadoc" depends="build-bootstrap-javac">
527        <build-bootstrap-classes includes="${javadoc.includes}"/>
528        <build-bootstrap-jar     name="javadoc" includes="${javadoc.includes}"
529                                 jarclasspath="javac.jar doclets.jar"/>
530        <build-bootstrap-tool    name="javadoc"/>
531    </target>
532
533    <target name="build-classes-javadoc" depends="build-classes-javac">
534        <build-classes includes="${javadoc.includes}"/>
535    </target>
536
537    <target name="build-javadoc" depends="build-javac,build-classes-javadoc">
538        <build-jar  name="javadoc" includes="${javadoc.includes}"
539                    jarclasspath="javac.jar doclets.jar"/>
540        <build-tool name="javadoc"/>
541    </target>
542
543    <target name="javadoc-javadoc" depends="build-javadoc,-def-javadoc-tool">
544        <javadoc-tool name="javadoc" includes="${javadoc.includes}"/>
545    </target>
546
547    <target name="jtreg-javadoc" depends="build-javadoc,-def-jtreg">
548        <jtreg-tool name="javadoc" tests="${javadoc.tests}"/>
549    </target>
550
551    <target name="findbugs-javadoc" depends="build-javadoc,-def-findbugs">
552        <findbugs-tool name="javadoc"/>
553    </target>
554
555    <target name="javadoc" depends="build-javadoc,jtreg-javadoc,findbugs-javadoc"/>
556
557
558    <!--
559    **** doclets targets.
560    -->
561
562    <target name="build-bootstrap-doclets" depends="build-bootstrap-javadoc,-def-build-bootstrap-jar">
563        <build-bootstrap-classes includes="${doclets.includes}"/>
564        <build-bootstrap-jar     name="doclets" includes="${doclets.includes}"
565                                 jarmainclass="com.sun.tools.javadoc.Main"
566                                 jarclasspath="javadoc.jar"/>
567    </target>
568
569    <target name="build-classes-doclets" depends="build-classes-javadoc">
570        <build-classes includes="${doclets.includes}"/>
571    </target>
572
573    <target name="build-doclets" depends="build-javadoc,build-classes-doclets">
574        <!-- just jar, no bin for doclets -->
575        <build-jar name="doclets" includes="${doclets.includes}" jarclasspath="javadoc.jar"/>
576    </target>
577
578    <!-- (no javadoc for doclets) -->
579
580    <target name="jtreg-doclets" depends="build-doclets,-def-jtreg">
581        <jtreg-tool name="doclets" tests="${doclets.tests}"/>
582    </target>
583
584    <target name="findbugs-doclets" depends="build-doclets,-def-findbugs">
585        <findbugs-tool name="doclets"/>
586    </target>
587
588    <target name="doclets" depends="build-doclets,jtreg-doclets,findbugs-doclets"/>
589
590
591    <!--
592    **** javah targets.
593    -->
594
595    <target name="build-bootstrap-javah" depends="build-bootstrap-javadoc">
596        <build-bootstrap-classes includes="${javah.includes}"/>
597        <build-bootstrap-jar     name="javah" includes="${javah.includes}"
598                                 jarclasspath="javadoc.jar doclets.jar javac.jar"/>
599        <build-bootstrap-tool    name="javah"/>
600    </target>
601
602    <target name="build-javah" depends="build-javac,build-classes-javah">
603        <build-jar  name="javah" includes="${javah.includes}" jarclasspath="javac.jar"/>
604        <build-tool name="javah"/>
605    </target>
606
607    <target name="build-classes-javah" depends="build-classes-javadoc">
608        <build-classes includes="${javah.includes}"/>
609    </target>
610
611    <!-- (no javadoc for javah) -->
612
613    <target name="jtreg-javah" depends="build-javah,-def-jtreg">
614        <jtreg-tool name="javah" tests="${javah.tests}"/>
615    </target>
616
617    <target name="findbugs-javah" depends="build-javah,-def-findbugs">
618        <findbugs-tool name="javah"/>
619    </target>
620
621    <target name="javah" depends="build-javah,jtreg-javah,findbugs-javah"/>
622
623
624    <!--
625    **** javap targets.
626    -->
627
628    <target name="build-bootstrap-javap"
629            depends="-def-build-bootstrap-classes,-def-build-bootstrap-jar,-def-build-bootstrap-tool">
630        <build-bootstrap-classes includes="${javap.includes}"/>
631        <build-bootstrap-jar     name="javap" includes="${javap.includes}"
632                                 jarmainclass="sun.tools.javap.Main"/>
633        <build-bootstrap-tool    name="javap"/>
634    </target>
635
636    <target name="build-classes-javap" depends="build-classes-javac">
637        <build-classes includes="${javap.includes}"/>
638    </target>
639
640    <target name="build-javap" depends="build-javac,build-classes-javap">
641        <build-jar  name="javap" includes="${javap.includes}"
642                    jarmainclass="com.sun.tools.javap.Main"
643                    jarclasspath="javac.jar"/>
644        <build-tool name="javap"/>
645    </target>
646
647    <!-- (no javadoc for javap) -->
648
649    <target name="jtreg-javap" depends="build-javap,-def-jtreg">
650        <jtreg-tool name="javap" tests="${javap.tests}"/>
651    </target>
652
653    <target name="findbugs-javap" depends="build-javap,-def-findbugs">
654        <findbugs-tool name="javap"/>
655    </target>
656
657    <target name="javap" depends="build-javap,jtreg-javap,findbugs-javap"/>
658
659    <!--
660    **** sjavac targets.
661    -->
662
663    <target name="build-bootstrap-sjavac"
664            depends="-def-build-bootstrap-classes,-def-build-bootstrap-jar,-def-build-bootstrap-tool">
665        <build-bootstrap-classes includes="${sjavac.includes}"/>
666        <build-bootstrap-jar     name="sjavac" includes="${sjavac.includes}"
667                                 jarmainclass="com.sun.tools.sjavac.Main"/>
668        <build-bootstrap-tool    name="sjavac"/>
669    </target>
670
671    <target name="build-classes-sjavac" depends="build-classes-javac">
672        <build-classes includes="${sjavac.includes}"/>
673    </target>
674
675    <target name="build-sjavac" depends="build-classes-sjavac">
676        <build-jar  name="sjavac" includes="${sjavac.includes}"
677                    jarmainclass="com.sun.tools.sjavac.Main"
678                    jarclasspath="sjavac.jar"/>
679        <build-tool name="sjavac"/>
680    </target>
681    
682    <!-- (no javadoc for javap) -->
683
684    <target name="jtreg-sjavac" depends="build-sjavac,-def-jtreg">
685        <jtreg-tool name="sjavac" tests="${sjavac.tests}"/>
686    </target>
687
688    <target name="findbugs-sjavac" depends="build-sjavac,-def-findbugs">
689        <findbugs-tool name="sjavac"/>
690    </target>
691
692    <target name="sjavac" depends="build-sjavac,jtreg-sjavac,findbugs-sjavac"/>
693
694    <!--
695    **** Create import JDK stubs.
696    -->
697
698    <target name="-create-import-jdk-stubs" depends="-def-genstubs" if="require.import.jdk.stubs">
699        <mkdir dir="${build.genstubs.dir}"/>
700        <genstubs
701            srcdir="${import.jdk.src.dir}" destdir="${build.genstubs.dir}"
702            includes="${import.jdk.stub.files}"
703            fork="true" classpath="${build.toolclasses.dir}:${build.bootstrap.dir}/classes:${ant.core.lib}"
704        />
705    </target>
706
707
708    <!--
709    **** Check targets.
710    **** "-check-*" targets check that a required property is set, and set to a reasonable value.
711    **** A user friendly message is generated if not, and the build exits.
712    -->
713
714    <target name="-check-boot.java.home" depends="-def-check">
715        <check name="bootstrap java" property="boot.java.home" marker="${java.marker}"/>
716    </target>
717
718    <target name="-check-target.java.home" depends="-def-check">
719        <check name="target java" property="target.java.home" marker="${java.marker}"/>
720    </target>
721
722    <target name="-check-cobertura.home" depends="-def-check">
723        <check name="cobertura" property="cobertura.home" marker="cobertura.jar"/>
724    </target>
725
726    <target name="-check-findbugs.home" depends="-def-check">
727        <check name="findbugs" property="findbugs.home" marker="lib/findbugs.jar"/>
728    </target>
729
730    <target name="-check-checkstyle.home" depends="-def-check">
731        <check name="checkstyle" property="checkstyle.home" marker="${checkstyle.name.version}.jar"/>
732    </target>
733
734    <target name="-check-jtreg.home" depends="-def-check">
735        <check name="jtreg" property="jtreg.home" marker="lib/jtreg.jar"/>
736    </target>
737
738    <target name="-check-vizant" depends="-def-check">
739        <check name="vizant" property="vizant.jar"/>
740        <check name="dot" property="dot"/>
741    </target>
742
743
744    <!--
745    **** Targets for Ant macro and task definitions.
746    -->
747
748    <target name="-def-build-tool">
749        <macrodef name="build-tool">
750            <attribute name="name"/>
751            <attribute name="bin.dir" default="${dist.bin.dir}"/>
752            <attribute name="java" default="${launcher.java}"/>
753            <sequential>
754                <mkdir dir="@{bin.dir}"/>
755                <copy file="${src.bin.dir}/launcher.sh-template" tofile="@{bin.dir}/@{name}">
756                    <filterset begintoken="#" endtoken="#">
757                        <filter token="PROGRAM" value="@{name}"/>
758                        <filter token="TARGET_JAVA" value="@{java}"/>
759                        <filter token="PS" value="${path.separator}"/>
760                    </filterset>
761                </copy>
762                <chmod file="@{bin.dir}/@{name}" perm="ugo+rx"/>
763            </sequential>
764        </macrodef>
765    </target>
766
767    <target name="-def-build-jar">
768        <macrodef name="build-jar">
769            <attribute name="name"/>
770            <attribute name="includes"/>
771            <attribute name="classes.dir" default="${build.classes.dir}"/>
772            <attribute name="lib.dir" default="${dist.lib.dir}"/>
773            <attribute name="jarmainclass" default="com.sun.tools.@{name}.Main"/>
774            <attribute name="jarclasspath" default=""/>
775            <sequential>
776                <mkdir dir="@{lib.dir}"/>
777                <jar destfile="@{lib.dir}/@{name}.jar"
778                     basedir="@{classes.dir}"
779                     includes="@{includes}">
780                    <manifest>
781                        <attribute name="Main-Class" value="@{jarmainclass}"/>
782                        <attribute name="Class-Path" value="@{jarclasspath}"/>
783                    </manifest>
784                </jar>
785            </sequential>
786        </macrodef>
787    </target>
788
789    <target name="-def-build-classes" depends="-def-pcompile">
790        <macrodef name="build-classes">
791            <attribute name="includes"/>
792            <attribute name="excludes" default="${exclude.files} **/package-info.java"/>
793            <attribute name="classes.dir" default="${build.classes.dir}"/>
794            <attribute name="gensrc.dir" default="${build.gensrc.dir}"/>
795            <attribute name="javac.bootclasspath" default="${build.bootstrap.dir}/classes"/>
796            <attribute name="bootclasspath.opt" default="${javac.bootclasspath.opt}"/>
797            <attribute name="classpath" default="${javac.classpath}"/>
798            <attribute name="sourcepath" default="${javac.sourcepath}"/>
799            <attribute name="java.home" default="${boot.java.home}"/>
800            <attribute name="source" default="${javac.source}"/>
801            <attribute name="target" default="${javac.target}"/>
802            <attribute name="release" default="${release}"/>
803            <attribute name="full.version" default="${full.version}"/>
804            <sequential>
805                <echo level="verbose" message="build-classes: excludes=@{excludes}"/>
806                <echo level="verbose" message="build-classes: bootclasspath.opt=@{bootclasspath.opt}"/>
807                <echo level="verbose" message="build-classes: classpath=@{classpath}"/>
808                <echo level="verbose" message="build-classes: sourcepath=@{sourcepath}"/>
809                <mkdir dir="@{gensrc.dir}"/>
810                <mkdir dir="@{classes.dir}"/>
811                <pcompile srcdir="${src.classes.dir}"
812                          destdir="@{gensrc.dir}"
813                          includes="@{includes}"/>
814                <copy todir="@{gensrc.dir}">
815                    <fileset dir="${src.classes.dir}" includes="@{includes}"/>
816                    <globmapper from="*.properties-template" to="*.properties"/>
817                    <filterset begintoken="$(" endtoken=")">
818                        <filter token="JDK_VERSION" value="${jdk.version}"/>
819                        <filter token="RELEASE" value="@{release}"/>
820                        <filter token="FULL_VERSION" value="@{full.version}"/>
821                    </filterset>
822                </copy>
823                <pcompile srcdir="@{gensrc.dir}"
824                          destdir="@{gensrc.dir}"
825                          includes="**/*.properties"/>
826                <javac fork="true"
827                       executable="@{java.home}/bin/javac"
828                       srcdir="${src.classes.dir}:@{gensrc.dir}"
829                       destdir="@{classes.dir}"
830                       includes="@{includes}"
831                       excludes="@{excludes}"
832                       sourcepath="@{sourcepath}"
833                       classpath="@{classpath}"
834                       includeAntRuntime="no"
835                       source="@{source}"
836                       target="@{target}"
837                       debug="${javac.debug}"
838                       debuglevel="${javac.debuglevel}">
839                    <compilerarg value="-implicit:none"/>
840                    <compilerarg value="-Xprefer:source"/>
841                    <compilerarg value="-J-Xbootclasspath/p:@{javac.bootclasspath}"/>
842                    <compilerarg line="@{bootclasspath.opt}"/>
843                    <compilerarg line="${javac.no.jdk.warnings}"/>
844                    <compilerarg line="${javac.version.opt}"/>
845                    <compilerarg line="${javac.lint.opts}"/>
846                </javac>
847                <copy todir="@{classes.dir}" includeemptydirs="false">
848                    <fileset dir="${src.classes.dir}" includes="@{includes}" excludes="@{excludes}">
849                        <exclude name="**/*.java"/>
850                        <exclude name="**/*.properties"/>
851                        <exclude name="**/*-template"/>
852                        <exclude name="**/*.rej"/>
853                        <exclude name="**/*.orig"/>
854                        <exclude name="**/overview.html"/>
855                        <exclude name="**/package.html"/>
856                    </fileset>
857                </copy>
858            </sequential>
859        </macrodef>
860    </target>
861
862    <target name="-def-build-bootstrap-tool" depends="-check-boot.java.home,-def-build-tool">
863        <presetdef name="build-bootstrap-tool">
864            <build-tool
865                bin.dir="${build.bootstrap.dir}/bin"
866                java="${boot.java}"/>
867        </presetdef>
868    </target>
869
870    <target name="-def-build-bootstrap-jar" depends="-def-build-jar">
871        <presetdef name="build-bootstrap-jar">
872            <build-jar
873                classes.dir="${build.bootstrap.dir}/classes"
874                lib.dir="${build.bootstrap.dir}/lib"/>
875        </presetdef>
876    </target>
877
878    <target name="-def-build-bootstrap-classes" depends="-def-build-classes">
879        <presetdef name="build-bootstrap-classes">
880            <build-classes
881                source="${boot.javac.source}"
882                target="${boot.javac.target}"
883                gensrc.dir="${build.bootstrap.dir}/gensrc"
884                classes.dir="${build.bootstrap.dir}/classes"
885                javac.bootclasspath=""
886                bootclasspath.opt="-Xbootclasspath/p:${build.bootstrap.dir}/classes"
887                sourcepath=""
888                release="${bootstrap.release}"
889                full.version="${bootstrap.full.version}"
890                excludes="${bootstrap.exclude.files} **/package-info.java"/>
891        </presetdef>
892    </target>
893
894    <target name="-def-pcompile">
895        <mkdir dir="${build.toolclasses.dir}"/>
896        <javac fork="true"
897               source="${boot.javac.source}"
898               target="${boot.javac.target}"
899               executable="${boot.java.home}/bin/javac"
900               srcdir="${make.tools.dir}"
901               includes="compileproperties/* anttasks/CompileProperties*"
902               destdir="${build.toolclasses.dir}/"
903               classpath="${ant.core.lib}"
904               bootclasspath="${boot.java.home}/jre/lib/rt.jar"
905               includeantruntime="false">
906            <compilerarg line="${javac.lint.opts}"/>
907        </javac>
908        <taskdef name="pcompile"
909                 classname="anttasks.CompilePropertiesTask"
910                 classpath="${build.toolclasses.dir}/"/>
911    </target>
912
913    <target name="-def-genstubs" depends="build-bootstrap-javac" if="require.import.jdk.stubs">
914        <mkdir dir="${build.toolclasses.dir}"/>
915        <javac fork="true"
916               source="${boot.javac.source}"
917               target="${boot.javac.target}"
918               executable="${boot.java.home}/bin/javac"
919               srcdir="${make.tools.dir}"
920               includes="genstubs/* anttasks/GenStubs*"
921               destdir="${build.toolclasses.dir}/"
922               classpath="${ant.core.lib}"
923               includeantruntime="false">
924            <compilerarg value="-Xbootclasspath/p:${build.bootstrap.dir}/classes"/>
925            <compilerarg line="${javac.lint.opts}"/>
926        </javac>
927        <taskdef name="genstubs"
928                 classname="anttasks.GenStubsTask"
929                 classpath="${build.toolclasses.dir}/"/>
930    </target>
931
932    <target name="-def-javadoc-tool" depends="-check-target.java.home">
933        <macrodef name="javadoc-tool">
934            <attribute name="name"/>
935            <attribute name="includes"/>
936            <attribute name="options" default=""/>
937            <attribute name="source" default="1.5"/> <!-- FIXME -->
938            <sequential>
939                <property name="javadoc.options" value=""/> <!-- default, can be overridden per user or per project -->
940                <!-- Note: even with this default value, includes
941                from src.classes.dir get javadoc'd; see packageset below -->
942                <property name="javadoc.packagenames" value="none"/> <!-- default, can be overridden per user or per project -->
943                <javadoc
944                    executable="${target.java.home}/bin/javadoc"
945                    destdir="${build.javadoc.dir}/@{name}"
946                    source="@{source}"
947                    windowtitle="UNOFFICIAL"
948                    failonerror="true"
949                    use="true"
950                    author="false"
951                    version="false"
952                    packagenames="${javadoc.packagenames}" >
953                    <header><![CDATA[<strong>Unofficial Javadoc</strong> generated from developer sources for preview purposes only]]></header>
954                    <arg line="@{options}"/>
955                    <bootclasspath>
956                        <path location="${build.classes.dir}"/>
957                        <path location="${target.java.home}/jre/lib/rt.jar"/>
958                    </bootclasspath>
959                    <sourcepath>
960                        <pathelement location="${src.classes.dir}"/>
961                    </sourcepath>
962                    <!-- XXX just <fileset> (restricted further to **/*.java) and no <packageset> -->
963                    <!-- means that {@link some.package} will not work, which is no good. -->
964                    <!-- (It correctly skips excluded single classes, but not if packageset is also included, -->
965                    <!-- which also causes duplicates in the class index for included files.) -->
966                    <packageset dir="${src.classes.dir}" includes="@{includes}">
967                        <or>
968                            <filename name="java/"/>
969                            <filename name="javax/"/>
970                            <filename name="com/sun/javadoc/"/>
971                            <filename name="com/sun/source/"/>
972                        </or>
973                    </packageset>
974                </javadoc>
975            </sequential>
976        </macrodef>
977    </target>
978
979    <target name="-def-jtreg" unless="jtreg.defined" depends="-check-jtreg.home,-check-target.java.home">
980        <taskdef name="jtreg" classname="com.sun.javatest.regtest.Main$$Ant">
981            <classpath>
982                <pathelement location="${jtreg.home}/lib/jtreg.jar"/>
983                <pathelement location="${jtreg.home}/lib/javatest.jar"/>
984            </classpath>
985        </taskdef>
986        <macrodef name="jtreg-tool">
987            <attribute name="name"/>
988            <attribute name="tests"/>
989            <attribute name="jdk" default="${target.java.home}"/>
990            <attribute name="samevm" default="true"/>
991            <attribute name="verbose" default="${default.jtreg.verbose}"/>
992            <attribute name="options" default="${other.jtreg.options}"/>
993            <attribute name="keywords" default="-keywords:!ignore"/>
994            <attribute name="jpda.jvmargs" default=""/>
995            <sequential>
996                <property name="coverage.options" value=""/>              <!-- default -->
997                <property name="coverage.classpath" value=""/>            <!-- default -->
998                <property name="default.jtreg.verbose" value="summary"/>  <!-- default -->
999                <property name="other.jtreg.options" value=""/>           <!-- default -->
1000                <jtreg
1001                    dir="${test.dir}"
1002                    workDir="${build.jtreg.dir}/@{name}/work"
1003                    reportDir="${build.jtreg.dir}/@{name}/report"
1004                    jdk="@{jdk}"
1005                    samevm="@{samevm}" verbose="@{verbose}"
1006                    failonerror="false" resultproperty="jtreg.@{name}.result"
1007                    javacoptions="-g"
1008                    vmoptions="${coverage.options} -Xbootclasspath/p:${coverage.classpath}${path.separator}${build.classes.dir} @{jpda.jvmargs}">
1009                    <arg line="@{keywords}"/>
1010                    <arg line="@{options}"/>
1011                    <arg line="@{tests}"/>
1012                </jtreg>
1013                <!-- the next two properties are for convenience, when only
1014                     a single instance of jtreg will be invoked. -->
1015                <condition property="jtreg.passed">
1016                    <equals arg1="${jtreg.@{name}.result}" arg2="0"/>
1017                </condition>
1018                <property name="jtreg.report" value="${build.jtreg.dir}/@{name}/report"/>
1019            </sequential>
1020        </macrodef>
1021        <property name="jtreg.defined" value="true"/>
1022    </target>
1023
1024    <target name="-def-cobertura" depends="-check-cobertura.home">
1025        <path id="cobertura.classpath">
1026            <fileset dir="${cobertura.home}">
1027                <include name="cobertura.jar"/>
1028                <include name="lib/**/*.jar"/>
1029            </fileset>
1030        </path>
1031        <taskdef classpathref="cobertura.classpath" resource="tasks.properties"/>
1032    </target>
1033
1034    <target name="-def-checkstyle" unless="checkstyle.defined"
1035        depends="-check-checkstyle.home">
1036        <taskdef resource="checkstyletask.properties">
1037            <classpath>
1038                <pathelement location="${checkstyle.home}/${checkstyle.name.version}-all.jar"/>
1039            </classpath>
1040        </taskdef>
1041        <property name="checkstyle.defined" value="true"/>
1042    </target>
1043
1044    <target name="-def-findbugs" unless="findbugs.defined"
1045        depends="-check-findbugs.home,-check-target.java.home">
1046        <taskdef name="findbugs" classname="edu.umd.cs.findbugs.anttask.FindBugsTask">
1047            <classpath>
1048                <pathelement location="${findbugs.home}/lib/findbugs.jar"/>
1049            </classpath>
1050        </taskdef>
1051        <macrodef name="findbugs-tool">
1052            <attribute name="name"/>
1053            <attribute name="output" default="emacs"/>
1054            <attribute name="outputFile" default=""/>
1055            <attribute name="reportLevel" default="high"/>
1056            <sequential>
1057                <findbugs
1058                    home="${findbugs.home}"
1059                    output="@{output}"
1060                    outputFile="@{outputFile}"
1061                    reportLevel="@{reportLevel}"
1062                    failOnError="false"
1063                    errorProperty="findbugs.@{name}.errors"
1064                    warningsProperty="findbugs.@{name}.warnings"
1065                    jvm="${target.java.home}/bin/java"
1066                    jvmargs="-Xmx512M" >
1067                    <class location="${dist.dir}/lib/@{name}.jar"/>
1068                    <auxClasspath>
1069                        <pathelement location="${build.classes.dir}"/>
1070                    </auxClasspath>
1071                    <sourcePath>
1072                        <pathelement location="${src.classes.dir}"/>
1073                    </sourcePath>
1074                </findbugs>
1075            </sequential>
1076        </macrodef>
1077        <property name="findbugs.defined" value="true"/>
1078    </target>
1079
1080    <target name="-def-vizant" unless="vizant.defined" depends="-check-vizant">
1081        <taskdef name="vizant" classname="net.sourceforge.vizant.Vizant" classpath="${vizant.jar}"/>
1082        <property name="vizant.defined" value="true"/>
1083    </target>
1084
1085    <target name="-def-check">
1086        <macrodef name="check">
1087            <attribute name="name"/>
1088            <attribute name="property"/>
1089            <attribute name="marker" default=""/>
1090            <sequential>
1091                <fail message="Cannot locate @{name}: please set @{property} to its location">
1092                    <condition>
1093                        <not>
1094                            <isset property="@{property}"/>
1095                        </not>
1096                    </condition>
1097                </fail>
1098                <fail message="@{name} is not installed in ${@{property}}">
1099                    <condition>
1100                        <and>
1101                            <not>
1102                                <equals arg1="@{marker}" arg2=""/>
1103                            </not>
1104                            <not>
1105                                <available file="${@{property}}/@{marker}"/>
1106                            </not>
1107                        </and>
1108                    </condition>
1109                </fail>
1110            </sequential>
1111        </macrodef>
1112    </target>
1113
1114</project>
1115
1116