--- jsr166/build.xml	2002/12/13 07:09:11	1.17
+++ jsr166/build.xml	2003/05/28 14:19:25	1.30
@@ -1,28 +1,36 @@
-<project name="jsr166" default="jar">
+<project name="jsr166" default="usage">
 
   <description>
+------------------------------------------------------------------------------
+  Build file for JSR-166
 
-    Build file for JSR-166
-
-    Note that junit.jar must be in ${ant.home}/lib for the
-    test target to work. [FIXME: This should be automatically
-    enforced by this build file by failing with a message if
-    junit.jar is not in the right place.]
+  Usage: ant [target]
 
+  User-specific settings are read from user.properties.
+  See user.properties.sample for examples.
+------------------------------------------------------------------------------
   </description>
 
+  <target name="usage" description="Advises user to run with -projecthelp">
+    <echo>Run "ant -projecthelp" for full usage information.</echo>
+  </target>
+
+
+  <!-- User-specific settings -->
+  <property file="user.properties"/>
+
+
   <!-- Compilation options -->
   <property name="build.sourcelevel"    value="1.5"/>
+  <property name="build.docsourcelevel" value="1.4"/>
   <property name="build.debug"          value="true"/>
   <property name="build.debuglevel"     value="source,lines,vars"/>
   <property name="build.deprecation"    value="false"/>
-  <!--
-  <property name="build.warnings"       value="true"/>
-  -->
 
   <!-- Build locations -->
   <property name="build.dir"            location="build"/>
   <property name="build.classes.dir"    location="${build.dir}/classes"/>
+  <property name="build.emulation.dir"  location="${build.dir}/emulation"/>
   <property name="build.testcases.dir"  location="${build.dir}/testcases"/>
   <property name="build.lib.dir"        location="${build.dir}/lib"/>
   <property name="build.ant.dir"        location="${build.dir}/ant"/>
@@ -33,8 +41,9 @@
   <property name="build.filter.src.dir" location="${build.dir}/filtersrc"/>
 
   <!-- Source locations -->
-  <property name="src.dir"              location="${basedir}"/>
-  <property name="test.src.dir"         location="${basedir}/etc/testcases"/>
+  <property name="src.dir"              location="${basedir}/src/main"/>
+  <property name="emulation.src.dir"    location="${basedir}/src/emulation"/>
+  <property name="test.src.dir"         location="${basedir}/src/test"/>
   <property name="ant.src.dir"          location="${basedir}/etc/ant"/>
   <property name="stylesheet.dir"       location="${basedir}/etc/xsl"/>
   <property name="lib.dir"              location="${basedir}/lib"/>
@@ -50,23 +59,66 @@
   <property name="junit.jar"            location="${lib.dir}/junit.jar"/>
   <property name="rt.jar"               location="${java.home}/lib/rt.jar"/>
 
-  <property name="javac.args"           value='-J-Xbootclasspath/p:${javac.jar}'/>
+
+
+  <!--
+   ! Bootclasspath munging for source compilation.
+   -->
+
+  <path id="javac.bootclasspath.prefix">
+    <!-- <pathelement location="${src.dir}"/> -->
+    <pathelement location="${javac.jar}"/>
+  </path>
 
   <path id="javac.bootclasspath">
+    <!-- <pathelement location="${src.dir}"/> -->
     <pathelement location="${collect.jar}"/>
     <pathelement location="${rt.jar}"/>
   </path>
 
+  <!-- Flatten bootclasspath prefix into a platform-appropriate string -->
+  <property name="javac.bootclasspath.prefix" refid="javac.bootclasspath.prefix"/>
+
+  <!-- Turn the flattened bootclasspath prefix into a javac argument -->
+  <property name="javac.args" value='-J-Xbootclasspath/p:${javac.bootclasspath.prefix}'/>
+
+
+
+  <!--
+   ! Bootclasspath munging for testing, so JUnit can test our local
+   ! modifications to java.*.
+   -->
+
   <path id="test.classpath">
     <pathelement location="${product.jar}"/>
+    <pathelement location="${build.testcases.dir}"/>
+    <pathelement location="${junit.jar}"/>
   </path>
 
+  <!-- Flatten test classpath into a platform-appropriate string -->
+  <property name="test.classpath" refid="test.classpath"/>
+
+  <!-- Turn the flattened test classpath into a javac argument -->
+  <property name="test.javac.args" value='-Xbootclasspath/p:${test.classpath}'/>
+
+
+
+  <!-- Files excluded from emulation and dist-docs -->
+  <patternset id="emulation.excludes">
+    <exclude name="java/util/Random.*"/>
+    <exclude name="sun/misc/Unsafe.*"/>
+  </patternset>
+
+
 
   <!-- Main targets -->
 
