Formatting
[jalview.git] / build.xml
index 8d93cda..0226383 100755 (executable)
--- a/build.xml
+++ b/build.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-  <project name="jalviewX" default="build" basedir=".">
+  <project name="jalviewX" default="usage" basedir=".">
 <!-- we use jalopy to format our sources -->
 <taskdef name="jalopy"
          classname="de.hunsicker.jalopy.plugin.ant.AntPlugin">
   </classpath>
 </taskdef>
 
+   <target name="help" depends="usage"/>
+   <target name="usage">
+     <echo message="~~~Jalview Ant build.xml Usage~~~~"/>
+     <echo message="Targets include:"/>
+     <echo message="usage - default target, displays this message"/>
+     <echo message="buildindices - generates JavaHelpSearch from the help files"/>
+     <echo message="build - compiles all necessary files for Application"/>
+     <echo message="makedist - compiles and places all necessary jar files into directory dist"/>
+     <echo message="makefulldist - signs all jar files and builds jnlp file for full distribution"/>
+     <echo message="              this needs a keystore and key. See docs/building.html for more information."/>
+     <echo message="compileApplet - compiles all necessary files for Applet"/>
+     <echo message="makeApplet - compiles, then packages and obfuscates the Applet"/>
+     <echo message="See docs/building.html and the comments in build file for other targets."/>
+   </target>
+
 
     <!-- utils is a class path to additional utilities needed for
     building docs, jars and webstart stuff -->
           <include name="*.jar"/>
         </fileset> -->
       </path>
-
-      <property name="JALVIEW_VERSION" value="2.01"/>
-      <property name="" value=""/>
+      <!-- Jalview Version String displayed by application on startup and used to check for updates -->
+      <property name="JALVIEW_VERSION" value="2.2"/>
+      <!-- Don't change anything below here unless you know what you are doing! -->
+      <!-- Url path for WebStart in JNLP file -->
+      <property name="WebStartLocation" value="http://www.jalview.org/webstart"/>
+      <!-- build directory configuration -->
       <property name="libDir" value="lib"/>
       <property name="resourceDir" value="resources"/>
       <property name="helpDir" value="help"/>
       <property name="outputDir" value="classes" />
       <property name="packageDir" value="dist" />
       <property name="outputJar" value="jalview.jar" />
+      <!-- Jalview Web Service Clients - see the comments in 'buildextclients' for details -->
       <property name="wsdl.File" value="http://www.compbio.dundee.ac.uk/JalviewWS/services/jpred?wsdl" />
       <property name="wsdl.Files" value="http://www.compbio.dundee.ac.uk/JalviewWS/services/vamsas?wsdlFiles" />
       <property name="wsdl.MsaWS" value="http://www.compbio.dundee.ac.uk/JalviewWS/services/MuscleWS?wsdl" />
       <property name="wsdl.MsaWS2" value="http://www.compbio.dundee.ac.uk/JalviewWS/services/ClustalWS?wsdl" />
-      <property name="wsdl.MsaWS2" value="http://www.compbio.dundee.ac.uk/JalviewWS/services/ClustalWS?wsdl" />
-        <property name="WSInterf" value="MsaWS" />
-      <property name="WebStartLocation" value="http://www.jalview.org/webstart"/>
+      <property name="WSInterf" value="MsaWS" />
       <property name="wsdl.Namespace" value="vamsas" />
       <property name="wsdl.ClientNS" value="ext.vamsas" />
-
+      <!-- the class path for building the application -->
       <path id="build.classpath">
         <fileset dir="utils">
           <include name="*.jar"/>
           <include name="*.jar"/>
           <include name="**/*.jar"/>
         </fileset>
-<!--        <fileset dir="old_lib_signed">
-<include name="lib_axis.jar"/>
-
-        </fileset>-->
       </path>
-      <!-->    <uptodate property="help.uptodate"
-      targetfile="${helpDir}/helpIndex.xml">
-      <srcfiles
-                 dir="${helpDir}"
-                 includes="**/*.html" />
-               </uptodate>
-      -->
     </target>
 
 
     <taskdef classpath="utils/roxes-ant-tasks-1.2-2004-01-30.jar" resource="com/roxes/tools/ant/taskdefs.properties"/>
     <target name="buildPropertiesFile" depends="init">
       <tstamp prefix="build">
-        <format property="date" pattern="dd MMMM yyyy hh.mm aa"/>
+        <format property="date" pattern="dd MMMM yyyy"/>
       </tstamp>
       <properties file="${outputDir}/.build_properties">
         <header>
-          ---Jalview Application Properties---
+          ---Jalview Build Details---
         </header>
         <property name="VERSION" value="${JALVIEW_VERSION}"/>
         <property name="BUILD_DATE" value="${build.date}"/>
     </java>
     </target>
 
