WIP: Add SDL3 bootstrap

Author: misl6

pythonforandroid/bootstrap.py

@@ -39,7 +39,7 @@ def copy_files(src_root, dest_root, override=True, symlink=False):
 
 
 default_recipe_priorities = [
-    "webview", "sdl2", "service_only"  # last is highest
+    "webview", "sdl2", "sdl3", "service_only"  # last is highest
 ]
 # ^^ NOTE: these are just the default priorities if no special rules
 # apply (which you can find in the code below), so basically if no
@@ -150,18 +150,18 @@ def get_bootstrap_dirs(self):
         return bootstrap_dirs
 
     def _copy_in_final_files(self):
-        if self.name == "sdl2":
-            # Get the paths for copying SDL2's java source code:
-            sdl2_recipe = Recipe.get_recipe("sdl2", self.ctx)
-            sdl2_build_dir = sdl2_recipe.get_jni_dir()
-            src_dir = join(sdl2_build_dir, "SDL", "android-project",
+        if self.name in ["sdl2", "sdl3"]:
+            # Get the paths for copying SDL's java source code:
+            sdl_recipe = Recipe.get_recipe(self.name, self.ctx)
+            sdl_build_dir = sdl_recipe.get_jni_dir()
+            src_dir = join(sdl_build_dir, "SDL", "android-project",
                            "app", "src", "main", "java",
                            "org", "libsdl", "app")
             target_dir = join(self.dist_dir, 'src', 'main', 'java', 'org',
                               'libsdl', 'app')
 
             # Do actual copying:
-            info('Copying in SDL2 .java files from: ' + str(src_dir))
+            info('Copying in SDL .java files from: ' + str(src_dir))
             if not os.path.exists(target_dir):
                 os.makedirs(target_dir)
             copy_files(src_dir, target_dir, override=True)
@@ -272,6 +272,13 @@ def have_dependency_in_recipes(dep):
             info('Using sdl2 bootstrap since it is in dependencies')
             return cls.get_bootstrap("sdl2", ctx)
 
+        # Special rule: return SDL3 bootstrap if there's an sdl3 dep:
+        if (have_dependency_in_recipes("sdl3") and
+                "sdl3" in [b.name for b in acceptable_bootstraps]
+                ):
+            info('Using sdl3 bootstrap since it is in dependencies')
+            return cls.get_bootstrap("sdl3", ctx)
+
         # Special rule: return "webview" if we depend on common web recipe:
         for possible_web_dep in known_web_packages:
             if have_dependency_in_recipes(possible_web_dep):

pythonforandroid/bootstraps/common/build/build.py

@@ -78,12 +78,12 @@ def get_bootstrap_name():
     _bootstrap_name = get_bootstrap_name()
 else:
     PYTHON = "python3"
-    _bootstrap_name = "sdl2"
+    _bootstrap_name = "sdl3"
 
 if PYTHON is not None and not exists(PYTHON):
     PYTHON = None
 
-if _bootstrap_name in ('sdl2', 'webview', 'service_only', 'qt'):
+if _bootstrap_name in ('sdl2', 'sdl3', 'webview', 'service_only', 'qt'):
     WHITELIST_PATTERNS.append('pyconfig.h')
 
 environment = jinja2.Environment(loader=jinja2.FileSystemLoader(
@@ -541,7 +541,7 @@ def make_package(args):
         "debug": "debug" in args.build_mode,
         "native_services": args.native_services
     }
-    if get_bootstrap_name() == "sdl2":
+    if get_bootstrap_name() in ["sdl2", "sdl3"]:
         render_args["url_scheme"] = url_scheme
 
     render(
@@ -596,7 +596,7 @@ def make_package(args):
         "args": args,
         "private_version": hashlib.sha1(private_version.encode()).hexdigest()
     }
-    if get_bootstrap_name() == "sdl2":
+    if get_bootstrap_name() in ["sdl2", "sdl3"]:
         render_args["url_scheme"] = url_scheme
     render(
         'strings.tmpl.xml',
@@ -769,7 +769,7 @@ def create_argument_parser():
     ap.add_argument('--private', dest='private',
                     help='the directory with the app source code files' +
                          ' (containing your main.py entrypoint)',
-                    required=(get_bootstrap_name() != "sdl2"))
+                    required=(get_bootstrap_name() not in ["sdl2", "sdl3"]))
     ap.add_argument('--package', dest='package',
                     help=('The name of the java package the project will be'
                           ' packaged under.'),
@@ -787,7 +787,7 @@ def create_argument_parser():
                           'same number of groups of numbers as previous '
                           'versions.'),
                     required=True)
-    if get_bootstrap_name() == "sdl2":
+    if get_bootstrap_name() in ["sdl2", "sdl3"]:
         ap.add_argument('--launcher', dest='launcher', action='store_true',
                         help=('Provide this argument to build a multi-app '
                               'launcher, rather than a single app.'))
@@ -1044,7 +1044,7 @@ def _read_configuration():
         args.orientation, args.manifest_orientation
     )
 