-  <target name="compile" depends="init"
-          description="Compiles all sources to build folder">
+  <target name="compile"
+          depends="init"
+          description="Compiles main sources to build folder">
+
     <mkdir dir="${build.classes.dir}"/>
+
     <javac srcdir="${src.dir}"
           destdir="${build.classes.dir}"
             debug="${build.debug}"
@@ -78,28 +130,25 @@
       <bootclasspath refid="javac.bootclasspath"/>
       <compilerarg line="${javac.args} ${build.warnings.option}"/>
 
-      <!-- need this because srcdir is basedir! -->
-      <include name="java/**/*.java"/>
-
     </javac>
+
   </target>
 
 
-  <target name="jar" depends="compile"
-          description="Builds library jar from compiled sources">
-    <mkdir dir="${build.lib.dir}"/>
-    <jar basedir="${build.classes.dir}"
-        destfile="${product.jar}"
-    />
-  </target>
+  <target name="jar"
+          depends="check-emulation, init-jar, native-jar, emulation-jar"
+          description="Builds library jar from compiled sources"/>
 
 
-  <target name="test" depends="init, report-tests"
-          description="Runs all tests"/>
+  <target name="test"
+          depends="init, check-junit, report-tests"
+          description="Runs all tests (requires JUnit 3.8.1 in ${ant.home}/lib)" />
 
 
-  <target name="checkstyle" depends="filter-src"
-          description="Reports on style errors in Java source">
+  <target name="checkstyle"
+          depends="filter-src"
+          description="Reports on style errors in Java source (verbose, mostly chaff)">
+
     <taskdef resource="checkstyletask.properties"
             classpath="${lib.dir}/checkstyle-all-2.4.jar"/>
 
@@ -107,46 +156,60 @@
       <formatter type="plain"/>  <!-- also available: type="xml" -->
       <fileset dir="${build.filter.src.dir}" includes="**/*.java"/>
     </checkstyle>
+
   </target>
 
 
-  <target name="doccheck" depends="filter-src"
-          description="Reports on javadoc style errors">
+  <target name="doccheck"
+          depends="filter-src"
+          description="Reports on javadoc style errors (not working yet)">
+
     <delete dir="${build.doccheck.dir}"/>
     <mkdir dir="${build.doccheck.dir}"/>
+
     <javadoc doclet="com.sun.tools.doclets.doccheck.DocCheck"
          docletpath="${lib.dir}/doccheck.jar"
             destdir="${build.doccheck.dir}">
-      <packageset dir="${build.filter.src.dir}">
-        <include name="java/**"/>
-      </packageset>
+      <packageset dir="${build.filter.src.dir}"/>
     </javadoc>
+
   </target>
 
 
-  <target name="docs" depends="filter-src"
+  <target name="docs"
+          depends="filter-src"
           description="Builds javadocs with custom tags to build folder">
+
     <delete dir="${build.javadocs.dir}"/>
     <mkdir dir="${build.javadocs.dir}"/>
+
     <javadoc destdir="${build.javadocs.dir}"
                 link="http://java.sun.com/j2se/1.4.1/docs/api"
             overview="${src.dir}/intro.html"
-              source="${build.sourcelevel}">
+              source="${build.docsourcelevel}">
 
       <tag name="revised" description="Last revised:"/>
-      <tag name="spec" description="Specified by:"/>
-      <tag name="editor" description="Last edited by:"/>
-      <tag name="fixme" description="FIX ME:"/>
-      <packageset dir="${build.filter.src.dir}">
-        <include name="java/**"/>
-      </packageset>
+      <tag name="spec"    description="Specified by:"/>
+      <tag name="editor"  description="Last edited by:"/>
+      <tag name="fixme"   description="FIX ME:"/>
+
+      <packageset dir="${build.filter.src.dir}"/>
 
     </javadoc>
+
   </target>
 
 
-  <target name="strip" depends="init">
+  <!--
+   # javac -s doesn't reliably generate compilable code. It generates
+   # bridge methods (marked as "synthetic") that can have identical
+   # signatures to existing methods except for the return value.
+   -->
+  <target name="strip"
+          depends="init">
+
     <mkdir dir="${build.stripped.dir}"/>
+
     <javac srcdir="${src.dir}"
           destdir="${build.stripped.dir}"
             debug="${build.debug}"
@@ -158,104 +221,164 @@
       <bootclasspath refid="javac.bootclasspath"/>
       <compilerarg line="${javac.args} ${build.warnings.option} -s"/>
 
