8050805: Add a target to langtools/make/build.xml to generate docs for test library classes
Reviewed-by: ksrini
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2007, 2014, Oracle and/or its affiliates. All rights reserved.
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
This code is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 only, as
published by the Free Software Foundation. Oracle designates this
particular file as subject to the "Classpath" exception as provided
by Oracle in the LICENSE file that accompanied this code.
This code is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
version 2 for more details (a copy is included in the LICENSE file that
accompanied this code).
You should have received a copy of the GNU General Public License version
2 along with this work; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
or visit www.oracle.com if you need additional information or have any
questions.
-->
<!--
This is the main build file for the complete langtools repository.
It is used when building JDK (in which case it is invoked from the
Makefile), and it can be used when working on the tools themselves,
in an IDE such as NetBeans.
External dependencies are specified via properties. These can be given
on the command line, or by providing a local build.properties file.
(They can also be edited into make/build.properties, although that is not
recommended.) At a minimum, boot.java.home must be set to the installed
location of the version of JDK used to build this repository. Additional
properties may be required, depending on the targets that are built.
For example, to run any of the jtreg tests you must set jtreg.home,
to run findbugs on the code you must set findbugs.home, and so on.
For the most part, javac can be built using the previous version of JDK.
However, a small number of javac files require access to the latest JDK,
which may not yet have been compiled. To compile these files, you can do
one of the following:
- Set boot.java.home to a recent build of the latest version of JDK.
- Set import.jdk to either a recent build (containing jre/lib/rt.jar)
or to jdk source repository. In the latter case, stub files will
automatically be generated and used for the required API, to avoid
unnecessary compilation of the source repository.
If you do neither, the relevant files will not be built.
The main build happens in two phases:
- First, javac and other tools as needed are built using ${boot.java.home}.
(This implies a constraint on the source code that they can be compiled
with the previous version of JDK.
- Second, all required classes are compiled with the latest javac, created
in the previous step.
The first phase is called the bootstrap phase. All targets, properties and
tasks that are specific to that phase have "bootstrap" in their name.
For more details on the JDK build, see
http://blogs.sun.com/kto/entry/anatomy_of_the_jdk_build
http://openjdk.java.net/groups/build/
For more details on the stub generator, see
http://blogs.sun.com/jjg/entry/building_javac_for_jdk7
Internal details ...
Interim build products are created in the build/ directory.
Final build products are created in the dist/ directory.
When building JDK, the dist/directory will contain:
- A bootstrap compiler suitable for running with ${boot.java.home}
suitable for compiling downstream parts of JDK
- Source files and class files for inclusion in the JDK being built
When building standalone, the dist/directory will contain:
- Separate jar files for each of the separate langtools components
- Simple scripts to invoke the tools by executing the corresponding
jar files.
These jar files and scripts are "for developer use only".
This file is organized into sections as follows:
- global property definitions
- general top level targets
- general diagnostic/debugging targets
- groups of targets for each tool: javac, javadoc, doclets, javah, javap
Within each group, the following targets are provided, where applicable
build-bootstrap-TOOL build the bootstrap version of the tool
build-classes-TOOL build the classes for the tool
build-TOOL build the jar file and script for the tool
jtreg-TOOL build the tool and run the appropriate tests
findbugs-TOOL run findbugs on the tool's source code
TOOL build the tool, run the tests, and run findbugs
- utility definitions
-->
<project name="langtools" default="build" basedir="..">
<!--
**** Global property definitions.
-->
<!-- Force full debuginfo for javac if the debug.classfiles
property is set. This must be BEFORE the include of
build.properties because it sets javac.debuglevel. -->
<condition property="javac.debuglevel" value="source,lines,vars">
<equals arg1="${debug.classfiles}" arg2="true"/>
</condition>
<!-- The following locations can be used to override default property values. -->
<!-- Use this location for customizations specific to this instance of this workspace -->
<property file="build.properties"/>
<!-- Use this location for customizations common to all OpenJDK langtools workspaces -->
<property file="${user.home}/.openjdk/${ant.project.name}-build.properties"/>
<!-- Use this location for customizations common to all OpenJDK workspaces -->
<property file="${user.home}/.openjdk/build.properties"/>
<!-- Convenient shorthands for standard locations within the workspace. -->
<property name="build.dir" location="build"/>
<property name="build.bootstrap.dir" location="${build.dir}/bootstrap"/>
<property name="build.coverage.dir" location="${build.dir}/coverage"/>
<property name="build.classes.dir" location="${build.dir}/classes"/>
<property name="build.gensrc.dir" location="${build.dir}/gensrc"/>
<property name="build.genstubs.dir" location="${build.dir}/genstubs"/>
<property name="build.javadoc.dir" location="${build.dir}/javadoc"/>
<property name="build.jtreg.dir" location="${build.dir}/jtreg"/>
<property name="build.toolclasses.dir" location="${build.dir}/toolclasses"/>
<property name="dist.dir" location="dist"/>
<property name="dist.bin.dir" location="${dist.dir}/bin"/>
<property name="dist.coverage.dir" location="${dist.dir}/coverage"/>
<property name="dist.findbugs.dir" location="${dist.dir}/findbugs"/>
<property name="dist.checkstyle.dir" location="${dist.dir}/checkstyle"/>
<property name="dist.lib.dir" location="${dist.dir}/lib"/>
<property name="make.dir" location="make"/>
<property name="make.conf.dir" location="${make.dir}/conf"/>
<property name="make.tools.dir" location="${make.dir}/tools"/>
<property name="src.dir" location="src"/>
<property name="src.bin.dir" location="${src.dir}/share/bin"/>
<property name="src.classes.dir" location="${src.dir}/share/classes"/>
<property name="test.dir" location="test"/>
<!-- java.marker is set to a marker file to check for within a Java install dir.
The best file to check for across Solaris/Linux/Windows/MacOS is one of the
executables; regrettably, that is OS-specific. -->
<condition property="java.marker" value="bin/java">
<os family="unix"/>
</condition>
<condition property="java.marker" value="bin/java.exe">
<os family="windows"/>
</condition>
<!-- Standard property values, if not overriden by earlier settings. -->
<property file="${make.dir}/build.properties"/>
<!-- launcher.java is used in the launcher scripts provided to run
the tools' jar files. If it has not already been set, then
default it to use ${target.java.home}, if available, otherwise
quietly default to simply use "java". -->
<condition property="launcher.java"
value="${target.java.home}/bin/java" else="java">
<isset property="target.java.home"/>
</condition>
<!-- Logic for handling access import jdk classes, if available.
import.jdk should be unset, or set to jdk home (to use rt.jar)
or to jdk repo (to use src/share/classes).
Based on the value, if any, set up default values for javac's sourcepath,
classpath and bootclasspath. Note: the default values are overridden
in the build-bootstrap-classes macro. -->
<available property="import.jdk.src.dir" value="${import.jdk}/src/share/classes"
filepath="${import.jdk}/src/share/classes" file="java/nio/file/Path.java"/>
<available property="import.jdk.jar" value="${import.jdk}/jre/lib/rt.jar"
ignoresystemclasses="true"
classpath="${import.jdk}/jre/lib/rt.jar" classname="java.nio.file.Path"/>
<!-- Set the default bootclasspath option used for javac.
Note that different variants of the option are used, meaning we can't just
define the value for the option.
Note the explicit use of the standard property ${path.separator} in the following.
This is because Ant is not clever enough to handle direct use of : or ; -->
<condition property="javac.bootclasspath.opt"
value="-Xbootclasspath:${build.classes.dir}${path.separator}${import.jdk.jar}"
else="-Xbootclasspath/p:${build.classes.dir}">
<isset property="import.jdk.jar"/>
</condition>
<condition property="boot.java.provides.latest.jdk">
<available
ignoresystemclasses="true"
classpath="${boot.java.home}/jre/lib/rt.jar" classname="java.nio.file.Path"/>
</condition>
<condition property="bootstrap.exclude.files" value="" else="${require.latest.jdk.files}">
<isset property="boot.java.provides.latest.jdk"/>
</condition>
<condition property="exclude.files" value="" else="${require.latest.jdk.files}">
<or>
<isset property="boot.java.provides.latest.jdk"/>
<isset property="import.jdk"/>
</or>
</condition>
<condition property="require.import.jdk.stubs">
<and>
<not>
<isset property="boot.java.provides.latest.jdk"/>
</not>
<isset property="import.jdk.src.dir"/>
</and>
</condition>
<!-- Set the default value of the sourcepath used for javac. -->
<condition property="javac.sourcepath" value="${build.genstubs.dir}" else="">
<isset property="require.import.jdk.stubs"/>
</condition>
<!-- Set the default value of the classpath used for javac. -->
<property name="javac.classpath" value=""/>
<!--
**** General top level targets.
-->
<!-- Standard target to build deliverables for JDK build. -->
<target name="build" depends="build-bootstrap-tools,build-all-classes">
<copy todir="${dist.dir}/bootstrap">
<fileset dir="${build.bootstrap.dir}" includes="bin/,lib/"/>
</copy>
<chmod dir="${dist.dir}/bootstrap/bin" perm="ugo+rx">
<include name="*"/>
</chmod>
<mkdir dir="${dist.lib.dir}"/>
<jar file="${dist.lib.dir}/classes.jar" basedir="${build.classes.dir}"/>
<zip file="${dist.lib.dir}/src.zip" basedir="${src.classes.dir}"/>
</target>
<target name="build-bootstrap-tools"
depends="build-bootstrap-javac,build-bootstrap-javadoc,build-bootstrap-doclets,build-bootstrap-javah,build-bootstrap-sjavac"
/>
<target name="build-all-tools"
depends="build-javac,build-javadoc,build-doclets,build-javah,build-javap,build-sjavac"
/>
<target name="build-all-classes" depends="build-bootstrap-javac,-create-import-jdk-stubs">
<build-classes includes="${javac.includes} ${javadoc.includes} ${doclets.includes} ${javah.includes} ${javap.includes} ${sjavac.includes}"/>
</target>
<!-- clean -->
<target name="clean" description="Delete all generated files">
<delete dir="${build.dir}"/>
<delete dir="${dist.dir}"/>
</target>
<!-- Additional targets for running tools on the build -->
<target name="jtreg" depends="build-all-tools,-def-jtreg">
<jtreg-tool name="all" tests="${jtreg.tests}"/>
</target>
<target name="checkstyle" depends="-def-checkstyle"
description="Generates reports for code convention violations.">
<mkdir dir="${dist.checkstyle.dir}"/>
<checkstyle config="${make.conf.dir}/checkstyle-langtools.xml"
failureProperty="checkstyle.failure"
failOnViolation="false">
<formatter type="xml" tofile="${dist.checkstyle.dir}/checkstyle_report.xml"/>
<fileset dir="src" includes="**/*.java, **/*.properties"/>
</checkstyle>
<!-- transform the output to a simple html -->
<xslt in="${dist.checkstyle.dir}/checkstyle_report.xml"
out="${dist.checkstyle.dir}/checkstyle_report.html"
style="${checkstyle.home}/contrib/checkstyle-simple.xsl"/>
<!-- transform the output to a very simple emacs friendly text file -->
<xslt in="${dist.checkstyle.dir}/checkstyle_report.xml"
out="${dist.checkstyle.dir}/checkstyle_report.tmp"
style="${make.conf.dir}/checkstyle-emacs.xsl"/>
<!-- beautify remove extra lines -->
<move file="${dist.checkstyle.dir}/checkstyle_report.tmp"
toFile="${dist.checkstyle.dir}/checkstyle_report.emacs.txt">
<filterchain>
<ignoreblank/>
<replaceregex byline="true" pattern="^File:" replace="${line.separator}File:"/>
</filterchain>
</move>
</target>
<!-- target can be invoked from an ide, the output of which can be used
to access and fix the errors directly.
-->
<target name="checkstyle-ide" depends="checkstyle">
<concat>
<fileset file="${dist.checkstyle.dir}/checkstyle_report.emacs.txt"/>
</concat>
</target>
<target name="findbugs" depends="-def-findbugs,build-all-tools">
<property name="findbugs.reportLevel" value="medium"/>
<mkdir dir="${dist.findbugs.dir}"/>
<findbugs
home="${findbugs.home}"
projectName="JDK langtools ${full.version}"
output="xml"
outputFile="${dist.findbugs.dir}/findbugs.xml"
reportLevel="${findbugs.reportLevel}"
failOnError="false"
errorProperty="findbugs.all.errors"
warningsProperty="findbugs.all.warnings"
jvm="${target.java.home}/bin/java"
jvmargs="-Xmx512M">
<class location="${build.classes.dir}"/>
<sourcePath>
<pathelement location="${src.classes.dir}"/>
</sourcePath>
</findbugs>
<exec executable="sh">
<arg value="${findbugs.home}/bin/convertXmlToText"/>
<arg value="-longBugCodes"/>
<arg value="-html:${findbugs.home}/src/xsl/fancy.xsl"/>
<arg value="${dist.findbugs.dir}/findbugs.xml"/>
<redirector output="${dist.findbugs.dir}/findbugs.html"/>
</exec>
</target>
<target name="coverage" depends="-def-cobertura,build-all-classes,instrument-classes,jtreg,coverage-report"/>
<target name="instrument-classes" depends="-def-cobertura">
<!-- only define the following property when we want coverage info -->
<path id="coverage.classpath">
<pathelement location="${build.coverage.dir}/classes"/>
<path refid="cobertura.classpath"/>
</path>
<property name="coverage.options" value="-Dnet.sourceforge.cobertura.datafile=${build.coverage.dir}/cobertura.ser"/>
<property name="coverage.classpath" refid="coverage.classpath"/>
<mkdir dir="${build.coverage.dir}/classes"/>
<delete file="${build.coverage.dir}/cobertura.ser"/>
<cobertura-instrument todir="${build.coverage.dir}/classes"
datafile="${build.coverage.dir}/cobertura.ser">
<fileset dir="${build.classes.dir}"
includes="**/*.class" excludes="**/resources/*.class"/>
</cobertura-instrument>
</target>
<target name="coverage-report" depends="-def-cobertura">
<mkdir dir="${dist.coverage.dir}"/>
<cobertura-report
srcdir="${src.classes.dir}"
destdir="${dist.coverage.dir}"
datafile="${build.coverage.dir}/cobertura.ser"/>
<cobertura-report
format="xml"
srcdir="${src.classes.dir}"
destdir="${dist.coverage.dir}"
datafile="${build.coverage.dir}/cobertura.ser"/>
</target>
<target name="diags-examples" depends="build-javac,build-javap">
<!-- can override the following on the command line if desired. -->
<property name="diags.examples.out" location="${build.dir}/diag-examples/diags-examples.html"/>
<mkdir dir="${build.dir}/diag-examples/classes"/>
<javac fork="true"
executable="${dist.bin.dir}/javac"
srcdir="test/tools/javac/diags"
destdir="${build.dir}/diag-examples/classes"
includes="ArgTypeCompilerFactory.java,Example.java,FileManager.java,HTMLWriter.java,RunExamples.java,DocCommentProcessor.java"
sourcepath=""
classpath="${dist.lib.dir}/javac.jar;${dist.lib.dir}/javap.jar"
includeAntRuntime="no"
debug="${javac.debug}"
debuglevel="${javac.debuglevel}">
<compilerarg line="${javac.lint.opts}"/>
</javac>
<java fork="true"
jvm="${target.java.home}/bin/java"
dir="test/tools/javac/diags"
classpath="${build.dir}/diag-examples/classes;${dist.lib.dir}/javac.jar;${dist.lib.dir}/javap.jar"
classname="RunExamples">
<jvmarg value="-Dtest.classes=${build.dir}/diag-examples/classes"/>
<arg value="-examples"/>
<arg value="examples"/>
<arg value="-o"/>
<arg file="${diags.examples.out}"/>
<arg value="-showFiles"/>
<arg value="-title"/>
<arg value="Examples of javac diagnostics"/>
</java>
</target>
<!-- a patching facility to speed up incorporating the langtools' classfiles
into a jdk of your choice. Either target.java.home or patch.jdk can be
set on the command line; setting target.java.home has the advantage of
patching the jdk used for jtreg and other tests.
-->
<target name="patch" depends="build-all-classes">
<condition property="patch.jdk" value="${target.java.home}">
<available file="${target.java.home}" type="dir"/>
</condition>
<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">
<condition>
<not>
<isset property="patch.jdk"/>
</not>
</condition>
</fail>
<property name="patch.tools.jar" location="${patch.jdk}/lib/tools.jar"/>
<property name="patch.rt.jar" location="${patch.jdk}/jre/lib/rt.jar"/>
<fail message="patch.jdk or target.java.home must point to a valid jdk image: missing tools.jar">
<condition>
<not>
<available file="${patch.tools.jar}" type="file"/>
</not>
</condition>
</fail>
<fail message="patch.jdk or target.java.home must point to a valid jdk image: missing rt.jar">
<condition>
<not>
<available file="${patch.rt.jar}" type="file"/>
</not>
</condition>
</fail>
<zip zipfile="${patch.tools.jar}" update="true">
<zipfileset dir="${build.classes.dir}" includes="com/**"/>
</zip>
<zip zipfile="${patch.rt.jar}" update="true">
<zipfileset dir="${build.classes.dir}" includes="javax/**"/>
</zip>
</target>
<target name="doclint-api" depends="build-all-classes">
<delete dir="${build.dir}/doclint/classes"/>
<mkdir dir="${build.dir}/doclint/classes"/>
<javac fork="true"
executable="${boot.javac}"
srcdir="${src.classes.dir}:${build.gensrc.dir}"
destdir="${build.dir}/doclint/classes"
includes="javax/lang/model/** com/sun/javadoc/** com/sun/source/**"
excludes=""
sourcepath="${javac.sourcepath}"
classpath="${javac.classpath}"
includeAntRuntime="no"
source="${javac.source}"
target="${javac.target}"
debug="${javac.debug}"
debuglevel="${javac.debuglevel}">
<compilerarg value="-implicit:none"/>
<compilerarg value="-Xprefer:source"/>
<compilerarg value="-J-Xbootclasspath/p:${build.bootstrap.dir}/classes"/>
<compilerarg line="${javac.no.jdk.warnings}"/>
<compilerarg line="${javac.version.opt}"/>
<compilerarg line="-Xdoclint:all/protected,-missing"/>
</javac>
</target>
<!-- Generate API docs for "important" test classes that are used by
multiple tests.
-->
<target name="test-framework-docs" depends="build-all-classes">
<javadoc executable="${target.java.home}/bin/javadoc"
destdir="${build.dir}/testframeworkdocs">
<!-- disable doclint for now; it might be good to enable -Xdoclint:missing -->
<arg value="-Xdoclint:none"/>
<!-- source files to be documented -->
<sourcefiles>
<fileset dir="${test.dir}">
<include name="**/ToolBox.java"/>
<include name="**/*Tester.java"/>
<include name="**/*TestBase.java"/>
<include name="**/*Testing*.java"/>
</fileset>
</sourcefiles>
<!-- source path used for documentation -->
<sourcepath>
<pathelement path="${test.dir}/lib"/>
<pathelement path="${test.dir}/lib/combo"/>
<pathelement path="${test.dir}/tools/javac/lib"/>
<pathelement path="${test.dir}/tools/javac/classfiles/attributes/LocalVariableTable"/>
</sourcepath>
<!-- exclude the following "packages" found by <javadoc>
on the sourcepath -->
<excludepackage name="combo.tools.javac.combo"/>
<excludepackage name="tools.javac.combo"/>
<!-- library classes used for documentation -->
<classpath>
<pathelement path="${jtreg.home}/lib/testng.jar"/>
</classpath>
<!-- platform classes used for documentation -->
<bootclasspath>
<pathelement path="${build.dir}/classes"/>
<pathelement path="${target.java.home}/jre/lib/rt.jar"/>
</bootclasspath>
</javadoc>
</target>
<!--
**** Debugging/diagnostic targets.
-->
<!-- standard JDK target -->
<target name="sanity"
description="display settings of configuration values">
<echo level="info">ant.home = ${ant.home}</echo>
<echo level="info">boot.java.home = ${boot.java.home}</echo>
<echo level="info">target.java.home = ${target.java.home}</echo>
<echo level="info">jtreg.home = ${jtreg.home}</echo>
<echo level="info">findbugs.home = ${findbugs.home}</echo>
<echo level="info">checkstyle.home = ${checkstyle.home}</echo>
</target>
<target name="post-sanity" depends="-def-jtreg,sanity,build"
description="perform basic validation after a standard build">
<jtreg
dir="make/test"
workDir="${build.jtreg.dir}/post-sanity/work"
reportDir="${build.jtreg.dir}/post-sanity/report"
jdk="${target.java.home}"
verbose="summary"
failonerror="false" resultproperty="jtreg.post-sanity.result">
</jtreg>
</target>
<!-- use vizant tool to generate graphical image of this Ant file.-->
<target name="vizant" depends="-def-vizant">
<mkdir dir="${build.dir}"/>
<echo message="Generating ${build.dir}/build.dot"/>
<vizant antfile="${make.dir}/build.xml" outfile="${build.dir}/build.dot"/>
<echo message="Generating ${build.dir}/build.png"/>
<exec executable="${dot}" >
<arg value="-Tpng"/>
<arg value="-o"/>
<arg file="${build.dir}/build.png"/>
<arg file="${build.dir}/build.dot"/>
</exec>
</target>
<target name="check-import.jdk">
<echo message="import.jdk: ${import.jdk}"/>
<echo message="import.jdk.jar: ${import.jdk.jar}"/>
<echo message="import.jdk.src.dir: ${import.jdk.src.dir}"/>
</target>
<target name="diagnostics">
<diagnostics/>
</target>
<!--
**** javac targets.
-->
<target name="build-bootstrap-javac"
depends="-def-build-bootstrap-classes,-def-build-bootstrap-jar,-def-build-bootstrap-tool">
<build-bootstrap-classes includes="${javac.includes}"/>
<build-bootstrap-jar name="javac" includes="${javac.includes}"/>
<build-bootstrap-tool name="javac"/>
</target>
<target name="build-classes-javac" depends="build-bootstrap-javac,-create-import-jdk-stubs">
<build-classes includes="${javac.includes}"/>
</target>
<target name="build-javac" depends="build-classes-javac">
<build-jar name="javac" includes="${javac.includes}"/>
<build-tool name="javac"/>
</target>
<target name="javadoc-javac" depends="build-javac,-def-javadoc-tool">
<javadoc-tool name="javac" includes="${javac.includes}" options="${javadoc.jls.option}"/>
</target>
<target name="jtreg-javac" depends="build-javac,build-javap,-def-jtreg">
<jtreg-tool name="javac" tests="${javac.tests}"/>
</target>
<target name="findbugs-javac" depends="build-javac,-def-findbugs">
<findbugs-tool name="javac"/>
</target>
<target name="javac" depends="build-javac,jtreg-javac,findbugs-javac"/>
<!--
**** javadoc targets.
-->
<target name="build-bootstrap-javadoc" depends="build-bootstrap-javac">
<build-bootstrap-classes includes="${javadoc.includes}"/>
<build-bootstrap-jar name="javadoc" includes="${javadoc.includes}"
jarclasspath="javac.jar doclets.jar"/>
<build-bootstrap-tool name="javadoc"/>
</target>
<target name="build-classes-javadoc" depends="build-classes-javac">
<build-classes includes="${javadoc.includes}"/>
</target>
<target name="build-javadoc" depends="build-javac,build-classes-javadoc">
<build-jar name="javadoc" includes="${javadoc.includes}"
jarclasspath="javac.jar doclets.jar"/>
<build-tool name="javadoc"/>
</target>
<target name="javadoc-javadoc" depends="build-javadoc,-def-javadoc-tool">
<javadoc-tool name="javadoc" includes="${javadoc.includes}"/>
</target>
<target name="jtreg-javadoc" depends="build-javadoc,-def-jtreg">
<jtreg-tool name="javadoc" tests="${javadoc.tests}"/>
</target>
<target name="findbugs-javadoc" depends="build-javadoc,-def-findbugs">
<findbugs-tool name="javadoc"/>
</target>
<target name="javadoc" depends="build-javadoc,jtreg-javadoc,findbugs-javadoc"/>
<!--
**** doclets targets.
-->
<target name="build-bootstrap-doclets" depends="build-bootstrap-javadoc,-def-build-bootstrap-jar">
<build-bootstrap-classes includes="${doclets.includes}"/>
<build-bootstrap-jar name="doclets" includes="${doclets.includes}"
jarmainclass="com.sun.tools.javadoc.Main"
jarclasspath="javadoc.jar"/>
</target>
<target name="build-classes-doclets" depends="build-classes-javadoc">
<build-classes includes="${doclets.includes}"/>
</target>
<target name="build-doclets" depends="build-javadoc,build-classes-doclets">
<!-- just jar, no bin for doclets -->
<build-jar name="doclets" includes="${doclets.includes}" jarclasspath="javadoc.jar"/>
</target>
<!-- (no javadoc for doclets) -->
<target name="jtreg-doclets" depends="build-doclets,-def-jtreg">
<jtreg-tool name="doclets" tests="${doclets.tests}"/>
</target>
<target name="findbugs-doclets" depends="build-doclets,-def-findbugs">
<findbugs-tool name="doclets"/>
</target>
<target name="doclets" depends="build-doclets,jtreg-doclets,findbugs-doclets"/>
<!--
**** javah targets.
-->
<target name="build-bootstrap-javah" depends="build-bootstrap-javadoc">
<build-bootstrap-classes includes="${javah.includes}"/>
<build-bootstrap-jar name="javah" includes="${javah.includes}"
jarclasspath="javadoc.jar doclets.jar javac.jar"/>
<build-bootstrap-tool name="javah"/>
</target>
<target name="build-javah" depends="build-javac,build-classes-javah">
<build-jar name="javah" includes="${javah.includes}" jarclasspath="javac.jar"/>
<build-tool name="javah"/>
</target>
<target name="build-classes-javah" depends="build-classes-javadoc">
<build-classes includes="${javah.includes}"/>
</target>
<!-- (no javadoc for javah) -->
<target name="jtreg-javah" depends="build-javah,-def-jtreg">
<jtreg-tool name="javah" tests="${javah.tests}"/>
</target>
<target name="findbugs-javah" depends="build-javah,-def-findbugs">
<findbugs-tool name="javah"/>
</target>
<target name="javah" depends="build-javah,jtreg-javah,findbugs-javah"/>
<!--
**** javap targets.
-->
<target name="build-bootstrap-javap"
depends="-def-build-bootstrap-classes,-def-build-bootstrap-jar,-def-build-bootstrap-tool">
<build-bootstrap-classes includes="${javap.includes}"/>
<build-bootstrap-jar name="javap" includes="${javap.includes}"
jarmainclass="sun.tools.javap.Main"/>
<build-bootstrap-tool name="javap"/>
</target>
<target name="build-classes-javap" depends="build-classes-javac">
<build-classes includes="${javap.includes}"/>
</target>
<target name="build-javap" depends="build-javac,build-classes-javap">
<build-jar name="javap" includes="${javap.includes}"
jarmainclass="com.sun.tools.javap.Main"
jarclasspath="javac.jar"/>
<build-tool name="javap"/>
</target>
<!-- (no javadoc for javap) -->
<target name="jtreg-javap" depends="build-javap,-def-jtreg">
<jtreg-tool name="javap" tests="${javap.tests}"/>
</target>
<target name="findbugs-javap" depends="build-javap,-def-findbugs">
<findbugs-tool name="javap"/>
</target>
<target name="javap" depends="build-javap,jtreg-javap,findbugs-javap"/>
<!--
**** sjavac targets.
-->
<target name="build-bootstrap-sjavac"
depends="-def-build-bootstrap-classes,-def-build-bootstrap-jar,-def-build-bootstrap-tool">
<build-bootstrap-classes includes="${sjavac.includes}"/>
<build-bootstrap-jar name="sjavac" includes="${sjavac.includes}"
jarmainclass="com.sun.tools.sjavac.Main"/>
<build-bootstrap-tool name="sjavac"/>
</target>
<target name="build-classes-sjavac" depends="build-classes-javac">
<build-classes includes="${sjavac.includes}"/>
</target>
<target name="build-sjavac" depends="build-classes-sjavac">
<build-jar name="sjavac" includes="${sjavac.includes}"
jarmainclass="com.sun.tools.sjavac.Main"
jarclasspath="sjavac.jar"/>
<build-tool name="sjavac"/>
</target>
<!-- (no javadoc for javap) -->
<target name="jtreg-sjavac" depends="build-sjavac,-def-jtreg">
<jtreg-tool name="sjavac" tests="${sjavac.tests}"/>
</target>
<target name="findbugs-sjavac" depends="build-sjavac,-def-findbugs">
<findbugs-tool name="sjavac"/>
</target>
<target name="sjavac" depends="build-sjavac,jtreg-sjavac,findbugs-sjavac"/>
<!--
**** crules targets.
-->
<target name="build-crules" depends="-def-compilecrules,-def-build-jar-with-services">
<compilecrules/>
<build-jar-with-services
name="crules"
includes="crules/* crules/resources/*"
classes.dir="${build.toolclasses.dir}"
lib.dir="${build.toolclasses.dir}"
jarmainclass=""
jarclasspath="crules.jar"
service.type="com.sun.source.util.Plugin"
service.provider="crules.MutableFieldsAnalyzer"/>
<build-tool name="crules"/>
</target>
<target name="check-coding-rules" depends="build-bootstrap-javac,-create-import-jdk-stubs,build-crules">
<build-classes includes="${javac.includes}"
plugin.options="-J-Xbootclasspath/a:${build.toolclasses.dir}/crules.jar -Xplugin:mutable_fields_analyzer" />
</target>
<!--
**** Create import JDK stubs.
-->
<target name="-create-import-jdk-stubs" depends="-def-genstubs" if="require.import.jdk.stubs">
<mkdir dir="${build.genstubs.dir}"/>
<genstubs
srcdir="${import.jdk.src.dir}" destdir="${build.genstubs.dir}"
includes="${import.jdk.stub.files}"
fork="true" classpath="${build.toolclasses.dir}:${build.bootstrap.dir}/classes:${ant.core.lib}"
/>
</target>
<!--
**** IDE support
-->
<target name="idea">
<mkdir dir=".idea"/>
<copy todir=".idea" >
<fileset dir="make/intellij" includes="**"/>
</copy>
<replace file=".idea/ant.xml" token="@@@" value="${jtreg.home}"/>
</target>
<!--
**** Check targets.
**** "-check-*" targets check that a required property is set, and set to a reasonable value.
**** A user friendly message is generated if not, and the build exits.
-->
<target name="-check-boot.java.home" depends="-def-check">
<check name="bootstrap java" property="boot.java.home" marker="${java.marker}"/>
</target>
<target name="-check-target.java.home" depends="-def-check">
<check name="target java" property="target.java.home" marker="${java.marker}"/>
</target>
<target name="-check-cobertura.home" depends="-def-check">
<check name="cobertura" property="cobertura.home" marker="cobertura.jar"/>
</target>
<target name="-check-findbugs.home" depends="-def-check">
<check name="findbugs" property="findbugs.home" marker="lib/findbugs.jar"/>
</target>
<target name="-check-checkstyle.home" depends="-def-check">
<check name="checkstyle" property="checkstyle.home" marker="${checkstyle.name.version}.jar"/>
</target>
<target name="-check-jtreg.home" depends="-def-check">
<check name="jtreg" property="jtreg.home" marker="lib/jtreg.jar"/>
</target>
<target name="-check-vizant" depends="-def-check">
<check name="vizant" property="vizant.jar"/>
<check name="dot" property="dot"/>
</target>
<!--
**** Targets for Ant macro and task definitions.
-->
<target name="-def-build-tool">
<macrodef name="build-tool">
<attribute name="name"/>
<attribute name="bin.dir" default="${dist.bin.dir}"/>
<attribute name="java" default="${launcher.java}"/>
<sequential>
<mkdir dir="@{bin.dir}"/>
<copy file="${src.bin.dir}/launcher.sh-template" tofile="@{bin.dir}/@{name}">
<filterset begintoken="#" endtoken="#">
<filter token="PROGRAM" value="@{name}"/>
<filter token="TARGET_JAVA" value="@{java}"/>
<filter token="PS" value="${path.separator}"/>
</filterset>
</copy>
<chmod file="@{bin.dir}/@{name}" perm="ugo+rx"/>
</sequential>
</macrodef>
</target>
<target name="-def-build-jar">
<macrodef name="build-jar">
<attribute name="name"/>
<attribute name="includes"/>
<attribute name="classes.dir" default="${build.classes.dir}"/>
<attribute name="lib.dir" default="${dist.lib.dir}"/>
<attribute name="jarmainclass" default="com.sun.tools.@{name}.Main"/>
<attribute name="jarclasspath" default=""/>
<sequential>
<mkdir dir="@{lib.dir}"/>
<jar destfile="@{lib.dir}/@{name}.jar"
basedir="@{classes.dir}"
includes="@{includes}">
<manifest>
<attribute name="Main-Class" value="@{jarmainclass}"/>
<attribute name="Class-Path" value="@{jarclasspath}"/>
</manifest>
</jar>
</sequential>
</macrodef>
</target>
<target name="-def-build-jar-with-services">
<macrodef name="build-jar-with-services">
<attribute name="name"/>
<attribute name="includes"/>
<attribute name="classes.dir" default="${build.classes.dir}"/>
<attribute name="lib.dir" default="${dist.lib.dir}"/>
<attribute name="jarmainclass" default="com.sun.tools.@{name}.Main"/>
<attribute name="jarclasspath" default=""/>
<attribute name="service.type" default=""/>
<attribute name="service.provider" default=""/>
<sequential>
<mkdir dir="${build.toolclasses.dir}"/>
<jar destfile="@{lib.dir}/@{name}.jar"
basedir="@{classes.dir}"
includes="@{includes}">
<service type="@{service.type}" provider="@{service.provider}"/>
<manifest>
<attribute name="Main-Class" value="@{jarmainclass}"/>
<attribute name="Class-Path" value="@{jarclasspath}"/>
</manifest>
</jar>
</sequential>
</macrodef>
</target>
<target name="-def-build-classes" depends="-def-pcompile">
<macrodef name="build-classes">
<attribute name="includes"/>
<attribute name="excludes" default="${exclude.files} **/package-info.java"/>
<attribute name="classes.dir" default="${build.classes.dir}"/>
<attribute name="gensrc.dir" default="${build.gensrc.dir}"/>
<attribute name="javac.bootclasspath" default="${build.bootstrap.dir}/classes"/>
<attribute name="bootclasspath.opt" default="${javac.bootclasspath.opt}"/>
<attribute name="classpath" default="${javac.classpath}"/>
<attribute name="sourcepath" default="${javac.sourcepath}"/>
<attribute name="java.home" default="${boot.java.home}"/>
<attribute name="source" default="${javac.source}"/>
<attribute name="target" default="${javac.target}"/>
<attribute name="release" default="${release}"/>
<attribute name="full.version" default="${full.version}"/>
<attribute name="plugin.options" default=""/>
<sequential>
<echo level="verbose" message="build-classes: excludes=@{excludes}"/>
<echo level="verbose" message="build-classes: bootclasspath.opt=@{bootclasspath.opt}"/>
<echo level="verbose" message="build-classes: classpath=@{classpath}"/>
<echo level="verbose" message="build-classes: sourcepath=@{sourcepath}"/>
<mkdir dir="@{gensrc.dir}"/>
<mkdir dir="@{classes.dir}"/>
<pcompile srcdir="${src.classes.dir}"
destdir="@{gensrc.dir}"
includes="@{includes}"/>
<copy todir="@{gensrc.dir}">
<fileset dir="${src.classes.dir}" includes="@{includes}"/>
<globmapper from="*.properties-template" to="*.properties"/>
<filterset begintoken="$(" endtoken=")">
<filter token="JDK_VERSION" value="${jdk.version}"/>
<filter token="RELEASE" value="@{release}"/>
<filter token="FULL_VERSION" value="@{full.version}"/>
</filterset>
</copy>
<pcompile srcdir="@{gensrc.dir}"
destdir="@{gensrc.dir}"
includes="**/*.properties"/>
<javac fork="true"
executable="@{java.home}/bin/javac"
srcdir="${src.classes.dir}:@{gensrc.dir}"
destdir="@{classes.dir}"
includes="@{includes}"
excludes="@{excludes}"
sourcepath="@{sourcepath}"
classpath="@{classpath}"
includeAntRuntime="no"
source="@{source}"
target="@{target}"
debug="${javac.debug}"
debuglevel="${javac.debuglevel}">
<compilerarg value="-implicit:none"/>
<compilerarg value="-Xprefer:source"/>
<compilerarg value="-J-Xbootclasspath/p:@{javac.bootclasspath}"/>
<compilerarg line="@{bootclasspath.opt}"/>
<compilerarg line="${javac.no.jdk.warnings}"/>
<compilerarg line="${javac.version.opt}"/>
<compilerarg line="${javac.lint.opts}"/>
<compilerarg line="@{plugin.options}"/>
</javac>
<copy todir="@{classes.dir}" includeemptydirs="false">
<fileset dir="${src.classes.dir}" includes="@{includes}" excludes="@{excludes}">
<exclude name="**/*.java"/>
<exclude name="**/*.properties"/>
<exclude name="**/*-template"/>
<exclude name="**/*.rej"/>
<exclude name="**/*.orig"/>
<exclude name="**/overview.html"/>
<exclude name="**/package.html"/>
</fileset>
</copy>
</sequential>
</macrodef>
</target>
<target name="-def-build-bootstrap-tool" depends="-check-boot.java.home,-def-build-tool">
<presetdef name="build-bootstrap-tool">
<build-tool
bin.dir="${build.bootstrap.dir}/bin"
java="${boot.java}"/>
</presetdef>
</target>
<target name="-def-build-bootstrap-jar" depends="-def-build-jar">
<presetdef name="build-bootstrap-jar">
<build-jar
classes.dir="${build.bootstrap.dir}/classes"
lib.dir="${build.bootstrap.dir}/lib"/>
</presetdef>
</target>
<target name="-def-build-bootstrap-classes" depends="-def-build-classes">
<presetdef name="build-bootstrap-classes">
<build-classes
source="${boot.javac.source}"
target="${boot.javac.target}"
gensrc.dir="${build.bootstrap.dir}/gensrc"
classes.dir="${build.bootstrap.dir}/classes"
javac.bootclasspath=""
bootclasspath.opt="-Xbootclasspath/p:${build.bootstrap.dir}/classes"
sourcepath=""
release="${bootstrap.release}"
full.version="${bootstrap.full.version}"
excludes="${bootstrap.exclude.files} **/package-info.java"/>
</presetdef>
</target>
<target name="-def-pcompile">
<mkdir dir="${build.toolclasses.dir}"/>
<javac fork="true"
source="${boot.javac.source}"
target="${boot.javac.target}"
executable="${boot.java.home}/bin/javac"
srcdir="${make.tools.dir}"
includes="compileproperties/* anttasks/CompileProperties*"
destdir="${build.toolclasses.dir}/"
classpath="${ant.core.lib}"
bootclasspath="${boot.java.home}/jre/lib/rt.jar"
includeantruntime="false">
<compilerarg line="${javac.lint.opts}"/>
</javac>
<taskdef name="pcompile"
classname="anttasks.CompilePropertiesTask"
classpath="${build.toolclasses.dir}/"/>
</target>
<target name="-def-compilecrules">
<macrodef name="compilecrules">
<sequential>
<mkdir dir="${build.toolclasses.dir}"/>
<javac fork="true"
source="${boot.javac.source}"
target="${boot.javac.target}"
executable="${boot.java.home}/bin/javac"
srcdir="${make.tools.dir}"
includes="crules/*"
destdir="${build.toolclasses.dir}/"
classpath="${ant.core.lib}"
bootclasspath="${boot.java.home}/jre/lib/rt.jar"
includeantruntime="false">
<compilerarg value="-Xbootclasspath/p:${build.bootstrap.dir}/classes"/>
<compilerarg line="${javac.lint.opts}"/>
</javac>
<copy todir="${build.toolclasses.dir}/" includeemptydirs="false">
<fileset dir="${make.tools.dir}">
<include name="**/*.properties"/>
</fileset>
</copy>
</sequential>
</macrodef>
</target>
<target name="-def-genstubs" depends="build-bootstrap-javac" if="require.import.jdk.stubs">
<mkdir dir="${build.toolclasses.dir}"/>
<javac fork="true"
source="${boot.javac.source}"
target="${boot.javac.target}"
executable="${boot.java.home}/bin/javac"
srcdir="${make.tools.dir}"
includes="genstubs/* anttasks/GenStubs*"
destdir="${build.toolclasses.dir}/"
classpath="${ant.core.lib}"
includeantruntime="false">
<compilerarg value="-Xbootclasspath/p:${build.bootstrap.dir}/classes"/>
<compilerarg line="${javac.lint.opts}"/>
</javac>
<taskdef name="genstubs"
classname="anttasks.GenStubsTask"
classpath="${build.toolclasses.dir}/"/>
</target>
<target name="-def-javadoc-tool" depends="-check-target.java.home">
<macrodef name="javadoc-tool">
<attribute name="name"/>
<attribute name="includes"/>
<attribute name="options" default=""/>
<attribute name="source" default="1.5"/> <!-- FIXME -->
<sequential>
<property name="javadoc.options" value=""/> <!-- default, can be overridden per user or per project -->
<!-- Note: even with this default value, includes
from src.classes.dir get javadoc'd; see packageset below -->
<property name="javadoc.packagenames" value="none"/> <!-- default, can be overridden per user or per project -->
<javadoc
executable="${target.java.home}/bin/javadoc"
destdir="${build.javadoc.dir}/@{name}"
source="@{source}"
windowtitle="UNOFFICIAL"
failonerror="true"
use="true"
author="false"
version="false"
packagenames="${javadoc.packagenames}" >
<header><![CDATA[<strong>Unofficial Javadoc</strong> generated from developer sources for preview purposes only]]></header>
<arg line="@{options}"/>
<bootclasspath>
<path location="${build.classes.dir}"/>
<path location="${target.java.home}/jre/lib/rt.jar"/>
</bootclasspath>
<sourcepath>
<pathelement location="${src.classes.dir}"/>
</sourcepath>
<!-- XXX just <fileset> (restricted further to **/*.java) and no <packageset> -->
<!-- means that {@link some.package} will not work, which is no good. -->
<!-- (It correctly skips excluded single classes, but not if packageset is also included, -->
<!-- which also causes duplicates in the class index for included files.) -->
<packageset dir="${src.classes.dir}" includes="@{includes}">
<or>
<filename name="java/"/>
<filename name="javax/"/>
<filename name="com/sun/javadoc/"/>
<filename name="com/sun/source/"/>
</or>
</packageset>
</javadoc>
</sequential>
</macrodef>
</target>
<target name="-def-jtreg" unless="jtreg.defined" depends="-check-jtreg.home,-check-target.java.home">
<taskdef name="jtreg" classname="com.sun.javatest.regtest.Main$$Ant">
<classpath>
<pathelement location="${jtreg.home}/lib/jtreg.jar"/>
<pathelement location="${jtreg.home}/lib/javatest.jar"/>
</classpath>
</taskdef>
<macrodef name="jtreg-tool">
<attribute name="name"/>
<attribute name="tests"/>
<attribute name="jdk" default="${target.java.home}"/>
<attribute name="samevm" default="true"/>
<attribute name="verbose" default="${default.jtreg.verbose}"/>
<attribute name="options" default="${other.jtreg.options}"/>
<attribute name="keywords" default="-keywords:!ignore"/>
<attribute name="jpda.jvmargs" default=""/>
<sequential>
<property name="coverage.options" value=""/> <!-- default -->
<property name="coverage.classpath" value=""/> <!-- default -->
<property name="default.jtreg.verbose" value="summary"/> <!-- default -->
<property name="other.jtreg.options" value=""/> <!-- default -->
<jtreg
dir="${test.dir}"
workDir="${build.jtreg.dir}/@{name}/work"
reportDir="${build.jtreg.dir}/@{name}/report"
jdk="@{jdk}"
samevm="@{samevm}" verbose="@{verbose}"
failonerror="false" resultproperty="jtreg.@{name}.result"
javacoptions="-g"
vmoptions="${coverage.options} -Xbootclasspath/p:${coverage.classpath}${path.separator}${build.classes.dir} @{jpda.jvmargs}">
<arg line="@{keywords}"/>
<arg line="@{options}"/>
<arg line="@{tests}"/>
</jtreg>
<!-- the next two properties are for convenience, when only
a single instance of jtreg will be invoked. -->
<condition property="jtreg.passed">
<equals arg1="${jtreg.@{name}.result}" arg2="0"/>
</condition>
<property name="jtreg.report" value="${build.jtreg.dir}/@{name}/report"/>
</sequential>
</macrodef>
<property name="jtreg.defined" value="true"/>
</target>
<target name="-def-cobertura" depends="-check-cobertura.home">
<path id="cobertura.classpath">
<fileset dir="${cobertura.home}">
<include name="cobertura.jar"/>
<include name="lib/**/*.jar"/>
</fileset>
</path>
<taskdef classpathref="cobertura.classpath" resource="tasks.properties"/>
</target>
<target name="-def-checkstyle" unless="checkstyle.defined"
depends="-check-checkstyle.home">
<taskdef resource="checkstyletask.properties">
<classpath>
<pathelement location="${checkstyle.home}/${checkstyle.name.version}-all.jar"/>
</classpath>
</taskdef>
<property name="checkstyle.defined" value="true"/>
</target>
<target name="-def-findbugs" unless="findbugs.defined"
depends="-check-findbugs.home,-check-target.java.home">
<taskdef name="findbugs" classname="edu.umd.cs.findbugs.anttask.FindBugsTask">
<classpath>
<pathelement location="${findbugs.home}/lib/findbugs.jar"/>
</classpath>
</taskdef>
<macrodef name="findbugs-tool">
<attribute name="name"/>
<attribute name="output" default="emacs"/>
<attribute name="outputFile" default=""/>
<attribute name="reportLevel" default="high"/>
<sequential>
<findbugs
home="${findbugs.home}"
output="@{output}"
outputFile="@{outputFile}"
reportLevel="@{reportLevel}"
failOnError="false"
errorProperty="findbugs.@{name}.errors"
warningsProperty="findbugs.@{name}.warnings"
jvm="${target.java.home}/bin/java"
jvmargs="-Xmx512M" >
<class location="${dist.dir}/lib/@{name}.jar"/>
<auxClasspath>
<pathelement location="${build.classes.dir}"/>
</auxClasspath>
<sourcePath>
<pathelement location="${src.classes.dir}"/>
</sourcePath>
</findbugs>
</sequential>
</macrodef>
<property name="findbugs.defined" value="true"/>
</target>
<target name="-def-vizant" unless="vizant.defined" depends="-check-vizant">
<taskdef name="vizant" classname="net.sourceforge.vizant.Vizant" classpath="${vizant.jar}"/>
<property name="vizant.defined" value="true"/>
</target>
<target name="-def-check">
<macrodef name="check">
<attribute name="name"/>
<attribute name="property"/>
<attribute name="marker" default=""/>
<sequential>
<fail message="Cannot locate @{name}: please set @{property} to its location">
<condition>
<not>
<isset property="@{property}"/>
</not>
</condition>
</fail>
<fail message="@{name} is not installed in ${@{property}}">
<condition>
<and>
<not>
<equals arg1="@{marker}" arg2=""/>
</not>
<not>
<available file="${@{property}}/@{marker}"/>
</not>
</and>
</condition>
</fail>
</sequential>
</macrodef>
</target>
</project>