<?xml version="1.0" encoding="UTF-8"?>

<!--

 Copyright (c) 2007, 2011, 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 oode

      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"

    />

    <target name="build-all-tools"

        depends="build-javac,build-javadoc,build-doclets,build-javah,build-javap"

    />

    <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}"/>

    </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">

        <!-- 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"

            sourcepath=""

            classpath="${dist.lib.dir}/javac.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"

            classname="RunExamples">

            <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>

    <!--

    **** 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}"/>