objc2-foundation 0.3.1

Bindings to the Foundation framework
Documentation 
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;

use crate::*;

/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsnoscripterror?language=objc)
pub const NSNoScriptError: NSInteger = 0;
/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsreceiverevaluationscripterror?language=objc)
pub const NSReceiverEvaluationScriptError: NSInteger = 1;
/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nskeyspecifierevaluationscripterror?language=objc)
pub const NSKeySpecifierEvaluationScriptError: NSInteger = 2;
/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsargumentevaluationscripterror?language=objc)
pub const NSArgumentEvaluationScriptError: NSInteger = 3;
/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsreceiverscanthandlecommandscripterror?language=objc)
pub const NSReceiversCantHandleCommandScriptError: NSInteger = 4;
/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsrequiredargumentsmissingscripterror?language=objc)
pub const NSRequiredArgumentsMissingScriptError: NSInteger = 5;
/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsargumentswrongscripterror?language=objc)
pub const NSArgumentsWrongScriptError: NSInteger = 6;
/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsunknownkeyscripterror?language=objc)
pub const NSUnknownKeyScriptError: NSInteger = 7;
/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsinternalscripterror?language=objc)
pub const NSInternalScriptError: NSInteger = 8;
/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsoperationnotsupportedforkeyscripterror?language=objc)
pub const NSOperationNotSupportedForKeyScriptError: NSInteger = 9;
/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nscannotcreatescriptcommanderror?language=objc)
pub const NSCannotCreateScriptCommandError: NSInteger = 10;

extern_class!(
    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsscriptcommand?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct NSScriptCommand;
);

#[cfg(feature = "NSObject")]
extern_conformance!(
    unsafe impl NSCoding for NSScriptCommand {}
);

extern_conformance!(
    unsafe impl NSObjectProtocol for NSScriptCommand {}
);

impl NSScriptCommand {
    extern_methods!(
        #[cfg(feature = "NSScriptCommandDescription")]
        #[unsafe(method(initWithCommandDescription:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithCommandDescription(
            this: Allocated<Self>,
            command_def: &NSScriptCommandDescription,
        ) -> Retained<Self>;