-    if get_bootstrap_name() == "sdl2":
+    if get_bootstrap_name() in ["sdl2", "sdl3"]:
         args.sdl_orientation_hint = get_sdl_orientation_hint(args.orientation)
 
     if args.res_xmls and isinstance(args.res_xmls[0], list):
@@ -1074,9 +1074,9 @@ def _read_configuration():
         WHITELIST_PATTERNS += patterns
 
     if args.private is None and \
-            get_bootstrap_name() == 'sdl2' and args.launcher is None:
+            get_bootstrap_name() in ['sdl2', 'sdl3'] and args.launcher is None:
         print('Need --private directory or ' +
-              '--launcher (SDL2 bootstrap only)' +
+              '--launcher (SDL2/SDL3 bootstrap only)' +
               'to have something to launch inside the .apk!')
         sys.exit(1)
     make_package(args)

pythonforandroid/bootstraps/common/build/jni/application/src/Android.mk

@@ -14,7 +14,7 @@ LOCAL_SRC_FILES := $(SDL_PATH)/src/main/android/SDL_android_main.c \
 
 LOCAL_CFLAGS += -I$(PYTHON_INCLUDE_ROOT) $(EXTRA_CFLAGS)
 
-LOCAL_SHARED_LIBRARIES := SDL2 python_shared
+LOCAL_SHARED_LIBRARIES := SDL3 python_shared
 
 LOCAL_LDLIBS := -lGLESv1_CM -lGLESv2 -llog $(EXTRA_LDLIBS)
 

pythonforandroid/bootstraps/common/build/src/main/java/org/kivy/android/PythonUtil.java

