519e10746d
Instead of setting property indicating if package should be signed with debug key in separate targets, this information is being passed as a package-helper macrodef parameter.
400 lines
17 KiB
XML
400 lines
17 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<project name="android_rules" default="debug">
|
|
|
|
<!--
|
|
This rules file is meant to be imported by the custom Ant task:
|
|
com.android.ant.AndroidInitTask
|
|
|
|
The following properties are put in place by the importing task:
|
|
android.jar, android.aidl, aapt, aidl, and dx
|
|
|
|
Additionnaly, the task sets up the following classpath reference:
|
|
android.target.classpath
|
|
This is used by the compiler task as the boot classpath.
|
|
-->
|
|
|
|
<!-- Custom tasks -->
|
|
<taskdef name="aaptexec"
|
|
classname="com.android.ant.AaptExecLoopTask"
|
|
classpathref="android.antlibs" />
|
|
|
|
<taskdef name="apkbuilder"
|
|
classname="com.android.ant.ApkBuilderTask"
|
|
classpathref="android.antlibs" />
|
|
|
|
<!-- Properties -->
|
|
|
|
<property name="android.tools.dir" location="${sdk.dir}/tools" />
|
|
|
|
<!-- Input directories -->
|
|
<property name="source.dir" value="src" />
|
|
<property name="source.absolute.dir" location="${source.dir}" />
|
|
<property name="gen.dir" value="gen" />
|
|
<property name="gen.absolute.dir" location="${gen.dir}" />
|
|
<property name="resource.dir" value="res" />
|
|
<property name="resource.absolute.dir" location="${resource.dir}" />
|
|
<property name="asset.dir" value="assets" />
|
|
<property name="asset.absolute.dir" location="${asset.dir}" />
|
|
|
|
<!-- Directory for the third party java libraries -->
|
|
<property name="external.libs.dir" value="libs" />
|
|
<property name="external.libs.absolute.dir" location="${external.libs.dir}" />
|
|
|
|
<!-- Directory for the native libraries -->
|
|
<property name="native.libs.dir" value="libs" />
|
|
<property name="native.libs.absolute.dir" location="${native.libs.dir}" />
|
|
|
|
<!-- Output directories -->
|
|
<property name="out.dir" value="bin" />
|
|
<property name="out.absolute.dir" location="${out.dir}" />
|
|
<property name="out.classes.dir" value="${out.absolute.dir}/classes" />
|
|
<property name="out.classes.absolute.dir" location="${out.classes.dir}" />
|
|
|
|
<!-- Intermediate files -->
|
|
<property name="dex.file.name" value="classes.dex" />
|
|
<property name="intermediate.dex.file" location="${out.absolute.dir}/${dex.file.name}" />
|
|
|
|
<!-- The final package file to generate -->
|
|
<property name="out.debug.unaligned.package"
|
|
location="${out.absolute.dir}/${ant.project.name}-debug-unaligned.apk" />
|
|
<property name="out.debug.package"
|
|
location="${out.absolute.dir}/${ant.project.name}-debug.apk" />
|
|
<property name="out.unsigned.package"
|
|
location="${out.absolute.dir}/${ant.project.name}-unsigned.apk" />
|
|
<property name="out.unaligned.package"
|
|
location="${out.absolute.dir}/${ant.project.name}-unaligned.apk" />
|
|
<property name="out.release.package"
|
|
location="${out.absolute.dir}/${ant.project.name}-release.apk" />
|
|
|
|
<!-- Tools -->
|
|
<condition property="exe" value=".exe" else=""><os family="windows" /></condition>
|
|
<property name="adb" location="${android.tools.dir}/adb${exe}" />
|
|
<property name="zipalign" location="${android.tools.dir}/zipalign${exe}" />
|
|
|
|
<!-- Emma configuration -->
|
|
<property name="emma.dir" value="${sdk.dir}/tools/lib" />
|
|
<path id="emma.lib">
|
|
<pathelement location="${emma.dir}/emma.jar" />
|
|
<pathelement location="${emma.dir}/emma_ant.jar" />
|
|
</path>
|
|
<taskdef resource="emma_ant.properties" classpathref="emma.lib" />
|
|
<!-- End of emma configuration -->
|
|
|
|
<!-- Macros -->
|
|
|
|
<!-- Configurable macro, which allows to pass as parameters output directory,
|
|
output dex filename and external libraries to dex (optional) -->
|
|
<macrodef name="dex-helper">
|
|
<element name="external-libs" optional="yes" />
|
|
<sequential>
|
|
<echo>Converting compiled files and external libraries into ${intermediate.dex.file}...
|
|
</echo>
|
|
<apply executable="${dx}" failonerror="true" parallel="true">
|
|
<arg value="--dex" />
|
|
<arg value="--output=${intermediate.dex.file}" />
|
|
<arg path="${out.classes.absolute.dir}" />
|
|
<fileset dir="${external.libs.absolute.dir}" includes="*.jar" />
|
|
<external-libs />
|
|
</apply>
|
|
</sequential>
|
|
</macrodef>
|
|
|
|
<!-- This is macro that enable passing variable list of external jar files to ApkBuilder
|
|
Example of use:
|
|
<package-helper>
|
|
<extra-jars>
|
|
<jarfolder path="my_jars" />
|
|
<jarfile path="foo/bar.jar" />
|
|
<jarfolder path="your_jars" />
|
|
</extra-jars>
|
|
</package-helper> -->
|
|
<macrodef name="package-helper">
|
|
<attribute name="sign.package" />
|
|
<element name="extra-jars" optional="yes" />
|
|
<sequential>
|
|
<apkbuilder
|
|
outfolder="${out.absolute.dir}"
|
|
basename="${ant.project.name}"
|
|
signed="@{sign.package}"
|
|
verbose="true">
|
|
<file path="${intermediate.dex.file}" />
|
|
<sourcefolder path="${source.absolute.dir}" />
|
|
<nativefolder path="${native.libs.absolute.dir}" />
|
|
<jarfolder path="${external.libs.absolute.dir}" />
|
|
<extra-jars/>
|
|
</apkbuilder>
|
|
</sequential>
|
|
</macrodef>
|
|
|
|
<!-- This is macro used only for sharing code among two targets, -debug and
|
|
-debug-with-emma which do exactly the same but differ in dependencies -->
|
|
<macrodef name="debug-helper">
|
|
<sequential>
|
|
<echo>Running zip align on final apk...</echo>
|
|
<exec executable="${zipalign}" failonerror="true">
|
|
<arg value="-f" />
|
|
<arg value="4" />
|
|
<arg path="${out.debug.unaligned.package}" />
|
|
<arg path="${out.debug.package}" />
|
|
</exec>
|
|
<echo>Debug Package: ${out.debug.package}</echo>
|
|
</sequential>
|
|
</macrodef>
|
|
|
|
<!-- This is macro used only for sharing code among two targets, -install and
|
|
-install-with-emma which do exactly the same but differ in dependencies -->
|
|
<macrodef name="install-helper">
|
|
<sequential>
|
|
<echo>Installing ${out.debug.package} onto default emulator or device...</echo>
|
|
<exec executable="${adb}" failonerror="true">
|
|
<arg value="install" />
|
|
<arg value="-r" />
|
|
<arg path="${out.debug.package}" />
|
|
</exec>
|
|
</sequential>
|
|
</macrodef>
|
|
|
|
<!-- Rules -->
|
|
|
|
<!-- Creates the output directories if they don't exist yet. -->
|
|
<target name="-dirs">
|
|
<echo>Creating output directories if needed...</echo>
|
|
<mkdir dir="${resource.absolute.dir}" />
|
|
<mkdir dir="${external.libs.absolute.dir}" />
|
|
<mkdir dir="${gen.absolute.dir}" />
|
|
<mkdir dir="${out.absolute.dir}" />
|
|
<mkdir dir="${out.classes.absolute.dir}" />
|
|
</target>
|
|
|
|
<!-- Generates the R.java file for this project's resources. -->
|
|
<target name="-resource-src" depends="-dirs">
|
|
<echo>Generating R.java / Manifest.java from the resources...</echo>
|
|
<exec executable="${aapt}" failonerror="true">
|
|
<arg value="package" />
|
|
<arg value="-m" />
|
|
<arg value="-J" />
|
|
<arg path="${gen.absolute.dir}" />
|
|
<arg value="-M" />
|
|
<arg path="AndroidManifest.xml" />
|
|
<arg value="-S" />
|
|
<arg path="${resource.absolute.dir}" />
|
|
<arg value="-I" />
|
|
<arg path="${android.jar}" />
|
|
</exec>
|
|
</target>
|
|
|
|
<!-- Generates java classes from .aidl files. -->
|
|
<target name="-aidl" depends="-dirs">
|
|
<echo>Compiling aidl files into Java classes...</echo>
|
|
<apply executable="${aidl}" failonerror="true">
|
|
<arg value="-p${android.aidl}" />
|
|
<arg value="-I${source.absolute.dir}" />
|
|
<arg value="-o${gen.absolute.dir}" />
|
|
<fileset dir="${source.absolute.dir}">
|
|
<include name="**/*.aidl" />
|
|
</fileset>
|
|
</apply>
|
|
</target>
|
|
|
|
<!-- Compiles this project's .java files into .class files. -->
|
|
<target name="compile" depends="-resource-src, -aidl"
|
|
description="Compiles project's .java files into .class files">
|
|
<!-- Allows to inject additional classpath from another (build|property) file.
|
|
As ant properties are immutable, the injected value will have priority
|
|
over the one defined below -->
|
|
<property name="extensible.classpath" value="." />
|
|
<javac encoding="ascii" target="1.5" debug="true" extdirs=""
|
|
destdir="${out.classes.absolute.dir}"
|
|
bootclasspathref="android.target.classpath"
|
|
verbose="false" classpath="${extensible.classpath}">
|
|
<src path="${source.absolute.dir}" />
|
|
<src path="${gen.absolute.dir}" />
|
|
<classpath>
|
|
<fileset dir="${external.libs.absolute.dir}" includes="*.jar" />
|
|
</classpath>
|
|
</javac>
|
|
</target>
|
|
|
|
<!-- Converts this project's .class files into .dex files -->
|
|
<target name="-dex" depends="compile">
|
|
<dex-helper />
|
|
</target>
|
|
|
|
<!-- Puts the project's resources into the output package file
|
|
This actually can create multiple resource package in case
|
|
Some custom apk with specific configuration have been
|
|
declared in default.properties.
|
|
-->
|
|
<target name="-package-resources">
|
|
<echo>Packaging resources</echo>
|
|
<aaptexec executable="${aapt}"
|
|
command="package"
|
|
manifest="AndroidManifest.xml"
|
|
resources="${resource.absolute.dir}"
|
|
assets="${asset.absolute.dir}"
|
|
androidjar="${android.jar}"
|
|
outfolder="${out.absolute.dir}"
|
|
basename="${ant.project.name}" />
|
|
</target>
|
|
|
|
<!-- Packages the application and sign it with a debug key. -->
|
|
<target name="-package-debug-sign" depends="-dex, -package-resources">
|
|
<package-helper sign.package="true" />
|
|
</target>
|
|
|
|
<!-- Packages the application without signing it. -->
|
|
<target name="-package-no-sign" depends="-dex, -package-resources">
|
|
<package-helper sign.package="false" />
|
|
</target>
|
|
|
|
<!-- Builds debug output package, provided all the necessary files are already dexed -->
|
|
<target name="debug" depends="-package-debug-sign"
|
|
description="Builds the application and signs it with a debug key.">
|
|
<debug-helper />
|
|
</target>
|
|
|
|
<target name="-release-check">
|
|
<condition property="release.sign">
|
|
<and>
|
|
<isset property="key.store" />
|
|
<isset property="key.alias" />
|
|
</and>
|
|
</condition>
|
|
</target>
|
|
|
|
<target name="-release-nosign" depends="-release-check" unless="release.sign">
|
|
<echo>No key.store and key.alias properties found in build.properties.</echo>
|
|
<echo>Please sign ${out.unsigned.package} manually</echo>
|
|
<echo>and run zipalign from the Android SDK tools.</echo>
|
|
</target>
|
|
|
|
<target name="release" depends="-package-no-sign, -release-nosign" if="release.sign"
|
|
description="Builds the application. The generated apk file must be signed before
|
|
it is published.">
|
|
<!-- Gets passwords -->
|
|
<input
|
|
message="Please enter keystore password (store:${key.store}):"
|
|
addproperty="key.store.password" />
|
|
<input
|
|
message="Please enter password for alias '${key.alias}':"
|
|
addproperty="key.alias.password" />
|
|
|
|
<!-- Signs the APK -->
|
|
<echo>Signing final apk...</echo>
|
|
<signjar
|
|
jar="${out.unsigned.package}"
|
|
signedjar="${out.unaligned.package}"
|
|
keystore="${key.store}"
|
|
storepass="${key.store.password}"
|
|
alias="${key.alias}"
|
|
keypass="${key.alias.password}" />
|
|
|
|
<!-- Zip aligns the APK -->
|
|
<echo>Running zip align on final apk...</echo>
|
|
<exec executable="${zipalign}" failonerror="true">
|
|
<arg value="-f" />
|
|
<arg value="4" />
|
|
<arg path="${out.unaligned.package}" />
|
|
<arg path="${out.release.package}" />
|
|
</exec>
|
|
<echo>Release Package: ${out.release.package}</echo>
|
|
</target>
|
|
|
|
<target name="install" depends="debug"
|
|
description="Installs/reinstalls the debug package onto a running
|
|
emulator or device. If the application was previously installed,
|
|
the signatures must match." >
|
|
<install-helper />
|
|
</target>
|
|
|
|
<target name="-uninstall-check">
|
|
<condition property="uninstall.run">
|
|
<isset property="application.package" />
|
|
</condition>
|
|
</target>
|
|
|
|
<target name="-uninstall-error" depends="-uninstall-check" unless="uninstall.run">
|
|
<echo>Unable to run 'ant uninstall', application.package is not defined in build.properties
|
|
</echo>
|
|
</target>
|
|
|
|
<!-- Uninstalls the package from the default emulator/device -->
|
|
<target name="uninstall" depends="-uninstall-error" if="uninstall.run"
|
|
description="Uninstalls the application from a running emulator or device.">
|
|
<echo>Uninstalling ${application.package} from the default emulator or device...</echo>
|
|
<exec executable="${adb}" failonerror="true">
|
|
<arg value="uninstall" />
|
|
<arg value="${application.package}" />
|
|
</exec>
|
|
</target>
|
|
|
|
<target name="clean" description="Removes output files created by other targets.">
|
|
<delete dir="${out.absolute.dir}" />
|
|
<delete dir="${gen.absolute.dir}" />
|
|
</target>
|
|
|
|
<!-- Targets for code-coverage measurement purposes, invoked from external file -->
|
|
|
|
<!-- Emma-instruments tested project classes (compiles the tested project if necessary)
|
|
and writes instrumented classes to ${instrumentation.absolute.dir}/classes -->
|
|
<target name="-emma-instrument" depends="compile">
|
|
<echo>Instrumenting classes from ${out.absolute.dir}/classes...</echo>
|
|
<!-- It only instruments class files, not any external libs -->
|
|
<emma enabled="true">
|
|
<instr verbosity="verbose"
|
|
mode="overwrite"
|
|
instrpath="${out.absolute.dir}/classes"
|
|
outdir="${out.absolute.dir}/classes">
|
|
</instr>
|
|
<!-- TODO: exclusion filters on R*.class and allowing custom exclusion from
|
|
user defined file -->
|
|
</emma>
|
|
</target>
|
|
|
|
<target name="-dex-instrumented" depends="-emma-instrument">
|
|
<dex-helper>
|
|
<external-libs>
|
|
<fileset file="${emma.dir}/emma_device.jar" />
|
|
</external-libs>
|
|
</dex-helper>
|
|
</target>
|
|
|
|
<!-- Invoked from external files for code coverage purposes -->
|
|
<target name="-package-with-emma" depends="-dex-instrumented, -package-resources">
|
|
<package-helper sign.package="true">
|
|
<extra-jars>
|
|
<!-- Injected from external file -->
|
|
<jarfile path="${emma.dir}/emma_device.jar" />
|
|
</extra-jars>
|
|
</package-helper>
|
|
</target>
|
|
|
|
<target name="-debug-with-emma" depends="-package-with-emma">
|
|
<debug-helper />
|
|
</target>
|
|
|
|
<target name="-install-with-emma" depends="-debug-with-emma">
|
|
<install-helper />
|
|
</target>
|
|
|
|
<!-- End of targets for code-coverage measurement purposes -->
|
|
|
|
<target name="help">
|
|
<!-- displays starts at col 13
|
|
|13 80| -->
|
|
<echo>Android Ant Build. Available targets:</echo>
|
|
<echo> help: Displays this help.</echo>
|
|
<echo> clean: Removes output files created by other targets.</echo>
|
|
<echo> compile: Compiles project's .java files into .class files.</echo>
|
|
<echo> debug: Builds the application and signs it with a debug key.</echo>
|
|
<echo> release: Builds the application. The generated apk file must be</echo>
|
|
<echo> signed before it is published.</echo>
|
|
<echo> install: Installs/reinstalls the debug package onto a running</echo>
|
|
<echo> emulator or device.</echo>
|
|
<echo> If the application was previously installed, the</echo>
|
|
<echo> signatures must match.</echo>
|
|
<echo> uninstall: Uninstalls the application from a running emulator or</echo>
|
|
<echo> device.</echo>
|
|
</target>
|
|
</project>
|