Merge pull request #1407 from nathanvoglsam/use_ios_framework

Add new use_ios_framework for linking to SDL2.framework on iOS

Author: Cobrand

Cargo.toml

@@ -53,6 +53,7 @@ use-bindgen = ["sdl2-sys/use-bindgen"]
 use-pkgconfig = ["sdl2-sys/use-pkgconfig"]
 use-vcpkg = ["sdl2-sys/use-vcpkg"]
 use_mac_framework = ["sdl2-sys/use_mac_framework"]
+use_ios_framework = ["sdl2-sys/use_ios_framework"]
 bundled = ["sdl2-sys/bundled"]
 static-link = ["sdl2-sys/static-link"]
 

README.md

@@ -25,6 +25,7 @@ Rust-SDL2 uses the MIT license, but SDL2 itselfais  in under the zlib license.
 * `use-pkgconfig` use pkg-config to detect where your library is located on your system. Mostly useful on unix systems for static linking.
 * `static-link` to link to SDL2 statically instead of dynamically.
 * `use_mac_framework` to use SDL2 from a Framework, on macOS only
+* `use_ios_framework` to use SDL2 from a Framework, on iOS only
 * `bundled`, which pulls the SDL repository and compiles it from source. More information below.
 
 # Documentation
@@ -142,6 +143,18 @@ default = []
 use_sdl2_mac_framework = ["sdl2/use_mac_framework"]
 ```
 
+Similarly for iOS you can follow the same process using the `use_ios_framework` feature. However
+official builds of the iOS framework are not available so you must compile your own SDL2.framework.
+
+Using the iOS framework also requires adding the 'Frameworks' directory to your rpath so that the
+dynamic linker can find SDL2.framework inside your app bundle. This is done by adding this to your
+`build.rs`:
+
+```rust
+#[cfg(target_os="ios")]
+println!("cargo:rustc-link-arg=-Wl,-rpath,@loader_path/Frameworks");
+```
+
 #### Static linking on macOS using vcpkg
 
 Instructions to generate a static binary on macOS and other operating systems using [vcpkg][vcpkg] are [here][cargo-vcpkg-usage].

changelog.md

@@ -1,6 +1,10 @@
 In this file will be listed the changes, especially the breaking ones that one should be careful of
 when upgrading from a version of rust-sdl2 to another.
 
+### Next
+
+[PR #1407](https://github.com/Rust-SDL2/rust-sdl2/pull/1407) Add new use_ios_framework for linking to SDL2.framework on iOS
+
 ### v0.37.0
 
 [PR #1406](https://github.com/Rust-SDL2/rust-sdl2/pull/1406) Update bindings to SDL 2.0.26, add Event.is\_touch() for mouse events, upgrade wgpu to 0.20 in examples

sdl2-sys/Cargo.toml

@@ -51,6 +51,7 @@ use-vcpkg = ["vcpkg"]
 use-bindgen = ["bindgen"]
 static-link = []
 use_mac_framework = []
+use_ios_framework = []
 bundled = ["cmake"]
 mixer = []
 image = []

sdl2-sys/build.rs

@@ -232,7 +232,9 @@ fn link_sdl2(target_os: &str) {
         // pkg-config automatically prints this output when probing,
         // however pkg_config isn't used with the feature "bundled"
         if cfg!(feature = "bundled") || cfg!(not(feature = "use-pkgconfig")) {
-            if cfg!(feature = "use_mac_framework") && target_os == "darwin" {
+            let use_mac_framework = cfg!(feature = "use_mac_framework") && target_os == "darwin";
+            let use_ios_framework = cfg!(feature = "use_ios_framework") && target_os == "ios";
+            if use_mac_framework || use_ios_framework {
                 println!("cargo:rustc-flags=-l framework=SDL2");
             } else if target_os != "emscripten" {
                 println!("cargo:rustc-flags=-l SDL2");
@@ -328,7 +330,15 @@ fn link_sdl2(target_os: &str) {
             } else if target_os.contains("windows") {
                 println!("cargo:rustc-flags=-l SDL2_mixer");
             } else if target_os.contains("darwin") {
-                if cfg!(any(mac_framework, feature = "use_mac_framework")) {
+                let use_framework = cfg!(any(mac_framework, feature = "use_mac_framework"));
+                if use_framework {
+                    println!("cargo:rustc-flags=-l framework=SDL2_mixer");
+                } else {
+                    println!("cargo:rustc-flags=-l SDL2_mixer");
+                }
+            } else if target_os.contains("ios") {
+                let use_framework = cfg!(any(ios_framework, feature = "use_ios_framework"));
+                if use_framework {
                     println!("cargo:rustc-flags=-l framework=SDL2_mixer");
                 } else {
                     println!("cargo:rustc-flags=-l SDL2_mixer");
@@ -344,7 +354,15 @@ fn link_sdl2(target_os: &str) {
             } else if target_os.contains("windows") {
                 println!("cargo:rustc-flags=-l SDL2_image");
             } else if target_os.contains("darwin") {
-                if cfg!(any(mac_framework, feature = "use_mac_framework")) {
+                let use_framework = cfg!(any(mac_framework, feature = "use_mac_framework"));
+                if use_framework {
+                    println!("cargo:rustc-flags=-l framework=SDL2_image");
+                } else {
+                    println!("cargo:rustc-flags=-l SDL2_image");
+                }
+            } else if target_os.contains("ios") {
+                let use_framework = cfg!(any(ios_framework, feature = "use_ios_framework"));
+                if use_framework {
                     println!("cargo:rustc-flags=-l framework=SDL2_image");
                 } else {
                     println!("cargo:rustc-flags=-l SDL2_image");
@@ -360,7 +378,15 @@ fn link_sdl2(target_os: &str) {
             } else if target_os.contains("windows") {
                 println!("cargo:rustc-flags=-l SDL2_ttf");
             } else if target_os.contains("darwin") {
-                if cfg!(any(mac_framework, feature = "use_mac_framework")) {
+                let use_framework = cfg!(any(mac_framework, feature = "use_mac_framework"));
+                if use_framework {
+                    println!("cargo:rustc-flags=-l framework=SDL2_ttf");
+                } else {
+                    println!("cargo:rustc-flags=-l SDL2_ttf");
+                }
+            } else if target_os.contains("ios") {
+                let use_framework = cfg!(any(ios_framework, feature = "use_ios_framework"));
+                if use_framework {
                     println!("cargo:rustc-flags=-l framework=SDL2_ttf");
                 } else {
                     println!("cargo:rustc-flags=-l SDL2_ttf");
@@ -376,7 +402,15 @@ fn link_sdl2(target_os: &str) {
             } else if target_os.contains("windows") {
                 println!("cargo:rustc-flags=-l SDL2_gfx");
             } else if target_os.contains("darwin") {
-                if cfg!(any(mac_framework, feature = "use_mac_framework")) {
+                let use_framework = cfg!(any(mac_framework, feature = "use_mac_framework"));
+                if use_framework {
+                    println!("cargo:rustc-flags=-l framework=SDL2_gfx");
+                } else {
+                    println!("cargo:rustc-flags=-l SDL2_gfx");
+                }
+            } else if target_os.contains("ios") {
+                let use_framework = cfg!(any(ios_framework, feature = "use_ios_framework"));
+                if use_framework {
                     println!("cargo:rustc-flags=-l framework=SDL2_gfx");
                 } else {
                     println!("cargo:rustc-flags=-l SDL2_gfx");