build.xml revision 1044:18002d039806
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 Copyright (c) 2007, 2011, 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, apt
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.lib.dir" location="${dist.dir}/lib"/>
135    <property name="make.dir" location="make"/>
136    <property name="make.tools.dir" location="${make.dir}/tools"/>
137    <property name="src.dir" location="src"/>
138    <property name="src.bin.dir" location="${src.dir}/share/bin"/>
139    <property name="src.classes.dir" location="${src.dir}/share/classes"/>
140    <property name="test.dir" location="test"/>
141
142    <!-- java.marker is set to a marker file to check for within a Java install dir.
143         The best file to check for across Solaris/Linux/Windows/MacOS is one of the
144         executables; regrettably, that is OS-specific. -->
145    <condition property="java.marker" value="bin/java">
146        <os family="unix"/>
147    </condition>
148    <condition property="java.marker" value="bin/java.exe">
149        <os family="windows"/>
150    </condition>
151
152    <!-- Standard property values, if not overriden by earlier settings. -->
153    <property file="${make.dir}/build.properties"/>
154
155    <!-- launcher.java is used in the launcher scripts provided to run
156        the tools' jar files.  If it has not already been set, then
157        default it to use ${target.java.home}, if available, otherwise
158        quietly default to simply use "java". -->
159    <condition property="launcher.java"
160        value="${target.java.home}/bin/java" else="java">
161        <isset property="target.java.home"/>
162    </condition>
163
164    <!-- Logic for handling access import jdk classes, if available.
165        import.jdk should be unset, or set to jdk home (to use rt.jar)
166        or to jdk repo (to use src/share/classes).
167        Based on the value, if any, set up default values for javac's sourcepath,
168        classpath and bootclasspath. Note: the default values are overridden
169        in the build-bootstrap-classes macro. -->
170
171    <available property="import.jdk.src.dir" value="${import.jdk}/src/share/classes"
172        filepath="${import.jdk}/src/share/classes" file="java/nio/file/Path.java"/>
173    <available property="import.jdk.jar" value="${import.jdk}/jre/lib/rt.jar"
174        ignoresystemclasses="true"
175        classpath="${import.jdk}/jre/lib/rt.jar" classname="java.nio.file.Path"/>
176
177    <!-- Set the default bootclasspath option used for javac.
178        Note that different variants of the option are used, meaning we can't just
179        define the value for the option.
180        Note the explicit use of the standard property ${path.separator} in the following.
181        This is because Ant is not clever enough to handle direct use of : or ; -->
182    <condition property="javac.bootclasspath.opt"
183            value="-Xbootclasspath:${build.classes.dir}${path.separator}${import.jdk.jar}"
184            else="-Xbootclasspath/p:${build.classes.dir}">
185        <isset property="import.jdk.jar"/>
186    </condition>
187
188    <condition property="boot.java.provides.latest.jdk">
189        <available
190            ignoresystemclasses="true"
191            classpath="${boot.java.home}/jre/lib/rt.jar" classname="java.nio.file.Path"/>
192    </condition>
193
194    <condition property="bootstrap.exclude.files" value="" else="${require.latest.jdk.files}">
195        <isset property="boot.java.provides.latest.jdk"/>
196    </condition>
197
198    <condition property="exclude.files" value="" else="${require.latest.jdk.files}">
199        <or>
200            <isset property="boot.java.provides.latest.jdk"/>
201            <isset property="import.jdk"/>
202        </or>
203    </condition>
204
205    <condition property="require.import.jdk.stubs">
206        <and>
207            <not>
208                <isset property="boot.java.provides.latest.jdk"/>
209            </not>
210            <isset property="import.jdk.src.dir"/>
211        </and>
212    </condition>
213
214    <!-- Set the default value of the sourcepath used for javac. -->
215    <condition property="javac.sourcepath" value="${build.genstubs.dir}" else="">
216        <isset property="require.import.jdk.stubs"/>
217    </condition>
218
219    <!-- Set the default value of the classpath used for javac. -->
220    <property name="javac.classpath" value=""/>
221
222
223    <!--
224    **** General top level targets.
225    -->
226
227    <!-- Standard target to build deliverables for JDK build. -->
228
229    <target name="build" depends="build-bootstrap-tools,build-all-classes">
230        <copy todir="${dist.dir}/bootstrap">
231            <fileset dir="${build.bootstrap.dir}" includes="bin/,lib/"/>
232        </copy>
233        <chmod dir="${dist.dir}/bootstrap/bin" perm="ugo+rx">
234            <include name="*"/>
235        </chmod>
236        <mkdir dir="${dist.lib.dir}"/>
237        <jar file="${dist.lib.dir}/classes.jar" basedir="${build.classes.dir}"/>
238        <zip file="${dist.lib.dir}/src.zip" basedir="${src.classes.dir}"/>
239    </target>
240
241    <target name="build-bootstrap-tools"
242        depends="build-bootstrap-javac,build-bootstrap-javadoc,build-bootstrap-doclets,build-bootstrap-javah"
243    />
244
245    <target name="build-all-tools"
246        depends="build-javac,build-javadoc,build-doclets,build-javah,build-javap,build-apt"
247    />
248
249    <target name="build-all-classes" depends="build-bootstrap-javac,-create-import-jdk-stubs">
250        <build-classes includes="${javac.includes} ${javadoc.includes} ${doclets.includes} ${javah.includes} ${javap.includes} ${apt.includes}"/>
251    </target>
252
253    <!-- clean -->
254
255    <target name="clean" description="Delete all generated files">
256        <delete dir="${build.dir}"/>
257        <delete dir="${dist.dir}"/>
258    </target>
259
260    <!-- Additional targets for running tools on the build -->
261
262    <target name="jtreg" depends="build-all-tools,-def-jtreg">
263        <jtreg-tool name="all" tests="${jtreg.tests}"/>
264    </target>
265
266    <target name="findbugs" depends="-def-findbugs,build-all-tools">
267        <property name="findbugs.reportLevel" value="medium"/>
268        <mkdir dir="${dist.findbugs.dir}"/>
269        <findbugs
270            home="${findbugs.home}"
271            projectName="JDK langtools ${full.version}"
272            output="xml"
273            outputFile="${dist.findbugs.dir}/findbugs.xml"
274            reportLevel="${findbugs.reportLevel}"
275            failOnError="false"
276            errorProperty="findbugs.all.errors"
277            warningsProperty="findbugs.all.warnings"
278            jvm="${target.java.home}/bin/java"
279            jvmargs="-Xmx512M">
280            <class location="${build.classes.dir}"/>
281            <sourcePath>
282                <pathelement location="${src.classes.dir}"/>
283            </sourcePath>
284        </findbugs>
285        <exec executable="sh">
286            <arg value="${findbugs.home}/bin/convertXmlToText"/>
287            <arg value="-longBugCodes"/>
288            <arg value="-html:${findbugs.home}/src/xsl/fancy.xsl"/>
289            <arg value="${dist.findbugs.dir}/findbugs.xml"/>
290            <redirector output="${dist.findbugs.dir}/findbugs.html"/>
291        </exec>
292    </target>
293
294    <target name="coverage" depends="-def-cobertura,build-all-classes,instrument-classes,jtreg,coverage-report"/>
295
296    <target name="instrument-classes" depends="-def-cobertura">
297        <!-- only define the following property when we want coverage info -->
298        <path id="coverage.classpath">
299            <pathelement location="${build.coverage.dir}/classes"/>
300            <path refid="cobertura.classpath"/>
301        </path>
302        <property name="coverage.options" value="-Dnet.sourceforge.cobertura.datafile=${build.coverage.dir}/cobertura.ser"/>
303        <property name="coverage.classpath" refid="coverage.classpath"/>
304        <mkdir dir="${build.coverage.dir}/classes"/>
305        <delete file="${build.coverage.dir}/cobertura.ser"/>
306        <cobertura-instrument todir="${build.coverage.dir}/classes"
307            datafile="${build.coverage.dir}/cobertura.ser">
308            <fileset dir="${build.classes.dir}"
309               includes="**/*.class" excludes="**/resources/*.class"/>
310        </cobertura-instrument>
311    </target>
312
313    <target name="coverage-report" depends="-def-cobertura">
314        <mkdir dir="${dist.coverage.dir}"/>
315        <cobertura-report
316            srcdir="${src.classes.dir}"
317            destdir="${dist.coverage.dir}"
318            datafile="${build.coverage.dir}/cobertura.ser"/>
319        <cobertura-report
320            format="xml"
321            srcdir="${src.classes.dir}"
322            destdir="${dist.coverage.dir}"
323            datafile="${build.coverage.dir}/cobertura.ser"/>
324    </target>
325
326    <target name="diags-examples" depends="build-javac">
327        <!-- can override the following on the command line if desired. -->
328        <property name="diags.examples.out" location="${build.dir}/diag-examples/diags-examples.html"/>
329        <mkdir dir="${build.dir}/diag-examples/classes"/>
330        <javac fork="true"
331            executable="${dist.bin.dir}/javac"
332            srcdir="test/tools/javac/diags"
333            destdir="${build.dir}/diag-examples/classes"
334            includes="ArgTypeCompilerFactory.java,Example.java,FileManager.java,HTMLWriter.java,RunExamples.java"
335            sourcepath=""
336            classpath="${dist.lib.dir}/javac.jar"
337            includeAntRuntime="no"
338            debug="${javac.debug}"
339            debuglevel="${javac.debuglevel}">
340            <compilerarg line="${javac.lint.opts}"/>
341        </javac>
342        <java fork="true"
343            jvm="${target.java.home}/bin/java"
344            dir="test/tools/javac/diags"
345            classpath="${build.dir}/diag-examples/classes;${dist.lib.dir}/javac.jar"
346            classname="RunExamples">
347            <arg value="-examples"/>
348            <arg value="examples"/>
349            <arg value="-o"/>
350            <arg file="${diags.examples.out}"/>
351            <arg value="-showFiles"/>
352            <arg value="-title"/>
353            <arg value="Examples of javac diagnostics"/>
354        </java>
355    </target>
356
357    <!-- a patching facility to speed up incorporating the langtools' classfiles
358         into a jdk of your choice. Either target.java.home or patch.jdk can be
359         set on the command line; setting target.java.home has the advantage of
360         patching the jdk used for jtreg and other tests.
361    -->
362    <target name="patch" depends="build-all-classes">
363        <condition property="patch.jdk" value="${target.java.home}">
364            <available file="${target.java.home}" type="dir"/>
365        </condition>
366        <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">
367            <condition>
368                <not>
369                    <isset property="patch.jdk"/>
370                </not>
371            </condition>
372        </fail>
373        <property name="patch.tools.jar" location="${patch.jdk}/lib/tools.jar"/>
374        <property name="patch.rt.jar" location="${patch.jdk}/jre/lib/rt.jar"/>
375        <fail message="patch.jdk or target.java.home must point to a valid jdk image: missing tools.jar">
376            <condition>
377                <not>
378                    <available file="${patch.tools.jar}" type="file"/>
379                </not>
380            </condition>
381        </fail>
382        <fail message="patch.jdk or target.java.home must point to a valid jdk image: missing rt.jar">
383            <condition>
384                <not>
385                    <available file="${patch.rt.jar}" type="file"/>
386                </not>
387            </condition>
388        </fail>
389        <zip zipfile="${patch.tools.jar}" update="true">
390            <zipfileset dir="${build.classes.dir}" includes="com/**"/>
391        </zip>
392        <zip zipfile="${patch.rt.jar}" update="true">
393            <zipfileset dir="${build.classes.dir}" includes="javax/**"/>
394        </zip>
395    </target>
396
397    <!--
398    **** Debugging/diagnostic targets.
399    -->
400
401    <!-- standard JDK target -->
402    <target name="sanity"
403        description="display settings of configuration values">
404        <echo level="info">ant.home = ${ant.home}</echo>
405        <echo level="info">boot.java.home = ${boot.java.home}</echo>
406        <echo level="info">target.java.home = ${target.java.home}</echo>
407        <echo level="info">jtreg.home = ${jtreg.home}</echo>
408        <echo level="info">findbugs.home = ${findbugs.home}</echo>
409    </target>
410
411    <target name="post-sanity" depends="-def-jtreg,sanity,build"
412        description="perform basic validation after a standard build">
413        <jtreg
414            dir="make/test"
415            workDir="${build.jtreg.dir}/post-sanity/work"
416            reportDir="${build.jtreg.dir}/post-sanity/report"
417            jdk="${target.java.home}"
418            verbose="summary"
419            failonerror="false" resultproperty="jtreg.post-sanity.result">
420        </jtreg>
421    </target>
422
423    <!-- use vizant tool to generate graphical image of this Ant file.-->
424    <target name="vizant" depends="-def-vizant">
425        <mkdir dir="${build.dir}"/>
426        <echo message="Generating ${build.dir}/build.dot"/>
427        <vizant antfile="${make.dir}/build.xml" outfile="${build.dir}/build.dot"/>
428        <echo message="Generating ${build.dir}/build.png"/>
429        <exec executable="${dot}" >
430            <arg value="-Tpng"/>
431            <arg value="-o"/>
432            <arg file="${build.dir}/build.png"/>
433            <arg file="${build.dir}/build.dot"/>
434        </exec>
435    </target>
436
437    <target name="check-import.jdk">
438        <echo message="import.jdk: ${import.jdk}"/>
439        <echo message="import.jdk.jar: ${import.jdk.jar}"/>
440        <echo message="import.jdk.src.dir: ${import.jdk.src.dir}"/>
441    </target>
442
443    <target name="diagnostics">
444        <diagnostics/>
445    </target>
446
447
448    <!--
449    **** javac targets.
450    -->
451
452    <target name="build-bootstrap-javac"
453            depends="-def-build-bootstrap-classes,-def-build-bootstrap-jar,-def-build-bootstrap-tool">
454        <build-bootstrap-classes includes="${javac.includes}"/>
455        <build-bootstrap-jar     name="javac" includes="${javac.includes}"/>
456        <build-bootstrap-tool    name="javac"/>
457    </target>
458
459    <target name="build-classes-javac" depends="build-bootstrap-javac,-create-import-jdk-stubs">
460        <build-classes includes="${javac.includes}"/>
461    </target>
462
463    <target name="build-javac" depends="build-classes-javac">
464        <build-jar  name="javac" includes="${javac.includes}"/>
465        <build-tool name="javac"/>
466    </target>
467
468    <target name="javadoc-javac" depends="build-javac,-def-javadoc-tool">
469        <javadoc-tool name="javac" includes="${javac.includes}" options="${javadoc.jls.option}"/>
470    </target>
471
472    <target name="jtreg-javac" depends="build-javac,build-javap,-def-jtreg">
473        <jtreg-tool name="javac" tests="${javac.tests}"/>
474    </target>
475
476    <target name="findbugs-javac" depends="build-javac,-def-findbugs">
477        <findbugs-tool name="javac"/>
478    </target>
479
480    <target name="javac" depends="build-javac,jtreg-javac,findbugs-javac"/>
481
482
483    <!--
484    **** javadoc targets.
485    -->
486
487    <target name="build-bootstrap-javadoc" depends="build-bootstrap-javac">
488        <build-bootstrap-classes includes="${javadoc.includes}"/>
489        <build-bootstrap-jar     name="javadoc" includes="${javadoc.includes}"
490                                 jarclasspath="javac.jar doclets.jar"/>
491        <build-bootstrap-tool    name="javadoc"/>
492    </target>
493
494    <target name="build-classes-javadoc" depends="build-classes-javac">
495        <build-classes includes="${javadoc.includes}"/>
496    </target>
497
498    <target name="build-javadoc" depends="build-javac,build-classes-javadoc">
499        <build-jar  name="javadoc" includes="${javadoc.includes}"
500                    jarclasspath="javac.jar doclets.jar"/>
501        <build-tool name="javadoc"/>
502    </target>
503
504    <target name="javadoc-javadoc" depends="build-javadoc,-def-javadoc-tool">
505        <javadoc-tool name="javadoc" includes="${javadoc.includes}"/>
506    </target>
507
508    <target name="jtreg-javadoc" depends="build-javadoc,-def-jtreg">
509        <jtreg-tool name="javadoc" tests="${javadoc.tests}"/>
510    </target>
511
512    <target name="findbugs-javadoc" depends="build-javadoc,-def-findbugs">
513        <findbugs-tool name="javadoc"/>
514    </target>
515
516    <target name="javadoc" depends="build-javadoc,jtreg-javadoc,findbugs-javadoc"/>
517
518
519    <!--
520    **** doclets targets.
521    -->
522
523    <target name="build-bootstrap-doclets" depends="build-bootstrap-javadoc,-def-build-bootstrap-jar">
524        <build-bootstrap-classes includes="${doclets.includes}"/>
525        <build-bootstrap-jar     name="doclets" includes="${doclets.includes}"
526                                 jarmainclass="com.sun.tools.javadoc.Main"
527                                 jarclasspath="javadoc.jar"/>
528    </target>
529
530    <target name="build-classes-doclets" depends="build-classes-javadoc">
531        <build-classes includes="${doclets.includes}"/>
532    </target>
533
534    <target name="build-doclets" depends="build-javadoc,build-classes-doclets">
535        <!-- just jar, no bin for doclets -->
536        <build-jar name="doclets" includes="${doclets.includes}" jarclasspath="javadoc.jar"/>
537    </target>
538
539    <!-- (no javadoc for doclets) -->
540
541    <target name="jtreg-doclets" depends="build-doclets,-def-jtreg">
542        <jtreg-tool name="doclets" tests="${doclets.tests}"/>
543    </target>
544
545    <target name="findbugs-doclets" depends="build-doclets,-def-findbugs">
546        <findbugs-tool name="doclets"/>
547    </target>
548
549    <target name="doclets" depends="build-doclets,jtreg-doclets,findbugs-doclets"/>
550
551
552    <!--
553    **** javah targets.
554    -->
555
556    <target name="build-bootstrap-javah" depends="build-bootstrap-javadoc">
557        <build-bootstrap-classes includes="${javah.includes}"/>
558        <build-bootstrap-jar     name="javah" includes="${javah.includes}"
559                                 jarclasspath="javadoc.jar doclets.jar javac.jar"/>
560        <build-bootstrap-tool    name="javah"/>
561    </target>
562
563    <target name="build-javah" depends="build-javac,build-classes-javah">
564        <build-jar  name="javah" includes="${javah.includes}" jarclasspath="javac.jar"/>
565        <build-tool name="javah"/>
566    </target>
567
568    <target name="build-classes-javah" depends="build-classes-javadoc">
569        <build-classes includes="${javah.includes}"/>
570    </target>
571
572    <!-- (no javadoc for javah) -->
573
574    <target name="jtreg-javah" depends="build-javah,-def-jtreg">
575        <jtreg-tool name="javah" tests="${javah.tests}"/>
576    </target>
577
578    <target name="findbugs-javah" depends="build-javah,-def-findbugs">
579        <findbugs-tool name="javah"/>
580    </target>
581
582    <target name="javah" depends="build-javah,jtreg-javah,findbugs-javah"/>
583
584
585    <!--
586    **** javap targets.
587    -->
588
589    <target name="build-bootstrap-javap"
590            depends="-def-build-bootstrap-classes,-def-build-bootstrap-jar,-def-build-bootstrap-tool">
591        <build-bootstrap-classes includes="${javap.includes}"/>
592        <build-bootstrap-jar     name="javap" includes="${javap.includes}"
593                                 jarmainclass="sun.tools.javap.Main"/>
594        <build-bootstrap-tool    name="javap"/>
595    </target>
596
597    <target name="build-classes-javap" depends="build-classes-javac">
598        <build-classes includes="${javap.includes}"/>
599    </target>
600
601    <target name="build-javap" depends="build-javac,build-classes-javap">
602        <build-jar  name="javap" includes="${javap.includes}"
603                    jarmainclass="com.sun.tools.javap.Main"
604                    jarclasspath="javac.jar"/>
605        <build-tool name="javap"/>
606    </target>
607
608    <!-- (no javadoc for javap) -->
609
610    <target name="jtreg-javap" depends="build-javap,-def-jtreg">
611        <jtreg-tool name="javap" tests="${javap.tests}"/>
612    </target>
613
614    <target name="findbugs-javap" depends="build-javap,-def-findbugs">
615        <findbugs-tool name="javap"/>
616    </target>
617
618    <target name="javap" depends="build-javap,jtreg-javap,findbugs-javap"/>
619
620
621    <!--
622    **** apt targets.
623    -->
624
625    <target name="build-bootstrap-apt" depends="build-bootstrap-javac">
626        <build-bootstrap-classes includes="${apt.includes}"/>
627        <build-bootstrap-jar     name="apt" includes="${apt.includes}"
628                                 jarclasspath="javac.jar"/>
629        <build-bootstrap-tool    name="apt"/>
630    </target>
631
632    <target name="build-apt" depends="build-javac,build-classes-apt">
633        <build-jar  name="apt" includes="${apt.includes}" jarclasspath="javac.jar"/>
634        <build-tool name="apt"/>
635    </target>
636
637    <target name="build-classes-apt" depends="build-classes-javac">
638        <build-classes includes="${apt.includes}"/>
639    </target>
640
641    <target name="javadoc-apt" depends="build-apt,-def-javadoc-tool">
642        <javadoc-tool name="apt" includes="${apt.includes}"/>
643    </target>
644
645
646    <target name="jtreg-apt" depends="build-apt,-def-jtreg">
647        <jtreg-tool name="apt" tests="${apt.tests}"/>
648    </target>
649
650    <target name="findbugs-apt" depends="build-apt,-def-findbugs">
651        <findbugs-tool name="apt"/>
652    </target>
653
654    <target name="apt" depends="build-apt,jtreg-apt,findbugs-apt"/>
655
656
657    <!--
658    **** Create import JDK stubs.
659    -->
660
661    <target name="-create-import-jdk-stubs" depends="-def-genstubs" if="require.import.jdk.stubs">
662        <mkdir dir="${build.genstubs.dir}"/>
663        <genstubs
664            srcdir="${import.jdk.src.dir}" destdir="${build.genstubs.dir}"
665            includes="${import.jdk.stub.files}"
666            fork="true" classpath="${build.toolclasses.dir}:${build.bootstrap.dir}/classes:${ant.core.lib}"
667        />
668    </target>
669
670
671    <!--
672    **** Check targets.
673    **** "-check-*" targets check that a required property is set, and set to a reasonable value.
674    **** A user friendly message is generated if not, and the build exits.
675    -->
676
677    <target name="-check-boot.java.home" depends="-def-check">
678        <check name="bootstrap java" property="boot.java.home" marker="${java.marker}"/>
679    </target>
680
681    <target name="-check-target.java.home" depends="-def-check">
682        <check name="target java" property="target.java.home" marker="${java.marker}"/>
683    </target>
684
685    <target name="-check-cobertura.home" depends="-def-check">
686        <check name="cobertura" property="cobertura.home" marker="cobertura.jar"/>
687    </target>
688
689    <target name="-check-findbugs.home" depends="-def-check">
690        <check name="findbugs" property="findbugs.home" marker="lib/findbugs.jar"/>
691    </target>
692
693    <target name="-check-jtreg.home" depends="-def-check">
694        <check name="jtreg" property="jtreg.home" marker="lib/jtreg.jar"/>
695    </target>
696
697    <target name="-check-vizant" depends="-def-check">
698        <check name="vizant" property="vizant.jar"/>
699        <check name="dot" property="dot"/>
700    </target>
701
702
703    <!--
704    **** Targets for Ant macro and task definitions.
705    -->
706
707    <target name="-def-build-tool">
708        <macrodef name="build-tool">
709            <attribute name="name"/>
710            <attribute name="bin.dir" default="${dist.bin.dir}"/>
711            <attribute name="java" default="${launcher.java}"/>
712            <sequential>
713                <mkdir dir="@{bin.dir}"/>
714                <copy file="${src.bin.dir}/launcher.sh-template" tofile="@{bin.dir}/@{name}">
715                    <filterset begintoken="#" endtoken="#">
716                        <filter token="PROGRAM" value="@{name}"/>
717                        <filter token="TARGET_JAVA" value="@{java}"/>
718                        <filter token="PS" value="${path.separator}"/>
719                    </filterset>
720                </copy>
721                <chmod file="@{bin.dir}/@{name}" perm="ugo+rx"/>
722            </sequential>
723        </macrodef>
724    </target>
725
726    <target name="-def-build-jar">
727        <macrodef name="build-jar">
728            <attribute name="name"/>
729            <attribute name="includes"/>
730            <attribute name="classes.dir" default="${build.classes.dir}"/>
731            <attribute name="lib.dir" default="${dist.lib.dir}"/>
732            <attribute name="jarmainclass" default="com.sun.tools.@{name}.Main"/>
733            <attribute name="jarclasspath" default=""/>
734            <sequential>
735                <mkdir dir="@{lib.dir}"/>
736                <jar destfile="@{lib.dir}/@{name}.jar"
737                     basedir="@{classes.dir}"
738                     includes="@{includes}">
739                    <manifest>
740                        <attribute name="Main-Class" value="@{jarmainclass}"/>
741                        <attribute name="Class-Path" value="@{jarclasspath}"/>
742                    </manifest>
743                </jar>
744            </sequential>
745        </macrodef>
746    </target>
747
748    <target name="-def-build-classes" depends="-def-pcompile">
749        <macrodef name="build-classes">
750            <attribute name="includes"/>
751            <attribute name="excludes" default="${exclude.files} **/package-info.java"/>
752            <attribute name="classes.dir" default="${build.classes.dir}"/>
753            <attribute name="gensrc.dir" default="${build.gensrc.dir}"/>
754            <attribute name="javac.bootclasspath" default="${build.bootstrap.dir}/classes"/>
755            <attribute name="bootclasspath.opt" default="${javac.bootclasspath.opt}"/>
756            <attribute name="classpath" default="${javac.classpath}"/>
757            <attribute name="sourcepath" default="${javac.sourcepath}"/>
758            <attribute name="java.home" default="${boot.java.home}"/>
759            <attribute name="source" default="${javac.source}"/>
760            <attribute name="target" default="${javac.target}"/>
761            <attribute name="release" default="${release}"/>
762            <attribute name="full.version" default="${full.version}"/>
763            <sequential>
764                <echo level="verbose" message="build-classes: excludes=@{excludes}"/>
765                <echo level="verbose" message="build-classes: bootclasspath.opt=@{bootclasspath.opt}"/>
766                <echo level="verbose" message="build-classes: classpath=@{classpath}"/>
767                <echo level="verbose" message="build-classes: sourcepath=@{sourcepath}"/>
768                <mkdir dir="@{gensrc.dir}"/>
769                <mkdir dir="@{classes.dir}"/>
770                <pcompile srcdir="${src.classes.dir}"
771                          destdir="@{gensrc.dir}"
772                          includes="@{includes}"/>
773                <copy todir="@{gensrc.dir}">
774                    <fileset dir="${src.classes.dir}" includes="@{includes}"/>
775                    <globmapper from="*.properties-template" to="*.properties"/>
776                    <filterset begintoken="$(" endtoken=")">
777                        <filter token="JDK_VERSION" value="${jdk.version}"/>
778                        <filter token="RELEASE" value="@{release}"/>
779                        <filter token="FULL_VERSION" value="@{full.version}"/>
780                    </filterset>
781                </copy>
782                <pcompile srcdir="@{gensrc.dir}"
783                          destdir="@{gensrc.dir}"
784                          includes="**/*.properties"/>
785                <javac fork="true"
786                       executable="@{java.home}/bin/javac"
787                       srcdir="${src.classes.dir}:@{gensrc.dir}"
788                       destdir="@{classes.dir}"
789                       includes="@{includes}"
790                       excludes="@{excludes}"
791                       sourcepath="@{sourcepath}"
792                       classpath="@{classpath}"
793                       includeAntRuntime="no"
794                       source="@{source}"
795                       target="@{target}"
796                       debug="${javac.debug}"
797                       debuglevel="${javac.debuglevel}">
798                    <compilerarg value="-implicit:none"/>
799                    <compilerarg value="-Xprefer:source"/>
800                    <compilerarg value="-J-Xbootclasspath/p:@{javac.bootclasspath}"/>
801                    <compilerarg line="@{bootclasspath.opt}"/>
802                    <compilerarg line="${javac.no.jdk.warnings}"/>
803                    <compilerarg line="${javac.version.opt}"/>
804                    <compilerarg line="${javac.lint.opts}"/>
805                </javac>
806                <copy todir="@{classes.dir}" includeemptydirs="false">
807                    <fileset dir="${src.classes.dir}" includes="@{includes}" excludes="@{excludes}">
808                        <exclude name="**/*.java"/>
809                        <exclude name="**/*.properties"/>
810                        <exclude name="**/*-template"/>
811                        <exclude name="**/*.rej"/>
812                        <exclude name="**/*.orig"/>
813                        <exclude name="**/overview.html"/>
814                        <exclude name="**/package.html"/>
815                    </fileset>
816                </copy>
817            </sequential>
818        </macrodef>
819    </target>
820
821    <target name="-def-build-bootstrap-tool" depends="-check-boot.java.home,-def-build-tool">
822        <presetdef name="build-bootstrap-tool">
823            <build-tool
824                bin.dir="${build.bootstrap.dir}/bin"
825                java="${boot.java}"/>
826        </presetdef>
827    </target>
828
829    <target name="-def-build-bootstrap-jar" depends="-def-build-jar">
830        <presetdef name="build-bootstrap-jar">
831            <build-jar
832                classes.dir="${build.bootstrap.dir}/classes"
833                lib.dir="${build.bootstrap.dir}/lib"/>
834        </presetdef>
835    </target>
836
837    <target name="-def-build-bootstrap-classes" depends="-def-build-classes">
838        <presetdef name="build-bootstrap-classes">
839            <build-classes
840                source="${boot.javac.source}"
841                target="${boot.javac.target}"
842                gensrc.dir="${build.bootstrap.dir}/gensrc"
843                classes.dir="${build.bootstrap.dir}/classes"
844                javac.bootclasspath=""
845                bootclasspath.opt="-Xbootclasspath/p:${build.bootstrap.dir}/classes"
846                sourcepath=""
847                release="${bootstrap.release}"
848                full.version="${bootstrap.full.version}"
849                excludes="${bootstrap.exclude.files} **/package-info.java"/>
850        </presetdef>
851    </target>
852
853    <target name="-def-pcompile">
854        <mkdir dir="${build.toolclasses.dir}"/>
855        <javac fork="true"
856               source="${boot.javac.source}"
857               target="${boot.javac.target}"
858               executable="${boot.java.home}/bin/javac"
859               srcdir="${make.tools.dir}/CompileProperties"
860               destdir="${build.toolclasses.dir}/"
861               classpath="${ant.core.lib}"
862               bootclasspath="${boot.java.home}/jre/lib/rt.jar"
863               includeantruntime="false">
864            <compilerarg line="${javac.lint.opts}"/>
865        </javac>
866        <taskdef name="pcompile"
867                 classname="CompilePropertiesTask"
868                 classpath="${build.toolclasses.dir}/"/>
869    </target>
870
871    <target name="-def-genstubs" depends="build-bootstrap-javac" if="require.import.jdk.stubs">
872        <mkdir dir="${build.toolclasses.dir}"/>
873        <javac fork="true"
874               source="${boot.javac.source}"
875               target="${boot.javac.target}"
876               executable="${boot.java.home}/bin/javac"
877               srcdir="${make.tools.dir}/GenStubs"
878               destdir="${build.toolclasses.dir}/"
879               classpath="${ant.core.lib}"
880               includeantruntime="false">
881            <compilerarg value="-Xbootclasspath/p:${build.bootstrap.dir}/classes"/>
882            <compilerarg line="${javac.lint.opts}"/>
883        </javac>
884        <taskdef name="genstubs"
885                 classname="GenStubs$$Ant"
886                 classpath="${build.toolclasses.dir}/"/>
887    </target>
888
889    <target name="-def-javadoc-tool" depends="-check-target.java.home">
890        <macrodef name="javadoc-tool">
891            <attribute name="name"/>
892            <attribute name="includes"/>
893            <attribute name="options" default=""/>
894            <attribute name="source" default="1.5"/> <!-- FIXME -->
895            <sequential>
896                <property name="javadoc.options" value=""/> <!-- default, can be overridden per user or per project -->
897                <!-- Note: even with this default value, includes
898                from src.classes.dir get javadoc'd; see packageset below -->
899                <property name="javadoc.packagenames" value="none"/> <!-- default, can be overridden per user or per project -->
900                <javadoc
901                    executable="${target.java.home}/bin/javadoc"
902                    destdir="${build.javadoc.dir}/@{name}"
903                    source="@{source}"
904                    windowtitle="UNOFFICIAL"
905                    failonerror="true"
906                    use="true"
907                    author="false"
908                    version="false"
909                    packagenames="${javadoc.packagenames}" >
910                    <header><![CDATA[<strong>Unofficial Javadoc</strong> generated from developer sources for preview purposes only]]></header>
911                    <arg line="@{options}"/>
912                    <bootclasspath>
913                        <path location="${build.classes.dir}"/>
914                        <path location="${target.java.home}/jre/lib/rt.jar"/>
915                    </bootclasspath>
916                    <sourcepath>
917                        <pathelement location="${src.classes.dir}"/>
918                    </sourcepath>
919                    <!-- XXX just <fileset> (restricted further to **/*.java) and no <packageset> -->
920                    <!-- means that {@link some.package} will not work, which is no good. -->
921                    <!-- (It correctly skips excluded single classes, but not if packageset is also included, -->
922                    <!-- which also causes duplicates in the class index for included files.) -->
923                    <packageset dir="${src.classes.dir}" includes="@{includes}">
924                        <or>
925                            <filename name="java/"/>
926                            <filename name="javax/"/>
927                            <filename name="com/sun/javadoc/"/>
928                            <filename name="com/sun/mirror/"/>
929                            <filename name="com/sun/source/"/>
930                        </or>
931                    </packageset>
932                </javadoc>
933            </sequential>
934        </macrodef>
935    </target>
936
937    <target name="-def-jtreg" unless="jtreg.defined" depends="-check-jtreg.home,-check-target.java.home">
938        <taskdef name="jtreg" classname="com.sun.javatest.regtest.Main$$Ant">
939            <classpath>
940                <pathelement location="${jtreg.home}/lib/jtreg.jar"/>
941                <pathelement location="${jtreg.home}/lib/javatest.jar"/>
942            </classpath>
943        </taskdef>
944        <macrodef name="jtreg-tool">
945            <attribute name="name"/>
946            <attribute name="tests"/>
947            <attribute name="jdk" default="${target.java.home}"/>
948            <attribute name="samevm" default="true"/>
949            <attribute name="verbose" default="${default.jtreg.verbose}"/>
950            <attribute name="options" default="${other.jtreg.options}"/>
951            <attribute name="keywords" default="-keywords:!ignore"/>
952            <attribute name="jpda.jvmargs" default=""/>
953            <sequential>
954                <property name="coverage.options" value=""/>              <!-- default -->
955                <property name="coverage.classpath" value=""/>            <!-- default -->
956                <property name="default.jtreg.verbose" value="summary"/>  <!-- default -->
957                <property name="other.jtreg.options" value=""/>           <!-- default -->
958                <jtreg
959                    dir="${test.dir}"
960                    workDir="${build.jtreg.dir}/@{name}/work"
961                    reportDir="${build.jtreg.dir}/@{name}/report"
962                    jdk="@{jdk}"
963                    samevm="@{samevm}" verbose="@{verbose}"
964                    failonerror="false" resultproperty="jtreg.@{name}.result"
965                    javacoptions="-g"
966                    vmoptions="${coverage.options} -Xbootclasspath/p:${coverage.classpath}:${build.classes.dir} @{jpda.jvmargs}">
967                    <arg line="@{keywords}"/>
968                    <arg line="@{options}"/>
969                    <arg line="@{tests}"/>
970                </jtreg>
971                <!-- the next two properties are for convenience, when only
972                     a single instance of jtreg will be invoked. -->
973                <condition property="jtreg.passed">
974                    <equals arg1="${jtreg.@{name}.result}" arg2="0"/>
975                </condition>
976                <property name="jtreg.report" value="${build.jtreg.dir}/@{name}/report"/>
977            </sequential>
978        </macrodef>
979        <property name="jtreg.defined" value="true"/>
980    </target>
981
982    <target name="-def-cobertura" depends="-check-cobertura.home">
983        <path id="cobertura.classpath">
984            <fileset dir="${cobertura.home}">
985                <include name="cobertura.jar"/>
986                <include name="lib/**/*.jar"/>
987            </fileset>
988        </path>
989        <taskdef classpathref="cobertura.classpath" resource="tasks.properties"/>
990    </target>
991
992    <target name="-def-findbugs" unless="findbugs.defined"
993        depends="-check-findbugs.home,-check-target.java.home">
994        <taskdef name="findbugs" classname="edu.umd.cs.findbugs.anttask.FindBugsTask">
995            <classpath>
996                <pathelement location="${findbugs.home}/lib/findbugs.jar"/>
997            </classpath>
998        </taskdef>
999        <macrodef name="findbugs-tool">
1000            <attribute name="name"/>
1001            <attribute name="output" default="emacs"/>
1002            <attribute name="outputFile" default=""/>
1003            <attribute name="reportLevel" default="high"/>
1004            <sequential>
1005                <findbugs
1006                    home="${findbugs.home}"
1007                    output="@{output}"
1008                    outputFile="@{outputFile}"
1009                    reportLevel="@{reportLevel}"
1010                    failOnError="false"
1011                    errorProperty="findbugs.@{name}.errors"
1012                    warningsProperty="findbugs.@{name}.warnings"
1013                    jvm="${target.java.home}/bin/java"
1014                    jvmargs="-Xmx512M" >
1015                    <class location="${dist.dir}/lib/@{name}.jar"/>
1016                    <auxClasspath>
1017                        <pathelement location="${build.classes.dir}"/>
1018                    </auxClasspath>
1019                    <sourcePath>
1020                        <pathelement location="${src.classes.dir}"/>
1021                    </sourcePath>
1022                </findbugs>
1023            </sequential>
1024        </macrodef>
1025        <property name="findbugs.defined" value="true"/>
1026    </target>
1027
1028    <target name="-def-vizant" unless="vizant.defined" depends="-check-vizant">
1029        <taskdef name="vizant" classname="net.sourceforge.vizant.Vizant" classpath="${vizant.jar}"/>
1030        <property name="vizant.defined" value="true"/>
1031    </target>
1032
1033    <target name="-def-check">
1034        <macrodef name="check">
1035            <attribute name="name"/>
1036            <attribute name="property"/>
1037            <attribute name="marker" default=""/>
1038            <sequential>
1039                <fail message="Cannot locate @{name}: please set @{property} to its location">
1040                    <condition>
1041                        <not>
1042                            <isset property="@{property}"/>
1043                        </not>
1044                    </condition>
1045                </fail>
1046                <fail message="@{name} is not installed in ${@{property}}">
1047                    <condition>
1048                        <and>
1049                            <not>
1050                                <equals arg1="@{marker}" arg2=""/>
1051                            </not>
1052                            <not>
1053                                <available file="${@{property}}/@{marker}"/>
1054                            </not>
1055                        </and>
1056                    </condition>
1057                </fail>
1058            </sequential>
1059        </macrodef>
1060    </target>
1061
1062</project>
1063
1064