        #[cfg(feature = "NSCoder")]
        #[unsafe(method(initWithCoder:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithCoder(
            this: Allocated<Self>,
            in_coder: &NSCoder,
        ) -> Option<Retained<Self>>;

        #[cfg(feature = "NSScriptCommandDescription")]
        #[unsafe(method(commandDescription))]
        #[unsafe(method_family = none)]
        pub unsafe fn commandDescription(&self) -> Retained<NSScriptCommandDescription>;

        #[unsafe(method(directParameter))]
        #[unsafe(method_family = none)]
        pub unsafe fn directParameter(&self) -> Option<Retained<AnyObject>>;

        /// Setter for [`directParameter`][Self::directParameter].
        #[unsafe(method(setDirectParameter:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setDirectParameter(&self, direct_parameter: Option<&AnyObject>);

        #[cfg(feature = "NSScriptObjectSpecifiers")]
        #[unsafe(method(receiversSpecifier))]
        #[unsafe(method_family = none)]
        pub unsafe fn receiversSpecifier(&self) -> Option<Retained<NSScriptObjectSpecifier>>;

        #[cfg(feature = "NSScriptObjectSpecifiers")]
        /// Setter for [`receiversSpecifier`][Self::receiversSpecifier].
        #[unsafe(method(setReceiversSpecifier:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setReceiversSpecifier(
            &self,
            receivers_specifier: Option<&NSScriptObjectSpecifier>,
        );

        #[unsafe(method(evaluatedReceivers))]
        #[unsafe(method_family = none)]
        pub unsafe fn evaluatedReceivers(&self) -> Option<Retained<AnyObject>>;

        #[cfg(all(feature = "NSDictionary", feature = "NSString"))]
        #[unsafe(method(arguments))]
        #[unsafe(method_family = none)]
        pub unsafe fn arguments(&self) -> Option<Retained<NSDictionary<NSString, AnyObject>>>;

        #[cfg(all(feature = "NSDictionary", feature = "NSString"))]
        /// Setter for [`arguments`][Self::arguments].
        #[unsafe(method(setArguments:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setArguments(&self, arguments: Option<&NSDictionary<NSString, AnyObject>>);

        #[cfg(all(feature = "NSDictionary", feature = "NSString"))]
        #[unsafe(method(evaluatedArguments))]
        #[unsafe(method_family = none)]
        pub unsafe fn evaluatedArguments(
            &self,
        ) -> Option<Retained<NSDictionary<NSString, AnyObject>>>;

        #[unsafe(method(isWellFormed))]
        #[unsafe(method_family = none)]
        pub unsafe fn isWellFormed(&self) -> bool;

        #[unsafe(method(performDefaultImplementation))]
        #[unsafe(method_family = none)]
        pub unsafe fn performDefaultImplementation(&self) -> Option<Retained<AnyObject>>;

        #[unsafe(method(executeCommand))]
        #[unsafe(method_family = none)]
        pub unsafe fn executeCommand(&self) -> Option<Retained<AnyObject>>;

        #[unsafe(method(scriptErrorNumber))]
        #[unsafe(method_family = none)]
        pub unsafe fn scriptErrorNumber(&self) -> NSInteger;

        /// Setter for [`scriptErrorNumber`][Self::scriptErrorNumber].
        #[unsafe(method(setScriptErrorNumber:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setScriptErrorNumber(&self, script_error_number: NSInteger);

        #[cfg(feature = "NSAppleEventDescriptor")]
        #[unsafe(method(scriptErrorOffendingObjectDescriptor))]
        #[unsafe(method_family = none)]
        pub unsafe fn scriptErrorOffendingObjectDescriptor(
            &self,
        ) -> Option<Retained<NSAppleEventDescriptor>>;

        #[cfg(feature = "NSAppleEventDescriptor")]
        /// Setter for [`scriptErrorOffendingObjectDescriptor`][Self::scriptErrorOffendingObjectDescriptor].
        #[unsafe(method(setScriptErrorOffendingObjectDescriptor:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setScriptErrorOffendingObjectDescriptor(
            &self,
            script_error_offending_object_descriptor: Option<&NSAppleEventDescriptor>,
        );

        #[cfg(feature = "NSAppleEventDescriptor")]
        #[unsafe(method(scriptErrorExpectedTypeDescriptor))]
        #[unsafe(method_family = none)]
        pub unsafe fn scriptErrorExpectedTypeDescriptor(
            &self,
        ) -> Option<Retained<NSAppleEventDescriptor>>;

        #[cfg(feature = "NSAppleEventDescriptor")]
        /// Setter for [`scriptErrorExpectedTypeDescriptor`][Self::scriptErrorExpectedTypeDescriptor].
        #[unsafe(method(setScriptErrorExpectedTypeDescriptor:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setScriptErrorExpectedTypeDescriptor(
            &self,
            script_error_expected_type_descriptor: Option<&NSAppleEventDescriptor>,
        );

        #[cfg(feature = "NSString")]
        #[unsafe(method(scriptErrorString))]
        #[unsafe(method_family = none)]
        pub unsafe fn scriptErrorString(&self) -> Option<Retained<NSString>>;

        #[cfg(feature = "NSString")]
        /// Setter for [`scriptErrorString`][Self::scriptErrorString].
        #[unsafe(method(setScriptErrorString:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setScriptErrorString(&self, script_error_string: Option<&NSString>);

        #[unsafe(method(currentCommand))]
        #[unsafe(method_family = none)]
        pub unsafe fn currentCommand() -> Option<Retained<NSScriptCommand>>;

        #[cfg(feature = "NSAppleEventDescriptor")]
        #[unsafe(method(appleEvent))]
        #[unsafe(method_family = none)]
        pub unsafe fn appleEvent(&self) -> Option<Retained<NSAppleEventDescriptor>>;

        #[unsafe(method(suspendExecution))]
        #[unsafe(method_family = none)]
        pub unsafe fn suspendExecution(&self);

        #[unsafe(method(resumeExecutionWithResult:))]
        #[unsafe(method_family = none)]
        pub unsafe fn resumeExecutionWithResult(&self, result: Option<&AnyObject>);
    );
}

/// Methods declared on superclass `NSObject`.
impl NSScriptCommand {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;
    );
}