fruity__bbqsrc/foundation/

ns_number.rs

use super::{NSComparisonResult, NSString, NSValue};
use crate::core::Arc;
use crate::objc::{ClassType, NSInteger, NSUInteger, ObjCObject, BOOL};
use std::{
    cmp::Ordering,
    fmt,
    os::raw::{
        c_char, c_double, c_float, c_int, c_long, c_longlong, c_short, c_uchar, c_uint, c_ulong,
        c_ulonglong, c_ushort,
    },
    ptr,
};

objc_subclass! {
    /// An object wrapper for primitive scalar numeric values.
    ///
    /// There are [static instances](#static-instances) which make using certain
    /// numbers much faster.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber).
    pub class NSNumber: NSValue;
}

impl PartialEq for NSNumber {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        unsafe { _msg_send_any_cached![self, isEqualToNumber: other => BOOL] }.into()
    }
}

impl Eq for NSNumber {}

impl PartialOrd for NSNumber {
    #[inline]
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for NSNumber {
    #[inline]
    fn cmp(&self, other: &Self) -> Ordering {
        self.compare(other).into()
    }
}

impl From<bool> for Arc<NSNumber> {
    #[inline]
    fn from(value: bool) -> Self {
        NSNumber::from_bool(value)
    }
}

impl From<c_double> for Arc<NSNumber> {
    #[inline]
    fn from(value: c_double) -> Self {
        NSNumber::from_double(value)
    }
}

impl From<c_float> for Arc<NSNumber> {
    #[inline]
    fn from(value: c_float) -> Self {
        NSNumber::from_float(value)
    }
}

impl From<NSInteger> for Arc<NSNumber> {
    #[inline]
    fn from(value: NSInteger) -> Self {
        NSNumber::from_integer(value)
    }
}

impl From<NSUInteger> for Arc<NSNumber> {
    #[inline]
    fn from(value: NSUInteger) -> Self {
        NSNumber::from_unsigned_integer(value)
    }
}

impl From<c_char> for Arc<NSNumber> {
    #[inline]
    fn from(value: c_char) -> Self {
        NSNumber::from_char(value)
    }
}

impl From<c_uchar> for Arc<NSNumber> {
    #[inline]
    fn from(value: c_uchar) -> Self {
        NSNumber::from_unsigned_char(value)
    }
}

impl From<c_int> for Arc<NSNumber> {
    #[inline]
    fn from(value: c_int) -> Self {
        NSNumber::from_int(value)
    }
}

impl From<c_uint> for Arc<NSNumber> {
    #[inline]
    fn from(value: c_uint) -> Self {
        NSNumber::from_unsigned_int(value)
    }
}

impl From<c_long> for Arc<NSNumber> {
    #[inline]
    fn from(value: c_long) -> Self {
        NSNumber::from_long(value)
    }
}

impl From<c_ulong> for Arc<NSNumber> {
    #[inline]
    fn from(value: c_ulong) -> Self {
        NSNumber::from_unsigned_long(value)
    }
}

// TODO: Determine if `c_longlong` and `c_ulonglong` differ from `c_long` and
// `c_ulong` on the targeted platforms. If they do, then conditionally add
// `From` implementations.

impl From<c_short> for Arc<NSNumber> {
    #[inline]
    fn from(value: c_short) -> Self {
        NSNumber::from_short(value)
    }
}

impl From<c_ushort> for Arc<NSNumber> {
    #[inline]
    fn from(value: c_ushort) -> Self {
        NSNumber::from_unsigned_short(value)
    }
}

impl From<&NSNumber> for Arc<NSString<'_>> {
    #[inline]
    fn from(number: &NSNumber) -> Self {
        number.string_value()
    }
}

impl fmt::Debug for NSNumber {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        fmt::Display::fmt(self, f)
    }
}

impl fmt::Display for NSNumber {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self._cfboolean_value() {
            Some(false) => "NO".fmt(f),
            Some(true) => "YES".fmt(f),
            None => match self.objc_type_single() as u8 {
                // https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/ObjCRuntimeGuide/Articles/ocrtTypeEncodings.html
                b'f' => self.float_value().fmt(f),
                b'd' => self.double_value().fmt(f),
                b'c' | b'i' | b's' | b'l' | b'q' => self.longlong_value().fmt(f),
                _ => self.unsigned_longlong_value().fmt(f),
            },
        }
    }
}

/// Scalar constructors.
impl NSNumber {
    // TODO: Add constructors:
    // - initWithCoder:

    /// Creates a number object containing a boolean.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1551475-numberwithbool).
    #[inline]
    #[doc(alias = "numberWithBool")]
    #[doc(alias = "numberWithBool:")]
    pub fn from_bool(value: bool) -> Arc<Self> {
        unsafe { _msg_send_any![Self::class(), numberWithBool: BOOL::from(value)] }
    }

