Skip to content

Commit

Permalink
Added working build system for Android.
Browse files Browse the repository at this point in the history
  • Loading branch information
freakboy3742 committed Oct 7, 2015
1 parent f07cad6 commit faeea8d
Show file tree
Hide file tree
Showing 12 changed files with 308 additions and 38 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
dist
build
local
local.properties
distribute-*
tests/temp
org
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ python:
- "3.4"
install:
- "pip install ."
- "ant"
- "ant java"
script:
- "python setup.py test"
15 changes: 15 additions & 0 deletions AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="org.python"
android:versionCode="1"
android:versionName="1.0">
<application android:label="@string/app_name" android:icon="@drawable/ic_launcher">
<activity android:name="ACTIVITY_ENTRY_NAME"
android:label="@string/app_name">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
</application>
</manifest>
30 changes: 26 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,18 +65,40 @@ run on any Java 1.7+ VM.

Next step - you need to compile the Python support libraries:

$ ant
$ ant java

This will create a `dist` directory that contains `python.jar`. You will need to
make sure that this `python.jar` support file is in your classpath::
This will create a `dist` directory that contains `python-java.jar`.

$ java -XX:-UseSplitVerifier -classpath dist/python.jar:. python.example
You can then run the example.class that was generated, ensuring that
the `python-java.jar` support file is in your classpath::

$ java -XX:-UseSplitVerifier -classpath dist/python-java.jar:. python.example
Hello, World

The ``-CC:-UseSplitVerifier`` argument is necessary to turn off stack map
verification in Java 7. This could be addressed by computing stack maps
for generated code.

Android
~~~~~~~

To compile for Android, you'll need to `download the Android SDK`_. You only
need the standalone SDK (see "Other install options") - you don't have to
download the fully Android Studio if you don't want to.

Once you've downloaded and installed the SDK, create a `local.properties`
in the top level `voc` project directory, containing a single line::

sdk.dir=<path to SDK>/sdk

You can then run `ant` to compile `dist/python-android.jar`::

$ ant android

You can then add `dist/python-android.jar` to your Android project.

.. _download the Android SDK: https://developer.android.com/sdk/index.html

Documentation
-------------

Expand Down
17 changes: 17 additions & 0 deletions ant.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# This file is used to override default values used by the Ant build system.
#
# This file must be checked into Version Control Systems, as it is
# integral to the build system of your project.

# This file is only used by the Ant script.

# You can use this to override default values such as
# 'source.dir' for the location of your java source folder and
# 'out.dir' for the location of your output folder.

# You can also use it define how the release builds are signed by declaring
# the following properties:
# 'key.store' for the location of your keystore and
# 'key.alias' for the name of the key to use.
# The password will be asked during the build when you use the 'release' target.

181 changes: 181 additions & 0 deletions build-android.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
<?xml version="1.0" encoding="UTF-8"?>
<project name="python" default="dist">

<!-- The local.properties file is created and updated by the 'android' tool.
It contains the path to the SDK. It should *NOT* be checked into
Version Control Systems. -->
<property file="local.properties" />
<!-- The ant.properties file can be created by you. It is only edited by the
'android' tool to add properties to it.
This is the place to change some Ant specific build properties.
Here are some properties you may want to change/update:
source.dir
The name of the source directory. Default is 'src'.
out.dir
The name of the output directory. Default is 'bin'.
For other overridable properties, look at the beginning of the rules
files in the SDK, at tools/ant/build.xml
Properties related to the SDK location or the project target should
be updated using the 'android' tool with the 'update' action.
This file is an integral part of the build system for your
application and should be checked into Version Control Systems.
-->
<property file="ant.properties" />

<!-- if sdk.dir was not set from one of the property file, then
get it from the ANDROID_HOME env var.
This must be done before we load project.properties since
the proguard config can use sdk.dir -->
<property environment="env" />
<condition property="sdk.dir" value="${env.ANDROID_HOME}">
<isset property="env.ANDROID_HOME" />
</condition>

<!-- The project.properties file is created and updated by the 'android'
tool, as well as ADT.
This contains project specific properties such as project target, and library
dependencies. Lower level build properties are stored in ant.properties
(or in .classpath for Eclipse projects).
This file is an integral part of the build system for your
application and should be checked into Version Control Systems. -->
<loadproperties srcFile="project.properties" />

