Skip to content

Commit

Permalink
Build CoreKiwix.xcframework
Browse files Browse the repository at this point in the history
CoreKiwix.xcframework is the packaging format required by Kiwix apple (macOS/iOS) reader for libkiwix.
Naming will hopefully be revisited later (libkiwix.xcframework?)

This folder is a combination of all static archive (*.a): dependencies and libkiwix itself
for all apple-supported platforms: macOS x86_64, macOS arm64, iOS arm64 and iOS x86_64.
It also includes the headers.
Note: while iOS archs are separated in the framework, the macOS archs are bundled as a fat binary.

This thus adds:

- A new `apple_all_static` target that lists mentioned sub-platforms.
- A new `AppleXCFramework` virtual dependency and builder
  -  requires `libkiwix`
  - merges the archives into one per target
  - creates the fat binary for macOS
  - creates the xcframework
- `libkiwix_xcframework-VERSION.tar.gz` because platformname is xcframework
  - it only contains the xcframework but in libkiwix_xcframework-VERSION/lib folder
    Because with this virtual target, there are no other files
  - requires a new `xcframework` platform_name in builddef
- subplatforms deps and macOS/iOS _ok files to make_deps_archive

---

https://developer.apple.com/documentation/xcode/creating-a-multi-platform-binary-framework-bundle
  • Loading branch information
rgaudin committed Nov 15, 2023
1 parent 6cfbd0c commit a063b91
Show file tree
Hide file tree
Showing 6 changed files with 131 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/scripts/build_definition.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
| macos | macOS_arm64_static | | | BP | BP | | macos-arm64 |
| macos | macOS_arm64_mixed | BP | BP | | | | macos-arm64 |
| macos | macOS_x86_64 | B | B | | | | |
| macos | apple_all_static | | BP | | | | xcframework |
----------------------------------------------------------------------------------------------
| | flatpak | | | | | BP | |
| | native_static | d | d | dBPSD | dBPSD | | linux-x86_64 |
Expand Down
11 changes: 11 additions & 0 deletions .github/scripts/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

from build_definition import get_platform_name