    /// Creates a number object from a C `float`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1551471-numberwithfloat)
    #[inline]
    #[doc(alias = "numberWithFloat")]
    #[doc(alias = "numberWithFloat:")]
    pub fn from_float(value: c_float) -> Arc<Self> {
        unsafe { _msg_send_any![Self::class(), numberWithFloat: value] }
    }

    /// Creates a number object from a C `double`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1551463-numberwithdouble)
    #[inline]
    #[doc(alias = "numberWithDouble")]
    #[doc(alias = "numberWithDouble:")]
    pub fn from_double(value: c_double) -> Arc<Self> {
        unsafe { _msg_send_any![Self::class(), numberWithDouble: value] }
    }

    /// Creates a number object from a C `char`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1551464-numberwithchar)
    #[inline]
    #[doc(alias = "numberWithChar")]
    #[doc(alias = "numberWithChar:")]
    pub fn from_char(value: c_char) -> Arc<Self> {
        unsafe { _msg_send_any![Self::class(), numberWithChar: value] }
    }

    /// Creates a number object from a C `short`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1551476-numberwithshort)
    #[inline]
    #[doc(alias = "numberWithShort")]
    #[doc(alias = "numberWithShort:")]
    pub fn from_short(value: c_short) -> Arc<Self> {
        unsafe { _msg_send_any![Self::class(), numberWithShort: value] }
    }

    /// Creates a number object from a C `int`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1551470-numberwithint)
    #[inline]
    #[doc(alias = "numberWithInt")]
    #[doc(alias = "numberWithInt:")]
    pub fn from_int(value: c_int) -> Arc<Self> {
        unsafe { _msg_send_any![Self::class(), numberWithInt: value] }
    }

    /// Creates a number object from a C `long`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1551474-numberwithlong)
    #[inline]
    #[doc(alias = "numberWithLong")]
    #[doc(alias = "numberWithLong:")]
    pub fn from_long(value: c_long) -> Arc<Self> {
        unsafe { _msg_send_any![Self::class(), numberWithLong: value] }
    }

    /// Creates a number object from a C `long long`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1551462-numberwithlonglong)
    #[inline]
    #[doc(alias = "numberWithLongLong")]
    #[doc(alias = "numberWithLongLong:")]
    pub fn from_longlong(value: c_longlong) -> Arc<Self> {
        unsafe { _msg_send_any![Self::class(), numberWithLongLong: value] }
    }

    /// Creates a number object from an Objective-C integer.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1551473-numberwithinteger)
    #[inline]
    #[doc(alias = "numberWithInteger")]
    #[doc(alias = "numberWithInteger:")]
    pub fn from_integer(value: NSInteger) -> Arc<Self> {
        unsafe { _msg_send_any![Self::class(), numberWithInteger: value] }
    }

    /// Creates a number object from a C `unsigned char`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1551468-numberwithunsignedchar)
    #[inline]
    #[doc(alias = "numberWithUnsignedChar")]
    #[doc(alias = "numberWithUnsignedChar:")]
    pub fn from_unsigned_char(value: c_uchar) -> Arc<Self> {
        unsafe { _msg_send_any![Self::class(), numberWithUnsignedChar: value] }
    }

    /// Creates a number object from a C `unsigned short`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1551467-numberwithunsignedshort)
    #[inline]
    #[doc(alias = "numberWithUnsignedShort")]
    #[doc(alias = "numberWithUnsignedShort:")]
    pub fn from_unsigned_short(value: c_ushort) -> Arc<Self> {
        unsafe { _msg_send_any![Self::class(), numberWithUnsignedShort: value] }
    }

    /// Creates a number object from a C `unsigned int`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1551472-numberwithunsignedint)
    #[inline]
    #[doc(alias = "numberWithUnsignedInt")]
    #[doc(alias = "numberWithUnsignedInt:")]
    pub fn from_unsigned_int(value: c_uint) -> Arc<Self> {
        unsafe { _msg_send_any![Self::class(), numberWithUnsignedInt: value] }
    }

    /// Creates a number object from a C `unsigned long`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1551477-numberwithunsignedlong)
    #[inline]
    #[doc(alias = "numberWithUnsignedLong")]
    #[doc(alias = "numberWithUnsignedLong:")]
    pub fn from_unsigned_long(value: c_ulong) -> Arc<Self> {
        unsafe { _msg_send_any![Self::class(), numberWithUnsignedLong: value] }
    }

    /// Creates a number object from a C `unsigned long long`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1551465-numberwithunsignedlonglong)
    #[inline]
    #[doc(alias = "numberWithUnsignedLongLong")]
    #[doc(alias = "numberWithUnsignedLongLong:")]
    pub fn from_unsigned_longlong(value: c_ulonglong) -> Arc<Self> {
        unsafe { _msg_send_any![Self::class(), numberWithUnsignedLongLong: value] }
    }

