Source code
Revision control
Copy as Markdown
Other Tools
use core::fmt;
use core::panic::{RefUnwindSafe, UnwindSafe};
#[cfg(feature = "gnustep-1-7")]
use crate::encode::Encode;
use crate::encode::{Encoding, RefEncode};
use crate::ffi;
/// A type used to identify and manage memory zones.
///
/// Zones are ignored on all newer platforms, you should very rarely need to
/// use this, but may be useful if you need to implement `copyWithZone:` or
/// `allocWithZone:`.
///
/// See [Apple's documentation](https://developer.apple.com/documentation/foundation/nszone?language=objc).
#[repr(C)]
pub struct NSZone {
_priv: [u8; 0],
// Use `OpaqueData` to mark the types as !Send, !Sync and UnsafeCell.
_inner: ffi::OpaqueData,
}
impl fmt::Debug for NSZone {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "<NSZone {self:p}>")
}
}
// Note: We don't know anything about the internals of `NSZone`, so best not
// to make it `Send` and `Sync` for now.
impl UnwindSafe for NSZone {}
impl RefUnwindSafe for NSZone {}
unsafe impl RefEncode for NSZone {
#[cfg(not(feature = "gnustep-1-7"))]
const ENCODING_REF: Encoding = Encoding::Pointer(&Encoding::Struct("_NSZone", &[]));
#[cfg(feature = "gnustep-1-7")]
const ENCODING_REF: Encoding = Encoding::Pointer(&Encoding::Struct(
"_NSZone",
&[
// Functions
Encoding::Pointer(&Encoding::Unknown),
Encoding::Pointer(&Encoding::Unknown),
Encoding::Pointer(&Encoding::Unknown),
Encoding::Pointer(&Encoding::Unknown),
Encoding::Pointer(&Encoding::Unknown),
Encoding::Pointer(&Encoding::Unknown),
// Stats
Encoding::Pointer(&Encoding::Unknown),
// Zone granularity
usize::ENCODING,
// Name of zone
Encoding::Object,
// Next zone - note that the contents of this doesn't matter,
// since this is nested far enough that the encoding string ends
// up ignoring it.
Encoding::Pointer(&Encoding::Struct("_NSZone", &[])),
],
));
}
#[cfg(test)]
mod tests {
use alloc::string::ToString;
use core::ptr;
use super::*;
use crate::msg_send;
use crate::rc::Allocated;
use crate::runtime::NSObject;
use crate::ClassType;
#[test]
fn alloc_with_zone() {
let zone: *const NSZone = ptr::null();
let _obj: Allocated<NSObject> =
unsafe { msg_send![NSObject::class(), allocWithZone: zone] };
}
#[test]
fn verify_encoding() {
let expected = if cfg!(all(feature = "gnustep-1-7", target_pointer_width = "64")) {
"^{_NSZone=^?^?^?^?^?^?^?Q@^{_NSZone}}"
} else if cfg!(all(
feature = "gnustep-1-7",
not(target_pointer_width = "64")
)) {
"^{_NSZone=^?^?^?^?^?^?^?I@^{_NSZone}}"
} else {
"^{_NSZone=}"
};
assert_eq!(NSZone::ENCODING_REF.to_string(), expected);
}
}