-      <!-- need this because srcdir is basedir! -->
-      <include name="java/**/*.java"/>
-
     </javac>
+
   </target>
 
 
-  <target name="dist" depends="init, dist-clean, dist-jar, dist-docs"
+  <target name="dist"
+          depends="init, dist-clean, dist-jar, dist-docs"
           description="Puts all distributable products in single hierarchy"/>
 
 
   <target name="clean"
           description="Removes all build products">
+
     <delete dir="${build.dir}"/>
     <delete dir="${build.classes.dir}"/>
     <delete dir="${build.lib.dir}"/>
+
   </target>
 
 
   <target name="dist-clean"
           description="Removes all build and distribution products">
+
     <delete dir="${dist.dir}"/>
+
   </target>
 
 
-  <!-- Anthill targets -->
+  <target name="dist-docs"
+          depends="filter-src"
+          description="Builds javadocs without custom tags to dist folder">
 
-  <!-- Should really run the tests instead of just the jar target -->
-  <target name="anthill-build" depends="jar, docs, dist-docs"
-          description="Build the jar and both the external and internal docs"/>
+    <delete dir="${dist.javadocs.dir}"/>
+    <mkdir dir="${dist.javadocs.dir}"/>
+
+    <javadoc destdir="${dist.javadocs.dir}"
+                link="http://java.sun.com/j2se/1.4.1/docs/api"
+            overview="${src.dir}/intro.html"
+              source="${build.docsourcelevel}">
+
+      <packageset dir="${build.filter.src.dir}"/>
+
+    </javadoc>
 
-  <target name="anthill-publish">
-    <copy todir="${deployDir}/docs/private">
-      <fileset dir="${build.javadocs.dir}"/>
-    </copy>
-    <copy todir="${deployDir}/docs/public">
-      <fileset dir="${dist.javadocs.dir}"/>
-    </copy>
-    <copy tofile="${deployDir}/index.html"
-          file="${basedir}/etc/anthill-index.html"/>
   </target>
 
 
+
   <!-- Internal targets -->
 
   <target name="set-warnings-if" if="build.warnings">
+
     <property name="build.warnings.option" value="-warnunchecked"/>
+
   </target>
 
 
   <target name="set-warnings-unless" unless="build.warnings">
+
     <property name="build.warnings.option" value=""/>
+
   </target>
 
 
-  <target name="init" depends="set-warnings-if, set-warnings-unless">
+  <target name="init"
+          depends="set-warnings-if, set-warnings-unless">
+
     <!-- Version is kept in a separate file -->
     <loadfile property="version" srcFile="version.properties"/>
     <echo>Building JSR-166 version ${version}</echo>
+
   </target>
 
 
-  <target name="dist-jar" depends="clean, jar">
-    <copy file="${product.jar}" todir="${dist.dir}"/>
+  <target name="init-jar">
+
+    <mkdir dir="${build.lib.dir}"/>
+
   </target>
 
 
-  <target name="dist-docs" depends="filter-src"
-          description="Builds javadocs without custom tags to dist folder">
-    <delete dir="${dist.javadocs.dir}"/>
-    <mkdir dir="${dist.javadocs.dir}"/>
-    <javadoc destdir="${dist.javadocs.dir}"
-                link="http://java.sun.com/j2se/1.4.1/docs/api"
-            overview="${src.dir}/intro.html"
-              source="${build.sourcelevel}">
+  <target name="native-jar"
+          depends="compile"
+          unless="build.emulation.true">
 
-      <packageset dir="${build.filter.src.dir}">
-        <include name="java/**"/>
-      </packageset>
+    <jar destfile="${product.jar}">
+      <fileset dir="${build.classes.dir}"/>
+    </jar>
+
+  </target>
+
+
+  <target name="compile-emulation"
+          depends="init"
+          if="build.emulation.true">
+
+    <mkdir dir="${build.emulation.dir}"/>
+
+    <javac srcdir="${emulation.src.dir}"
+          destdir="${build.emulation.dir}"
+            debug="${build.debug}"
+       debuglevel="${build.debuglevel}"
+      deprecation="${build.deprecation}"
+           source="${build.sourcelevel}"
+             fork="true">
+
+      <bootclasspath refid="javac.bootclasspath"/>
+      <compilerarg line="${javac.args} ${build.warnings.option}"/>
+
+    </javac>
 
-    </javadoc>
   </target>
 
 
