Use objc2-* family of crates (#334)

* Use objc2

* Avoid premature Retained::retain

* Use expect instead of unwrap on missing NSWindow

Author: madsmtm

Cargo.toml

@@ -56,14 +56,62 @@ serial_test = "3.1.0"
 
 [target.'cfg(target_os = "macos")'.dependencies]
 cgl = "0.3.2"
-cocoa = "0.25"
-core-foundation = "0.9"
-core-graphics = "0.23"
-servo-display-link = "0.2"
-io-surface = "0.15"
 mach2 = "0.4"
-metal = "0.24"
-objc = "0.2"
+objc2 = "0.6.1"
+objc2-app-kit = { version = "0.3", default-features = false, features = [
+    "std",
+    "objc2-quartz-core",
+    "objc2-core-foundation",
+    "NSResponder",
+    "NSScreen",
+    "NSView",
+    "NSGraphics",
+    "NSWindow",
+] }
+objc2-core-foundation = { version = "0.3.1", default-features = false, features = [
+    "std",
+    "CFBase",
+    "CFBundle",
+    "CFCGTypes",
+    "CFDictionary",
+    "CFNumber",
+    "CFString",
+] }
+objc2-core-video = { version = "0.3.1", default-features = false, features = [
+    "std",
+    "objc2-core-graphics",
+    "CVBase",
+    "CVDisplayLink",
+    "CVPixelBuffer",
+    "CVReturn",
+] }
+objc2-foundation = { version = "0.3.1", default-features = false, features = [
+    "std",
+    "objc2-core-foundation",
+    "NSEnumerator",
+    "NSGeometry",
+    "NSString",
+    "NSValue",
+] }
+objc2-io-surface = { version = "0.3.1", default-features = false, features = [
+    "std",
+    "libc",
+    "objc2",
+    "objc2-core-foundation",
+    "IOSurfaceRef",
+    "IOSurfaceTypes",
+] }
+objc2-metal = { version = "0.3.1", default-features = false, features = [
+    "std",
+    "MTLDevice",
+] }
+objc2-quartz-core = { version = "0.3.1", default-features = false, features = [
+    "std",
+    "objc2-core-foundation",
+    "CALayer",
+    "CATransaction",
+    "CATransform3D",
+] }
 
 [target.'cfg(all(unix, not(any(target_os = "macos", target_os = "android", target_env = "ohos"))))'.dependencies.wayland-sys]
 version = "0.30"

src/lib.rs

@@ -16,10 +16,6 @@ extern crate bitflags;
 #[macro_use]
 extern crate log;
 
-#[cfg(target_os = "macos")]
-#[macro_use]
-extern crate objc;
-
 pub mod platform;
 pub use platform::default::connection::{Connection, NativeConnection};
 pub use platform::default::context::{Context, ContextDescriptor, NativeContext};

src/platform/macos/cgl/connection.rs

@@ -125,15 +125,26 @@ impl Connection {
         raw_handle: rwh_05::RawWindowHandle,
         _size: Size2D<i32>,
     ) -> Result<NativeWidget, Error> {
-        use crate::platform::macos::system::surface::NSView;
-        use cocoa::base::id;
+        use objc2::{MainThreadMarker, Message};
+        use objc2_app_kit::{NSView, NSWindow};
         use rwh_05::RawWindowHandle::AppKit;
 
         match raw_handle {
-            AppKit(handle) => Ok(NativeWidget {
-                view: NSView(unsafe { msg_send![handle.ns_view as id, retain] }),
-                opaque: unsafe { msg_send![handle.ns_window as id, isOpaque] },
-            }),
+            AppKit(handle) => {
+                assert!(
+                    MainThreadMarker::new().is_some(),
+                    "NSView is only usable on the main thread"
+                );
+                // SAFETY: The pointer is valid for as long as the handle is,
+                // and we just checked that we're on the main thread.
+                let ns_view = unsafe { handle.ns_view.cast::<NSView>().as_ref().unwrap() };
+                let ns_window = unsafe { handle.ns_window.cast::<NSWindow>().as_ref().unwrap() };
+
+                Ok(NativeWidget {
+                    view: ns_view.retain(),
+                    opaque: unsafe { ns_window.isOpaque() },
+                })
+            }
             _ => Err(Error::IncompatibleNativeWidget),
         }
     }
@@ -146,21 +157,26 @@ impl Connection {
         handle: rwh_06::WindowHandle,
         _size: Size2D<i32>,
     ) -> Result<NativeWidget, Error> {
-        use crate::platform::macos::system::surface::NSView;
-        use cocoa::base::id;
+        use objc2::{MainThreadMarker, Message};
+        use objc2_app_kit::NSView;
         use rwh_06::RawWindowHandle::AppKit;
 
         match handle.as_raw() {
             AppKit(handle) => {
-                let ns_view = handle.ns_view.as_ptr() as id;
-                // https://developer.apple.com/documentation/appkit/nsview/1483301-window
-                let ns_window: id = unsafe { msg_send![ns_view, window] };
+                assert!(
+                    MainThreadMarker::new().is_some(),
+                    "NSView is only usable on the main thread"
+                );
+                // SAFETY: The pointer is valid for as long as the handle is,
+                // and we just checked that we're on the main thread.
+                let ns_view = unsafe { handle.ns_view.cast::<NSView>().as_ref() };
+                let ns_window = ns_view
+                    .window()
+                    .expect("view must be installed in a window");
                 Ok(NativeWidget {
-                    // Increment the nsview's reference count with retain. See:
-                    // https://developer.apple.com/documentation/objectivec/1418956-nsobject/1571946-retain
-                    view: NSView(unsafe { msg_send![ns_view, retain] }),
-                    // https://developer.apple.com/documentation/appkit/nswindow/1419086-isopaque
-                    opaque: unsafe { msg_send![ns_window, isOpaque] },
+                    // Extend the lifetime of the view.
+                    view: ns_view.retain(),
+                    opaque: unsafe { ns_window.isOpaque() },
                 })
             }
             _ => Err(Error::IncompatibleNativeWidget),

src/platform/macos/cgl/context.rs

@@ -18,17 +18,12 @@ use cgl::{
 };
 use cgl::{CGLGetCurrentContext, CGLGetPixelFormat, CGLPixelFormatAttribute, CGLPixelFormatObj};
 use cgl::{CGLReleasePixelFormat, CGLRetainPixelFormat, CGLSetCurrentContext};
-use core_foundation::base::TCFType;
-use core_foundation::bundle::CFBundleGetBundleWithIdentifier;
-use core_foundation::bundle::CFBundleGetFunctionPointerForName;
-use core_foundation::bundle::CFBundleRef;
-use core_foundation::string::CFString;
 use glow::HasContext;
+use objc2_core_foundation::{CFBundle, CFRetained, CFString};
 use std::mem;
 use std::os::raw::c_void;
 use std::ptr;
 use std::rc::Rc;
-use std::str::FromStr;
 use std::thread;
 
 // No CGL error occurred.
@@ -48,15 +43,10 @@ const kCGLOGLPVersion_GL4_Core: CGLPixelFormatAttribute = 0x4100;
 static OPENGL_FRAMEWORK_IDENTIFIER: &str = "com.apple.opengl";
 
 thread_local! {
-    static OPENGL_FRAMEWORK: CFBundleRef = {
-        unsafe {
-            let framework_identifier: CFString =
-                FromStr::from_str(OPENGL_FRAMEWORK_IDENTIFIER).unwrap();
-            let framework =
-                CFBundleGetBundleWithIdentifier(framework_identifier.as_concrete_TypeRef());
-            assert!(!framework.is_null());
-            framework
-        }
+    static OPENGL_FRAMEWORK: CFRetained<CFBundle> = {
+        let framework_identifier = CFString::from_str(OPENGL_FRAMEWORK_IDENTIFIER);
+        let framework = CFBundle::bundle_with_identifier(Some(&framework_identifier));
+        framework.unwrap()
     };
 }
 
@@ -495,9 +485,9 @@ impl Device {
 }
 
 fn get_proc_address(symbol_name: &str) -> *const c_void {
-    OPENGL_FRAMEWORK.with(|framework| unsafe {
-        let symbol_name: CFString = FromStr::from_str(symbol_name).unwrap();
-        CFBundleGetFunctionPointerForName(*framework, symbol_name.as_concrete_TypeRef())
+    OPENGL_FRAMEWORK.with(|framework| {
+        let symbol_name = CFString::from_str(symbol_name);
+        framework.function_pointer_for_name(Some(&symbol_name))
     })
 }
 

src/platform/macos/cgl/surface.rs

@@ -9,12 +9,13 @@ use crate::gl_utils;
 use crate::platform::macos::system::surface::Surface as SystemSurface;
 use crate::renderbuffers::Renderbuffers;
 use crate::{gl, Error, SurfaceAccess, SurfaceID, SurfaceInfo, SurfaceType, WindowingApiError};
+use cgl::{kCGLNoError, CGLErrorString, CGLGetCurrentContext, CGLTexImageIOSurface2D, GLenum};
 use glow::Context as Gl;
 
-use core_foundation::base::TCFType;
 use euclid::default::Size2D;
 use glow::{HasContext, Texture};
-use io_surface::{self, IOSurface};
+use objc2_io_surface::IOSurfaceRef;
+use std::ffi::CStr;
 use std::fmt::{self, Debug, Formatter};
 use std::marker::PhantomData;
 use std::rc::Rc;
@@ -76,6 +77,38 @@ impl Debug for SurfaceTexture {
     }
 }
 
+fn surface_bind_to_gl_texture(surface: &IOSurfaceRef, width: i32, height: i32, has_alpha: bool) {
+    const BGRA: GLenum = 0x80E1;
+    const RGBA: GLenum = 0x1908;
+    const RGB: GLenum = 0x1907;
+    const TEXTURE_RECTANGLE_ARB: GLenum = 0x84F5;
+    const UNSIGNED_INT_8_8_8_8_REV: GLenum = 0x8367;
+
+    unsafe {
+        let context = CGLGetCurrentContext();
+        let gl_error = CGLTexImageIOSurface2D(
+            context,
+            TEXTURE_RECTANGLE_ARB,
+            if has_alpha {
+                RGBA as GLenum
+            } else {
+                RGB as GLenum
+            },
+            width,
+            height,
+            BGRA as GLenum,
+            UNSIGNED_INT_8_8_8_8_REV,
+            surface as *const IOSurfaceRef as cgl::IOSurfaceRef,
+            0,
+        );
+
+        if gl_error != kCGLNoError {
+            let error_msg = CStr::from_ptr(CGLErrorString(gl_error));
+            panic!("{}", error_msg.to_string_lossy());
+        }
+    }
+}
+
 impl Device {
     /// Creates either a generic or a widget surface, depending on the supplied surface type.
     ///
@@ -172,12 +205,17 @@ impl Device {
         })
     }
 
-    fn bind_to_gl_texture(&self, gl: &Gl, io_surface: &IOSurface, size: &Size2D<i32>) -> Texture {
+    fn bind_to_gl_texture(
+        &self,
+        gl: &Gl,
+        io_surface: &IOSurfaceRef,
+        size: &Size2D<i32>,
+    ) -> Texture {
         unsafe {
             let texture = gl.create_texture().unwrap();
 
             gl.bind_texture(gl::TEXTURE_RECTANGLE, Some(texture));
-            io_surface.bind_to_gl_texture(size.width, size.height, true);
+            surface_bind_to_gl_texture(io_surface, size.width, size.height, true);
 
             gl.tex_parameter_i32(
                 gl::TEXTURE_RECTANGLE,
@@ -291,10 +329,12 @@ impl Device {
         unsafe {
             let size = surface.system_surface.size;
             gl.bind_texture(gl::TEXTURE_RECTANGLE, surface.texture_object);
-            surface
-                .system_surface
-                .io_surface
-                .bind_to_gl_texture(size.width, size.height, true);
+            surface_bind_to_gl_texture(
+                &surface.system_surface.io_surface,
+                size.width,
+                size.height,
+                true,
+            );
             gl.bind_texture(gl::TEXTURE_RECTANGLE, None);
         }
 
@@ -403,7 +443,7 @@ impl Device {
 impl Surface {
     #[inline]
     fn id(&self) -> SurfaceID {
-        SurfaceID(self.system_surface.io_surface.as_concrete_TypeRef() as usize)
+        SurfaceID(&*self.system_surface.io_surface as *const IOSurfaceRef as usize)
     }
 }