Show the background layer name.
[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="-locale=${locales.list}" />
99       <arg line="-allow-source-path-overlap true" />
100     </exec>
101   </target>
102
103   <target name="manifests">
104         <!-- Adapted from http://dreamingwell.com/articles/archives/2009/12/excluding-direc.php -->
105         <!-- Generating documentation for a class generates all the dependant documentation too. We
106              don't want to do this for certain projects like org.vanrijkom etc (.swc files are
107              automatically ignored). Unfortunately asdoc only has options for excluding particular
108              classes, and there's lots of them - so this stuff autogenerates the class lists that
109              we want to ignore. -->
110
111         <fileset id="com_sources" dir="${basedir}/com/" />
112         <!-- convert the names of excluded classes to packages with class names -->
113         <pathconvert property="com_classes" pathsep=" " refid="com_sources">
114                 <chainedmapper>
115                         <globmapper from="${basedir}/*" to="*"/>
116                         <mapper type="package" from="*.as" to="*"/>
117                 </chainedmapper>
118         </pathconvert>
119
120         <!-- Get the list of all files in the org directory -->
121         <fileset id="org_sources" dir="${basedir}/org/" />
122         <!-- convert the names of excluded classes to packages with class names -->
123         <pathconvert property="org_classes" pathsep=" " refid="org_sources">
124                 <chainedmapper>
125                         <globmapper from="${basedir}/*" to="*"/>
126                         <mapper type="package" from="*.as" to="*"/>
127                 </chainedmapper>
128         </pathconvert>
129
130         <fileset id="it_sources" dir="${basedir}/it/" />
131         <!-- convert the names of excluded classes to packages with class names -->
132         <pathconvert property="it_classes" pathsep=" " refid="it_sources">
133                 <chainedmapper>
134                         <globmapper from="${basedir}/*" to="*"/>
135                         <mapper type="package" from="*.as" to="*"/>
136                 </chainedmapper>
137         </pathconvert>
138
139         <fileset id="hxasm_sources" dir="${basedir}/hxasm/" />
140         <!-- convert the names of excluded classes to packages with class names -->
141         <pathconvert property="hxasm_classes" pathsep=" " refid="hxasm_sources">
142                 <chainedmapper>
143                         <globmapper from="${basedir}/*" to="*"/>
144                         <mapper type="package" from="*.as" to="*"/>
145                 </chainedmapper>
146         </pathconvert>
147
148         <!-- if we end up with third-party stuff in the net/ folder, then do something like this -->
149         <!-- <fileset id="net_sources" dir="${basedir}/net/">
150                <exclude name="**net.systemeD**"/>
151         </fileset> -->
152
153         <!-- echo the exlcusions for debugging purposes -->
154         <!--<echo message="manifests = ${org_classes} ${it_classes} ${hxasm_classes}"/>-->
155   </target>
156
157   <!-- ======================================= -->
158   <!-- Unit Test Targets -->
159   <!-- ======================================= -->
160  
161   <target name="compileTestRunner" depends="init" description="Compiles the test runner application.">
162    
163     <!-- Compile TestRunner MXML as a SWF -->
164     <mxmlc file="${test.src.dir}/${test.application.name}.mxml"
165       output="${test.bin.dir}/${test.application.name}.swf">
166      
167       <!--<load-config filename="${FLEX_HOME}/frameworks/air-config.xml" />-->
168
169       <!-- we need to supply source paths for the real source and the test source. But passing
170           the potlatch2 top-level directory causes a problem since that also contains the test source.
171           We could move every source folder (net, org, it and hxasm) into a src/ folder, or alternatively
172           set up a fake root folder in the test folder with symlinks to the four directories concerned.
173           It's a bodge, but it works. -->
174       <source-path path-element="${test.fakeroot.dir}" />
175       <source-path path-element="${test.src.dir}" />
176        
177       <!-- The TestRunner needs the flexunit libraries in the build/libs folder -->
178       <library-path dir="${LIBS_DIR}" append="true">
179          <include name="*.swc" />
180       </library-path>
181
182        
183       <!-- Sets java.awt.headless=true so font compilation works in headless environments -->
184       <compiler.headless-server>true</compiler.headless-server>
185       <target-player>10.0.0</target-player>
186      </mxmlc>
187      
188      <echo message="The ${test.application.name}.swf test runner has been created in ${test.bin.dir}" />
189   </target>
190    
191   <target name="runTestsAndReport" depends="init" description="Launches the test runner, captures results, generates test report artifacts.">
192
193       <mkdir dir="${report.dir}" />
194       <mkdir dir="${report.html.dir}" />
195   
196      <!-- Run FlexUnit Ant Task to execute the unit tests and capture reporting data -->
197      <!-- on linux, make sure that gflashplayer is in your PATH and launches a standalone flashplayer binary -->
198      <taskdef resource="flexUnitTasks.tasks" classpath="${LIBS_DIR}/flexUnitTasks-4.1.0_RC2-28.jar" />
199      <flexunit swf="${test.bin.dir}/${test.application.name}.swf" toDir="${report.dir}"
200        haltonfailure="false" verbose="false" localTrusted="true" player="flash" />
201        
202       <!-- Generate html JUnit-style reports based on test results -->
203       <junitreport todir="${report.dir}">
204         <fileset dir="${report.dir}">
205           <include name="TEST-*.xml" />
206         </fileset>
207         <report format="frames" todir="${report.html.dir}" />
208       </junitreport>
209          
210          <echo message="The unit test reports have been created in ${report.dir}" />
211   </target>
212
213   <target name="test" depends="init, compileTestRunner, runTestsAndReport" description="Compiles unit tests and generates test report artifacts." />
214
215   <!-- ======================================= -->
216   <!-- Locale Targets -->
217   <!-- ======================================= -->
218
219   <!-- Deploy compiled Localization Resource Bundles and resources. -->
220   <macrodef name="deployLocale" description="Deploying the compiled swfs">
221     <attribute name="locale" default="en_GB"/>
222     <sequential>
223       <echo>Copying @{locale}.swf to deploy directory...</echo>
224
225       <mkdir dir="${basedir}/resources/locales"/>
226       <copy file="${basedir}/l10n/locale/bundles/@{locale}.swf" tofile="${basedir}/resources/locales/@{locale}.swf" />
227
228     </sequential>
229   </macrodef>
230
231   <!-- Compiles Localization Resource Bundle. -->
232   <macrodef name="compileLocale" description="Compiles the Resource package for the given locale">
233     <attribute name="locale" default="en_GB"/>
234     <sequential>
235
236       <!--
237       Invoke MXMLC
238       - also include the MX Framework locale assets
239       Note: this requires user to invoke copyLocale.exe prior to running this script
240       -->
241       <mxmlc output="${basedir}/l10n/locale/bundles/@{locale}.swf">
242 <!--         <locale>@{locale}</locale> -->
243
244
245         <source-path path-element="${basedir}/l10n/locale/@{locale}"/>
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           <exclude name="bundles"/>
273           <include name="??_??"/>
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>