@@ -49,6 +49,10 @@ protected static ArrayList<String> getLibraries(File libsDir) {
         addLibraryIfExists(libsList, "SDL2_image", libsDir);
         addLibraryIfExists(libsList, "SDL2_mixer", libsDir);
         addLibraryIfExists(libsList, "SDL2_ttf", libsDir);
+        addLibraryIfExists(libsList, "SDL3", libsDir);
+        addLibraryIfExists(libsList, "SDL3_image", libsDir);
+        addLibraryIfExists(libsList, "SDL3_mixer", libsDir);
+        addLibraryIfExists(libsList, "SDL3_ttf", libsDir);
         libsList.add("python3.5m");
         libsList.add("python3.6m");
         libsList.add("python3.7m");

pythonforandroid/bootstraps/common/build/templates/gradle.tmpl.properties

@@ -6,4 +6,5 @@ org.gradle.jvmargs=-Xmx2500m -XX:MaxMetaspaceSize=512m -XX:+HeapDumpOnOutOfMemor
 {% if args.enable_androidx %}
 android.useAndroidX=true
 android.enableJetifier=true
-{% endif %}
+{% endif %}
+org.gradle.jvmargs=-Xmx4608m

pythonforandroid/bootstraps/sdl3/__init__.py

@@ -0,0 +1,54 @@
+from os.path import join
+
+import sh
+
+from pythonforandroid.toolchain import (
+    Bootstrap, shprint, current_directory, info, info_main)
+from pythonforandroid.util import ensure_dir, rmdir
+
+
+class SDL3GradleBootstrap(Bootstrap):
+    name = 'sdl3'
+
+    recipe_depends = list(
+        set(Bootstrap.recipe_depends).union({'sdl3'})
+    )
+
+    def assemble_distribution(self):
+        info_main("# Creating Android project ({})".format(self.name))
+
+        rmdir(self.dist_dir)
+        info("Copying SDL3/gradle build")
+        shprint(sh.cp, "-r", self.build_dir, self.dist_dir)
+
+        # either the build use environment variable (ANDROID_HOME)
+        # or the local.properties if exists
+        with current_directory(self.dist_dir):
+            with open('local.properties', 'w') as fileh:
+                fileh.write('sdk.dir={}'.format(self.ctx.sdk_dir))
+
+        with current_directory(self.dist_dir):
+            info("Copying Python distribution")
+
+            self.distribute_javaclasses(self.ctx.javaclass_dir,
+                                        dest_dir=join("src", "main", "java"))
+
+            for arch in self.ctx.archs:
+                python_bundle_dir = join(f'_python_bundle__{arch.arch}', '_python_bundle')
+                ensure_dir(python_bundle_dir)
+
+                self.distribute_libs(arch, [self.ctx.get_libs_dir(arch.arch)])
+                site_packages_dir = self.ctx.python_recipe.create_python_bundle(
+                    join(self.dist_dir, python_bundle_dir), arch)
+                if not self.ctx.with_debug_symbols:
+                    self.strip_libraries(arch)
+                self.fry_eggs(site_packages_dir)
+
+            if 'sqlite3' not in self.ctx.recipe_build_order:
+                with open('blacklist.txt', 'a') as fileh:
+                    fileh.write('\nsqlite3/*\nlib-dynload/_sqlite3.so\n')
+
+        super().assemble_distribution()
+
+
+bootstrap = SDL3GradleBootstrap()

pythonforandroid/bootstraps/sdl3/build/.gitignore

@@ -0,0 +1,14 @@
+.gradle
+/build/
+
+# Ignore Gradle GUI config
+gradle-app.setting
+
+# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
+!gradle-wrapper.jar
+
+# Cache of project
+.gradletasknamecache
+
+# # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
+# gradle/wrapper/gradle-wrapper.properties

pythonforandroid/bootstraps/sdl3/build/blacklist.txt

@@ -0,0 +1,84 @@
+# prevent user to include invalid extensions
+*.apk
+*.aab
+*.apks
+*.pxd
+
+# eggs
+*.egg-info
+
+# unit test
+unittest/*
+
+# python config
+config/makesetup
+
+# unused kivy files (platform specific)
+kivy/input/providers/wm_*
+kivy/input/providers/mactouch*
+kivy/input/providers/probesysfs*
+kivy/input/providers/mtdev*
+kivy/input/providers/hidinput*
+kivy/core/camera/camera_videocapture*
+kivy/core/spelling/*osx*
+kivy/core/video/video_pyglet*
+kivy/tools
+kivy/tests/*
+kivy/*/*.h
+kivy/*/*.pxi
+
+# unused encodings
+lib-dynload/*codec*
+encodings/cp*.pyo
+encodings/tis*
+encodings/shift*
+encodings/bz2*
+encodings/iso*
+encodings/undefined*
+encodings/johab*
+encodings/p*
+encodings/m*
+encodings/euc*
+encodings/k*
+encodings/unicode_internal*
+encodings/quo*
+encodings/gb*
+encodings/big5*
+encodings/hp*
+encodings/hz*
+
+# unused python modules
+bsddb/*
+wsgiref/*
+hotshot/*
+pydoc_data/*
+tty.pyo
+anydbm.pyo
+nturl2path.pyo
+LICENCE.txt
+macurl2path.pyo
+dummy_threading.pyo
+audiodev.pyo
+antigravity.pyo
+dumbdbm.pyo
+sndhdr.pyo
+__phello__.foo.pyo
+sunaudio.pyo
+os2emxpath.pyo
+multiprocessing/dummy*
+
+# unused binaries python modules
+lib-dynload/termios.so
+lib-dynload/_lsprof.so
+lib-dynload/*audioop.so
+lib-dynload/_hotshot.so
+lib-dynload/_heapq.so
+lib-dynload/_json.so
+lib-dynload/grp.so
+lib-dynload/resource.so
+lib-dynload/pyexpat.so
+lib-dynload/_ctypes_test.so
+lib-dynload/_testcapi.so
+
+# odd files
+plat-linux3/regen

pythonforandroid/bootstraps/sdl3/build/jni/Application.mk

@@ -0,0 +1,8 @@
+
+# Uncomment this if you're using STL in your project
+# See CPLUSPLUS-SUPPORT.html in the NDK documentation for more information
+# APP_STL := stlport_static 
+
+# APP_ABI := armeabi armeabi-v7a x86
+APP_ABI := $(ARCH)
+APP_PLATFORM := $(NDK_API)

pythonforandroid/bootstraps/sdl3/build/jni/application/src/Android_static.mk

@@ -0,0 +1,12 @@
+LOCAL_PATH := $(call my-dir)
+
+include $(CLEAR_VARS)
+
+LOCAL_MODULE := main
+
+LOCAL_SRC_FILES := start.c
+
+LOCAL_STATIC_LIBRARIES := SDL3_static
+
+include $(BUILD_SHARED_LIBRARY)
+$(call import-module,SDL)LOCAL_PATH := $(call my-dir)