1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

// Used for simplifying doc comments.
#[allow(unused_imports)]
use crate::foundation::{NSError, NSErrorRecoveryAttempting, NSNumber, NSString, NSStringEncoding};

ns_string_wrapper! {
    /// Keys that may exist in an [`NSError`] user info dictionary.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nserroruserinfokey).
    #[derive(Ord, PartialOrd, Eq, PartialEq)]
    pub wrapper NSErrorUserInfoKey;
}

macro_rules! key {
    (
        $(#[$docs:meta])+
        $fn:ident $value:literal
    ) => {
        $(#[$docs])+
        #[inline]
        #[doc(alias = $value)]
        pub fn $fn() -> &'static NSErrorUserInfoKey {
            extern "C" {
                #[link_name = $value]
                static VALUE: &'static NSErrorUserInfoKey;
            }
            unsafe { VALUE }
        }
    };
}

impl NSErrorUserInfoKey {
    // TODO: For newer keys, consider detecting the minimum version.

    key! {
        /// The corresponding value is an [`NSURL`].
        ///
        /// See [documentation](https://developer.apple.com/documentation/foundation/nsurlerrorkey).
        ns_url "NSURLErrorKey"
    }

    key! {
        /// Contains the file path of the error.
        ///
        /// The corresponding value is an [`NSString`].
        ///
        /// See [documentation](https://developer.apple.com/documentation/foundation/nsfilepatherrorkey).
        file_path "NSFilePathErrorKey"
    }

    key! {
        /// The corresponding value is an [`NSString`] containing the localized
        /// help corresponding to the help button.
        ///
        /// If present, its value is returned by [`NSError::help_anchor`].
        ///
        /// See [documentation](https://developer.apple.com/documentation/foundation/nshelpanchorerrorkey).
        help_anchor "NSHelpAnchorErrorKey"
    }

    key! {
        /// The corresponding value is an [`NSString`] containing the localized
        /// error description.
        ///
        /// If present, its value is returned by
        /// [`NSError::localized_description`].
        ///
        /// See [documentation](https://developer.apple.com/documentation/foundation/nslocalizeddescriptionkey).
        localized_description "NSLocalizedDescriptionKey"
    }

    key! {
        /// Returns `NSDebugDescriptionErrorKey`, which is currently
        /// undocumented.
        ///
        /// See [documentation](https://developer.apple.com/documentation/foundation/nsdebugdescriptionerrorkey).
        debug_description "NSDebugDescriptionErrorKey"
    }

    key! {
        /// Returns `NSLocalizedFailureErrorKey`, which is currently
        /// undocumented.
        ///
        /// See [documentation](https://developer.apple.com/documentation/foundation/nslocalizedfailureerrorkey).
        localized_failure "NSLocalizedFailureErrorKey"
    }

    key! {
        /// The corresponding value is an [`NSString`] containing the localized
        /// reason for the failure.
        ///
        /// If present, its value is returned by
        /// [`NSError::localized_failure_reason`].
        ///
        /// See [documentation](https://developer.apple.com/documentation/foundation/nslocalizedfailurereasonerrorkey).
        localized_failure_reason "NSLocalizedFailureReasonErrorKey"
    }

    key! {
        /// The corresponding value is an [`NSArray`]`<`[`NSString`]`>`
        /// containing the localized titles of buttons appropriate for displaying in
        /// an alert panel.
        ///
        /// If present, its value is returned by
        /// [`NSError::localized_recovery_options`].
        ///
        /// See [documentation](https://developer.apple.com/documentation/foundation/nslocalizedrecoveryoptionserrorkey).
        localized_recovery_options "NSLocalizedRecoveryOptionsErrorKey"
    }

    key! {
        /// The corresponding value is an [`NSString`] containing the localized
        /// recovery suggestion for the error.
        ///
        /// If present, its value is returned by
        /// [`NSError::localized_recovery_suggestion`].
        ///
        /// See [documentation](https://developer.apple.com/documentation/foundation/nslocalizedrecoverysuggestionerrorkey).
        localized_recovery_suggestion "NSLocalizedRecoverySuggestionErrorKey"
    }

    key! {
        /// The corresponding value is an object that conforms to the
        /// [`NSErrorRecoveryAttempting`] informal protocol.
        ///
        /// If present, its value is returned by
        /// [`NSError::recovery_attempter`].
        ///
        /// See [documentation](https://developer.apple.com/documentation/foundation/nsrecoveryattemptererrorkey).
        recovery_attempter "NSRecoveryAttempterErrorKey"
    }

    key! {
        /// The corresponding value is an [`NSNumber`] containing the
        /// [`NSStringEncoding`] value.
        ///
        /// See [documentation](https://developer.apple.com/documentation/foundation/nsrecoveryattemptererrorkey).
        string_encoding "NSStringEncodingErrorKey"
    }

    key! {
        /// The corresponding value is an error that was encountered in an
        /// underlying implementation and caused the error that the receiver
        /// represents to occur.
        ///
        /// See [documentation](https://developer.apple.com/documentation/foundation/nsrecoveryattemptererrorkey).
        underlying_error "NSUnderlyingErrorKey"
    }
}