-    <target name="makejars" depends="build, buildPropertiesFile, buildindices">
-      <!-- make the package jar -->
-      <mkdir dir="${packageDir}"/>
-
-      <jar destfile="${packageDir}/${outputJar}">
-        <fileset dir="${outputDir}/">
-          <exclude name="cache*/**"/>
-          <exclude name="*.jar" />
-          <exclude name="*.jar.*" />
-          <exclude name="**/*.jar" />
-          <exclude name="**/*.jar.*" />
-        </fileset>
-      </jar>
-
-      <copy toDir="${packageDir}" flatten="true">
-        <fileset dir="${outputDir}">
-          <include name="*.jar"/>
-          <include name="**/*.jar"/>
-        </fileset>
-      </copy>
-<!-- the default keystore details might need to be edited here -->
+    <target name="makefulldist" depends="makedist">
+ <!-- the default keystore details might need to be edited here -->
       <signjar
       storepass="alignmentisfun"
       keypass="alignmentisfun"
       <taskdef classpathref="build.classpath" resource="com/roxes/tools/ant/taskdefs.properties"/>
 
       <!--    codebase="http://www.jalview.org/jalview/webstart" -->
-      <jnlp toFile="${packageDir}/Jalview.jnlp" href="Jalview.jnlp"
+      <jnlp toFile="${packageDir}/jalview.jnlp" href="jalview.jnlp"
       codebase="${WebStartLocation}">
       <information>
         <title>Jalview</title>
         <vendor>The Barton Group</vendor>
-        <homepage href="www.jalview.org"/>
+        <homepage href="http://www.jalview.org"/>
         <description>Jalview Multiple Alignment Editor</description>
         <description kind="short">Jalview</description>
         <icon href="logo_big.gif"/>
+        <offline_allowed/>
        <!--
        <association mime-type="application-x/ext-file" extensions="fa"/>
         <association mime-type="application-x/ext-file" extensions="fasta"/>
         <resources>
           <j2se version="1.4+"/>
           <fileset dir="${packageDir}">
+            <include name="jalview.jar"/>
+          </fileset>
+          <fileset dir="${packageDir}">
             <include name="*.jar"/>
             <exclude name="jalview.jar"/>
           </fileset>
     </target>
 
     <target name="buildextclients" depends="init">
+      <input message="Building external client source from WSDLs - Do you really want to do this ? (Yy/Nn)"
+      validargs="Y,y,n,N" defaultvalue="N"
+      addproperty="doextbuild.response"/>
+      <condition property="dontextbuild">
+        <equals arg1="n" arg2="${doextbuild.response}"/>
+      </condition>
+      <condition property="dontextbuild">
+        <equals arg1="N" arg2="${doextbuild.response}"/>
+      </condition>
+      <fail if="dontextbuild">
+        Build External Client Code process aborted by user. Jalview source is unchanged.
+      </fail>
 <!-- Currently, this doesn't happen automatically.
      1. Run WSDL2Java as below, which generates an ext.vamsas +
      vamsas.<datapackages> fileset.
 
 -->
       <path id="axisbuild">
-        <!--        <path refid="axis.classpath"/> -->
         <path refid="build.classpath"/>
       </path>
       <taskdef resource="axis-tasks.properties" classpathref="axisbuild"/>
         package="${wsdl.ClientNS}"/>
         </mappingSet>
     </axis-wsdl2java>
+    </target>
 
-  </target>
-  <target name="package" depends="init, build">
+    <target name="makedist" depends="build, buildPropertiesFile, buildindices">
+      <!-- make the package jar -->
+      <mkdir dir="${packageDir}"/>
 
+      <jar destfile="${packageDir}/${outputJar}">
+        <manifest>
+             <attribute name="Main-Class" value="jalview.bin.Jalview"/>
+        </manifest>
+        <fileset dir="${outputDir}/">
+          <exclude name="cache*/**"/>
+          <exclude name="*.jar" />
+          <exclude name="*.jar.*" />
+          <exclude name="**/*.jar" />
+          <exclude name="**/*.jar.*" />
+        </fileset>
+      </jar>
+
+      <copy toDir="${packageDir}" flatten="true">
+        <fileset dir="${outputDir}">
+          <include name="*.jar"/>
+          <include name="**/*.jar"/>
+        </fileset>
+      </copy>
   </target>
+
+
   <!-- jalopy code reformatter -->
   <target name="sourcescrub" depends="init,build">
     <jalopy destdir="jsrc" classpathref="run.classpath"
        excludes="ext/**,MCview/**,org/**,vamsas/**"/>
   </target>
 
-  <target name="packageApplet" depends="compileApplet">
+  <target name="packageApplet" depends="compileApplet, buildPropertiesFile">
+  <copy file="${resourceDir}/images/idwidth.gif" toFile="${outputDir}/images/idwidth.gif"/>
+  <copy file="${resourceDir}/images/link.gif" toFile="${outputDir}/images/link.gif"/>
        <jar destfile="in.jar">
+        <manifest>
+            <attribute name="Main-Class" value="jalview.bin.JalviewLite"/>
+        </manifest>
         <fileset dir="${outputDir}">
           <include name="com/**"/>
+          <include name="MCview/**"/>
           <include name="jalview/**"/>
-          <include name="${resourceDir}/images/idwidth.gif"/>
+          <include name=".build_properties"/>
+          <include name="images/idwidth.gif"/>
+          <include name="images/link.gif"/>
         </fileset>
       </jar>
   </target>
       -injars      in.jar
       -outjars     jalviewApplet.jar
       -keep public class jalview.bin.JalviewLite
+       { public * ; }
     </proguard>
     <delete file="in.jar"/>
   </target>