<property name="out.jar.name" value="python-android" />
<property name="source.absolute.dir" location="${source.dir}/common" />
<property name="platform.absolute.dir" location="${source.dir}/android" />

<!-- quick check on sdk.dir -->
<fail
message="sdk.dir is missing. Make sure to generate local.properties using 'android update project' or to inject it through the ANDROID_HOME environment variable."
unless="sdk.dir"
/>

<!-- Compiles this project's .java files into .class files.
This is a copy of the content from sdk/tools/ant/build.xml, removing
the -code-gen dependency, adding support for multiple source directories,
and allowing for a customized jarfile name. -->
<target name="-compile" depends="-pre-build, -build-setup, -pre-compile">
<do-only-if-manifest-hasCode elseText="hasCode = false. Skipping...">
<!-- merge the project's own classpath and the tested project's classpath -->
<path id="project.javac.classpath">
<path refid="project.all.jars.path" />
<path refid="tested.project.classpath" />
<path path="${java.compiler.classpath}" />
</path>
<javac encoding="${java.encoding}"
source="${java.source}" target="${java.target}"
debug="true" extdirs="" includeantruntime="false"
destdir="${out.classes.absolute.dir}"
bootclasspathref="project.target.class.path"
verbose="${verbose}"
classpathref="project.javac.classpath"
fork="${need.javac.fork}">
<src path="${source.absolute.dir}" />
<src path="${platform.absolute.dir}" />
<src path="${gen.absolute.dir}" />
<compilerarg line="${java.compilerargs}" />
</javac>

<!-- if the project is instrumented, intrument the classes -->
<if condition="${build.is.instrumented}">
<then>
<echo level="info">Instrumenting classes from ${out.absolute.dir}/classes...</echo>

<!-- build the filter to remove R, Manifest, BuildConfig -->
<getemmafilter
appPackage="${project.app.package}"
libraryPackagesRefId="project.library.packages"
filterOut="emma.default.filter"/>

<!-- define where the .em file is going. This may have been
setup already if this is a library -->
<property name="emma.coverage.absolute.file" location="${out.absolute.dir}/coverage.em" />

<!-- It only instruments class files, not any external libs -->
<emma enabled="true">
<instr verbosity="${verbosity}"
mode="overwrite"
instrpath="${out.absolute.dir}/classes"
outdir="${out.absolute.dir}/classes"
metadatafile="${emma.coverage.absolute.file}">
<filter excludes="${emma.default.filter}" />
<filter value="${emma.filter}" />
</instr>
</emma>
</then>
</if>

<!-- if the project is a library then we generate a jar file -->
<if condition="${project.is.library}">
<then>
<echo level="info">Creating library output jar file...</echo>
<property name="out.library.jar.file" location="${out.absolute.dir}/${out.jar.name}.jar" />
<if>
<condition>
<length string="${android.package.excludes}" trim="true" when="greater" length="0" />
</condition>
<then>
<echo level="info">Custom jar packaging exclusion: ${android.package.excludes}</echo>
</then>
</if>

<propertybyreplace name="project.app.package.path" input="${project.app.package}" replace="." with="/" />

<jar destfile="${out.library.jar.file}">
<fileset dir="${out.classes.absolute.dir}"
includes="**/*.class"
excludes="${project.app.package.path}/R.class ${project.app.package.path}/R$*.class ${project.app.package.path}/BuildConfig.class"/>
<fileset dir="${source.absolute.dir}" excludes="**/*.java ${android.package.excludes}" />
</jar>
</then>
</if>

</do-only-if-manifest-hasCode>
</target>

<target name="dist" depends="-compile, -post-compile, -obfuscate" />

<!--
Import per project custom build rules if present at the root of the project.
This is the place to put custom intermediary targets such as:
-pre-build
-pre-compile
-post-compile (This is typically used for code obfuscation.
Compiled code location: ${out.classes.absolute.dir}
If this is not done in place, override ${out.dex.input.absolute.dir})
-post-package
-post-build
-pre-clean
-->
<import file="custom_rules.xml" optional="true" />

<!-- Import the actual build file.
To customize existing targets, there are two options:
- Customize only one target:
- copy/paste the target into this file, *before* the
<import> task.
- customize it to your needs.
- Customize the whole content of build.xml
- copy/paste the content of the rules files (minus the top node)
into this file, replacing the <import> task.
- customize to your needs.
***********************
****** IMPORTANT ******
***********************
In all cases you must update the value of version-tag below to read 'custom' instead of an integer,
in order to avoid having your file be overridden by tools such as "android update project"
-->
<!-- version-tag: 1 -->
<import file="${sdk.dir}/tools/ant/build.xml" />