    /// Creates a number object from a Objective-C unsigned integer.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1551469-numberwithunsignedinteger)
    #[inline]
    #[doc(alias = "numberWithUnsignedInteger")]
    #[doc(alias = "numberWithUnsignedInteger:")]
    pub fn from_unsigned_integer(value: NSUInteger) -> Arc<Self> {
        unsafe { _msg_send_any![Self::class(), numberWithUnsignedInteger: value] }
    }
}

/// <span id="static-instances">Static instances</span>.
///
/// Use these number references over corresponding constructors for better
/// performance.
impl NSNumber {
    // SAFETY: NSNumber is toll-free bridged to CFNumber and CFBoolean, the
    // underlying types of these statics.

    /// Returns a reference to the equivalent of `@NO`.
    ///
    /// This internally references
    /// [`kCFBooleanFalse`](https://developer.apple.com/documentation/corefoundation/kCFBooleanFalse).
    #[inline]
    #[doc(alias = "kCFBooleanFalse")]
    pub fn no() -> &'static NSNumber {
        extern "C" {
            static kCFBooleanFalse: &'static NSNumber;
        }
        unsafe { kCFBooleanFalse }
    }

    /// Returns a reference to the equivalent of `@YES`.
    ///
    /// This internally references
    /// [`kCFBooleanTrue`](https://developer.apple.com/documentation/corefoundation/kCFBooleanTrue).
    #[inline]
    #[doc(alias = "kCFBooleanTrue")]
    pub fn yes() -> &'static NSNumber {
        extern "C" {
            static kCFBooleanTrue: &'static NSNumber;
        }
        unsafe { kCFBooleanTrue }
    }

    /// Returns a reference to a
    /// [NaN (Not a Number)](https://en.wikipedia.org/wiki/NaN) value.
    ///
    /// This internally references
    /// [`kCFNumberNaN`](https://developer.apple.com/documentation/corefoundation/kCFNumberNaN).
    #[inline]
    #[doc(alias = "kCFNumberNaN")]
    pub fn nan() -> &'static NSNumber {
        extern "C" {
            static kCFNumberNaN: &'static NSNumber;
        }
        unsafe { kCFNumberNaN }
    }

    /// Returns a reference to the infinity (∞) value.
    ///
    /// This internally references
    /// [`kCFNumberPositiveInfinity`](https://developer.apple.com/documentation/corefoundation/kcfnumberpositiveinfinity).
    #[inline]
    #[doc(alias = "kCFNumberPositiveInfinity")]
    pub fn infinity() -> &'static NSNumber {
        extern "C" {
            static kCFNumberPositiveInfinity: &'static NSNumber;
        }
        unsafe { kCFNumberPositiveInfinity }
    }

    /// Returns a reference to the negative infinity (−∞) value.
    ///
    /// This internally references
    /// [`kCFNumberNegativeInfinity`](https://developer.apple.com/documentation/corefoundation/kcfnumbernegativeinfinity).
    #[inline]
    #[doc(alias = "kCFNumberNegativeInfinity")]
    pub fn neg_infinity() -> &'static NSNumber {
        extern "C" {
            static kCFNumberNegativeInfinity: &'static NSNumber;
        }
        unsafe { kCFNumberNegativeInfinity }
    }
}

/// Instance operations.
impl NSNumber {
    #[inline]
    pub(crate) fn _cfboolean_value(&self) -> Option<bool> {
        if ptr::eq(self, Self::no()) {
            Some(false)
        } else if ptr::eq(self, Self::yes()) {
            Some(true)
        } else {
            None
        }
    }

    /// Returns an `NSComparisonResult` value that indicates whether the number
    /// object’s value is greater than, equal to, or less than a given number.
    ///
    /// This method follows the standard C rules for type conversion. For
    /// example, if you compare an NSNumber object that has an integer value
    /// with an NSNumber object that has a floating point value, the integer
    /// value is converted to a floating-point value for comparison.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1413562-compare)
    #[inline]
    pub fn compare(&self, other: &NSNumber) -> NSComparisonResult {
        unsafe { _msg_send_any![self, compare: other] }
    }

    /// Returns the number object's value expressed as a human-readable string.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1415802-stringvalue)
    #[inline]
    #[doc(alias = "stringValue")]
    pub fn string_value(&self) -> Arc<NSString<'static>> {
        unsafe { _msg_send_any![self, stringValue] }
    }

    /// Returns a string that represents the contents of the number object for a
    /// given locale.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1409984-descriptionwithlocale)
    #[inline]
    #[doc(alias = "descriptionWithLocale")]
    pub fn description_with_locale<'l, L>(&self, locale: Option<&L>) -> Arc<NSString>
    where
        L: AsRef<ObjCObject<'l>>,
    {
        let locale: Option<&ObjCObject<'_>> = match &locale {
            Some(locale) => Some(locale.as_ref()),
            None => None,
        };
        unsafe { _msg_send_any![self, descriptionWithLocale: locale] }
    }
}

