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