</project>
29 changes: 29 additions & 0 deletions build-java.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<project name="python" default="dist" basedir=".">
<description>
Build Python support libraries for voc
</description>

<!-- set global properties for this build -->
<property name="src" location="python"/>
<property name="build" location="build"/>
<property name="dist" location="dist"/>

<target name="compile" description="Compile the Oracle-specific source">
<mkdir dir="${build}/java"/>
<javac includeantruntime="false" destdir="${build}/java">
<src path="${src}/common" />
<src path="${src}/java" />
</javac>
</target>

<target name="dist" depends="compile" description="Generate Oracle jar file">
<mkdir dir="${dist}"/>

<jar jarfile="${dist}/python-java.jar" basedir="${build}/java"/>
</target>

<target name="clean" description="Clean up">
<delete dir="${build}"/>
<delete dir="${dist}"/>
</target>
</project>
36 changes: 7 additions & 29 deletions build.xml
Original file line number Diff line number Diff line change
@@ -1,44 +1,22 @@
<project name="MyProject" default="dist" basedir=".">
<project name="python" default="all" basedir=".">
<description>
Build Python support libraries for voc
</description>

<!-- set global properties for this build -->
<property name="src" location="python"/>
<property name="build" location="build"/>
<property name="dist" location="dist"/>

<target name="compile-android" description="Compile the Android-specific source">
<mkdir dir="${build}/android"/>
<javac includeantruntime="false" destdir="${build}/android">
<src path="${src}/common" />
<src path="${src}/android" />
</javac>
<target name="java">
<ant antfile="build-java.xml" target="dist"/>
</target>

<target name="compile-oracle" description="Compile the Oracle-specific source">
<mkdir dir="${build}/oracle"/>
<javac includeantruntime="false" destdir="${build}/oracle">
<src path="${src}/common" />
<src path="${src}/oracle" />
</javac>
<target name="android">
<ant antfile="build-android.xml" target="dist"/>
</target>

<target name="dist-android" depends="compile-android" description="Generate Android jar file">
<mkdir dir="${dist}"/>
<target name="all" depends="java, android" />

<jar jarfile="${dist}/python-android.jar" basedir="${build}/android"/>
</target>

<target name="dist-oracle" depends="compile-oracle" description="Generate Oracle jar file">
<mkdir dir="${dist}"/>

<jar jarfile="${dist}/python.jar" basedir="${build}/oracle"/>
</target>

<target name="dist" depends="dist-android,dist-oracle" description="Generate all jar files"/>

<target name="clean" description="clean up">
<target name="clean" description="Clean up">
<delete dir="${build}"/>
<delete dir="${dist}"/>
</target>
Expand Down
27 changes: 27 additions & 0 deletions project.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# This file is automatically generated by Android Tools.
# Do not modify this file -- YOUR CHANGES WILL BE ERASED!
#
# This file must be checked in Version Control Systems.
#
# To customize properties used by the Ant build system edit
# "ant.properties", and override values to adapt the script to your
# project structure.
#
# To enable ProGuard to shrink and obfuscate your code, uncomment this (available properties: sdk.dir, user.home):
#proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project.txt

android.library=true
# Project target.
target=android-14
source.dir=python
out.dir=dist
out.classes.absolute.dir=build/android
# Nasty hack - we don't want all these cruft directories to be created,
# so set them to a directory that we know *will* be created.
resource.absolute.dir=build
gen.absolute.dir=build
out.res.absolute.dir=build
out.rs.obj.absolute.dir=build
out.rs.libs.absolute.dir=build
out.aidl.absolute.dir=build
out.dexed.absolute.dir=build
2 changes: 1 addition & 1 deletion python/common/python/platform.java
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ public class platform extends org.python.types.Module {
java.lang.Class platform_class;

if (vendor.equals("Oracle Corporation")) {
platform_class_name = "python.OraclePlatform";
platform_class_name = "python.JavaPlatform";
} else if (vendor.equals("The Android Project")) {
platform_class_name = "python.AndroidPlatform";
} else {
Expand Down
Loading

0 comments on commit faeea8d

Please sign in to comment.