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