source: plugins/base2/net.sf.basedb.normalizers/trunk/build.xml @ 1219

<?xml version="1.0" encoding="UTF-8"?>
<!--
    $Id: build.xml 1219 2010-03-30 12:00:55Z jari $

    Copyright (C) 2008 Martin Svensson
    Copyright (C) 2009 Jari Häkkinen, Martin Svensson
    Copyright (C) 2010 Jari Häkkinen

    This file is part of the Normalizers plug-in package for BASE
    (net.sf.based.normalizers). The package is available at
    http://baseplugins.thep.lu.se/ BASE main site is
    http://base.thep.lu.se/

    This is free software; you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    The software 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 for more details.

    You should have received a copy of the GNU General Public License
    along with this program. If not, see <http://www.gnu.org/licenses/>.
-->
  
<project   
  name="NormalizationPlugins"   
  default="dist"   
  basedir="."  
  >  
  <description>
    Build file for the Normalizers plug-in package for BASE. The main
    targets are ('dist' is default):

    Clean up:
    clean         Remove generated files
    distclean     Remove all generated and downloaded files

    Compiling:
    build         Build all Java code
    c++           Build all C++ code in directory src/c++
    dist          Build all Java code for distribution (put in 'dist'
                  subdirectory)
    download-lib  Download required external dependecy files
    
    Packaging:
    package:      Create *.tar.gz file containing required jars and
                  source tar.gz files for non-Java source files.
  </description>
   
  <!--create this file if you need to override values from properties below -->
  <property file="build.properties" />

  <!-- variables used -->  
  <property name="name" value="normalization-plugins" />  
  <property name="src" value="src" />
  <property name="build" value="build" description="Location of build class files"/>  
  <property name="dist" value="dist" description="Location where jar-file are created"/>
  <property name="jar" value="${name}.jar" description="Name of the jar file"/>
  <property name="package" location="package" description="Directory where packaged distribution files are created"/>
  <property name="javac.arg" value="-Xlint:unchecked" />
  <property name="javac.source" value="1.5" />
  <property name="javac.target" value="1.5" />
  <property name="javac.encoding" value="UTF-8" />

  <property name="depend.BASEjars" 
    value="http://base2.thep.lu.se/base/jars/2.15.0" 
    description="The location of the BASE core JARs that we depend on"
  />
  <property name="depend.PluginUtilityLocation" 
    value="http://baseplugins.thep.lu.se/attachment/wiki/net.sf.basedb.pluginutilties" 
    description="The location of the PluginUtility JAR that we depend on"
  />
  <property name="PluginUtilityVersion" value="0.2" 
    description="The version of PluginUtility that we depend on"
  />
  <property name="PluginUtilitiesBase"
            value="PluginUtilities-${PluginUtilityVersion}" />
  
  <!-- Package variables to be used in normalizers.properties file -->
  <property name="version" value="1.1pre" description="Version number of the package" />
  <property name="url" value="http://baseplugins.thep.lu.se/wiki/net.sf.basedb.normalizers" 
    description="The url to this plug-in's web-page" />
  <property name="copyright" value="2009 The BASE 2 development team" description="Copyright text" />
  <property name="email" value="basedb-users@lists.sourceforge.net" description="Email address to get in contact with the developer" />
  
  <!-- set up classpath for compiling -->
  <path id="classpath">
    <fileset dir="lib">
      <include name="**/*.jar"/>
    </fileset>
  </path>

  <target name="init">
    <mkdir dir="${build}" />
    <mkdir dir="${dist}" />
  </target>
    
  <target name="clean">
    <delete failonerror="false" includeemptydirs="true">
      <fileset dir="${build}" defaultexcludes="no" />
      <fileset dir="${dist}" defaultexcludes="no" />
      <fileset dir="${package}" defaultexcludes="no" />
    </delete>
  </target>

  <target
    name="distclean"
    depends="clean">
    <delete failonerror="false" includeemptydirs="true">
      <fileset dir="lib/${PluginUtilitiesBase}" defaultexcludes="no" />
      <fileset file="lib/${PluginUtilitiesBase}.tgz" />
      <fileset dir="lib/compile" defaultexcludes="no">
        <include name="*.jar" />
      </fileset>
    </delete>
  </target>

  <!-- main target -->
  <target
    name="dist"
    depends="clean,build,manifest"
    >
    <jar
      jarfile="${dist}/${jar}"
      basedir="${build}"
      manifest="${build}/META-INF/MANIFEST.MF"
    />
    <copy todir="${dist}">
      <fileset dir="." includes="README*,license.txt,INSTALL" />
    </copy> 
    <copy file="lib/${PluginUtilitiesBase}/${PluginUtilitiesBase}.jar"
          tofile="${dist}/PluginUtilities.jar" />
  </target> 

  <target
    name="manifest"
    description="Create MANIFEST.MF needed to set class path"
    >
    <manifest file="${build}/META-INF/MANIFEST.MF">
      <attribute name="Built-By" value="${user.name}"/>
      <attribute name="Class-Path" value="PluginUtilities.jar"/>
    </manifest>
  </target>

  <target
    name="package"
    depends="dist, package-qQuantileSource"
    description="Create binary distribution package"
    >
    <property name="tar.prefix" value="${name}-${version}" />
    <mkdir dir="${package}" />
    <tar
      destfile="${package}/${tar.prefix}.tar.gz"
      longfile="gnu"
      compression="gzip"
      >
      <tarfileset
        dir="${dist}"
        mode="755"
        prefix="${tar.prefix}"
        preserveLeadingSlashes="true"
        >
        <include name="**/*.sh" />
      </tarfileset>
      <tarfileset
        dir="${dist}"
        prefix="${tar.prefix}"
        preserveLeadingSlashes="true"
        >
        <exclude name="**/*.sh" />
      </tarfileset>
    </tar>
    <checksum file="${package}/${tar.prefix}.tar.gz" />
  </target>

  <target
     name="package-qQuantileSource"
     description="Add qQuantileNormalization C++ package to 'dist'"
     >
    <exec dir="${src}/c++/" executable="./bootstrap" />
    <replace file="${src}/c++/configure">
      <replacefilter 
         token="@PKGVERSION@"
         value="${version}"
         />
    </replace>
    <chmod file="${src}/c++/configure" perm="a+x" />
    <exec dir="${src}/c++/" executable="./configure">
      <arg line="--disable-libcheck" />
    </exec>
    <exec dir="${src}/c++/" executable="make">
      <arg line="dist" />
    </exec>
    <move file="${src}/c++/qqn-${version}.tar.gz" todir="dist" />
  </target>

  <target 
    name="build"
    depends="init, checkjar"
    description="Compiles the plugin and put in jar"
    >
    <property name="jar" value="${name}.jar" />
    <mkdir dir="${build}" />
    <javac 
      encoding="${javac.encoding}" 
      srcdir="${src}" 
      destdir="${build}" 
      debug="true" 
      classpathref="classpath"
      source="${javac.source}"
      target="${javac.target}"
      >
      <compilerarg value="${javac.arg}" />
    </javac>
    <copy todir="${build}">
      <fileset dir="." includes="META-INF/*" />
    </copy>
    <replace token="%%plugins.jar%%" value="${jar}" file="${build}/META-INF/base-plugins.xml" />

    <!-- Write package properties to normalizers.properties file -->
    <echo file="${build}/normalizers.properties">version: ${version}${line.separator}</echo>
    <echo append="true" file="${build}/normalizers.properties">url: ${url}${line.separator}</echo>
    <echo append="true" file="${build}/normalizers.properties">email: ${email}${line.separator}</echo>
    <echo append="true" file="${build}/normalizers.properties">copyright: ${copyright}${line.separator}</echo>
    
  </target>
  
  <target 
    name="checkjar"
    description="Checks that the BASE2Core.jar, BASE2CorePlugins.jar,
    and appropriate PluginUtilities jar file exists."
    >
    <available classname="net.sf.basedb.core.Application" 
      classpathref="classpath" property="base2core" />
    <available classname="net.sf.basedb.plugins.ReporterFlatFileImporter" 
      classpathref="classpath" property="base2coreplugins" />
    <available classname="net.sf.basedb.plugins.AbstractRunBinaryPlugin"
      classpathref="classpath"
      classpath="lib/${PluginUtilitiesBase}/${PluginUtilitiesBase}.jar"
      property="pluginutilities" />
    <fail unless="base2core" message="Can't find BASE2Core.jar in ./lib/compile. Try 'ant download-lib' to download the missing file." />
    <fail unless="base2coreplugins" message="Can't find BASE2CorePlugins.jar in ./lib/compile. Try 'ant download-lib' to download the missing file." />
    <fail unless="pluginutilities" message="Can't find PluginUtilities jar file ./lib. Try 'ant download-lib' to download the missing file." />
    <echo>Found BASE2Core.jar, BASE2WSClient.jar, and PluginUtilities jar file</echo>
  </target>

  <target name="c++">
    <exec dir="${src}/c++/" executable="./bootstrap" />
    <replace file="${src}/c++/configure">
      <replacefilter 
         token="@PKGVERSION@"
         value="${version}"
         />
    </replace>
    <chmod file="${src}/c++/configure" perm="a+x" />
    <exec dir="${src}/c++/" executable="./configure">
    </exec>
    <exec dir="${src}/c++/" executable="make">
    </exec>
  </target>

  <target 
    name="download-lib"
    depends="download-message, download-pluginutilities"
    description="Download BASE2Core.jar and BASE2CorePlugins.jar."
    >
    <download
      location="${depend.BASEjars}"
      file="BASE2Core.jar"
      destdir="lib/compile"
      tofile="BASE2Core.jar"
    />
    <download
      location="${depend.BASEjars}"
      file="BASE2CorePlugins.jar"
      destdir="lib/compile"
      tofile="BASE2CorePlugins.jar"
    />
  </target>
    
  <target name="download-message">
    <echo>
-------------------------------------------------------   
NOTE! You may specify a different download locations by
creating the file './build.properties' and set one or
more of the below variables

'depend.BASEjars': the URL to download BASE core jar
        files from.

'depend.PluginUtilityLocation': the URL to download
        PluginUtility jar from.
'PluginUtilityVersion': the version of PluginUtility to
        download.
-------------------------------------------------------
    </echo>
  </target>

  <target
    name="download-pluginutilities"
    description="Download PluginUtilities.jar."
    >
    <download
      location="${depend.PluginUtilityLocation}"
      file="${PluginUtilitiesBase}.tgz?format=raw"
      destdir="lib"
      tofile="${PluginUtilitiesBase}.tgz"
    />
    <untar src="lib/${PluginUtilitiesBase}.tgz" dest="lib"
           compression="gzip" />
  </target>

  <macrodef name="download" description="Download requested files">
    <attribute name="destdir" />
    <attribute name="location" />
    <attribute name="file" />
    <attribute name="tofile" />
    <sequential>
      <get 
        dest="@{destdir}/@{tofile}" 
        src="@{location}/@{file}" 
        usetimestamp="true" 
        verbose="true"
        ignoreerrors="false"
      />
    </sequential>
  </macrodef> 
  
</project>