source: subversion/applications/editors/josm/plugins/build-common.xml @ 28990

Last change on this file since 28990 was 28990, checked in by simon04, 7 years ago

fix #josm8222 - Update plugin build system

File size: 11.6 KB
Line 
1<?xml version="1.0" encoding="utf-8"?>
2<!--
3** Template for the build targets common to all plugins
4** ====================================================
5**
6** To override a property, add it to the plugin build.xml _before_
7** this template has been imported.
8** To override a target, add it _after_ this template has been imported.
9**
10** Paths are relative to the build.xml that imports this template.
11**
12-->
13<project name="plugin_common" basedir=".">
14
15    <property name="josm"                   location="../../core/dist/josm-custom.jar"/>
16    <property name="plugin.build.dir"       value="build"/>
17    <property name="plugin.src.dir"         value="src"/>
18    <property name="plugin.lib.dir"         value="lib"/>
19    <!-- this is the directory where the plugin jar is copied to -->
20    <property name="plugin.dist.dir"        value="../../dist"/>
21    <property name="ant.build.javac.target" value="1.6"/>
22    <property name="ant.build.javac.source" value="1.6"/>
23    <property name="plugin.jar"             value="${plugin.dist.dir}/${ant.project.name}.jar"/>
24
25    <!--
26    **********************************************************
27    ** init - initializes the build
28    **********************************************************
29    -->
30    <target name="init">
31        <mkdir dir="${plugin.build.dir}"/>
32    </target>
33    <!--
34    **********************************************************
35    ** compile - complies the source tree
36    **********************************************************
37    -->
38    <target name="compile" depends="init">
39        <echo message="compiling sources for ${plugin.jar} ..."/>
40        <javac srcdir="src" debug="true" destdir="${plugin.build.dir}" includeantruntime="false">
41            <compilerarg value="-Xlint:deprecation"/>
42            <compilerarg value="-Xlint:unchecked"/>
43            <classpath>
44                <pathelement location="${josm}"/>
45                <fileset dir="${plugin.lib.dir}" erroronmissingdir="no">
46                    <include name="**/*.jar"/>
47                </fileset>
48            </classpath>
49        </javac>
50    </target>
51    <!--
52    **********************************************************
53    ** dist - creates the plugin jar
54    **********************************************************
55    -->
56    <target name="dist" depends="compile,revision">
57        <echo message="creating ${ant.project.name}.jar ... "/>
58        <copy todir="${plugin.build.dir}/resources" failonerror="no" includeemptydirs="no">
59            <fileset dir="resources"/>
60        </copy>
61        <copy todir="${plugin.build.dir}/images" failonerror="no" includeemptydirs="no">
62            <fileset dir="images"/>
63        </copy>
64        <copy todir="${plugin.build.dir}/data" failonerror="no" includeemptydirs="no">
65            <fileset dir="data"/>
66        </copy>
67        <copy todir="${plugin.build.dir}">
68            <fileset dir=".">
69                <include name="README"/>
70                <include name="LICENSE"/>
71            </fileset>
72        </copy>
73        <delete file="MANIFEST" failonerror="no"/>
74        <manifest file="MANIFEST" mode="update">
75            <attribute name="Plugin-Mainversion" value="${plugin.main.version}"/>
76            <attribute name="Plugin-Version" value="${version.entry.commit.revision}"/>
77            <attribute name="Plugin-Class" value="${plugin.class}" />
78            <attribute name="Plugin-Description" value="${plugin.description}" />
79            <attribute name="Plugin-Date" value="${version.entry.commit.date}" />
80            <attribute name="Author" value="${plugin.author}"/>
81        </manifest>
82        <antcall target="add-manifest-attribute">
83            <param name="manifest.attribute" value="Plugin-Link"/>
84            <param name="propery.name" value="plugin.link"/>
85            <param name="propery.value" value="${plugin.link}"/>
86        </antcall>
87        <antcall target="add-manifest-attribute">
88            <param name="manifest.attribute" value="Plugin-Icon"/>
89            <param name="propery.name" value="plugin.icon"/>
90            <param name="propery.value" value="${plugin.icon}"/>
91        </antcall>
92        <antcall target="add-manifest-attribute">
93            <param name="manifest.attribute" value="Plugin-Early"/>
94            <param name="propery.name" value="plugin.early"/>
95            <param name="propery.value" value="${plugin.early}"/>
96        </antcall>
97        <antcall target="add-manifest-attribute">
98            <param name="manifest.attribute" value="Plugin-Requires"/>
99            <param name="propery.name" value="plugin.requires"/>
100            <param name="propery.value" value="${plugin.requires}"/>
101        </antcall>
102        <antcall target="add-manifest-attribute">
103            <param name="manifest.attribute" value="Plugin-Stage"/>
104            <param name="propery.name" value="plugin.stage"/>
105            <param name="propery.value" value="${plugin.stage}"/>
106        </antcall>
107        <jar destfile="${plugin.jar}" basedir="${plugin.build.dir}" manifest="MANIFEST">
108            <zipgroupfileset dir="${plugin.lib.dir}" includes="*.jar" erroronmissingdir="no"/>
109        </jar>
110        <delete file="MANIFEST" failonerror="no"/>
111    </target>
112    <target name="add-manifest-attribute" depends="check-manifest-attribute" if="have-${propery.name}">
113        <manifest file="MANIFEST" mode="update">
114            <attribute name="${manifest.attribute}" value="${propery.value}" />
115        </manifest>
116    </target>
117    <target name="check-manifest-attribute">
118        <condition property="have-${propery.name}">
119            <and>
120                <isset property="${propery.name}"/>
121                <not>
122                    <equals arg1="${propery.value}" arg2=""/>
123                </not>
124                <not>
125                    <equals arg1="${propery.value}" arg2="..."/>
126                </not>
127            </and>
128        </condition>
129    </target>
130    <!--
131    **********************************************************
132    ** revision - extracts the current revision number for the
133    **    file build.number and stores it in the XML property
134    **    version.*
135    **********************************************************
136    -->
137    <target name="revision">
138        <exec append="false" outputproperty="svn.revision.output" executable="svn" failifexecutionfails="false">
139            <env key="LANG" value="C"/>
140            <arg value="info"/>
141            <arg value="--xml"/>
142            <arg value="."/>
143        </exec>
144        <xmlproperty prefix="version" keepRoot="false" collapseAttributes="true">
145            <propertyresource name="svn.revision.output"/>
146        </xmlproperty>
147    </target>
148    <!--
149    **********************************************************
150    ** clean - clean up the build environment
151    **********************************************************
152    -->
153    <target name="clean">
154        <delete dir="${plugin.build.dir}"/>
155        <delete file="${plugin.jar}"/>
156    </target>
157    <!--
158    **********************************************************
159    ** install - install the plugin in your local JOSM installation
160    **********************************************************
161    -->
162    <target name="install" depends="dist">
163        <property environment="env"/>
164        <condition property="josm.plugins.dir" value="${env.APPDATA}/JOSM/plugins" else="${user.home}/.josm/plugins">
165            <and>
166                <os family="windows"/>
167            </and>
168        </condition>
169        <copy file="${plugin.jar}" todir="${josm.plugins.dir}"/>
170    </target>
171    <!--
172    ************************** Publishing the plugin ***********************************
173    -->
174    <!--
175    ** extracts the JOSM release for the JOSM version in ../core and saves it in the
176    ** property ${coreversion.info.entry.revision}
177    **
178    -->
179    <target name="core-info">
180        <exec append="false" output="core.info.xml" executable="svn" failifexecutionfails="false">
181            <env key="LANG" value="C"/>
182            <arg value="info"/>
183            <arg value="--xml"/>
184            <arg value="../../core"/>
185        </exec>
186        <xmlproperty file="core.info.xml" prefix="coreversion" keepRoot="true" collapseAttributes="true"/>
187        <echo>Building against core revision ${coreversion.info.entry.revision}.</echo>
188        <echo>Plugin-Mainversion is set to ${plugin.main.version}.</echo>
189        <delete file="core.info.xml"/>
190    </target>
191    <!--
192    ** commits the source tree for this plugin
193    -->
194    <target name="commit-current">
195        <echo>Commiting the plugin source with message '${commit.message}' ...</echo>
196        <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
197            <env key="LANG" value="C"/>
198            <arg value="commit"/>
199            <arg value="-m"/>
200            <arg value="${commit.message}"/>
201            <arg value="."/>
202        </exec>
203    </target>
204    <!--
205    ** updates (svn up) the source tree for this plugin
206    -->
207    <target name="update-current">
208        <echo>Updating plugin source ...</echo>
209        <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
210            <env key="LANG" value="C"/>
211            <arg value="up"/>
212            <arg value="."/>
213        </exec>
214        <echo>Updating ${plugin.jar} ...</echo>
215        <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
216            <env key="LANG" value="C"/>
217            <arg value="up"/>
218            <arg value="../dist/${plugin.jar}"/>
219        </exec>
220    </target>
221    <!--
222    ** commits the plugin.jar
223    -->
224    <target name="commit-dist">
225        <echo>
226    ***** Properties of published ${plugin.jar} *****
227    Commit message    : '${commit.message}'
228    Plugin-Mainversion: ${plugin.main.version}
229    JOSM build version: ${coreversion.info.entry.revision}
230    Plugin-Version    : ${version.entry.commit.revision}
231    ***** / Properties of published ${plugin.jar} *****
232
233    Now commiting ${plugin.jar} ...
234    </echo>
235        <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
236            <env key="LANG" value="C"/>
237            <arg value="-m"/>
238            <arg value="${commit.message}"/>
239            <arg value="commit"/>
240            <arg value="${plugin.jar}"/>
241        </exec>
242    </target>
243    <!-- ** make sure svn is present as a command line tool ** -->
244    <target name="ensure-svn-present">
245        <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false" failonerror="false" resultproperty="svn.exit.code">
246            <env key="LANG" value="C"/>
247            <arg value="--version"/>
248        </exec>
249        <fail message="Fatal: command 'svn --version' failed. Please make sure svn is installed on your system.">
250            <!-- return code not set at all? Most likely svn isn't installed -->
251            <condition>
252                <not>
253                    <isset property="svn.exit.code"/>
254                </not>
255            </condition>
256        </fail>
257        <fail message="Fatal: command 'svn --version' failed. Please make sure a working copy of svn is installed on your system.">
258            <!-- error code from SVN? Most likely svn is not what we are looking on this system -->
259            <condition>
260                <isfailure code="${svn.exit.code}"/>
261            </condition>
262        </fail>
263    </target>
264
265    <target name="publish" depends="ensure-svn-present,core-info,commit-current,update-current,clean,dist,commit-dist">
266    </target>
267
268    <target name="runjosm" depends="install">
269        <java jar="${josm}" fork="true">
270        </java>
271    </target>
272
273    <target name="profilejosm" depends="install">
274        <nbprofiledirect>
275        </nbprofiledirect>
276        <java jar="${josm}" fork="true">
277            <jvmarg value="${profiler.info.jvmargs.agent}"/>
278        </java>
279    </target>
280</project>
281
Note: See TracBrowser for help on using the repository browser.