build.xml

<project name="buck" default="default">
  <property environment="env"/>

  <property name="src.dir" value="${basedir}/src" />
  <property name="aosp.src.dir" value="third-party/java/aosp/src" />
  <property name="test.dir" value="${basedir}/test" />
  <property name="lib.dir" value="${basedir}/lib" />
  <property name="third-party.dir" value="${basedir}/third-party" />
  <property name="build.dir" value="${basedir}/build" />
  <property name="testrunner.classes.dir" value="${build.dir}/testrunner/classes" />
  <property name="abi_processor.src.dir" value="${src.dir}/com/facebook/buck/java/abi/" />
  <property name="abi_processor.classes.dir" value="${build.dir}/abi_processor/classes" />
  <property name="buck.path_to_buck_py" value="${basedir}/src/com/facebook/buck/parser/buck.py" />
  <property name="buck.path_to_compile_asset_catalogs_py" value="${basedir}/src/com/facebook/buck/apple/compile_asset_catalogs.py" />
  <property name="buck.path_to_compile_asset_catalogs_build_phase_sh" value="${basedir}/src/com/facebook/buck/apple/compile_asset_catalogs_build_phase.sh" />
  <property name="buck.logging_config_file" value="${basedir}/config/logging.properties" />
  <property name="classes.dir" value="${build.dir}/classes" />
  <property name="testclasses.dir" value="${build.dir}/testclasses" />
  <property name="javadoc.dir" value="${build.dir}/javadoc" />
  <property name="javadoc-with-android.dir" value="${build.dir}/javadoc-with-android" />
  <property name="javadoc-all.dir" value="${build.dir}/javadoc-all" />
  <property name="client.dir" value="third-party/nailgun" />
  <property name="test.class" value="Test" />
  <property name="javacc.gensrc.dir" value="${build.dir}/javacc" />
  <property name="javacc.test.dir" value="${build.dir}/testjavacc" />
  <property name="lint.outputpath" value="${build.dir}/lint.output" />

  <property name="dx.base.dir" value="${basedir}/third-party/java/dx-from-kitkat" />
  <property name="dx.src.dir" value="${dx.base.dir}/src" />
  <property name="dx.test.dir" value="${dx.base.dir}/tests" />
  <property name="dx.etc.dir" value="${dx.base.dir}/etc" />
  <property name="dx.classes.dir" value="${build.dir}/dx_classes" />

  <property name="eclipse.dir" value="${basedir}/third-party/java/eclipse" />

  <fileset dir="${lib.dir}" id="buck.jars">
    <include name="args4j-2.0.28.jar" />
    <include name="ddmlib-22.5.3.jar" />
    <include name="guava-17.0.jar" />
    <include name="ini4j-0.5.2.jar" />
    <include name="jackson-annotations-2.0.5.jar" />
    <include name="jackson-core-2.0.5.jar" />
    <include name="jackson-databind-2.0.5.jar" />
    <include name="jsr305.jar" />
    <include name="sdklib.jar" />
    <include name="nailgun-server-0.9.2-SNAPSHOT.jar" />
  </fileset>

  <fileset dir="${third-party.dir}" id="third-party.jars">
    <include name="java/asm/asm-debug-all-4.1.jar" />
    <include name="java/astyanax/astyanax-cassandra-1.56.38.jar" />
    <include name="java/astyanax/astyanax-cassandra-1.56.38-javadoc.jar" />
    <include name="java/astyanax/astyanax-cassandra-1.56.38-sources.jar" />
    <include name="java/astyanax/astyanax-core-1.56.38.jar" />
    <include name="java/astyanax/astyanax-thrift-1.56.38.jar" />
    <include name="java/astyanax/cassandra-1.2.3.jar" />
    <include name="java/astyanax/cassandra-thrift-1.2.3.jar" />
    <include name="java/astyanax/commons-cli-1.1.jar" />
    <include name="java/astyanax/commons-codec-1.2.jar" />
    <include name="java/astyanax/commons-lang-2.6.jar" />
    <include name="java/astyanax/high-scale-lib-1.1.2.jar" />
    <include name="java/astyanax/joda-time-2.2.jar" />
    <include name="java/astyanax/libthrift-0.7.0.jar" />
    <include name="java/astyanax/log4j-1.2.16.jar" />
    <include name="java/eclipse/org.eclipse.core.contenttype_3.4.200.v20130326-1255.jar" />
    <include name="java/eclipse/org.eclipse.core.jobs_3.5.300.v20130429-1813.jar" />
    <include name="java/eclipse/org.eclipse.core.resources_3.8.101.v20130717-0806.jar" />
    <include name="java/eclipse/org.eclipse.core.runtime_3.9.100.v20131218-1515.jar" />
    <include name="java/eclipse/org.eclipse.equinox.common_3.6.200.v20130402-1505.jar" />
    <include name="java/eclipse/org.eclipse.equinox.preferences_3.5.100.v20130422-1538.jar" />
    <include name="java/eclipse/org.eclipse.jdt.core_3.9.2.v20140114-1555.jar" />
    <include name="java/eclipse/org.eclipse.osgi_3.9.1.v20140110-1610.jar" />
    <include name="java/astyanax/slf4j-api-1.7.2.jar" />
    <include name="java/astyanax/slf4j-log4j12-1.7.2.jar" />
    <include name="java/closure-templates/soy-2012-12-21-no-guava.jar" />
    <include name="java/dd-plist/dd-plist.jar" />
    <include name="java/gson/gson-2.2.4.jar" />
    <include name="java/infer-annotations/infer-annotations-1.0.jar" />
    <include name="java/jetty/jetty-all-9.0.4.v20130625.jar" />
    <include name="java/jetty/servlet-api.jar" />
    <include name="java/xz-java-1.3/xz-1.3.jar" />
    <include name="java/commons-compress/commons-compress-1.8.1.jar" />
  </fileset>

  <path id="classpath-no-src">
    <fileset refid="buck.jars" />
    <fileset refid="third-party.jars" />
    <pathelement location="${classes.dir}" />
    <pathelement location="${dx.classes.dir}" />
  </path>

  <path id="classpath">
    <path refid="classpath-no-src" />
    <pathelement location="${src.dir}" />
  </path>

  <path id="junit">
    <pathelement location="${lib.dir}/junit-4.11.jar" />
    <pathelement location="${lib.dir}/hamcrest-core-1.3.jar" />
    <pathelement location="${lib.dir}/hamcrest-library-1.3.jar" />
  </path>

  <target name="clean" description="remove all generated files">
    <ant inheritAll="false" antfile="third-party/java/jacoco-0.6.4/build.xml" target="clean" />
    <delete dir="${build.dir}" />
  </target>

  <!-- Default target so that a command line build can
       do more than one thing.  'success' must be the last dependency. -->
  <target name="default" depends="compile, dx, client, javacc-tests, success" />

  <target name="checkversion">
    <!-- The nio Files class was only introduced in Java 7. -->
    <available property="jdk7" classname="java.nio.file.Files"/>
    <fail message="Require JDK 7 or higher" unless="jdk7"/>
  </target>

  <target name="compile-testrunner" depends="checkversion">
    <mkdir dir="${testrunner.classes.dir}" />
    <javac srcdir="${src.dir}"
           includes="com/facebook/buck/junit/**,src/com/facebook/buck/util/concurrent/MoreExecutors.java"
           destdir="${testrunner.classes.dir}"
           classpathref="junit"
           debug="on"
           includeAntRuntime="no"
           >
      <compilerarg value="-Xlint:rawtypes" />
      <compilerarg value="-Xlint:unchecked" />
      <compilerarg value="-Xlint:serial" />
    </javac>
  </target>

  <target name="compile-abi-processor" depends="checkversion">
    <mkdir dir="${abi_processor.classes.dir}" />
    <javac srcdir="${abi_processor.src.dir}"
           destdir="${abi_processor.classes.dir}"
           debug="on"
           includeAntRuntime="no"
           >
      <compilerarg value="-Xlint:rawtypes" />
      <compilerarg value="-Xlint:unchecked" />
      <compilerarg value="-Xlint:serial" />
    </javac>
  </target>

  <target name="javacc">
    <mkdir dir="${javacc.gensrc.dir}/com/facebook/buck/apple/xcode/xcconfig" />
    <javacc target="src/com/facebook/buck/apple/xcode/xcconfig/XcconfigParser.jj"
            outputdirectory="${javacc.gensrc.dir}/com/facebook/buck/apple/xcode/xcconfig"
            javacchome="third-party/java/javacc"
            static="false"
    />
  </target>

  <target name="javacc-tests">
    <mkdir dir="${javacc.test.dir}/com/facebook/buck/javacc" />
    <javacc target="test/com/facebook/buck/javacc/Simple1.jj"
            outputdirectory="${javacc.test.dir}/com/facebook/buck/javacc"
            javacchome="third-party/java/javacc"
            static="false"
        />
  </target>

  <macrodef name="ecj" description="Compile Java using the ecj compiler with strict checks.">
    <attribute name="srcdir" default="${src.dir}" />
    <attribute name="classpathref" default="classpath-no-src" />
    <attribute name="destdir" default="${classes.dir}" />
    <!--
      patterns should be a list of include and possibly exclude elements.
      According to http://ant.apache.org/manual/Tasks/javac.html, the only way
      to enumerate the .java inputs to javac in Ant is to set the sourcepath
      to the empty string, set the srcdir to something, and use include/exclude
      elements to filter things under the srcdir.
    -->
    <element name="patterns" />
    <sequential>
      <javac srcdir="@{srcdir}"
             sourcepath=""
             destdir="@{destdir}"
             classpathref="@{classpathref}"
             debug="on"
             deprecation="on"
             includeAntRuntime="no"
             compiler="org.eclipse.jdt.core.JDTCompilerAdapter"
             >
        <patterns />
        <!--
          ecj does not appear to support -Werror. As suggested by
          http://stackoverflow.com/a/14927725/396304, we specify an Eclipse preferences
          file to ECJ with the rules we want to enforce set to error.

          To see the full list of compiler options available, read the Javadoc for JavaCore at:
          http://help.eclipse.org/kepler/index.jsp?topic=%2Forg.eclipse.jdt.doc.isv%2Freference%2Fapi%2Forg%2Feclipse%2Fjdt%2Fcore%2FJavaCore.html
          Apparently Eclipse refuses to publish traditional Javadoc with manageable URLs.
        -->
        <compilerarg line="-properties ${eclipse.dir}/org.eclipse.jdt.core.prefs" />
        <compilerarg value="-Xlint:rawtypes" />
        <compilerarg value="-Xlint:unchecked" />
        <compilerarg value="-Xlint:serial" />
        <compilerarg value="-time" />
        <compilerclasspath>
          <pathelement location="${eclipse.dir}/org.eclipse.jdt.core_3.9.2.v20140114-1555.jar" />
          <pathelement location="${eclipse.dir}/jdtCompilerAdapter.jar" />
        </compilerclasspath>
      </javac>
    </sequential>
  </macrodef>

  <target name="compile"
          depends="compile-testrunner, compile-abi-processor, javacc, dx"
          description="compile Java source code">
    <ant inheritAll="false" antfile="third-party/java/jacoco-0.6.4/build.xml" target="build" />
    <mkdir dir="${classes.dir}" />

    <!--
      //src/com/facebook/buck/apple/xcode/xcconfig:xcconfig depends on
      //src/com/facebook/buck/util:exceptions and //src/com/facebook/buck/util:io,
      so we must compile these build targets (and their transitive deps) first.

      Admittedly, it is annoying to keep this list in sync with src/com/facebook/buck/util/BUCK,
      but there does not seem to be an easier way to do this right now. (Though moving
      these build rules into their own subpackages of util would make the patterns easier
      to maintain.)
    -->
    <ecj>
      <patterns>
        <!-- //src/com/facebook/buck/util:exceptions -->
        <include name="com/facebook/buck/util/ExceptionWithHumanReadableMessage.java" />
        <include name="com/facebook/buck/util/HumanReadableException.java" />
        <include name="com/facebook/buck/util/WatchmanWatcherException.java" />

        <!-- //src/com/facebook/buck/util:io -->
        <include name="com/facebook/buck/util/Ansi.java" />
        <include name="com/facebook/buck/util/Console.java" />
        <include name="com/facebook/buck/util/CapturingPrintStream.java" />
        <include name="com/facebook/buck/util/DefaultDirectoryTraverser.java" />
        <include name="com/facebook/buck/util/DirectoryTraverser.java" />
        <include name="com/facebook/buck/util/DirectoryTraversal.java" />
        <include name="com/facebook/buck/util/DirtyPrintStreamDecorator.java" />
        <include name="com/facebook/buck/util/InputStreamConsumer.java" />
        <include name="com/facebook/buck/util/MoreFiles.java" />
        <include name="com/facebook/buck/util/MorePaths.java" />
        <include name="com/facebook/buck/util/MorePosixFilePermissions.java" />
        <include name="com/facebook/buck/util/ProcessExecutor.java" />
        <include name="com/facebook/buck/util/ProjectFilesystem.java" />
        <include name="com/facebook/buck/util/Threads.java" />
        <include name="com/facebook/buck/util/Verbosity.java" />

        <!-- //src/com/facebook/buck/util:constants -->
        <include name="com/facebook/buck/util/BuckConstant.java" />

        <!-- //src/com/facebook/buck/util/environment:platform -->
        <include name="com/facebook/buck/util/environment/Platform.java" />

        <!-- //src/com/facebook/buck/zip:stream -->
        <include name="com/facebook/buck/zip/AppendingZipOutputStream.java" />
        <include name="com/facebook/buck/zip/ByteIo.java" />
        <include name="com/facebook/buck/zip/CentralDirectory.java" />
        <include name="com/facebook/buck/zip/CustomZipOutputStream.java" />
        <include name="com/facebook/buck/zip/CustomZipEntry.java" />
        <include name="com/facebook/buck/zip/EntryAccounting.java" />
        <include name="com/facebook/buck/zip/OverwritingZipOutputStream.java" />
        <include name="com/facebook/buck/zip/ZipOutputStreams.java" />

        <!-- //src/com/facebook/buck/timing:timing -->
        <include name="com/facebook/buck/timing/*.java" />
      </patterns>
    </ecj>

    <!--
      Compile code from AOSP as well as code generated by javacc using the default compiler.
      Using ecj spits out too many warnings that are not our responsibility (or in the case
      of javacc, within our control) to fix.

      Although we should compile src/com/facebook/buck/apple/xcode/xcconfig/*.java with
      strict checks from ecj, they must be compiled with
      build/javacc/com/facebook/buck/apple/xcode/xcconfig/*.java, which will not abide by
      those strict checks, so we must use the more lenient javac in this case.
    -->
    <javac destdir="${classes.dir}"
           classpathref="classpath"
           debug="on"
           deprecation="on"
           includeAntRuntime="no"
           >
      <src path="${aosp.src.dir}" />
      <src path="${javacc.gensrc.dir}" />
      <src path="${src.dir}/com/facebook/buck/apple/xcode/xcconfig" />

      <compilerarg value="-Xlint:rawtypes" />
      <compilerarg value="-Xlint:unchecked" />
      <compilerarg value="-Xlint:serial" />
    </javac>

    <!--
      Note that the inputs to this <ecj> task overlap with those from the previous
      <ecj> task. It's too much work to exclude them here.
    -->
    <ecj>
      <patterns>
        <!--
          These patterns are excluded because they are compiled elsewhere
          and are deliberately isolated from Buck's core.
        -->
        <exclude name="com/facebook/buck/android/support/**" />
        <exclude name="com/facebook/buck/apple/xcode/xcconfig/**" />
        <exclude name="com/facebook/buck/cli/quickstart/**" />
        <exclude name="com/facebook/buck/java/abi/AbiWriter.java" />
        <exclude name="com/facebook/buck/java/abi/Annotations.java" />
        <exclude name="com/facebook/buck/java/abi/ConstructorSummary.java" />
        <exclude name="com/facebook/buck/java/abi/EmptySummary.java" />
        <exclude name="com/facebook/buck/java/abi/EnumConstantSummary.java" />
        <exclude name="com/facebook/buck/java/abi/FieldSummary.java" />
        <exclude name="com/facebook/buck/java/abi/Joiner.java" />
        <exclude name="com/facebook/buck/java/abi/MethodSummary.java" />
        <exclude name="com/facebook/buck/java/abi/Modifiers.java" />
        <exclude name="com/facebook/buck/java/abi/Parameters.java" />
        <exclude name="com/facebook/buck/java/abi/Renderable.java" />
        <exclude name="com/facebook/buck/java/abi/RenderableTypes.java" />
        <exclude name="com/facebook/buck/java/abi/TypeSummary.java" />
        <exclude name="com/facebook/buck/junit/**" />
      </patterns>
    </ecj>
  </target>

  <fileset dir="${lib.dir}" id="dx.jars">
    <include name="guava-17.0.jar" />
  </fileset>

  <path id="dx.classpath">
    <fileset refid="dx.jars" />
  </path>

  <target name="dx">
    <mkdir dir="${dx.classes.dir}" />

    <javac destdir="${dx.classes.dir}"
           classpathref="dx.classpath"
           debug="on"
           deprecation="on"
           includeAntRuntime="no"
           >
      <src path="${dx.src.dir}" />
    </javac>

    <jar destfile="${build.dir}/dx.jar">
      <zipfileset includes="**/*.class" src="${lib.dir}/guava-17.0.jar"/>
      <zipfileset includes="**/*.class" src="${lib.dir}/junit-4.11.jar" />
      <fileset dir="${dx.classes.dir}" />
      <manifest>
        <attribute name="Main-Class" value="com.android.dx.command.Main" />
      </manifest>
    </jar>
  </target>

  <!--
       Note: two of the dx tests (the two tests for the merger) run the command
       "dalvik" and expect it to be a working dalvik virtual machine.
       Fulfilling this expectation is no easy task.  Here's how I did it.

       - Be on Linux (Dalvik doesn't build for Mac).
       - Check out Android (I used ICS because I had it lying around).
       - make -kj25 dalvik-host
       - If you built on a remote machine, rsync "out" to where you are
         developing Buck, inside of a dedicated directory called "android"
         or something.
       - Edit android/out/host/linux-x86/dalvik to change the log tags to
         "*:w", because a spurious info message was messing up the test.
       - Delete android/out/host/linux-x86/dx so the tests will use our dx.
       - Run this rule as
         ANDROID_BUILD_TOP=/path/to/android PATH=$PATH:$ANDROID_BUILD_TOP/out/host/linux-x86/bin ant dx-tests
       -->
  <target name="dx-tests" depends="dx">
    <exec
        failonerror="true"
        dir="${dx.test.dir}"
        executable="./run-all-tests">
      <env key="PATH" path="${env.PATH}:${dx.etc.dir}"/>
    </exec>
  </target>

  <target name="jar"
          depends="compile"
          description="build buck.jar"
          >
    <jar destfile="${build.dir}/buck.jar" update="true">
      <zipfileset refid="buck.jars" />
      <zipfileset refid="third-party.jars" />
      <fileset dir="${src.dir}"
               excludes="**/*.java, **/BUCK"
               />
      <fileset dir="${classes.dir}" />
      <manifest>
        <attribute name="Main-Class" value="com.facebook.buck.cli.Main" />
      </manifest>
    </jar>
  </target>

  <!-- The buck wrapper script checks the output file from this target
       to determine whether Buck needs to be built. -->
  <target name="success"
          description="Run after a successful build to indicate that a rebuild is unnecessary.">
    <touch file="${build.dir}/successful-build" />
  </target>

  <path id="tests.classpath">
    <path refid="classpath" />
    <fileset dir="${lib.dir}" >
      <include name="cglib-nodep-2.2.jar" />
      <include name="easymock-3.0.jar" />
      <include name="junit-4.11.jar" />
      <include name="hamcrest-core-1.3.jar" />
      <include name="hamcrest-library-1.3.jar" />
      <include name="objenesis-1.2.jar" />
    </fileset>
    <pathelement location="${testclasses.dir}" />
    <pathelement location="${test.dir}" />
    <pathelement location="${abi_processor.classes.dir}" />
    <pathelement location="${testrunner.classes.dir}" />
  </path>

  <target name="compile-tests"
          depends="compile, javacc-tests"
          >
    <mkdir dir="${testclasses.dir}" />
    <javac srcdir="${javacc.test.dir}"
           destdir="${testclasses.dir}"
           classpathref="tests.classpath"
           debug="on"
           deprecation="on"
           includeAntRuntime="on"
           />
    <ecj srcdir="${test.dir}"
         destdir="${testclasses.dir}"
         classpathref="tests.classpath"
         >
      <patterns>
        <exclude name="**/testdata/**" />
      </patterns>
    </ecj>
  </target>

  <target name="java-test"
          depends="compile-tests"
          description="runs the Java tests"
          >
    <junit failureproperty="hasFailingTests"
           showoutput="true"
           forkmode="perBatch"
           haltonerror="on">
      <sysproperty key="buck.path_to_buck_py" value="${buck.path_to_buck_py}" />
      <sysproperty key="buck.path_to_compile_asset_catalogs_py" value="${buck.path_to_compile_asset_catalogs_py}" />
      <sysproperty key="buck.path_to_compile_asset_catalogs_build_phase_sh" value="${buck.path_to_compile_asset_catalogs_build_phase_sh}" />
      <sysproperty key="buck.logging_config_file" value="${buck.logging_config_file}" />
      <sysproperty key="java.util.logging.config.class" value="com.facebook.buck.log.LogConfig" />

      <!-- See DEFS for details on why this property is needed. -->
      <sysproperty key="sun.zip.disableMemoryMapping" value="true" />

      <formatter type="plain" usefile="false" />

      <batchtest fork="yes">
        <fileset dir="${test.dir}">
          <!--
            Do not exclude tests that start with "Abstract", as there are some tests for abstract
            classes.
          -->
          <include name="**/*${test.class}.java" />
          <exclude name="**/testdata/**" />
        </fileset>
      </batchtest>
      <classpath refid="tests.classpath" />
    </junit>
    <fail if="hasFailingTests" />
  </target>

  <target name="py-test" description="runs the Python tests">
    <exec executable="python" failonerror="true">
      <arg value="src/com/facebook/buck/parser/buck_test.py" />
    </exec>
    <exec executable="python" failonerror="true">
      <arg value="src/com/facebook/buck/apple/compile_asset_catalogs_test.py" />
    </exec>
  </target>

  <path id="pmd-classpath">
    <fileset dir="${basedir}/pmd" includes="*.jar" />
  </path>

  <!--
  Runs pmd on the file(s) specified in the property "lint.files",
  separated by commas. Writes output to ${lint.outputpath}.
  -->
  <target name="pmd-files-xml" if="lint.files">
    <taskdef name="pmd"
             classpathref="pmd-classpath"
             classname="net.sourceforge.pmd.ant.PMDTask"
             />
    <pmd failOnRuleViolation="true" rulesetfiles="pmd/rules.xml">
      <ruleset>buck</ruleset>
      <formatter type="xml" toFile="${lint.outputpath}" />
      <fileset dir="${basedir}" includes="${lint.files}" />
    </pmd>
  </target>

  <!--
  Runs pmd on all source and test files.
  -->
  <target name="pmd">
    <taskdef name="pmd"
             classpathref="pmd-classpath"
             classname="net.sourceforge.pmd.ant.PMDTask"
             />
    <pmd failOnRuleViolation="true" rulesetfiles="pmd/rules.xml">
      <ruleset>buck</ruleset>
      <fileset dir="${src.dir}">
        <include name="**/*.java"/>
      </fileset>
      <fileset dir="${test.dir}">
        <include name="**/*.java"/>
        <exclude name="**/testdata/**"/>
      </fileset>
    </pmd>
  </target>

  <path id="checkstyle-classpath">
    <fileset dir="${basedir}/third-party/java/checkstyle" includes="*.jar" />
  </path>

  <!--
  Runs checkstyle on the file(s) specified in the property "lint.files",
  separated by commas.
  -->
  <target name="checkstyle-files-xml" if="lint.files">
    <taskdef resource="checkstyletask.properties"
           classpathref="checkstyle-classpath"/>
    <checkstyle config="checkstyle.xml">
      <formatter type="xml" toFile="${lint.outputpath}" />
      <fileset dir="${basedir}" includes="${lint.files}" />
    </checkstyle>
  </target>

    <!--
  Runs checkstyle on the file(s) specified in the property "lint.files",
  separated by commas.
  -->
  <target name="checkstyle-xml">
    <taskdef resource="checkstyletask.properties"
           classpathref="checkstyle-classpath"/>
    <checkstyle config="checkstyle.xml">
      <formatter type="xml" toFile="${lint.outputpath}" />
      <fileset dir="${src.dir}">
        <include name="**/*.java"/>
      </fileset>
      <fileset dir="${test.dir}">
        <include name="**/*.java"/>
        <exclude name="**/testdata/**"/>
      </fileset>
    </checkstyle>
  </target>

  <!--
  Runs checkstyle on all source and test files.
  -->
  <target name="checkstyle">
    <taskdef resource="checkstyletask.properties"
           classpathref="checkstyle-classpath"/>
    <checkstyle config="checkstyle.xml">
      <fileset dir="${src.dir}">
        <include name="**/*.java"/>
      </fileset>
      <fileset dir="${test.dir}">
        <include name="**/*.java"/>
        <exclude name="**/testdata/**"/>
      </fileset>
      <formatter type="plain"/>
    </checkstyle>
  </target>

  <target name="lint" depends="pmd, checkstyle" />

  <target name="test" depends="java-test, py-test" description="runs the unit tests" />

  <macrodef name="buck-javadoc" description="generates HTML documentation for Java code">
    <attribute name="destdir" />
    <attribute name="classpathref" />
    <attribute name="access" default="protected" />
    <element name="additional-links" optional="true" />
    <sequential>
      <delete dir="@{destdir}" />
      <mkdir dir="@{destdir}" />
      <record name="@{destdir}/javadoc.log" action="start" />
      <javadoc destdir="@{destdir}"
               access="@{access}"
               classpathref="@{classpathref}"
               windowtitle="Buck"
               failonerror="true"
               >
        <fileset dir="${src.dir}">
          <include name="**/*.java" />
          <exclude name="com/facebook/buck/cli/quickstart/**" />
        </fileset>
        <fileset dir="${javacc.gensrc.dir}" />
        <link href="http://docs.oracle.com/javase/7/docs/api/" />
        <link href="http://docs.guava-libraries.googlecode.com/git-history/v15.0/javadoc/" />
        <!-- The latest version of the javadocs is only for 4.10 -->
        <link href="https://junit-team.github.io/junit/javadoc/latest/" />
        <additional-links />
      </javadoc>
      <record name="@{destdir}/javadoc.log" action="stop" />
    </sequential>
  </macrodef>

  <target name="-javadoc-deps" depends="compile" />

  <path id="javadoc.classpath">
    <path refid="classpath" />
    <!-- Buck test runner has references to JUnit. -->
    <pathelement location="${lib.dir}/junit-4.11.jar" />
  </path>

  <target name="javadoc"
          description="generates HTML documentation for Java code"
          depends="-javadoc-deps">
    <buck-javadoc destdir="${javadoc.dir}"
                  classpathref="javadoc.classpath"
                  >
    </buck-javadoc>
  </target>

  <path id="javadoc-with-android.classpath">
    <path refid="javadoc.classpath" />
    <!-- Buck's Android support library has references to Android. -->
    <pathelement location="${env.ANDROID_HOME}/platforms/android-16/android.jar" />
  </path>

  <macrodef name="javadoc-with-android">
    <attribute name="destdir" />
    <attribute name="access" />
    <sequential>
      <fail unless="env.ANDROID_HOME" message="ANDROID_HOME not set." />

      <buck-javadoc destdir="@{destdir}"
                    classpathref="javadoc-with-android.classpath"
                    access="@{access}"
                    >
        <additional-links>
          <!--
            This is the recommended way to link to Android's Javadoc.
            This problem derives from Android's refusal to publish the package-list file
            with their Javadoc: http://stackoverflow.com/a/2823592/396304.

            Surprisingly, the generated Javadoc does link to http://d.android.com/
            rather than a local file:/// URI that points to the local $ANDROID_HOME.
          -->
          <link offline="true" href="http://d.android.com/reference" packagelistLoc="${env.ANDROID_HOME}/docs/reference"/>
        </additional-links>
      </buck-javadoc>
    </sequential>
  </macrodef>

  <target name="javadoc-with-android"
          description="generates HTML documentation for Java code with links to Android"
          depends="-javadoc-deps">
    <javadoc-with-android destdir="${javadoc-with-android.dir}" access="protected" />
  </target>

  <target name="verify-javadoc"
          description="verify that full Javadoc ran without errors"
          depends="-javadoc-deps">
    <!-- Runs javadoc with -private to catch errors in all possible docblocks. -->
    <javadoc-with-android destdir="${javadoc-all.dir}" access="private" />
    <exec executable="${basedir}/scripts/verify-javadoc.py" failonerror="true">
      <arg value="${javadoc-all.dir}/javadoc.log" />
    </exec>
  </target>

  <target name="travis" depends="test, verify-javadoc" />

  <target name="client" description="install nailgun buckd c client">
    <mkdir dir="${build.dir}" />
    <exec dir="${basedir}" executable="gcc">
      <arg line="-Wall -pedantic -O3 -o ${build.dir}/ng ${client.dir}/nailgun-client/ng.c" />
    </exec>
  </target>

  <target name="pre-checkin" depends="clean, default, compile-tests, lint"/>
  <target name="all" depends="jar, test, javadoc, client" />
</project>