3 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
4 * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
6 * This file is part of Jalview.
8 * Jalview is free software: you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 <project name="jalviewX" default="usage" basedir=".">
20 <!-- we use jalopy to format our sources -->
21 <taskdef name="jalopy" classname="de.hunsicker.jalopy.plugin.ant.AntPlugin">
23 <fileset dir="utils/jalopy/lib">
24 <include name="*.jar" />
29 <target name="help" depends="usage" />
31 <echo message="~~~Jalview Ant build.xml Usage~~~~" />
32 <echo message="Targets include:" />
33 <echo message="usage - default target, displays this message" />
34 <echo message="buildindices - generates JavaHelpSearch from the help files" />
35 <echo message="build - compiles all necessary files for Application" />
36 <echo message="makedist - compiles and places all necessary jar files into directory dist" />
37 <echo message="makefulldist - signs all jar files and builds jnlp file for full distribution" />
38 <echo message=" this needs a keystore and key. See docs/building.html for more information." />
39 <echo message="compileApplet - compiles all necessary files for Applet" />
40 <echo message="makeApplet - compiles, then packages and obfuscates the Applet" />
41 <echo message="See docs/building.html and the comments in build file for other targets." />
42 <echo message="note: compile and makeApplet require the property java118.home to be set to point to a java 1.1.8 jdk." />
43 <echo message="Useful -D flags: -Ddonotobfuscate will prevent applet obfuscation" />
47 <!-- utils is a class path to additional utilities needed for
48 building docs, jars and webstart stuff -->
50 Userdefined build property defaults
52 wsdl.server list (plus namespace mapping info ???) - also want
53 ... to make this a dynamically generatable property
55 Build location - provide a temporary root for speed
56 jarsigner keystore and info
57 Jakarta and axis classpath ?
58 Default argument for starting Jalview (if it exists).
63 <path id="axis.classpath">
65 <fileset dir="/usr/local/axis/lib">
66 <include name="**/*.jar" />
68 <fileset dir="/usr/local/jakarta-tomcat-5/webapps/axis/WEB-INF/lib">
69 <include name="**/*.jar"/>
70 <include name="*.jar"/>
73 <!-- Jalview Version String displayed by application on startup and used to check for updates -->
74 <property name="JALVIEW_VERSION" value="DEVELOPMENT" />
75 <!-- 2.4 (VAMSAS)" -->
76 <!-- Include debugging information in javac true or false -->
77 <property name="javac.debug" value="true" />
79 <!-- JarSigner Key Store for Webstart Distribution -->
80 <property name="jalview.keystore" value="./keys/.keystore" />
81 <!-- Keystore Password -->
82 <property name="jalview.keystore.pass" value="alignmentisfun" />
84 <property name="jalview.key" value="jalview" />
86 <property name="jalview.key.pass" value="alignmentisfun" />
88 <!-- Don't change anything below here unless you know what you are doing! -->
89 <!-- Url path for WebStart in JNLP file -->
90 <property name="WebStartLocation" value="http://www.jalview.org/webstart" />
91 <!-- build directory configuration -->
92 <property name="libDir" value="lib" />
93 <property name="resourceDir" value="resources" />
94 <property name="helpDir" value="help" />
95 <property name="docDir" value="doc" />
96 <property name="sourceDir" value="src" />
97 <property name="schemaDir" value="schemas" />
98 <property name="outputDir" value="classes" />
99 <property name="packageDir" value="dist" />
100 <property name="outputJar" value="jalview.jar" />
101 <!-- Jalview Applet JMol Jar Dependency -->
102 <property name="jmolJar" value="JmolApplet-12.1.13.jar" />
103 <property name="jalviewLiteJar" value="jalviewApplet.jar" />
104 <!-- switch to indicate if we should obfuscate jalviewLite -->
105 <!--<property name="donotobfuscate" value="true"/> -->
107 <!-- Jalview Web Service Clients - see the comments in 'buildextclients' for details -->
108 <property name="wsdl.File" value="http://www.compbio.dundee.ac.uk/JalviewWS/services/jpred?wsdl" />
109 <property name="wsdl.Files" value="http://www.compbio.dundee.ac.uk/JalviewWS/services/vamsas?wsdlFiles" />
110 <property name="wsdl.MsaWS" value="http://www.compbio.dundee.ac.uk/JalviewWS/services/MuscleWS?wsdl" />
111 <property name="wsdl.MsaWS2" value="http://www.compbio.dundee.ac.uk/JalviewWS/services/ClustalWS?wsdl" />
112 <property name="WSInterf" value="MsaWS" />
113 <property name="wsdl.Namespace" value="vamsas" />
114 <property name="wsdl.ClientNS" value="ext.vamsas" />
115 <!-- the class path for building the application -->
116 <path id="build.classpath">
117 <fileset dir="utils">
118 <include name="*.jar" />
119 <include name="**/*.jar" />
121 <fileset dir="${libDir}">
122 <include name="*.jar" />
123 <include name="**/*.jar" />
125 <fileset dir="${java.home}/lib">
126 <include name="plugin.jar"/>
128 <fileset dir="appletlib">
129 <!-- the JmolApplet includes the JmolApplet console and the application javac seems to always try and build all packages
131 <include name="${jmolJar}" />
135 <property name="source.dist.name" value="${basedir}/jalview-src.tar.gz" />
136 <!-- The Location of the java 1.1.8 jdk -->
137 <!--<property name="java118.home" value="C:\Sun\jdk1.1.8" />
139 <property name="java118.home" value="${java.home}" />
140 <!--<property name="applet.jre.tools" value="${java118.home}/lib/classes.zip" />
141 --><!-- jre for 1.4 version -->
142 <property name="applet.jre.tools" value="${java.home}/lib/rt.jar"/>
144 <!-- the classpath for building the 1.1 applet -->
145 <path id="jalviewlite.deps">
146 <fileset dir="${java118.home}">
147 <include name="lib/classes.zip" />
149 <fileset dir="${java.home}/lib">
150 <include name="plugin.jar"/>
152 <pathelement location="appletlib/${jmolJar}" />
154 <!-- default location for outputting javadoc -->
155 <property name="javadocDir" value="${packageDir}/javadoc"/>
159 <taskdef classpath="utils/roxes-ant-tasks-1.2-2004-01-30.jar" resource="com/roxes/tools/ant/taskdefs.properties" />
160 <target name="buildPropertiesFile" depends="init">
161 <tstamp prefix="build">
162 <format property="date" pattern="dd MMMM yyyy" />
164 <properties file="${outputDir}/.build_properties">
166 ---Jalview Build Details---
168 <property name="VERSION" value="${JALVIEW_VERSION}" />
169 <property name="BUILD_DATE" value="${build.date}" />
174 <target name="clean" depends="init">
175 <!-- not efficient yet. -->
176 <delete dir="${outputDir}" includes="*,**/*"/>
179 <target name="distclean" depends="init, clean">
181 <echo message="REMOVING ALL BACKUP/AUTOSAVES!" />
184 <include name="${outputJar}" />
185 <include name="#*#" />
186 <include name="#*.*#" />
187 <include name="**/#*#" />
188 <include name="**/#*.*#" />
189 <include name="*~" />
190 <include name="*.*~" />
191 <include name="**/*~" />
192 <include name="**/*.*~" />
197 <target name="prepare" depends="init">
198 <mkdir dir="${outputDir}" />
199 <copy todir="${outputDir}">
201 <include name="${docDir}/**/*.*" />
202 <include name="${helpDir}/**/*.*" />
203 <include name="${libDir}/*.jar" />
205 <fileset dir="${resourceDir}">
206 <include name="**/*.*" />
211 <target name="build" depends="prepare">
212 <!-- not efficient yet. -->
213 <javac source="1.5" target="1.5" srcdir="${sourceDir}" destdir="${outputDir}" debug="${javac.debug}" classpathref="build.classpath">
214 <exclude name="jalview/*applet*" />
215 <exclude name="jalview/appletgui/**" />
216 <exclude name="com/stevesoft/**" />
219 <target name="buildindices" depends="init, prepare" unless="help.uptodate">
220 <java classname="com.sun.java.help.search.Indexer" classpathref="build.classpath" fork="true" dir="${outputDir}/${helpDir}">
225 <target name="makefulldist" depends="makedist">
226 <!-- the default keystore details might need to be edited here -->
227 <signjar storepass="${jalview.keystore.pass}" keypass="${jalview.key.pass}" keystore="${jalview.keystore}" alias="${jalview.key}" lazy="false" verbose="false">
229 <fileset dir="${packageDir}">
230 <include name="*.jar" />
233 <taskdef classpathref="build.classpath" resource="com/roxes/tools/ant/taskdefs.properties" />
235 <!-- codebase="http://www.jalview.org/jalview/webstart" -->
236 <!-- href="jalview.jnlp" prevent hard-wired pickup of jnlp in certain javaws versions -->
237 <jnlp toFile="${packageDir}/jalview.jnlp" codebase="${WebStartLocation}">
239 <title>Jalview</title>
240 <vendor>The Barton Group</vendor>
241 <homepage href="http://www.jalview.org" />
242 <description>Jalview Multiple Alignment Editor</description>
243 <description kind="short">Jalview</description>
244 <icon href="logo_big.gif" />
247 <association mime-type="application-x/ext-file" extensions="fa"/>
248 <association mime-type="application-x/ext-file" extensions="fasta"/>
249 <association mime-type="application-x/ext-file" extensions="fastq"/>
250 <association mime-type="application-x/ext-file" extensions="blc"/>
251 <association mime-type="application-x/ext-file" extensions="msf"/>
252 <association mime-type="application-x/ext-file" extensions="pfam"/>
253 <association mime-type="application-x/ext-file" extensions="aln"/>
254 <association mime-type="application-x/ext-file" extensions="pir"/>
255 <association mime-type="application-x/ext-file" extensions="amsa"/>
259 <j2se version="1.5+" initial_heap_size="10M" />
260 <fileset dir="${packageDir}">
261 <include name="jalview.jar" />
263 <fileset dir="${packageDir}">
264 <include name="*.jar" />
265 <include name="*_*.jar" />
266 <exclude name="jalview.jar" />
268 <property name="jalview.version" value="${JALVIEW_VERSION}" />
270 <application_desc main_class="jalview.bin.Jalview">
276 <!-- the rest of these jnlp tasks are copy and pastes of the above but with different Vm args -->
277 <jnlp toFile="${packageDir}/jalview_1G.jnlp" codebase="${WebStartLocation}">
279 <title>Jalview</title>
280 <vendor>The Barton Group</vendor>
281 <homepage href="http://www.jalview.org" />
282 <description>Jalview Multiple Alignment Editor</description>
283 <description kind="short">Jalview</description>
284 <icon href="logo_big.gif" />
287 <association mime-type="application-x/ext-file" extensions="fa"/>
288 <association mime-type="application-x/ext-file" extensions="fasta"/>
289 <association mime-type="application-x/ext-file" extensions="fastq"/>
290 <association mime-type="application-x/ext-file" extensions="blc"/>
291 <association mime-type="application-x/ext-file" extensions="msf"/>
292 <association mime-type="application-x/ext-file" extensions="pfam"/>
293 <association mime-type="application-x/ext-file" extensions="aln"/>
294 <association mime-type="application-x/ext-file" extensions="pir"/>
295 <association mime-type="application-x/ext-file" extensions="amsa"/>
299 <j2se version="1.5+" initial_heap_size="64M" max_heap_size="512M" />
300 <fileset dir="${packageDir}">
301 <include name="jalview.jar" />
303 <fileset dir="${packageDir}">
304 <include name="*.jar" />
305 <include name="*_*.jar" />
306 <exclude name="jalview.jar" />
308 <property name="jalview.version" value="${JALVIEW_VERSION}" />
310 <application_desc main_class="jalview.bin.Jalview">
316 <jnlp toFile="${packageDir}/jalview_2G.jnlp" codebase="${WebStartLocation}">
318 <title>Jalview</title>
319 <vendor>The Barton Group</vendor>
320 <homepage href="http://www.jalview.org" />
321 <description>Jalview Multiple Alignment Editor</description>
322 <description kind="short">Jalview</description>
323 <icon href="logo_big.gif" />
326 <association mime-type="application-x/ext-file" extensions="fa"/>
327 <association mime-type="application-x/ext-file" extensions="fasta"/>
328 <association mime-type="application-x/ext-file" extensions="fastq"/>
329 <association mime-type="application-x/ext-file" extensions="blc"/>
330 <association mime-type="application-x/ext-file" extensions="msf"/>
331 <association mime-type="application-x/ext-file" extensions="pfam"/>
332 <association mime-type="application-x/ext-file" extensions="aln"/>
333 <association mime-type="application-x/ext-file" extensions="pir"/>
334 <association mime-type="application-x/ext-file" extensions="amsa"/>
338 <j2se version="1.5+" initial_heap_size="256M" max_heap_size="1024M" />
339 <fileset dir="${packageDir}">
340 <include name="jalview.jar" />
342 <fileset dir="${packageDir}">
343 <include name="*.jar" />
344 <include name="*_*.jar" />
345 <exclude name="jalview.jar" />
347 <property name="jalview.version" value="${JALVIEW_VERSION}" />
349 <application_desc main_class="jalview.bin.Jalview">
358 <target name="runenv" depends="init">
359 <path id="run.classpath">
360 <pathelement location="${outputDir}" />
361 <fileset dir="${outputDir}">
362 <include name="${libDir}/*.jar" />
365 <pathconvert targetos="unix" refid="run.classpath" property="run.classpath" />
367 <echo>java -classpath ${run.classpath} jalview.bin.Jalview
371 <target name="buildextclients" depends="init">
372 <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" />
373 <condition property="dontextbuild">
374 <equals arg1="n" arg2="${doextbuild.response}" />
376 <condition property="dontextbuild">
377 <equals arg1="N" arg2="${doextbuild.response}" />
379 <fail if="dontextbuild">
380 Build External Client Code process aborted by user. Jalview source is unchanged.
382 <!-- Currently, this doesn't happen automatically.
383 1. Run WSDL2Java as below, which generates an ext.vamsas +
384 vamsas.<datapackages> fileset.
385 2. refactor ext.vamsas.SpecificserviceWS* to
386 ext.vamsas.ServiceclassWS* that implements the ServiceclassWSI interface.
387 3. Update the jalview.ws.*WServices classes to reflect the
388 interface type, and all locations of this wsdl type that Jalview
392 <path id="axisbuild">
393 <path refid="build.classpath" />
395 <taskdef resource="axis-tasks.properties" classpathref="axisbuild" />
397 <fileset dir="${sourceDir}" id="client">
398 <include name="${wsdl.ClientNS}/*.*" />
402 <axis-wsdl2java output="${sourceDir}" verbose="true" url="${wsdl.MsaWS2}" serverside="false" deployscope="Request" debug="false" helpergen="true" all="true">
404 <mapping namespace="${wsdl.Namespace}" package="${wsdl.ClientNS}" />
405 <mapping namespace="http://dataTypes.vamsas" package="${wsdl.ClientNS}" />
410 <target name="makedist" depends="build, buildPropertiesFile, buildindices">
411 <!-- make the package jar if not already existing -->
412 <mkdir dir="${packageDir}" />
413 <!-- clean dir if it already existed -->
415 <fileset dir="${packageDir}">
416 <include name="*.jar"/>
419 <jar destfile="${packageDir}/${outputJar}">
421 <attribute name="Main-Class" value="jalview.bin.Jalview" />
423 <fileset dir="${outputDir}/">
424 <exclude name="cache*/**" />
425 <exclude name="*.jar" />
426 <exclude name="*.jar.*" />
427 <exclude name="**/*.jar" />
428 <exclude name="**/*.jar.*" />
432 <copy toDir="${packageDir}" flatten="true">
433 <fileset dir="${outputDir}">
434 <include name="*.jar" />
435 <include name="**/*.jar" />
441 <!-- jalopy code reformatter -->
442 <target name="sourcescrub" depends="init,build">
443 <jalopy destdir="jsrc" classpathref="run.classpath" convention="jalview-jalopy.xml">
444 <fileset dir="${sourceDir}">
445 <include name="*.java" />
446 <include name="**/*.java" />
447 <include name="**/**/*.java" />
454 <!-- Compile, package and obfuscate Jalview Applet -->
455 <target name="makeApplet" depends="obfuscate" description="assemble the final jalviewLite applet jar with or without obfuscation"/>
457 <target name="compileApplet" depends="init,clean">
458 <mkdir dir="${outputDir}" />
459 <javac source="1.5" target="1.5" srcdir="${sourceDir}" destdir="${outputDir}" debug="${javac.debug}"
460 classpathref="jalviewlite.deps" includes="jalview/appletgui/**"
461 excludes="ext/**,MCview/**,org/**,vamsas/**" />
464 <target name="packageApplet" depends="compileApplet, buildPropertiesFile">
465 <copy file="${resourceDir}/images/idwidth.gif" toFile="${outputDir}/images/idwidth.gif" />
466 <copy file="${resourceDir}/images/link.gif" toFile="${outputDir}/images/link.gif" />
467 <jar destfile="in.jar">
469 <attribute name="Main-Class" value="jalview.bin.JalviewLite" />
471 <fileset dir="${outputDir}">
472 <include name="com/**" />
473 <include name="MCview/**" />
474 <include name="jalview/**" />
475 <include name=".build_properties" />
476 <include name="images/idwidth.gif" />
477 <include name="images/link.gif" />
481 <target name="obfuscate" depends="-obfuscatefake,-obfuscatereally">
483 <target name="-obfuscatefake" depends="packageApplet" if="donotobfuscate">
484 <copy file="in.jar" tofile="${jalviewLiteJar}" overwrite="true" />
485 <delete file="in.jar" />
487 <target name="-obfuscatereally" unless="donotobfuscate">
489 <path id="obfuscateDeps.path">
490 <pathelement location="${applet.jre.tools}" />
491 <pathelement location="appletlib/${jmolJar}" />
493 <taskdef resource="proguard/ant/task.properties" classpath="utils/proguard.jar" />
496 <injar file="in.jar" />
497 <outjar file="${jalviewLiteJar}" />
498 <libraryjar refid="obfuscateDeps.path" />
499 <keep access="public" type="class" name="jalview.bin.JalviewLite">
500 <field access="public" />
501 <method access="public" />
502 <constructor access="public" />
504 <!-- -libraryjars "${obfuscateDeps}"
506 -outjars jalviewApplet.jar
507 -keep public class jalview.bin.JalviewLite
510 <delete file="in.jar" />
513 <target name="castorbinding" depends="init" description="Generate Java bindings to supported Jalview XML models.">
514 <taskdef name="castor-srcgen" classname="org.castor.anttask.CastorCodeGenTask" classpathref="build.classpath" />
516 <fileset dir="${sourceDir}/jalview/schemabinding/version2">
517 <include name="*.java" />
518 <include name="descriptors/*.java" />
521 <castor-srcgen file="${schemaDir}/vamsas.xsd" todir="${sourceDir}" package="jalview.schemabinding.version2" warnings="false" nodesc="false" verbose="true" properties="${schemaDir}/jalview.properties" />
522 <castor-srcgen file="${schemaDir}/JalviewUserColours.xsd" todir="${sourceDir}" package="jalview.schemabinding.version2" warnings="false" nodesc="false" verbose="true" properties="${schemaDir}/jalview.properties" />
523 <castor-srcgen file="${schemaDir}/JalviewWsParamSet.xsd" todir="${sourceDir}" package="jalview.schemabinding.version2" warnings="false" nodesc="false" verbose="true" properties="${schemaDir}/jalview.properties" />
524 <castor-srcgen file="${schemaDir}/jalview.xsd" todir="${sourceDir}" package="jalview.schemabinding.version2" warnings="false" nodesc="false" verbose="true" properties="${schemaDir}/jalview.properties" />
526 now build the jalview.binding package with the old schema set
529 <fileset dir="${sourceDir}/jalview/binding/">
530 <include name="**" />
533 <castor-srcgen file="${schemaDir}/vamsasJvV1.xsd" todir="${sourceDir}" package="jalview.binding" warnings="false" nodesc="true" verbose="true" properties="${schemaDir}/jalview.nodesc.properties" />
534 <castor-srcgen file="${schemaDir}/JalviewUserColours.xsd" todir="${sourceDir}" package="jalview.binding" warnings="false" nodesc="true" verbose="true" properties="${schemaDir}/jalview.nodesc.properties" />
535 <castor-srcgen file="${schemaDir}/jalviewJvV1.xsd" todir="${sourceDir}" package="jalview.binding" warnings="false" nodesc="true" verbose="true" properties="${schemaDir}/jalview.nodesc.properties" />
537 <target name="sourcedist" description="create jalview source distribution" depends="init">
538 <delete file="${source.dist.name}" />
539 <tar destfile="${source.dist.name}" compression="gzip">
540 <tarfileset dir="./" prefix="jalview" preserveLeadingSlashes="true">
541 <include name="LICENSE" />
542 <include name="README" />
543 <include name="build.xml" />
544 <include name="jalview-jalopy.xml" />
545 <include name="JalviewApplet.jpx" />
546 <include name="JalviewX.jpx" />
547 <include name="nbbuild.xml"/>
548 <include name="nbproject/genfiles.properties"/>
549 <include name="nbproject/project.properties"/>
550 <include name="nbproject/project.xml"/>
551 <include name="${sourceDir}/*.java" />
552 <include name="${sourceDir}/**/*.java" />
553 <include name="${sourceDir}/**/*.cdr" />
554 <include name="${libDir}/**/*" />
555 <include name="${resourceDir}/**/*" />
556 <include name="${helpDir}/**/*" />
557 <include name="appletlib/${jmolJar}" />
558 <exclude name="**/*locales" />
559 <exclude name="*locales/**" />
560 <exclude name="utils/InstallAnywhere/**Build.iap_xml" />
561 <exclude name="utils/InstallAnywhere/**Build*/**" />
562 <exclude name="utils/InstallAnywhere/**Build*/**" />
563 <exclude name="utils/InstallAnywhere/**locale*" />
564 <exclude name="utils/InstallAnywhere/**locale*/**" />
565 <include name="${schemaDir}/**/*" />
566 <include name="utils/**/*" />
567 <include name="${docDir}/**/*" />
568 <include name="examples/**/*" />
572 <target name="pubapplet" description="installs the jalviewLite applet and dependent jars into an applet examples directory built under ${outputDir}" depends="makeApplet">
573 <copy todir="${packageDir}/examples">
574 <fileset dir="examples">
575 <include name="**/*"/>
576 <include name="javascript/*"/>
577 <include name="jmol/*"/>
580 <include name="jalviewApplet.jar"/>
582 <fileset dir="appletlib">
583 <include name="**/*"/>
588 <target name="sourcedoc" description="Create jalview source documentation pages" depends="init">
589 <javadoc destdir="${javadocDir}">
590 <packageset dir="${sourceDir}" includes="jalview/*,MCView/*">