-  <target name="compile-ant-filter" depends="init">
+  <target name="emulation-jar"
+          depends="compile-emulation"
+          if="build.emulation.true">
+
+
+    <jar destfile="${product.jar}" duplicate="add">
+      <fileset dir="${build.classes.dir}">
+        <patternset refid="emulation.excludes"/>
+      </fileset>
+      <fileset dir="${build.emulation.dir}"/>
+    </jar>
+
+  </target>
+
+
+  <target name="dist-jar"
+          depends="clean, jar">
+
+    <copy file="${product.jar}" todir="${dist.dir}"/>
+
+  </target>
+
+
+  <target name="compile-ant-filter"
+          depends="init">
+
     <mkdir dir="${build.ant.dir}"/>
+
     <javac srcdir="${ant.src.dir}"
           destdir="${build.ant.dir}"
            source="1.4"
     />
+
   </target>
 
 
-  <target name="filter-src" depends="compile-ant-filter">
+  <target name="filter-src"
+          depends="compile-ant-filter">
+
     <mkdir dir="${build.filter.src.dir}"/>
+
     <copy todir="${build.filter.src.dir}">
       <fileset dir="${src.dir}">
-        <include name="java/**/*.java"/>
+        <patternset refid="emulation.excludes"/>
       </fileset>
       <filterchain>
         <filterreader classname="jsr166.ant.filters.ReplaceFilter"
@@ -289,11 +412,15 @@
         </filterreader>
       </filterchain>
     </copy>
+
   </target>
 
 
-  <target name="compile-tests" depends="jar">
+  <target name="compile-tests"
+          depends="jar">
+
     <mkdir dir="${build.testcases.dir}"/>
+
     <javac srcdir="${test.src.dir}"
           destdir="${build.testcases.dir}"
             debug="${build.debug}"
@@ -305,14 +432,20 @@
       <bootclasspath refid="javac.bootclasspath"/>
       <compilerarg line="${javac.args} ${build.warnings.option}"/>
       <classpath refid="test.classpath"/>
-      <include name="**/*Test.java"/>
 
     </javac>
+
   </target>
 
 
-  <target name="run-tests" depends="compile-tests">
+  <target name="run-tests"
+          depends="compile-tests">
+
+    <!-- May be overridden by user.properties -->
+    <property name="testcase" value="*"/>
+
     <mkdir dir="${build.reports.dir}"/>
+
     <junit printsummary="true"
              showoutput="true"
           errorProperty="junit.failed"
@@ -320,26 +453,24 @@
                     dir="${build.reports.dir}"
                    fork="true">
 
-      <jvmarg value="-Xbootclasspath/p:${product.jar}"/>
-
-      <classpath>
-        <!-- <path refid="test.classpath"/> -->
-        <pathelement location="${build.testcases.dir}"/>
-      </classpath>
+      <jvmarg value="${test.javac.args}"/>
 
       <formatter type="xml"/>
 
       <batchtest todir="${build.reports.dir}">
         <fileset dir="${test.src.dir}">
-          <include name="**/*Test.java"/>
+          <include name="**/${testcase}Test.java"/>
         </fileset>
       </batchtest>
 
     </junit>
+
   </target>
 
 
-  <target name="report-tests" depends="run-tests">
+  <target name="report-tests"
+          depends="run-tests">
+
     <!-- Sets junit.report.format to frames if Xalan is present,
          otherwise sets it to noframes. -->
     <available property="junit.report.format"
@@ -359,6 +490,55 @@
     </junitreport>
 
     <fail message="Test Cases Failed" if="junit.failed"/>
+
+  </target>
+
+
+  <target name="check-junit">
+
+    <!-- junit.framework.Protectable is in JUnit 3.8.1 but not in 3.7 -->
+    <available property="junit.available"
+               classname="junit.framework.Protectable"/>
+
+    <fail message="Need JUnit 3.8.1 in ${ant.home}${file.separator}lib to run tests"
+          unless="junit.available"/>
+
+  </target>
+
+
+  <target name="check-emulation">
+    <condition property="build.emulation.true">
+      <or>
+        <isset property="build.emulation"/>
+        <os family="windows"/>
+      </or>
+    </condition>
+  </target>
+
+
+
+  <!-- Anthill targets -->
+
+  <target name="anthill-build"
+          depends="jar, test, docs, dist-docs"/>
+
+  <target name="anthill-publish">
+
+    <copy todir="${deployDir}/docs/private">
+      <fileset dir="${build.javadocs.dir}"/>
+    </copy>
+
+    <copy todir="${deployDir}/docs/public">
+      <fileset dir="${dist.javadocs.dir}"/>
+    </copy>
+
+    <copy tofile="${deployDir}/index.html"
+          file="${basedir}/etc/anthill-index.html"/>
+
+    <copy todir="${deployDir}/notes">
+      <fileset dir="${basedir}/etc/notes"/>
+    </copy>
+
   </target>