<?xml version="1.0"?>

<project name="DoctorJ" default="compile" basedir=".">
  
    <property name="debug"          value="true"                  />
    <property name="deprecation"    value="false"                 />
    <property name="optimize"       value="true"                  />
  
    <property name="basedir"        value="."                     />
  
    <property name="src.dir"        value="${basedir}"            />
    <property name="lib.dir"        value="lib"                   />
    <property name="docs.dir"       value="docs"                  />
    <property name="test.dir"       value="${basedir}/test"       />
  
    <property name="build.dir"      value="${basedir}"            />
    <property name="build.classes"  value="${build.dir}/classes"  />
    <property name="build.lib"      value="${build.dir}/lib"      />
    <property name="build.javadocs" value="${build.dir}/javadocs" />

    <property name="version"        value="5.0.0"                 />

    <!-- the top directory, equivalent to DESTDIR                -->
    <property name="destdir"        value="/tmp/drjtgt"           />

    <property name="prefix"         value="/usr"                  />
    <property name="mandir"         value="${prefix}/share/man"   />
    <property name="datadir"        value="${prefix}/share"       />
    <property name="bindir"         value="${prefix}/bin"         />
  
    <path id="classpath">
        <pathelement location="${build.classes}" />
    </path>
  
    <path id="run-classpath">
        <pathelement location="${test.dir}/classes" />
        <path refid="classpath" />
        <pathelement location="/home/jpace/lib/java/junit.jar" />
    </path>
  
    <target name="compile" 
            depends=""
            description="--> compiles the core code">
        <mkdir dir="${build.dir}"/>
        <mkdir dir="${build.classes}"/>
      
        <javac srcdir="${src.dir}"
               destdir="${build.classes}"
               debug="${debug}"
               deprecation="${deprecation}"
               optimize="${optimize}" >
            <classpath refid="classpath" />
            <include name="org/**/*.java" />
        </javac>
    </target>
  
    <target name="compile-tests" 
            depends="compile"
            description="--> compiles the tests">
        <mkdir dir="${build.dir}"        />
        <mkdir dir="${build.classes}"    />
        <mkdir dir="${test.dir}/classes" />
      
        <javac srcdir="${test.dir}"
               destdir="${test.dir}/classes"
               debug="${debug}"
               deprecation="${deprecation}"
               optimize="${optimize}" >
            <classpath refid="classpath" />
        </javac>
    </target>
  
    <target name="run-ast-dump-commented" 
            depends="compile"
            description="--> runs the AST dump">
        <java classname="org.incava.java.Main" fork="true">
            <classpath refid="run-classpath" />
            <arg value="--dump" />
            <arg value="testfiles/Commented.java" />
        </java>
    </target>
  
    <target name="run-ast-dump-tiny" 
            depends="compile"
            description="--> runs the AST dump">
        <java classname="org.incava.java.Main" fork="true">
            <classpath refid="run-classpath" />
            <arg value="--dump" />
            <arg value="testfiles/Tiny.java" />
        </java>
    </target>
  
    <target name="run-javadoc-analyzer" 
            depends="compile"
            description="--> runs the AST dump">
        <java classname="org.incava.doctorj.Main" fork="true">
            <classpath refid="run-classpath" />
            <arg value="testfiles/Tiny.java" />
         </java>
    </target>
  
    <target name="run-doc" 
            depends="compile"
            description="--> runs the Javadoc analyzer">
        <java classname="org.incava.doctorj.Main" fork="true">
            <classpath refid="run-classpath" />
            <arg value="testfiles/Tiny.java" />
        </java>
    </target>
  
    <target name="remake" 
            depends="clean,compile"
            description="--> rebuild the application">
    </target>
  
    <target name="clean" 
            depends=""
            description="--> removes compiled code">
        <delete>
            <fileset dir="${basedir}" includes="**/*.class" /> 
        </delete>
    </target>

    <!-- unit tests -->
  
    <target name="test-spell-checker" 
            description="--> runs the test of the spell checker">
        <antcall target="run-test"><param name="classname" value="org.incava.text.TestSpellChecker"/></antcall>
    </target>
  
    <target name="test-nocase-spell-checker" 
            description="--> runs the test of the spell checker">
        <antcall target="run-test"><param name="classname" value="org.incava.text.TestNoCaseSpellChecker"/></antcall>
    </target>
  
    <target name="test-javadoc-parser" 
            description="--> runs the test of the Javadoc parser">
        <antcall target="run-test"><param name="classname" value="org.incava.java.TestJavadocParser"/></antcall>
    </target>
  
    <target name="test-javadoc-node" 
            description="--> runs the test of the Javadoc Node">
        <antcall target="run-test"><param name="classname" value="org.incava.java.TestJavadocNode"/></antcall>
    </target>
  
    <target name="test-javadoc-tagged-node" 
            description="--> runs the test of the Javadoc Tagged Node">
        <antcall target="run-test"><param name="classname" value="org.incava.java.TestJavadocTaggedNode"/></antcall>
    </target>
  
    <target name="test-violation" 
            description="--> runs the test of the violations">
        <antcall target="run-test"><param name="classname" value="org.incava.analysis.TestViolation"/></antcall>
    </target>
  
    <target name="test-report" 
            description="--> runs the test of the report">
        <antcall target="run-test"><param name="classname" value="org.incava.analysis.TestReport"/></antcall>
    </target>
  
    <target name="test-terse-report" 
            description="--> runs the test of the terse report">
        <antcall target="run-test"><param name="classname" value="org.incava.analysis.TestTerseReport"/></antcall>
    </target>
  
    <target name="test-context-report" 
            description="--> runs the test of the context report">
        <antcall target="run-test"><param name="classname" value="org.incava.analysis.TestContextReport"/></antcall>
    </target>
  
    <target name="test-collect" 
            description="--> runs the test of the Collect class">
        <antcall target="run-test"><param name="classname" value="org.incava.util.TestCollect"/></antcall>
    </target>
  
    <!-- jagol unit tests -->
  
    <target name="test-jagol-option" 
            description="--> runs the test of the jagol option">
        <antcall target="run-test"><param name="classname" value="org.incava.jagol.TestOption"/></antcall>
    </target>
  
    <target name="test-jagol-integer-option" 
            description="--> runs the test of the jagol integer option">
        <antcall target="run-test"><param name="classname" value="org.incava.jagol.TestIntegerOption"/></antcall>
    </target>
  
    <target name="test-jagol-nonboolean-option" 
            description="--> runs the test of the jagol nonboolean option">
        <antcall target="run-test"><param name="classname" value="org.incava.jagol.TestNonBooleanOption"/></antcall>
    </target>
  
    <target name="test-jagol-double-option" 
            description="--> runs the test of the jagol double option">
        <antcall target="run-test"><param name="classname" value="org.incava.jagol.TestDoubleOption"/></antcall>
    </target>
  
    <target name="test-jagol-float-option" 
            description="--> runs the test of the jagol float option">
        <antcall target="run-test"><param name="classname" value="org.incava.jagol.TestFloatOption"/></antcall>
    </target>
  
    <target name="test-jagol-string-option" 
            description="--> runs the test of the jagol string option">
        <antcall target="run-test"><param name="classname" value="org.incava.jagol.TestStringOption"/></antcall>
    </target>
  
    <target name="test-jagol-boolean-option" 
            description="--> runs the test of the jagol boolean option">
        <antcall target="run-test"><param name="classname" value="org.incava.jagol.TestBooleanOption"/></antcall>
    </target>
  
    <target name="test-jagol-list-option" 
            description="--> runs the test of the jagol list option">
        <antcall target="run-test"><param name="classname" value="org.incava.jagol.TestListOption"/></antcall>
    </target>
  
    <target name="test-jagol-option-set" 
            description="--> runs the test of the jagol option set">
        <antcall target="run-test"><param name="classname" value="org.incava.jagol.TestOptionSet"/></antcall>
    </target>
  
    <!-- javadoc analysis unit tests -->
  
    <target name="test-comment-spell-check" 
            description="--> runs the test of the comment spell checker">
        <antcall target="run-javadoc-test"><param name="classname" value="TestCommentSpellCheck"/></antcall>
    </target>

    <target name="test-exception-doc-analyzer" 
            description="--> runs the test of the Javadoc exceptions">
        <antcall target="run-javadoc-test"><param name="classname" value="TestExceptionDocAnalyzer"/></antcall>
    </target>
  
    <target name="test-item-doc-analyzer" 
            description="--> runs the test of an Item ">
        <antcall target="run-javadoc-test"><param name="classname" value="TestItemDocAnalyzer"/></antcall>
    </target>
  
    <target name="test-parameter-doc-analyzer" 
            description="--> runs the test of the Javadoc @param tag">
        <antcall target="run-javadoc-test"><param name="classname" value="TestParameterDocAnalyzer"/></antcall>
    </target>

    <target name="test-function-doc-analyzer" 
            description="--> runs the test of the Javadoc function analyzer">
        <antcall target="run-javadoc-test"><param name="classname" value="TestFunctionDocAnalyzer"/></antcall>
    </target>

    <target name="test-method-doc-analyzer" 
            description="--> runs the test of the Javadoc method analyzer">
        <antcall target="run-javadoc-test"><param name="classname" value="TestMethodDocAnalyzer"/></antcall>
    </target>

    <target name="test-ctor-doc-analyzer" 
            description="--> runs the test of the Javadoc ctor analyzer">
        <antcall target="run-javadoc-test"><param name="classname" value="TestMethodDocAnalyzer"/></antcall>
    </target>

    <target name="test-field-doc-analyzer" 
            description="--> runs the test of the Javadoc field analyzer">
        <antcall target="run-javadoc-test"><param name="classname" value="TestFieldDocAnalyzer"/></antcall>
    </target>

    <target name="test-type-doc-analyzer" 
            description="--> runs the test of the Javadoc type analyzer">
        <antcall target="run-javadoc-test"><param name="classname" value="TestTypeDocAnalyzer"/></antcall>
    </target>

    <target name="test-class-doc-analyzer" 
            description="--> runs the test of the Javadoc class analyzer">
        <antcall target="run-javadoc-test"><param name="classname" value="TestClassDocAnalyzer"/></antcall>
    </target>

    <target name="test-interface-doc-analyzer" 
            description="--> runs the test of the Javadoc interface analyzer">
        <antcall target="run-javadoc-test"><param name="classname" value="TestInterfaceDocAnalyzer"/></antcall>
    </target>

    <target name="test-options" 
            description="--> runs the test of the effect of options on the analyzers">
        <antcall target="run-javadoc-test"><param name="classname" value="TestOptions"/></antcall>
    </target>

    <!-- generic testing targets -->

    <target name="run-javadoc-test" 
            description="--> runs a Javadoc test">
        <antcall target="run-test"><param name="classname" value="org.incava.doctorj.${classname}"/></antcall>
    </target>
  
    <target name="run-test" 
            depends="compile-tests"
            description="--> runs a unit test">
        <junit printsummary="no" haltonfailure="yes" fork="yes" filtertrace="true" showoutput="no">
            <classpath refid="run-classpath" />
            <formatter type="plain" usefile="false" />
            <test name="${classname}" />
        </junit>
    </target>
  
    <target name="tests" 
            depends="compile-tests"
            description="--> runs all tests">
        <junit printsummary="yes" haltonfailure="yes" fork="yes" filtertrace="true" showoutput="no">
            <classpath refid="run-classpath" />
            <formatter type="plain" usefile="false" />
            <batchtest fork="yes">
                <fileset dir="test">
                    <include name="**/Test*.java"/>
                    <exclude name="**/Tester.java"/>
                </fileset>
            </batchtest>
            <sysproperty key="verbose" value="false" />
        </junit>
    </target>
  
    <target name="test-jagol" 
            depends="compile-tests"
            description="--> runs all Jagol tests">
        <junit printsummary="yes" haltonfailure="yes" fork="yes" filtertrace="true" showoutput="no">
            <classpath refid="run-classpath" />
            <formatter type="plain" usefile="false" />
            <batchtest fork="yes">
                <fileset dir="test">
                    <include name="org/incava/jagol/**/Test*.java"/>
                </fileset>
            </batchtest>
            <sysproperty key="verbose" value="false" />
        </junit>
    </target>
  
    <target name="jarfile" 
            depends="compile"
            description="--> builds the .jar file">
        <mkdir dir="lib"/>
        <jar destfile="lib/doctorj.jar" basedir="classes" includes="org/incava/**/*.class">
            <manifest>
                <attribute name="Main-Class" value="org.incava.doctorj.Main" />
            </manifest>
        </jar>
    </target>
  
    <target name="dist" 
            depends="jarfile, manpage"
            description="--> builds the distribution tarball">
        <property name="tarball" value="${build.dir}/doctorj-${version}.tar" />
        <tar tarfile="${tarball}">
            <tarfileset dir="${src.dir}" prefix="doctorj-${version}">
                <include name="Makefile"           />
                <include name="build.xml"          />
                <include name="AUTHORS"            />
                <include name="ChangeLog"          />
                <include name="COPYING"            />
                <include name="INSTALL"            />
                <include name="NEWS"               />
                <include name="README"             />
                <include name="bin/doctorj"        />
                <include name="doc/doctorj.1"      />
                <include name="doctorj.spec"       />
                <include name="org/**/*.java"      />
                <include name="org/**/*.jj*"       />
                <include name="etc/words.*"        />
                <include name="test/org/**/*.java" />
            </tarfileset>
        </tar>
        <gzip zipfile="${tarball}.gz" src="${tarball}" />
        <delete file="${tarball}" />
    </target>
  
    <target name="manpage" 
            description="--> builds the man page from the XML source">
        <exec dir="." executable="xmlto">
            <arg value="-o"/>
            <arg value="doc"/>
            <arg value="man"/>
            <arg value="doc/doctorj.xml"/>
        </exec>
    </target>
  
    <target name="install" 
            depends="jarfile"
            description="--> installs the program">
        <mkdir dir="${destdir}${bindir}"           />
	<mkdir dir="${destdir}${datadir}/doctorj"  />
	<mkdir dir="${destdir}${mandir}/man1"      />

        <!-- can't use the copy task, since permissions are not retained -->
	<exec executable="cp">
            <arg value="bin/doctorj"               />
            <arg value="${destdir}${bindir}"       />
        </exec>

	<copy todir="${destdir}${datadir}/doctorj">
            <fileset dir="etc">
                <include name="words.*" />
            </fileset>
	</copy>

	<copy file="lib/doctorj.jar" todir="${destdir}${datadir}/doctorj" />
       	<copy file="doc/doctorj.1"   todir="${destdir}${mandir}/man1"     />
    </target>
  
</project>