Initial revision
[mir.git] / build.xml
1 <project name="Mir" default="compile" basedir=".">
2
3
4 <!-- Property Definitions
5      app.name          Base name of this application, used to
6                        construct filenames and directories.
7
8      deploy.home       The name of the directory into which the
9                        deployment hierarchy will be created.
10                        Normally, this will be the name of a
11                        subdirectory under $TOMCAT_HOME/webapps.
12
13      dist.home         The name of the base directory in which
14                        distribution files are created.
15
16      dist.src          The name of the distribution JAR file
17                        containing the application source code,
18                        to be stored in the "dist.home" directory.
19                        This filename should end with ".jar".
20
21      dist.war          The name of the Web ARchive (WAR) file
22                        containing our deployable application.
23                        This filename should end with ".war".
24
25      javadoc.home      The name of the base directory in which
26                        the JavaDoc documentation for this application
27                        is generated.
28
29      tomcat.home       The name of the base directory in which
30                        Tomcat has been installed.  This value is
31                        normally set automatically from the value
32                        of the TOMCAT_HOME environment variable.
33 -->
34
35   <property name="app.name"       value="Mir"/>
36   <property name="deploy.home"    value="../${app.name}"/>
37   <property name="dist.home"      value="${deploy.home}"/>
38   <property name="dist.src"       value="${app.name}.jar"/>
39   <property name="dist.war"       value="${app.name}.war"/>
40   <property name="javadoc.home"   value="${deploy.home}/javadoc"/>
41
42
43 <!-- The "prepare" target is used to construct the deployment home
44      directory structure (if necessary), and to copy in static files
45      as required.  In the example below, Ant is instructed to create
46      the deployment directory, copy the contents of the "web/" source
47      hierarchy, and set up the WEB-INF subdirectory appropriately.
48 -->
49
50   <target name="prepare">
51     <mkdir  dir="${deploy.home}"/>
52     <copy todir="${deploy.home}">
53       <fileset dir="web"/>
54     </copy>
55     <mkdir  dir="${deploy.home}/templates"/>
56     <copy todir="${deploy.home}/templates">
57       <fileset dir="templates"/>
58     </copy>
59     <mkdir  dir="${deploy.home}/src"/>
60     <copy todir="${deploy.home}/src">
61       <fileset dir="source"/>
62     </copy>
63
64     <mkdir  dir="${deploy.home}/WEB-INF"/>
65     <copy  file="etc/web.xml"          tofile="${deploy.home}/WEB-INF/web.xml"/>
66     <copy  file="etc/${app.name}.conf" tofile="${deploy.home}/WEB-INF/${app.name}.conf"/>
67     <mkdir  dir="${deploy.home}/WEB-INF/classes"/>
68     <mkdir  dir="${deploy.home}/WEB-INF/lib"/>
69     <copy todir="${deploy.home}/WEB-INF/lib">
70       <fileset dir="lib"/>
71     </copy>
72     <mkdir  dir="${javadoc.home}"/>
73     <mkdir  dir="${deploy.home}/log"/>
74
75   </target>
76
77
78 <!-- The "clean" target removes the deployment home directory structure,
79      so that the next time the "compile" target is requested, it will need
80      to compile everything from scratch.
81 -->
82
83
84   <target name="clean">
85     <delete dir="${deploy.home}"/>
86   </target>
87
88
89 <!-- The "compile" target is used to compile (or recompile) the Java classes
90      that make up this web application.  The recommended source code directory
91      structure makes this very easy because the <javac> task automatically
92      works its way down a source code hierarchy and compiles any class that
93      has not yet been compiled, or where the source file is newer than the
94      class file.
95
96      Feel free to adjust the compilation option parameters (debug,
97      optimize, and deprecation) to suit your requirements.  It is also
98      possible to base them on properties, so that you can adjust this
99      behavior at runtime.
100
101      The "compile" task depends on the "prepare" task, so the deployment
102      home directory structure will be created if needed the first time.
103 -->
104
105   <target name="compile" depends="prepare">
106     <javac srcdir="source" destdir="${deploy.home}/WEB-INF/classes"
107            classpath="${deploy.home}/WEB-INF/classes"
108            debug="on" optimize="off" deprecation="on"/>
109     <copy   todir="${deploy.home}/WEB-INF/classes">
110       <fileset dir="source" includes="**/*.properties"/>
111     </copy>
112   </target>
113
114
115 <!-- The "javadoc" target is used to create the Javadoc API documentation
116      for the Java classes in this web application.  It is assumed that
117      this documentation is included in the deployed application, so the
118      example below generates the Javadoc HTML files in a subdirectory under
119      the deployment home directory.  Feel free to customize the options for
120      the JavaDoc task, after consulting the Ant documentation.
121 -->
122
123   <target name="javadoc" depends="prepare">
124     <javadoc packagenames="mir.*, webdb.*"
125              sourcefiles="source/${app.name}.java"
126              sourcepath="source"
127              destdir="${javadoc.home}"/>
128   </target>
129
130
131 <!-- The "all" target rebuilds everything by executing the "clean"
132      target first, which forces the "compile" target to compile all
133      source code instead of just the files that have been changed.
134 -->
135
136   <target name="all" depends="clean,prepare,compile,javadoc"/>
137
138
139 <!-- The "dist" target builds the distribution Web ARchive (WAR) file
140      for this application, suitable for distribution to sites that wish
141      to install your application.  It also creates a JAR file containing
142      the source code for this application, if you wish to distribute
143      that separately.
144 -->
145
146   <target name="dist" depends="prepare,compile">
147     <jar jarfile="${dist.home}/${dist.src}"
148          basedir="./source"/>
149     <jar jarfile="${dist.home}/${dist.war}"
150          basedir="${deploy.home}"/>
151   </target>
152 </project>