from kiwixbuild.dependencies.apple_xcframework import AppleXCFramework
from kiwixbuild.versions import (
main_project_versions,
release_versions,
Expand Down Expand Up @@ -102,6 +103,7 @@ def major_version(version: str) -> str:
"libkiwix": (
INSTALL_DIR,
(
"lib/CoreKiwix.xcframework/",
"lib/*/libkiwix.so",
"lib/*/libkiwix.so.{version}".format(
version=main_project_versions["libkiwix"]
Expand Down Expand Up @@ -279,6 +281,13 @@ def make_deps_archive(target=None, name=None, full=False):
print_message("Create archive {}.", archive_name)
files_to_archive = list(filter_install_dir(INSTALL_DIR))
files_to_archive += HOME.glob("BUILD_*/LOGS")
if PLATFORM_TARGET == "apple_all_static":
for subplatform in AppleXCFramework.subPlatformNames:
base_dir = HOME / "BUILD_{}".format(subplatform)
files_to_archive += filter_install_dir(base_dir / "INSTALL")
if (base_dir / "meson_cross_file.txt").exists():
files_to_archive.append(base_dir / "meson_cross_file.txt")

if PLATFORM_TARGET.endswith("_mixed"):
static_platform = PLATFORM_TARGET.replace("_mixed", "_static")
files_to_archive += filter_install_dir(HOME / ("BUILD_" + static_platform) / "INSTALL")
Expand Down Expand Up @@ -309,6 +318,8 @@ def make_deps_archive(target=None, name=None, full=False):
files_to_archive += (HOME / "BUILD_native_dyn").glob("*/.*_ok")
files_to_archive += (HOME / "BUILD_native_static").glob("*/.*_ok")
files_to_archive += HOME.glob("BUILD_android*/**/.*_ok")
files_to_archive += HOME.glob("BUILD_macOS*/**/.*_ok")
files_to_archive += HOME.glob("BUILD_iOS*/**/.*_ok")
files_to_archive += SOURCE_DIR.glob("*/.*_ok")
files_to_archive += SOURCE_DIR.glob("zim-testing-suite-*/*")

Expand Down
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ jobs:
- macOS_arm64_static
- macOS_arm64_mixed
- macOS_x86_64
- apple_all_static
runs-on: macos-13
env:
SSH_KEY: /tmp/id_rsa
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/releaseNigthly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ jobs:
- native_mixed
- macOS_arm64_static
- macOS_arm64_mixed
- apple_all_static
runs-on: macos-13
env:
SSH_KEY: /tmp/id_rsa
Expand Down
101 changes: 101 additions & 0 deletions kiwixbuild/dependencies/apple_xcframework.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
import os
import shutil
from pathlib import Path

from kiwixbuild.platforms import PlatformInfo
from kiwixbuild.utils import pj, run_command
from .base import Dependency, NoopSource, Builder as BaseBuilder


class AppleXCFramework(Dependency):
name = "apple_xcframework"
subPlatformNames = ["macOS_x86_64", "macOS_arm64_static", "iOS_x86_64", "iOS_arm64"]
Source = NoopSource

class Builder(BaseBuilder):
@property
def all_subplatforms(self):
return self.buildEnv.platformInfo.subPlatformNames

@property
def macos_subplatforms(self):
return [
target for target in self.all_subplatforms if target.startswith("macOS")
]

@property
def ios_subplatforms(self):
return [
target for target in self.all_subplatforms if target.startswith("iOS")
]

@classmethod
def get_dependencies(cls, platfomInfo, alldeps):
return [
(target, "libkiwix") for target in AppleXCFramework.subPlatformNames
]

@property
def final_path(self):
return pj(self.buildEnv.install_dir, "lib", "CoreKiwix.xcframework")

def _remove_if_exists(self, context):
if not os.path.exists(self.final_path):
return

shutil.rmtree(self.final_path)

def _merge_libs(self, context):
"""create merged.a in all targets to bundle all static archives"""
xcf_libs = []
for target in self.all_subplatforms:
static_ars = []

plt = PlatformInfo.get_platform(target)
lib_dir = pj(plt.buildEnv.install_dir, "lib")
static_ars = [str(f) for f in Path(lib_dir).glob("*.a")]

# create merged.a from all *.a in install_dir/lib
command = "libtool -static -o merged.a "
command += " ".join(static_ars)
run_command(command, lib_dir, context)

# will be included in xcframework
if target in self.ios_subplatforms:
xcf_libs.append(pj(lib_dir, "merged.a"))

return xcf_libs

def _make_macos_fat(self, context):
"""create fat merged.a in fake macOS_fat install/lib with macOS archs"""
macos_libs = []
for target in self.macos_subplatforms:
plt = PlatformInfo.get_platform(target)
macos_libs.append(pj(plt.buildEnv.install_dir, "lib", "merged.a"))

fat_dir = pj(self.buildEnv.build_dir, "macOS_fat")
os.makedirs(fat_dir, exist_ok=True)

command = "lipo -create -output {fat_dir}/merged.a ".format(fat_dir=fat_dir)
command += " ".join(macos_libs)
run_command(command, self.buildEnv.build_dir, context)

return [pj(fat_dir, "merged.a")]

def _build_xcframework(self, xcf_libs, context):
# create xcframework
ref_plat = PlatformInfo.get_platform(self.macos_subplatforms[0])
command = "xcodebuild -create-xcframework "
for lib in xcf_libs:
command += " -library {lib} -headers {include}".format(
lib=lib, include=pj(ref_plat.buildEnv.install_dir, "include")
)
command += " -output {dest}".format(dest=self.final_path)
run_command(command, self.buildEnv.build_dir, context)

def build(self):
xcf_libs = []
self.command("remove_if_exists", self._remove_if_exists)
xcf_libs += self.command("merge_libs", self._merge_libs)
xcf_libs += self.command("make_macos_fat", self._make_macos_fat)
self.command("build_xcframework", self._build_xcframework, xcf_libs)
16 changes: 16 additions & 0 deletions kiwixbuild/platforms/ios.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
from kiwixbuild._global import option
from kiwixbuild.utils import pj, xrun_find
from .base import PlatformInfo, MetaPlatformInfo, MixedMixin
from kiwixbuild.dependencies.apple_xcframework import AppleXCFramework


MIN_MACOS_VERSION = '12.0'
Expand Down Expand Up @@ -183,3 +184,18 @@ def add_targets(self, targetName, targets):

def __str__(self):
return self.name

class AppleStaticAll(MetaPlatformInfo):
name = "apple_all_static"
compatible_hosts = ['Darwin']

@property
def subPlatformNames(self):
return AppleXCFramework.subPlatformNames

def add_targets(self, targetName, targets):
super().add_targets(targetName, targets)
return PlatformInfo.add_targets(self, 'apple_xcframework', targets)

def __str__(self):
return self.name

0 comments on commit a063b91

Please sign in to comment.