build.xml

<!-- $Id: build.xml,v 1.39 2002-10-28 09:14:30 triolet Exp $ -->

<project name="transmo" default="compile" basedir="..">
	
	<!--taskdef name="transmorph" classname="fr.fluxmedia.transmorpher.Application.TransmorphTask"/-->

	<!-- tested -->
	<target name="usage" depends="init">
		<echo message="sh ant _target_ _options_"/>
		<echo/>
		<echo message="usage: this message"/>
		<echo message="init: sets necessary variables"/>
		<echo message="compile: incrementaly compiles sources"/>
		<echo message="compileall: recompiles all sources"/>
		<echo message="jar: archives compiled code"/>
		<echo message="test: performs unit tests"/>
		<echo message="updatetests: update the tests skeletons"/>
		<echo message="javadoc: generates documentation"/>
		<echo message="update: update the CVS repository"/>
		<echo message="commit: "/>
		<echo message="prepare: prepare the base for a release (VERSION variable set)"/>
		<echo message="mark: set the tag on the version in the CVS base "/>
		<echo message="image: prepage the release directory"/>
		<echo message="package: create compressed releases"/>
		<echo message="tidy: suppresses temporary files"/>
		<echo message="ttask: test Transmorpher as a Ant task"/>
		<echo message="release: releases a new version"/>
		<echo message="extrajar: create archive with required jars"/>
		<echo message="cdrom: prepare the CDROM image for INRIA"/>
		<echo message="clean: clean-up the release directory"/>
		<echo/>
		<echo message="	-Dversion=${version}"/>
	</target>

	<!-- tested -->
	<target name="init">
		<tstamp><format locale="fr,fr" pattern="dd/MM/yyyy" property="TODAY"/></tstamp>
		<property name="doing" value="running"/>
		<property name="version" value="0-9-10${doing}"/>
		<property name="date" value="${TODAY}"/>
		<property name="login" value="triolet"/>
		<property name="email" value="Fabien.Triolet@inrialpes.fr"/>
		<property name="libdir"  value="lib" />
		<property name="fullname" value="Transmorpher"/>
		<property name="debug" value="off"/>

		<filter token="DATE" value="${date}"/>
		<filter token="VERS" value="${version}"/>
		<echo message="Transmorpher build for version ${version} of ${date}"/>
	
		<path id="classpath">
			<fileset dir="./lib">
				<include name="*.jar"/>
			</fileset>
		</path>
	
	</target>

	<!-- =================================================================== -->
	<!-- Macro for optional warnings                                    							     -->
	<!-- =================================================================== -->
	<target name="op-warning" unless="omit.opt.warnings">
		<echo>**********************************************</echo>
		<echo>*   ${fullname} builds without ${thing}.</echo>
		<!-- <echo>*  ${message}</echo> -->
		<echo>*  Recovery:</echo>
		<echo>*  ${recovery}</echo>
		<echo>***********************************************</echo>
	</target>
	
	<!-- =================================================================== -->
	<!-- Test for optional components                                    						     -->
	<!-- =================================================================== -->
  	<target name="optional-tests" depends="init">
		<available property="fop.present" classname="org.apache.fop.apps.Driver">
			<classpath refid="classpath"/>
		</available>
		
		<available property="jfor.present" classname="org.jfor.jfor.converter.Converter">
			<classpath refid="classpath"/>
		</available>
		
		<available property="tidy.present" classname="org.w3c.tidy.Tidy">
			<classpath refid="classpath"/>
		</available>
		
		<available property="mail.present" classname="javax.mail.Session">
			<classpath refid="classpath"/>
		</available>
		
	</target>
  
	<!-- =================================================================== -->
	<!-- Warnings                                                            							     -->
	<!-- =================================================================== -->

	<!-- Outputs a warning if org.apache.fop.* classes are missing during compilation -->
	<target name="fop-warn" unless="fop.present" depends="optional-tests">
		<antcall target="op-warning">
			<param name="thing" value="FOP"/>
			<param name="recovery" 
				value="Get FOP from http://xml.apache.org/fop/ and place the jar in the lib/ dir"/>
				<param name="message"
					value="FOP is required for the pdf and ps serializer."/>
		</antcall>
	</target>
	
	<!-- Outputs a warning if org.jfor.jfor.* classes are missing during compilation -->
	<target name="jfor-warn" unless="jfor.present" depends="optional-tests">
		<antcall target="op-warning">
			<param name="thing" value="JFOR"/>
			<param name="recovery" 
				value="Get the JFOR package from http://www.jfor.org/ and place the jar in the lib/ dir"/>
			<param name="message"
				value="JFOR is required for the rtf serializer."/>
			</antcall>
	</target>
	
	<!-- Outputs a warning if org.w3c.tidy.* classes are missing during compilation -->
	<target name="tidy-warn" unless="tidy.present" depends="optional-tests">
		<antcall target="op-warning">
			<param name="thing" value="JTidy"/>
			<param name="recovery" 
				value="Get JTidy from http://sourceforge.net/projects/jtidy/ and place the jar in the lib/ dir"/>
			<param name="message"
				value="JTidy is required for the html generator."/>
		</antcall>
	</target>
	
	<!-- Outputs a warning if javax.mail.* classes are missing during compilation -->
	<target name="mail-warn" unless="mail.present" depends="optional-tests">
		<antcall target="op-warning">
			<param name="thing" value="mail"/>
			<param name="recovery" 
				value="Get mail from http://java.sun.com/products/javamail/ and place the jar in the lib/ dir"/>
			<param name="message"
				value="mail is required for the vcs generator and serializer."/>
		</antcall>
	</target>
  
	<!-- =================================================================== -->
	<!-- Print out warnings for optional components                          -->
	<!-- =================================================================== -->
	<target name="optional-warnings" 
		depends="fop-warn, tidy-warn,jfor-warn,mail-warn">
	</target>
	
	
	<!-- tested -->
  <target name="compile" depends="init,optional-tests, optional-warnings">
    <echo message="Compiling..."/>
    <javac  srcdir="src" destdir="classes">
      <classpath refid="classpath"/>
      <exclude name="**/PDF*" unless="fop.present"/>
      <exclude name="**/tidy*" unless="tidy.present"/>
      <exclude name="**/RTF*" unless="jfor.present"/>
      <exclude name="**/*vcs*" unless="mail.present"/>
    </javac>
  </target>

  <target name="compileall" depends="init">
    <echo message="Erasing..."/>
    <delete>
      <fileset dir="classes" includes="**/*.class"/>
    </delete>
    <antcall target="compile"/>
  </target>

  <!-- tested -->
  <target name="jar" depends="compile">
    <echo message="Jarchiving..."/>
    <copy file="distrib/LICENSE.TXT" tofile="classes/LICENSE.TXT" filtering="true"/>
    <delete file="lib/transmo.jar"/>
    <jar jarfile="lib/transmo.jar" manifest="scripts/MANIFEST.MF">
      <fileset dir="classes" includes="**/*.class"/>
      <fileset dir="resources" includes="*.properties"/>
    </jar>
  </target>

  <!-- untested: should depend on compile -->
  <target name="updatetests" depends="init">
    <echo message="Building test directory..."/>
   <javadoc
        sourcepath="src" destdir="tests"
        packagenames="fr.fluxmedia.*"
        defaultexcludes="yes"
        doclet="com.objectfab.tools.junitdoclet.JUnitDoclet"
        docletpathref="classpath"
        additionalparam="-d ../tests -buildall"
        >
     <classpath refid="classpath"/>
   </javadoc>
  </target>

