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

<!--

 Copyright (c) 2007, 2015, 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 a convenience build file supporting development in the langtools

 repository. It can be run either standalone, or from IDEs. This build script

 is for a developer use only, it is not used to build the production version

 of javac or other langtools tools.

 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.

 The main build happens in two phases:

 - First, javac is 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 build generally builds one module at time.

 For more details on the stub generator, see

    http://blogs.sun.com/jjg/entry/building_javac_for_jdk7

 Internal details ...

 Bootstrap classes are built into the build/bootstrap/<module-name>/classes directory.

 Final classes are built into the build/<module-name>/classes directory.

 Final runnable javac is in dist/bin and dist/lib. Bootstrap javac (if requested by

 using the build-bootstrap-javac target) is built into dist/bootstrap.

 This file is organized into sections as follows:

 - global property definitions

 - primary top level targets (cleaning, building, testing, producing javac)

 - secondary top level targets (code analysis, diagnostics, extra documentation, etc.)

 - utility definitions

 -->

<project name="langtools" default="build" basedir="..">

    <!--

    **** Global property definitions.

    -->

    <!-- 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.crules.dir" location="${build.dir}/crules"/>

    <property name="build.jtreg.dir" location="${build.dir}/jtreg"/>

    <property name="build.toolclasses.dir" location="${build.dir}/toolclasses"/>

    <property name="build.javadoc.dir" location="${build.dir}/javadoc"/>

    <property name="dist.dir" location="dist"/>

    <property name="dist.bin.dir" location="${dist.dir}/bin"/>

    <property name="dist.lib.dir" location="${dist.dir}/lib"/>

    <property name="dist.findbugs.dir" location="${dist.dir}/findbugs"/>

    <property name="dist.checkstyle.dir" location="${dist.dir}/checkstyle"/>

    <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="test.dir" location="test"/>

    <property name="boot.build.dir" location="${build.dir}/bootstrap"/>

    <property name="boot.dist.dir" location="${dist.dir}/bootstrap"/>

    <property name="boot.dist.bin.dir" location="${boot.dist.dir}/bin"/>

    <property name="boot.dist.lib.dir" location="${boot.dist.dir}/lib"/>

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

    <!-- setup basic properties holding paths to all sources, generated source and class directories

         (both boot and non-boot) -->

    <pathconvert property="langtools.sources">

        <path>

            <pathelement path="${langtools.modules}" />

        </path>

        <map from="${basedir}/" to="${basedir}/src/" />

        <mapper type="glob" from="*" to="*/share/classes"/>

    </pathconvert>

    <pathconvert property="langtools.gensrc">

        <path>

            <pathelement path="${langtools.modules}" />

        </path>

        <map from="${basedir}/" to="${build.dir}/" />

        <mapper type="glob" from="*" to="*/gensrc"/>

    </pathconvert>

    <pathconvert property="langtools.boot.classes">

        <path>

            <pathelement path="${langtools.modules}" />

        </path>

        <map from="${basedir}/" to="${boot.build.dir}/" />

        <mapper type="glob" from="*" to="*/classes"/>

    </pathconvert>

    <pathconvert property="langtools.classes">

        <path>

            <pathelement path="${langtools.modules}" />

        </path>

        <map from="${basedir}/" to="${build.dir}/" />

        <mapper type="glob" from="*" to="*/classes"/>

    </pathconvert>

    <!--

        **** Primary targets

    -->

    <target name="clean" description="Delete all generated files">

        <delete dir="${build.dir}"/>

        <delete dir="${dist.dir}"/>

    </target>

    <target name="build" depends="build-all-tools">

    </target>

    <target name="build-all-tools" depends="build-all-classes,-def-build-all-module-jars,-def-build-tool">

        <build-all-module-jars />

        <build-tool name="javac"/>

        <build-tool name="javadoc"/>

        <build-tool name="javap"/>

        <build-tool name="javah"/>

        <build-tool name="sjavac"/>

        <build-tool name="jshell"/>

    </target>

    <target name="build-all-classes" depends="-def-build-all-module-classes,build-bootstrap-javac-classes">

        <build-all-module-classes />

    </target>

    <target name="jtreg" depends="build-all-tools,-def-jtreg">

        <jtreg-tool name="all" tests="${jtreg.tests}"/>

    </target>

    <target name="javadoc" depends="build-all-classes,-def-javadoc-tool">

        <javadoc-tool options="${javadoc.jls.option}"/>

    </target>

    <target name="build-bootstrap-javac-classes" depends="-check-boot.java.home,-def-build-all-module-classes">

        <build-all-module-classes compilation.kind="boot." />

    </target>

    <!--

        **** Extra targets

    -->

    <target name="build-bootstrap-javac" depends="build-bootstrap-javac-classes,-def-build-all-module-jars,-def-build-tool">

        <build-all-module-jars compilation.kind="boot." />

        <build-tool name="javac" compilation.kind="boot." />

    </target>

    <target name="jtreg-bootstrap-javac" depends="build-bootstrap-javac,-def-jtreg">

        <jtreg-tool name="bootstrap-javac"

                    tests="${boot.javac.tests}"

                    langtools.classes="${langtools.boot.classes}"/>

    </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.dir}/java.compiler/classes"/>

            <class location="${build.dir}/jdk.compiler/classes"/>

            <class location="${build.dir}/jdk.javadoc/classes"/>

            <class location="${build.dir}/jdk.jdeps/classes"/>

            <sourcePath>

                <pathelement path="${langtools.sources}"/>

            </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="diags-examples" depends="build-all-tools">

        <!-- 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="${langtools.classes}"

            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;${langtools.classes}"

            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>

    <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.java.home}/bin/javac"

               destdir="${build.dir}/doclint/classes"

               includes="javax/lang/model/** com/sun/javadoc/** com/sun/source/**"

               excludes=""

               sourcepath=""

               classpath="${langtools.classes}"

               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.extra.opts}"/>

            <compilerarg line="-Xdoclint:all/protected,-missing"/>

            <src>

                <pathelement path="${langtools.sources}"/>

                <pathelement path="${langtools.gensrc}"/>

            </src>

        </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="${langtools.classes}"/>

                <pathelement path="${target.java.home}/jre/lib/rt.jar"/>

            </bootclasspath>

        </javadoc>

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

        <diagnostics/>

    </target>

    <target name="jtreg-crules" depends="build-all-classes,-def-jtreg">

        <mkdir dir="${build.crules.dir}/classes"/>

        <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.crules.dir}/classes"

               includeantruntime="false">

            <compilerarg value="-Xbootclasspath/p:${langtools.classes}"/>

            <compilerarg line="${javac.lint.opts}"/>

        </javac>

        <copy todir="${build.crules.dir}/classes" includeemptydirs="false">

            <fileset dir="${make.tools.dir}">

                <include name="**/*.properties"/>

            </fileset>

        </copy>

        <echo file="${build.crules.dir}/classes/META-INF/services/com.sun.source.util.Plugin">crules.CodingRulesAnalyzerPlugin</echo>

        <jtreg-tool name="crules"

                    tests="${crules.tests}"

                    extra.jvmargs="-Xbootclasspath/a:${build.crules.dir}/classes" />

    </target>

    <!--

    **** IDE support

    -->

    <target name="idea">

        <mkdir dir=".idea"/>

        <copy todir=".idea" >

            <fileset dir="make/intellij" excludes="**/src/**"/>

        </copy>

            <isset property="jtreg.home"/>

        </condition>

        <replace file=".idea/workspace.xml" token="@FILE_SEP@" value="${file.separator}"/>

        <replace file=".idea/workspace.xml" token="@PATH_SEP@" value="${path.separator}"/>

        <mkdir dir=".idea/classes"/>

        <javac srcdir="make/intellij/src"

               destdir=".idea/classes"/>

    </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-jtreg.home" depends="-def-check">

        <check name="jtreg" property="jtreg.home" marker="lib/jtreg.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=""/> <!--TODO: better checkstyle verification-->

    </target>

    <!-- Definitions -->

    <target name="-def-build-all-module-jars" depends="-def-build-module-jar">

        <macrodef name="build-all-module-jars">

            <attribute name="compilation.kind" default=""/>

            <sequential>

                <build-module-jar module.name="java.compiler" compilation.kind="@{compilation.kind}" />

                <build-module-jar module.name="jdk.compiler" compilation.kind="@{compilation.kind}" />

                <build-module-jar module.name="jdk.javadoc" compilation.kind="@{compilation.kind}" />

                <build-module-jar module.name="jdk.jdeps" compilation.kind="@{compilation.kind}" />

                <build-module-jar module.name="jdk.internal.le" compilation.kind="@{compilation.kind}" />

                <build-module-jar module.name="jdk.jdi" compilation.kind="@{compilation.kind}" />

                <build-module-jar module.name="jdk.jshell" compilation.kind="@{compilation.kind}" />

            </sequential>

        </macrodef>

    </target>

    <target name="-def-build-module-jar">

        <macrodef name="build-module-jar">

            <attribute name="module.name"/>

            <attribute name="compilation.kind"/>

            <attribute name="dependencies" default="${@{compilation.kind}@{module.name}.dependencies}"/>

            <attribute name="build.dir" default="${@{compilation.kind}build.dir}"/>

            <attribute name="lib.dir" default="${@{compilation.kind}dist.lib.dir}"/>

            <attribute name="classes.dir" default="@{build.dir}/@{module.name}/classes"/>

            <sequential>

                <mkdir dir="@{lib.dir}"/>

                <local name="jarclasspath" />

                <pathconvert property="jarclasspath">

                    <path>

                        <pathelement path="@{dependencies}" />

                    </path>