iOS: Namespace includes to avoid polluting global name space (#924)

* Namespace includes without renaming FerrostarCoreRS target.

This might be a more transparent change since the internal frameworks
don't change names, but it does rely on an unreleased feature of uniffi
to set the ffi_module_name

* Revert "Namespace includes without renaming FerrostarCoreRS target."

This reverts commit 0ec7f04.

* Namespace includes (requires renaming FFI target to match UniFFI conventions)

Otherwise module.modulemap will be dumped in the top level build
includes, which will conflict with any other package doing the same
thing.

To avoid collision, we should put it in a subdir of Headers.
To be sure the xcode build process finds our includes, the subdir should
have the same name as the target.

With the latest stable uniffi (0.31), it's not possible to rename `ffi_module_name`,
so we instead have to line up all our names with uniffi's defaults.

* Cleanup

---------

Co-authored-by: Ian Wagner <ian.wagner@stadiamaps.com>

Author: michaelkirk

Package.swift

@@ -10,7 +10,7 @@ let useLocalMapLibreSwiftUIDSL = false
 
 if useLocalFramework {
     binaryTarget = .binaryTarget(
-        name: "FerrostarCoreRS",
+        name: "ferrostarFFI",
         // IMPORTANT: Swift packages importing this locally will not be able to
         // import Ferrostar core unless you specify this as a relative path!
         path: "./common/target/ios/libferrostar-rs.xcframework"
@@ -19,7 +19,7 @@ if useLocalFramework {
     let releaseTag = "0.51.0"
     let releaseChecksum = "23a35bcd60eb926465458f40f8f764e068878d96fe4ed76b73ed4dfd3e56ed1f"
     binaryTarget = .binaryTarget(
-        name: "FerrostarCoreRS",
+        name: "ferrostarFFI",
         url:
         "https://github.com/stadiamaps/ferrostar/releases/download/\(releaseTag)/libferrostar-rs.xcframework.zip",
         checksum: releaseChecksum
@@ -111,7 +111,7 @@ let package = Package(
         ),
         .target(
             name: "FerrostarCoreFFI",
-            dependencies: [.target(name: "FerrostarCoreRS")],
+            dependencies: [.target(name: "ferrostarFFI")],
             path: "apple/Sources/UniFFI"
         ),
 

common/build-ios.sh

@@ -11,24 +11,22 @@ set -u
 release=false
 ffi_only=false
 
-for arg in "$@"
-do
-    case $arg in
-        --release)
-            release=true
-            shift # Remove --release from processing
-            ;;
-        --ffi-only)
-            ffi_only=true
-            shift # Remove --ffi-only from processing
-            ;;
-        *)
-            shift # Ignore other argument from processing
-            ;;
-    esac
+for arg in "$@"; do
+  case $arg in
+  --release)
+    release=true
+    shift # Remove --release from processing
+    ;;
+  --ffi-only)
+    ffi_only=true
+    shift # Remove --ffi-only from processing
+    ;;
+  *)
+    shift # Ignore other argument from processing
+    ;;
+  esac
 done
 
-
 # Potential optimizations for the future:
 #
 # * Only build one simulator arch for local development (we build both since many still use Intel Macs)
@@ -37,7 +35,7 @@ fat_simulator_lib_dir="target/ios-simulator-fat/release"
 
 generate_ffi() {
   echo "Generating framework module mapping and FFI bindings"
-  
+
   # Use different library path based on build mode
   if $ffi_only; then
     echo "Using native library for FFI generation"
@@ -46,20 +44,15 @@ generate_ffi() {
     if [[ "$(uname)" == "Darwin" ]]; then
       lib_ext="dylib"
     fi
-    cargo run -p uniffi-bindgen-swift -- target/release/lib$1.$lib_ext target/uniffi-xcframework-staging --swift-sources --headers --modulemap --module-name $1FFI --modulemap-filename module.modulemap
+    cargo run -p uniffi-bindgen-swift -- target/release/lib$1.$lib_ext target/uniffi-xcframework-staging/$1FFI --swift-sources --headers --modulemap --module-name $1FFI --modulemap-filename module.modulemap
   else
     echo "Using iOS library for FFI generation"
     # NOTE: Convention requires the modulemap be named module.modulemap
-    cargo run -p uniffi-bindgen-swift -- target/aarch64-apple-ios/release/lib$1.a target/uniffi-xcframework-staging --swift-sources --headers --modulemap --module-name $1FFI --modulemap-filename module.modulemap
+    cargo run -p uniffi-bindgen-swift -- target/aarch64-apple-ios/release/lib$1.a target/uniffi-xcframework-staging/$1FFI --swift-sources --headers --modulemap --module-name $1FFI --modulemap-filename module.modulemap
   fi
-  
+
   mkdir -p ../apple/Sources/UniFFI/
-  mv target/uniffi-xcframework-staging/*.swift ../apple/Sources/UniFFI/
-  
-  # Only move modulemap if not in ffi-only mode
-  if ! $ffi_only; then
-    mv target/uniffi-xcframework-staging/module.modulemap target/uniffi-xcframework-staging/module.modulemap
-  fi
+  mv target/uniffi-xcframework-staging/$1FFI/*.swift ../apple/Sources/UniFFI/
 }
 
 create_fat_simulator_lib() {
@@ -111,6 +104,5 @@ git config core.hooksPath .githooks
 cargo build -p $basename --lib --release --target aarch64-apple-ios-sim
 cargo build -p $basename --lib --release --target x86_64-apple-ios
 
-
 create_fat_simulator_lib $basename
-build_xcframework $basename
+build_xcframework $basename