Allow the font library path to be specified with a parameter
[potlatch2.git] / build.xml
1 <project name="Potlatch 2" default="debug" xmlns:ac="antlib:net.sf.antcontrib">
2
3   <!-- load properties from the environment -->
4   <property environment="env" />
5
6   <!-- load previously defined configuration properties file -->
7   <property file="build.properties" />
8
9   <!-- flexTasks comes with flex, but apparently it's good practice to put in the libs folder -->
10   <taskdef resource="flexTasks.tasks" classpath="${basedir}/lib/flexTasks.jar"/>
11
12   <!-- ant-contrib to build multiple locales -->
13   <taskdef uri="antlib:net.sf.antcontrib" resource="net/sf/antcontrib/antlib.xml" classpath="${basedir}/lib/ant-contrib-1.0b3.jar"/>
14
15   <!-- if you are running git-svn, you need to run "git tag -a 0.4 0ac0de" where 0ac0de corresponds to the commitid of
16       potlatch2 v0.4 . You need to do this for each point release while we're still in SVN.
17       If you don't, then expect "git describe" to fail miserably.
18       Produces a build number of the form 0.4-1-g9692243 which means 1 commit later than 0.4, latest commit was 9692243 -->
19   <available file=".git" type="dir" property="git.present"/>
20   <target name="git-buildnumber" description="Store output from git-describe in ${buildnumber}" if="git.present">
21     <exec outputproperty="build_number" executable="git" dir="${basedir}">
22       <arg value="describe" />
23     </exec>
24   </target>
25
26   <!-- if you are running svn ("I pity the fool", etc) then svnversion will give the svn revision number, and the
27        build number will be of the form 24041 -->
28   <available file=".svn" type="dir" property="svn.present"/>
29   <target name="svn-buildnumber" description="Store output from svnversion in ${buildnumber}" if="svn.present">
30     <exec outputproperty="build_number" executable="svnversion" dir="${basedir}" />
31   </target>
32
33   <!-- delete and create the DEPLOY dir again -->
34   <target name="init" depends="git-buildnumber,svn-buildnumber,deployLocales">
35     <echo>Build Number ${build_number}</echo>
36     <copy file="version.as.template" tofile="version.as" overwrite="true" />
37     <replace file="version.as" token="@@@buildnumber@@@" value="${build_number}" />
38   </target>
39
40   <!-- Build and output potlatch2.swf in debug mode -->
41   <target name="debug" depends="init">
42     <mxmlc file="potlatch2.mxml">
43       <load-config filename="${FLEX_HOME}/frameworks/flex-config.xml"/>
44       <load-config filename="debug-config.xml"/>
45       <source-path path-element="${FLEX_HOME}/frameworks"/>
46       <compiler.debug>true</compiler.debug>
47     </mxmlc>
48   </target>
49
50   <!-- Build and output potlatch2.swf in release mode -->
51   <target name="release" depends="init"> <!-- FIXME convention is dist not release -->
52     <mxmlc file="potlatch2.mxml">
53       <load-config filename="${FLEX_HOME}/frameworks/flex-config.xml"/>
54       <source-path path-element="${FLEX_HOME}/frameworks"/>
55       <compiler.debug>false</compiler.debug>
56     </mxmlc>
57   </target>
58
59   <target name="halcyon">
60     <mxmlc file="halcyon_viewer.as" />
61   </target>
62
63   <!-- note that there's an asdoc target in Flex 4, if/when we move to that -->
64   <target name="docs" depends="manifests,makeLocalesList">
65     <exec executable="${ASDOC}" failonerror="true">
66       <arg line="-source-path=."/>
67       <arg line="-doc-sources=net/systemeD/"/>
68       <arg line="-external-library-path=lib/"/>
69       <arg line="-external-library-path=${FLEX_HOME}/frameworks/libs/"/>
70       <arg line="-external-library-path=${FLEX_HOME}/frameworks/libs/player/10.2/"/>
71       <arg line="-lenient"/>
72       <arg line="-target-player=10.2.0"/>
73       <arg line="-exclude-classes=${org_classes},${it_classes},${hxasm_classes},${com_classes}"/>
74       <arg line="-output=resources/docs/"/>
75       <arg line="-window-title='Halcyon and Potlatch2 Developer documentation'" />
76       <arg line="-main-title='Halcyon and Potlatch2 Developer documentation'" />
77       <arg line="-footer='Found an error? Help us fix it. http://wiki.openstreetmap.org/wiki/Potlatch2'"/>
78       <arg line="-package net.systemeD.controls 'Custom-built controls used in Potlatch2'" />
79       <arg line="-package net.systemeD.halcyon 'The AS3 rendering library'" />
80       <arg line="-package net.systemeD.halcyon.connection 'The connection to the main OSM server, and the entities'" />
81       <arg line="-package net.systemeD.halcyon.connection.actions 'The undoable actions that apply to OSM data'" />
82       <arg line="-package net.systemeD.halcyon.styleparser 'The logic for parsing MapCSS stylesheets'" />
83       <arg line="-package net.systemeD.potlatch2 'The OpenStreetMap editor'" />
84       <arg line="-package net.systemeD.potlatch2.collections 'Singletons for handling collections loaded from config files'" />
85       <arg line="-package net.systemeD.potlatch2.controller 'The various controller states that p2 can be in'" />
86       <arg line="-package net.systemeD.potlatch2.find 'The search dialog for jumping to another place'" />
87       <arg line="-package net.systemeD.potlatch2.help 'The Help dialog'" />
88       <arg line="-package net.systemeD.potlatch2.mapfeatures 'The engine behind the mapfeatures parsing'" />
89       <arg line="-package net.systemeD.potlatch2.mapfeatures.editors 'The various widgets used in the Simple panel'" />
90       <arg line="-package net.systemeD.potlatch2.mygpx 'The dialog for loading GPX files from the server'" />
91       <arg line="-package net.systemeD.potlatch2.options 'The options dialog'" />
92       <arg line="-package net.systemeD.potlatch2.panels 'The panels for the left-hand pane of p2'" />
93       <arg line="-package net.systemeD.potlatch2.save 'The save dialog and SaveManager'" />
94       <arg line="-package net.systemeD.potlatch2.tools 'Data manipulation tools'" />
95       <arg line="-package net.systemeD.potlatch2.utils 'Data loading utilities'" />
96       
97       <arg line="-left-frameset-width=300" />
98       <arg line="-allow-source-path-overlap=true" />
99     </exec>
100   </target>
101
102   <target name="manifests">
103         <!-- Adapted from http://dreamingwell.com/articles/archives/2009/12/excluding-direc.php -->
104         <!-- Generating documentation for a class generates all the dependant documentation too. We
105              don't want to do this for certain projects like org.vanrijkom etc (.swc files are
106              automatically ignored). Unfortunately asdoc only has options for excluding particular
107              classes, and there's lots of them - so this stuff autogenerates the class lists that
108              we want to ignore. -->
109
110         <fileset id="com_sources" dir="${basedir}/com/" />
111         <!-- convert the names of excluded classes to packages with class names -->
112         <pathconvert property="com_classes" pathsep="," refid="com_sources">
113                 <chainedmapper>
114                         <globmapper from="${basedir}/*" to="*"/>
115                         <mapper type="package" from="*.as" to="*"/>
116                 </chainedmapper>
117         </pathconvert>
118
119         <!-- Get the list of all files in the org directory -->
120         <fileset id="org_sources" dir="${basedir}/org/" />
121         <!-- convert the names of excluded classes to packages with class names -->
122         <pathconvert property="org_classes" pathsep="," refid="org_sources">
123                 <chainedmapper>
124                         <globmapper from="${basedir}/*" to="*"/>
125                         <mapper type="package" from="*.as" to="*"/>
126                 </chainedmapper>
127         </pathconvert>
128
129         <fileset id="it_sources" dir="${basedir}/it/" />
130         <!-- convert the names of excluded classes to packages with class names -->
131         <pathconvert property="it_classes" pathsep="," refid="it_sources">
132                 <chainedmapper>
133                         <globmapper from="${basedir}/*" to="*"/>
134                         <mapper type="package" from="*.as" to="*"/>
135                 </chainedmapper>
136         </pathconvert>
137
138         <fileset id="hxasm_sources" dir="${basedir}/hxasm/" />
139         <!-- convert the names of excluded classes to packages with class names -->
140         <pathconvert property="hxasm_classes" pathsep="," refid="hxasm_sources">
141                 <chainedmapper>
142                         <globmapper from="${basedir}/*" to="*"/>
143                         <mapper type="package" from="*.as" to="*"/>
144                 </chainedmapper>
145         </pathconvert>
146
147         <!-- if we end up with third-party stuff in the net/ folder, then do something like this -->
148         <!-- <fileset id="net_sources" dir="${basedir}/net/">
149                <exclude name="**net.systemeD**"/>
150         </fileset> -->
151
152         <!-- echo the exlcusions for debugging purposes -->
153         <!--<echo message="manifests = ${org_classes} ${it_classes} ${hxasm_classes}"/>-->
154   </target>
155
156   <!-- ======================================= -->
157   <!-- Unit Test Targets -->
158   <!-- ======================================= -->
159  
160   <target name="compileTestRunner" depends="init" description="Compiles the test runner application.">
161    
162     <!-- Compile TestRunner MXML as a SWF -->
163     <mxmlc file="${test.src.dir}/${test.application.name}.mxml"
164       output="${test.bin.dir}/${test.application.name}.swf">
165      
166       <!--<load-config filename="${FLEX_HOME}/frameworks/air-config.xml" />-->
167
168       <!-- we need to supply source paths for the real source and the test source. But passing
169           the potlatch2 top-level directory causes a problem since that also contains the test source.
170           We could move every source folder (net, org, it and hxasm) into a src/ folder, or alternatively
171           set up a fake root folder in the test folder with symlinks to the four directories concerned.
172           It's a bodge, but it works. -->
173       <source-path path-element="${test.fakeroot.dir}" />
174       <source-path path-element="${test.src.dir}" />
175        
176       <!-- The TestRunner needs the flexunit libraries in the build/libs folder -->
177       <library-path dir="${LIBS_DIR}" append="true">
178          <include name="*.swc" />
179       </library-path>
180
181        
182       <!-- Sets java.awt.headless=true so font compilation works in headless environments -->
183       <compiler.headless-server>true</compiler.headless-server>
184       <target-player>10.2.0</target-player>
185      </mxmlc>
186      
187      <echo message="The ${test.application.name}.swf test runner has been created in ${test.bin.dir}" />
188   </target>
189    
190   <target name="runTestsAndReport" depends="init" description="Launches the test runner, captures results, generates test report artifacts.">
191
192       <mkdir dir="${report.dir}" />
193       <mkdir dir="${report.html.dir}" />
194   
195      <!-- Run FlexUnit Ant Task to execute the unit tests and capture reporting data -->
196      <!-- on linux, make sure that gflashplayer is in your PATH and launches a standalone flashplayer binary -->
197      <taskdef resource="flexUnitTasks.tasks" classpath="${LIBS_DIR}/flexUnitTasks-4.1.0_RC2-28.jar" />
198      <flexunit swf="${test.bin.dir}/${test.application.name}.swf" toDir="${report.dir}"
199        haltonfailure="false" verbose="false" localTrusted="true" player="flash" />
200        
201       <!-- Generate html JUnit-style reports based on test results -->
202       <junitreport todir="${report.dir}">
203         <fileset dir="${report.dir}">
204           <include name="TEST-*.xml" />
205         </fileset>
206         <report format="frames" todir="${report.html.dir}" />
207       </junitreport>
208          
209          <echo message="The unit test reports have been created in ${report.dir}" />
210   </target>
211
212   <target name="test" depends="init, compileTestRunner, runTestsAndReport" description="Compiles unit tests and generates test report artifacts." />
213
214   <!-- ======================================= -->
215   <!-- Locale Targets -->
216   <!-- ======================================= -->
217
218   <!-- Deploy compiled Localization Resource Bundles and resources. -->
219   <macrodef name="deployLocale" description="Deploying the compiled swfs">
220     <attribute name="locale" default="en_GB"/>
221     <sequential>
222       <echo>Copying @{locale}.swf to deploy directory...</echo>
223
224       <mkdir dir="${basedir}/resources/locales"/>
225       <copy file="${basedir}/l10n/locale/bundles/@{locale}.swf" tofile="${basedir}/resources/locales/@{locale}.swf" />
226
227     </sequential>
228   </macrodef>
229
230   <!-- Compiles Localization Resource Bundle. -->
231   <macrodef name="compileLocale" description="Compiles the Resource package for the given locale">
232     <attribute name="locale" default="en_GB"/>
233     <sequential>
234
235       <!--
236       Invoke MXMLC
237       - also include the MX Framework locale assets
238       Note: this requires user to invoke copyLocale.exe prior to running this script
239       -->
240       <mxmlc output="${basedir}/l10n/locale/bundles/@{locale}.swf">
241 <!--         <locale>@{locale}</locale> -->
242
243
244         <source-path path-element="${basedir}/l10n/locale/@{locale}"/>
245         <source-path path-element="${basedir}/l10n/locale/en_US"/>
246         <include-resource-bundles>help_dialog</include-resource-bundles>
247         <include-resource-bundles>p2_main</include-resource-bundles>
248
249 <!--        <source-path path-element="${src.dir}/locale/framework/bundles/{locale}/src"/>
250         <include-resource-bundles>collections</include-resource-bundles>
251         <include-resource-bundles>containers</include-resource-bundles>
252         <include-resource-bundles>controls</include-resource-bundles>
253         <include-resource-bundles>core</include-resource-bundles>
254         <include-resource-bundles>effects</include-resource-bundles>
255         <include-resource-bundles>formatters</include-resource-bundles>
256         <include-resource-bundles>logging</include-resource-bundles>
257         <include-resource-bundles>SharedResources</include-resource-bundles>
258         <include-resource-bundles>skins</include-resource-bundles>
259         <include-resource-bundles>states</include-resource-bundles>
260         <include-resource-bundles>styles</include-resource-bundles>
261         <include-resource-bundles>utils</include-resource-bundles>
262         <include-resource-bundles>validators</include-resource-bundles>-->
263       </mxmlc>
264
265     </sequential>
266   </macrodef>
267
268   <target name="makeLocalesList">
269     <ac:for param="dirname">
270       <path>
271         <dirset dir="${basedir}/l10n/locale/">
272           <include name="*"/>
273           <exclude name="bundles"/>
274         </dirset>
275       </path>
276       <sequential>
277         <ac:var name="localename" unset="true"/>
278         <basename property="localename" file="@{dirname}" />
279         <script language="javascript"><![CDATA[
280             if ((l = project.getProperty("locales.list")) != null) {
281                project.setUserProperty("locales.list", l+ "," +project.getProperty("localename"));
282             } else {
283                project.setUserProperty("locales.list", project.getProperty("localename"));
284             }
285         ]]></script>
286       </sequential>
287     </ac:for>
288   </target>
289
290   <target name="buildLocales" depends="makeLocalesList">
291     <echo>Building Localization .swf's</echo>
292     <ac:for list="${locales.list}" keepgoing="true" param="localename">
293       <sequential>
294         <compileLocale locale="@{localename}" />
295       </sequential>
296     </ac:for>
297   </target>
298
299   <target name="deployLocales" depends="buildLocales">
300     <echo>Deploying the compiled swf and assets package for the given locales</echo>
301     <ac:for list="${locales.list}" keepgoing="true" param="localename">
302       <sequential>
303         <deployLocale locale="@{localename}" />
304       </sequential>
305     </ac:for>
306   </target>
307
308
309   <target name="clean"
310     description="clean up" >
311     <!-- Delete the ${build} and ${dist} directory trees -->
312     <!--
313
314     FIXME what is supposed to be cleaned?
315
316     <delete dir="${build}"/>
317     <delete dir="${dist}"/>
318
319     -->
320   </target>
321
322
323 </project>