/// Accessing numeric values.
impl NSNumber {
    // TODO: Implement methods:
    // - decimalValue

    /// Returns the number object's value expressed as boolean, converted as necessary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1410865-boolvalue).
    #[inline]
    #[doc(alias = "boolValue")]
    pub fn bool_value(&self) -> bool {
        unsafe { _msg_send_any![self, boolValue => BOOL] }.into()
    }

    /// Returns the number object's value expressed as a C `float`, converted as necessary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1418317-floatvalue).
    #[inline]
    #[doc(alias = "floatValue")]
    pub fn float_value(&self) -> c_float {
        unsafe { _msg_send_any![self, floatValue] }
    }

    /// Returns the number object's value expressed as a C `double`, converted as necessary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1414104-doublevalue).
    #[inline]
    #[doc(alias = "doubleValue")]
    pub fn double_value(&self) -> c_double {
        unsafe { _msg_send_any![self, doubleValue] }
    }

    /// Returns the number object's value expressed as a C `char`, converted as necessary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1407838-charvalue).
    #[inline]
    #[doc(alias = "charValue")]
    pub fn char_value(&self) -> c_char {
        unsafe { _msg_send_any![self, charValue] }
    }

    /// Returns the number object's value expressed as a C `short`, converted as necessary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1407601-shortvalue).
    #[inline]
    #[doc(alias = "shortValue")]
    pub fn short_value(&self) -> c_short {
        unsafe { _msg_send_any![self, shortValue] }
    }

    /// Returns the number object's value expressed as a C `int`, converted as necessary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1407153-intvalue).
    #[inline]
    #[doc(alias = "intValue")]
    pub fn int_value(&self) -> c_int {
        unsafe { _msg_send_any![self, intValue] }
    }

    /// Returns the number object's value expressed as a C `long`, converted as necessary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1412566-longvalue).
    #[inline]
    #[doc(alias = "longValue")]
    pub fn long_value(&self) -> c_long {
        unsafe { _msg_send_any![self, longValue] }
    }

    /// Returns the number object's value expressed as a C `long long`, converted as necessary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1416870-longlongvalue).
    #[inline]
    #[doc(alias = "longLongValue")]
    pub fn longlong_value(&self) -> c_longlong {
        unsafe { _msg_send_any![self, longLongValue] }
    }

    /// Returns the number object's value expressed as an Objective-C integer, converted as necessary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1412554-integervalue).
    #[inline]
    #[doc(alias = "integerValue")]
    pub fn integer_value(&self) -> NSInteger {
        unsafe { _msg_send_any![self, integerValue] }
    }

    /// Returns the number object's value expressed as a C `unsigned char`, converted as necessary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1409016-unsignedcharvalue).
    #[inline]
    #[doc(alias = "unsignedCharValue")]
    pub fn unsigned_char_value(&self) -> c_uchar {
        unsafe { _msg_send_any![self, unsignedCharValue] }
    }

    /// Returns the number object's value expressed as a C `unsigned short`, converted as necessary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1410604-unsignedshortvalue).
    #[inline]
    #[doc(alias = "unsignedShortValue")]
    pub fn unsigned_short_value(&self) -> c_ushort {
        unsafe { _msg_send_any![self, unsignedShortValue] }
    }

    /// Returns the number object's value expressed as a C `unsigned int`, converted as necessary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1417875-unsignedintvalue).
    #[inline]
    #[doc(alias = "unsignedIntValue")]
    pub fn unsigned_int_value(&self) -> c_uint {
        unsafe { _msg_send_any![self, unsignedIntValue] }
    }

    /// Returns the number object's value expressed as a C `unsigned long`, converted as necessary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1415252-unsignedlongvalue).
    #[inline]
    #[doc(alias = "unsignedLongValue")]
    pub fn unsigned_long_value(&self) -> c_ulong {
        unsafe { _msg_send_any![self, unsignedLongValue] }
    }

    /// Returns the number object's value expressed as a C `unsigned long long`, converted as necessary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1414524-unsignedlonglongvalue).
    #[inline]
    #[doc(alias = "unsignedLongLongValue")]
    pub fn unsigned_longlong_value(&self) -> c_ulonglong {
        unsafe { _msg_send_any![self, unsignedLongLongValue] }
    }

    /// Returns the number object's value expressed as an Objective-C unsigned integer, converted as necessary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nsnumber/1413324-unsignedintegervalue).
    #[inline]
    #[doc(alias = "unsignedIntegerValue")]
    pub fn unsigned_integer_value(&self) -> NSUInteger {
        unsafe { _msg_send_any![self, unsignedIntegerValue] }
    }
}