Fix pointer bounds and a lot of nullability in CoreFoundation

Author: madsmtm

crates/header-translator/src/config.rs

@@ -712,7 +712,9 @@ pub enum PointerBounds {
     #[serde(rename = "single")]
     Single,
     #[serde(rename = "null-terminated")]
-    NullTerminated, // Or TerminatedBy(b'\0')
+    NullTerminated, // Equivalent to TerminatedBy(b'\0')
+    #[serde(rename = "terminated-by")]
+    TerminatedBy(String),
     #[serde(rename = "counted-by")]
     CountedBy(String),
     #[serde(rename = "sized-by")]

examples/corefoundation/runloop.rs

@@ -165,9 +165,7 @@ unsafe fn create_observer_unchecked<F: Fn(&CFRunLoopObserver, CFRunLoopActivity)
         callback(observer, activity);
     }
 
-    // This is marked `mut` to match the signature of `CFRunLoopObserver::new`,
-    // but the information is copied, and not actually mutated.
-    let mut context = CFRunLoopObserverContext {
+    let context = CFRunLoopObserverContext {
         version: 0,
         // This pointer is retained by CF on creation.
         info: Arc::as_ptr(&callback) as *mut c_void,
@@ -187,7 +185,7 @@ unsafe fn create_observer_unchecked<F: Fn(&CFRunLoopObserver, CFRunLoopActivity)
             repeats,
             order,
             Some(callout::<F>),
-            &mut context,
+            Some(&context),
         )
     }
     .unwrap()
@@ -246,9 +244,7 @@ unsafe fn create_timer_unchecked<F: Fn(&CFRunLoopTimer) + 'static>(
         callback(timer);
     }
 
-    // This is marked `mut` to match the signature of `CFRunLoopTimer::new`,
-    // but the information is copied, and not actually mutated.
-    let mut context = CFRunLoopTimerContext {
+    let context = CFRunLoopTimerContext {
         version: 0,
         // This pointer is retained by CF on creation.
         info: Arc::as_ptr(&callback) as *mut c_void,
@@ -269,7 +265,7 @@ unsafe fn create_timer_unchecked<F: Fn(&CFRunLoopTimer) + 'static>(
             0, // Documentation says to pass 0 for future compat.
             order,
             Some(callout::<F>),
-            &mut context,
+            Some(&context),
         )
     }
     .unwrap()