<!-- tested -->
  <!-- For graphic test, just do:
   $ setenv CLASSPATH transmo.jar:xalan.jar:xerces.jar:xml-apis.jar:junit.jar:gnu-regexp.jar
   $ java junit.swingui.TestRunner &
  -->

  <target name="test" depends="init">
    <echo message="Testing..."/>
    <javac srcdir="tests/fr/fluxmedia/transmorpher/Graph/Rules"
    debug="on" destdir="classes">
     <classpath refid="classpath"/>
    </javac>
    <javac srcdir="tests/fr/fluxmedia/" debug="on" destdir="classes">
     <classpath refid="classpath"/>
     <include name="AllTests.*"/>
     <include name="transmorpher/Graph/TransmorpherTest.*"/>
		 <include name="transmorpher/Graph/GraphSuite.*"/>
     <include name="transmorpher/Utils/mVersionTest.*"/>
     <include name="transmorpher/Utils/ParametersTest.*"/>
     <include name="transmorpher/Utils/FifoTest.*"/>
     <include name="transmorpher/Utils/UtilsSuite.*"/>
		 <include name="transmorpher/stdlib/ReadfileTest.*"/>
		 <include name="transmorpher/stdlib/BroadcastTest.*"/>
		 <include name="transmorpher/stdlib/ConcatTest.*"/>
		 <include name="transmorpher/stdlib/IntegerIteratorTest.*"/>
		 <include name="transmorpher/stdlib/FileIteratorTest.*"/>
		 <include name="transmorpher/stdlib/FixpointIteratorTest.*"/>
		 <include name="transmorpher/stdlib/TestingDispatcherTest.*"/> 
		 <include name="transmorpher/stdlib/XsltTest.*"/>
		 <include name="transmorpher/stdlib/WritefileTest.*"/>
		 <include name="transmorpher/stdlib/StdoutTest.*"/>
		 <include name="transmorpher/stdlib/StdlibSuite.*"/>
		 <include name="transmorpher/TProcessFactory/ContentHandlerInfoTest.*"/>
		 <include name="transmorpher/TProcessFactory/XML_PortTest.*"/>		 
		 <include name="transmorpher/TProcessFactory/TProcessFactorySuite.*"/>
	
    </javac>
    <antcall target="jar"/>
    <junit printsummary="no" fork="yes" haltonfailure="no">
      <test name="fr.fluxmedia.AllTests">
      <formatter type="brief" usefile="false"/>
	</test>
      <classpath refid="classpath"/>
    </junit>
  </target>

  <target name="ttask" depends="init">
  	<taskdef name="transmorph" classname="fr.fluxmedia.transmorpher.Application.TransmorphTask"
	classpath="./lib/transmo.jar"/>

    <echo message="Transmorphing..."/>
    <transmorph debug="2" mode="run" srcfile="../JAVA/transmorpher/samples//biblio/process.xml" message="Yurk">
      <param name="myParam" select="value"/>
      <param name="myParam">value</param>
    </transmorph>
  </target>

  <!-- tested -->
  <target name="javadoc">
   <echo message="Javadocing..."/>
   <javadoc
        sourcepath="src" destdir="api"
        packagenames="fr.fluxmedia.transmorpher.*"
        group="Transmorpher 'fr.fluxmedia.transmorpher.*'"
        Use="true" Splitindex="true" private="true"
        Windowtitle="Transmorpher 1.0 API"
        Doctitle="transmorpher" Header="INRIA &amp; FluxMedia"
        bottom="..no bottom yet..."
        >
      <!--link href="http://www.inrialpes.fr/exmo/local/doc/jdk1.3-doc/api"/>
      <link href="http://www.inrialpes.fr/exmo/local/doc/xerces-doc/apiDocs"/>
      <link href="http://www.inrialpes.fr/exmo/local/doc/xalan-doc/apidocs"/>
      <link href="http://www.inrialpes.fr/exmo/local/doc/SAX2-doc/javadoc"/-->
    </javadoc>
  </target>

  <!-- tested -->
  <target name="update">
    <cvs command="update -d" cvsRoot=":ext:${login}@fluxlog1.inrialpes.fr:/home/fluxlog/transmorpher"/>
  </target>

  <target name="commit">
    <!-- //here the option should not be -d -->
    <cvs command="commit -d" cvsRoot=":ext:${login}@fluxlog1.inrialpes.fr:/home/fluxlog/transmorpher"/>
  </target>

  <!-- tested -->
  <target name="prepare" depends="init">
    <echo message="Preparing release... assume that all is updated and test have been run"/>
    <copy file="src/fr/fluxmedia/transmorpher/Utils/Version.java" tofile="Version.java"/>
    <copy file="Version.java"
	  tofile="src/fr/fluxmedia/transmorpher/Utils/Version.java"
	  filtering="true" overwrite="true"/>
    <!-- This force recompiling of these dependent files -->
    <delete file="classes/fr/fluxmedia/transmorpher/Application/CommandLineArgument.class"/>
    <delete file="classes/fr/fluxmedia/transmorpher/Graph/MainProcess.class"/>
    <!-- depends on compile -->
    <antcall target="jar"/>
    <antcall target="javadoc"/>
    <move file="Version.java"
	  tofile="src/fr/fluxmedia/transmorpher/Utils/Version.java" 
	  overwrite="true"/>
    <touch file="src/fr/fluxmedia/transmorpher/Utils/Version.java"/>
    <delete file="classes/fr/fluxmedia/transmorpher/Application/CommandLineArgument.class"/>
    <delete file="classes/fr/fluxmedia/transmorpher/Graph/MainProcess.class"/>
  </target>
    
  <target name="mark" depends="prepare">
    <cvs command="rtag -R v${version} transmorpher" cvsRoot=":ext:${login}@fluxlog1.inrialpes.fr:/home/fluxlog/transmorpher"/>
  </target>

  <!-- tested -->
  <target name="image" depends="init">
    <!-- depends on compil -->
    <antcall target="mark"/>
    <mkdir dir="transmo-${version}"/>
    <copy todir="transmo-${version}/resources">
      <fileset dir="resources" includes="**/*.properties"/>
    </copy>
    <copy todir="transmo-${version}/scripts">
      <fileset dir="scripts" includes="**/build.xml,**/*.MF"/>
    </copy>
    <copy todir="transmo-${version}/src">
      <fileset dir="src" includes="**/*.java"/>
    </copy>
    <copy todir="transmo-${version}/classes">
      <fileset dir="classes" includes="**/*.class"/>
    </copy>
    <copy todir="transmo-${version}/tests">
      <fileset dir="tests" includes="**/*.java"/>
    </copy>
    <copy todir="transmo-${version}/api">
      <fileset dir="api" includes="**/*.html"/>
    </copy>
    <copy todir="transmo-${version}/docs">
      <fileset dir="docs" includes="**/*.html,**/*.gif,**/*.txt,**/*.jpg"/>
    </copy>
    <copy filtering="true" overwrite="true"
	  file="distrib/preindex.html"
	  tofile="distrib/index.html"/>
    <copy todir="transmo-${version}/distrib">
      <fileset dir="distrib" includes="**/*.TXT,**/*.html,**/*.htm"/>
    </copy>
    <copy todir="transmo-${version}/lib">
      <fileset dir="lib" includes="**/transmo.jar"/>
    </copy>
    <copy todir="transmo-${version}/samples">
      <fileset dir="samples" includes="**/*.dtd,**/*.TXT,**/*.xsd,**/*.xml,**/*.css,**/*.xsl,**/*.jpg,**/*.html,**/output,**/results,**/resulst,**/classes"/>
    </copy>
    <copy todir="transmo-${version}/refman">
      <fileset dir="refman" includes="**/*.html,**/*.gif,**/*.jpg,**/*.png"/>
    </copy>
    <copy todir="transmo-${version}/dtd">
      <fileset dir="dtd" includes="**/*.dtd,**/*.xsd,**/index.html"/>
    </copy>
    <copy todir="transmo-${version}" filtering="true">
      <fileset dir="distrib" includes="LICENSE.TXT,README.TXT"/>
    </copy>
  </target>
    
  <!-- tested -->
  <target name="extrajar" depends="init">
    <zip zipfile="../releases/transmo-extra.zip">
      <fileset dir="lib">
        <include name="xml-apis.jar"/>
        <include name="xercesImpl.jar"/>
        <include name="xalan.jar"/>
        <include name="Apache-SL-1.1.txt"/>
        <include name="gnu-regexp.jar"/>
        <include name="GNU-LGPL-2.1.txt"/>
        <include name="LICENCE.txt"/>
      </fileset>
    </zip>
  </target>

  <!-- tested -->
  <target name="cdrom" depends="init">
    <echo message="CDROM building... works only on barbara"/>
    <!-- build the hierarchy -->
    <mkdir dir="cdrom"/>
    <mkdir dir="cdrom/projs"/>
    <mkdir dir="cdrom/projs/exmo"/>
    <mkdir dir="cdrom/www"/>
    <mkdir dir="cdrom/ftp"/>
    <mkdir dir="cdrom/ftp/transmo"/>
    <mkdir dir="cdrom/prog"/>
    <mkdir dir="cdrom/prog/pc"/>
    <mkdir dir="cdrom/prog/pc/transmo"/>
    <mkdir dir="cdrom/prog/mac"/>
    <mkdir dir="cdrom/prog/mac/transmo"/>
    <mkdir dir="cdrom/prog/unix"/>
    <mkdir dir="cdrom/prog/unix/transmo"/>
    <!-- copy the release -->
    <copy todir="cdrom/ftp/transmo/">
      <fileset dir="../releases" includes="transmo-${version}.zip"/>
    </copy>
    <!-- copy the FREELY DISTRIBUTABLE adds-on -->
    <zip zipfile="cdrom/ftp/transmo/transmo-xml.zip" update="true">
      <fileset dir="lib">
        <include name="xml-apis.jar"/>
        <include name="xercesImpl.jar"/>
        <include name="xalan.jar"/>
        <include name="Apache-SL-1.1.txt"/>
	<!-- ant.jar, bsf.jar, jakarta-ant-1.4-optional.jar, junit.jar -->
        <include name="LICENCE.txt"/>
      </fileset>
    </zip>
    <!-- copy the reference manual -->
    <copy todir="cdrom/www/transmo">
      <fileset dir="refman" includes="**/*.html,**/*.gif,**/*.jpg,**/*.png"/>
    </copy>
    <!-- copy the special purpose HTML pages --> 
    <copy file="cdrom/www/transmo/index.html"
	  tofile="cdrom/www/transmo/fra.htm" filtering="true"/> 
    <copy file="cdrom/www/transmo/index.html"
	  tofile="cdrom/www/transmo/eng.htm" filtering="true"/> 
    <copy file="distrib/transmo-fra.htm"
	  tofile="cdrom/prog/pc/transmo/fra.htm" filtering="true"/> 
    <copy file="distrib/transmo-eng.htm"
	  tofile="cdrom/prog/pc/transmo/eng.htm" filtering="true"/> 
    <copy file="distrib/transmo-fra.htm"
	  tofile="cdrom/prog/mac/transmo/fra.htm" filtering="true"/> 
    <copy file="distrib/transmo-eng.htm"
	  tofile="cdrom/prog/mac/transmo/eng.htm" filtering="true"/> 
    <copy file="distrib/transmo-fra.htm"
	  tofile="cdrom/prog/unix/transmo/fra.htm" filtering="true"/> 
    <copy file="distrib/transmo-eng.htm"
	  tofile="cdrom/prog/unix/transmo/eng.htm" filtering="true"/>
    <copy file="distrib/exmo-fra.htm" tofile="cdrom/projs/exmo/fra.htm"
	  filtering="true"/> 
    <copy file="distrib/exmo-eng.htm"
	  tofile="cdrom/projs/exmo/eng.htm" filtering="true"/>
    <!-- set the right for reading --> 
    <chmod perm="a+rx" dir="cdrom" includes="**/*"/>
    <!-- package an deliver --> 
    <tar tarfile="cdrom.tar" basedir="cdrom"/> 
    <gzip src="cdrom.tar" zipfile="cdrom.tar.gz" /> 
    <delete file="cdrom.tar"/>
    <!-- delete the directory, move the file --> 
    <echo message="You must do: $ cd ..; mv cdrom.tar.gz /ftpexmo/tmp/; rm -rf cdrom"/>
  </target>

  <!-- tested -->
  <target name="package" depends="image">
    <exec dir="transmo-${version}" executable="ls" os="Linux" output="transmo-${version}/FILES.TXT">
        <arg line="-FRB1"/>
    </exec>
    <zip zipfile="../releases/transmo-${version}.zip" basedir="transmo-${version}"/>
    <tar tarfile="transmo-${version}.tar" basedir="transmo-${version}"/>
    <gzip src="transmo-${version}.tar" zipfile="../releases/transmo-${version}.tar.gz" />
    <delete file="transmo-${version}.tar"/>
  </target>

  <!-- tested -->
  <target name="release" depends="init">
    <record name="../releases/transmo-${version}.log" action="start" />
    <antcall target="package"/>
    <antcall target="extrajar"/>
    <echo message="Exposing..."/>
    <copy file="refman/depend.html" tofile="refman/cdepend.html"/>
    <replace file="refman/cdepend.html">
        <replacetoken><![CDATA[<!-- last release mark: do not modify -->]]></replacetoken>
        <replacevalue><![CDATA[<!-- last release mark: do not modify -->
<TR><TD>@DATE@</TD><TD><A HREF="../releases/transmo-@VERS@.zip">@VERS@</A></TD>
<TD>1.3</TD><TD>Xerces 2.1</TD><TD>Xalan 2.4</TD><TD>1.1.3</TD><TD>4.0.4</TD></TR>]]></replacevalue>
      </replace>
    <move file="refman/cdepend.html" tofile="refman/depend.html" filtering="true"/>
    <antcall target="clean"/>
    <!-- //unfortunately the file is not closed so it is impossible to put it in the mail -->
    <mail from="${email}" tolist="transmorpher-dev@inrialpes.fr"
          subject="Transmorpher Release ${version} of ${date}"
    message="Logfile at http://transmorpher.inrialpes.fr/releases/transmo-${version}.log"/>
    <record name="../releases/transmo-${version}.log" action="stop" />
  </target>

  <target name="tidy">
    <echo message="Cleaning all useless files..."/>
    <delete>
      <fileset dir="." includes="**/*~,**/#*#,**/*.BAK"/>
    </delete>
  </target>

  <target name="clean">
    <echo message="Cleaning..."/>
    <delete dir="transmo-${version}"/>
  </target>

</project>