@@ -353,9 +349,7 @@ fn create_source<F: Fn(SourceData<'_>) + Send + Sync + 'static>(
         (signaller)(SourceData::Perform);
     }
 
-    // This is marked `mut` to match the signature of `CFRunLoopSource::new`,
-    // but the information is copied, and not actually mutated.
-    let mut context = CFRunLoopSourceContext {
+    let context = CFRunLoopSourceContext {
         version: 0, // Version 0 source
         // This pointer is retained by CF on creation.
         info: Arc::as_ptr(&callback) as *mut c_void,
@@ -373,5 +367,5 @@ fn create_source<F: Fn(SourceData<'_>) + Send + Sync + 'static>(
     // with `Send + Sync`, so that is thread-safe too.
     //
     // `F: 'static`, so extending the lifetime of the closure is fine.
-    unsafe { CFRunLoopSource::new(kCFAllocatorDefault, order, &mut context) }.unwrap()
+    unsafe { CFRunLoopSource::new(kCFAllocatorDefault, order, &context) }.unwrap()
 }

framework-crates/objc2-core-foundation/src/array.rs

@@ -77,7 +77,7 @@ impl<T: ?Sized> CFArray<T> {
         //
         // The objects are retained internally by the array, so we do not need
         // to keep them alive ourselves after this.
-        let array = unsafe { CFArray::new(None, ptr, len, &kCFTypeArrayCallBacks) }
+        let array = unsafe { CFArray::new(None, ptr, len, Some(&kCFTypeArrayCallBacks)) }
             .unwrap_or_else(|| failed_creating_array(len));
 
         // SAFETY: The objects came from `T`.
@@ -107,7 +107,7 @@ impl<T: ?Sized> CFArray<T> {
         let ptr = objects.as_ptr().cast::<*const c_void>().cast_mut();
 
         // SAFETY: Same as in `from_objects`.
-        let array = unsafe { CFArray::new(None, ptr, len, &kCFTypeArrayCallBacks) }
+        let array = unsafe { CFArray::new(None, ptr, len, Some(&kCFTypeArrayCallBacks)) }
             .unwrap_or_else(|| failed_creating_array(len));
 
         // SAFETY: The objects came from `T`.
@@ -139,7 +139,7 @@ impl<T: ?Sized> CFMutableArray<T> {
 
         // SAFETY: The objects are CFTypes (`T: Type` bound), and the array
         // callbacks are thus correct.
-        let array = unsafe { CFMutableArray::new(None, capacity, &kCFTypeArrayCallBacks) }
+        let array = unsafe { CFMutableArray::new(None, capacity, Some(&kCFTypeArrayCallBacks)) }
             .unwrap_or_else(|| failed_creating_array(capacity));
 
         // SAFETY: The array contains no objects yet, and thus it's safe to
@@ -540,7 +540,7 @@ mod tests {
     fn array_with_invalid_pointers() {
         // without_provenance
         let ptr = [0 as _, 1 as _, 2 as _, 3 as _, usize::MAX as _].as_mut_ptr();
-        let array = unsafe { CFArray::new(None, ptr, 1, null()) }.unwrap();
+        let array = unsafe { CFArray::new(None, ptr, 1, None) }.unwrap();
         let value = unsafe { array.value_at_index(0) };
         assert!(value.is_null());
     }
@@ -550,7 +550,7 @@ mod tests {
     #[ignore = "aborts (as expected)"]
     fn object_array_cannot_contain_null() {
         let ptr = [null()].as_mut_ptr();
-        let _array = unsafe { CFArray::new(None, ptr, 1, &kCFTypeArrayCallBacks) };
+        let _array = unsafe { CFArray::new(None, ptr, 1, Some(&kCFTypeArrayCallBacks)) };
     }
 
     #[test]

framework-crates/objc2-core-foundation/src/date.rs

@@ -51,7 +51,7 @@ impl Ord for CFDate {
     fn cmp(&self, other: &Self) -> Ordering {
         // Documented that one should pass NULL here.
         let context = ptr::null_mut();
-        unsafe { self.compare(Some(other), context) }.into()
+        unsafe { self.compare(other, context) }.into()
     }
 }
 

framework-crates/objc2-core-foundation/src/dictionary.rs

@@ -87,8 +87,8 @@ impl<K: ?Sized, V: ?Sized> CFDictionary<K, V> {
                 keys,
                 values,
                 len,
-                &kCFTypeDictionaryKeyCallBacks,
-                &kCFTypeDictionaryValueCallBacks,
+                Some(&kCFTypeDictionaryKeyCallBacks),
+                Some(&kCFTypeDictionaryValueCallBacks),
             )
         }
         .unwrap_or_else(|| failed_creating_dictionary(len));
@@ -129,8 +129,8 @@ impl<K: ?Sized, V: ?Sized> CFMutableDictionary<K, V> {
             CFMutableDictionary::new(
                 None,
                 capacity,
-                &kCFTypeDictionaryKeyCallBacks,
-                &kCFTypeDictionaryValueCallBacks,
+                Some(&kCFTypeDictionaryKeyCallBacks),
+                Some(&kCFTypeDictionaryValueCallBacks),
             )
         }
         .unwrap_or_else(|| failed_creating_dictionary(capacity));

framework-crates/objc2-core-foundation/src/number.rs

@@ -117,7 +117,7 @@ impl Ord for CFNumber {
     fn cmp(&self, other: &Self) -> Ordering {
         // Documented that one should pass NULL here.
         let context = ptr::null_mut();
-        unsafe { self.compare(Some(other), context) }.into()
+        unsafe { self.compare(other, context) }.into()
     }
 }
 

framework-crates/objc2-core-foundation/src/string.rs

@@ -159,7 +159,7 @@ impl fmt::Display for CFString {
                     false,
                     buf.as_mut_ptr(),
                     buf.len() as _,
-                    &mut read_utf8,
+                    Some(&mut read_utf8),
                 )
             };
             if read_utf16 <= 0 {
@@ -243,7 +243,7 @@ mod tests {
         ];
         for (cstr, encoding, expected) in table {
             let cstr = CStr::from_bytes_with_nul(cstr).unwrap();
-            let s = unsafe { CFString::with_c_string(None, cstr.as_ptr(), encoding.0) }.unwrap();
+            let s = unsafe { CFString::with_c_string(None, cstr, encoding.0) }.unwrap();
             assert_eq!(s.to_string(), expected);
         }
     }
@@ -335,7 +335,7 @@ mod tests {
         let s = unsafe {
             CFString::with_c_string(
                 None,
-                b"\x65\x26\0".as_ptr().cast(),
+                CStr::from_bytes_with_nul_unchecked(b"\x65\x26\0"),
                 CFStringBuiltInEncodings::EncodingUnicode.0,
             )
         }