]>
git.saurik.com Git - apple/objc4.git/blob - runtime/objc-api.h
2 * Copyright (c) 1999-2006 Apple Inc. All Rights Reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
21 * @APPLE_LICENSE_HEADER_END@
23 // Copyright 1988-1996 NeXT Software, Inc.
25 #ifndef _OBJC_OBJC_API_H_
26 #define _OBJC_OBJC_API_H_
28 #include <Availability.h>
29 #include <AvailabilityMacros.h>
30 #include <TargetConditionals.h>
31 #include <sys/types.h>
34 # define __has_feature(x) 0
37 #ifndef __has_extension
38 # define __has_extension __has_feature
41 #ifndef __has_attribute
42 # define __has_attribute(x) 0
45 #if !__has_feature(nullability)
52 # ifndef _Null_unspecified
53 # define _Null_unspecified
57 #ifndef __APPLE_BLEACH_SDK__
58 # if __has_feature(attribute_availability_bridgeos)
59 # ifndef __BRIDGEOS_AVAILABLE
60 # define __BRIDGEOS_AVAILABLE(_vers) __OS_AVAILABILITY(bridgeos,introduced=_vers)
62 # ifndef __BRIDGEOS_DEPRECATED
63 # define __BRIDGEOS_DEPRECATED(_start, _dep, _msg) __BRIDGEOS_AVAILABLE(_start) __OS_AVAILABILITY_MSG(bridgeos,deprecated=_dep,_msg)
65 # ifndef __BRIDGEOS_UNAVAILABLE
66 # define __BRIDGEOS_UNAVAILABLE __OS_AVAILABILITY(bridgeos,unavailable)
69 # ifndef __BRIDGEOS_AVAILABLE
70 # define __BRIDGEOS_AVAILABLE(_vers)
72 # ifndef __BRIDGEOS_DEPRECATED
73 # define __BRIDGEOS_DEPRECATED(_start, _dep, _msg)
75 # ifndef __BRIDGEOS_UNAVAILABLE
76 # define __BRIDGEOS_UNAVAILABLE
82 * OBJC_API_VERSION 0 or undef: Tiger and earlier API only
83 * OBJC_API_VERSION 2: Leopard and later API available
85 #if !defined(OBJC_API_VERSION)
86 # if defined(__MAC_OS_X_VERSION_MIN_REQUIRED) && __MAC_OS_X_VERSION_MIN_REQUIRED < __MAC_10_5
87 # define OBJC_API_VERSION 0
89 # define OBJC_API_VERSION 2
95 * OBJC_NO_GC 1: GC is not supported
96 * OBJC_NO_GC undef: GC is supported. This SDK no longer supports this mode.
98 * OBJC_NO_GC_API undef: Libraries must export any symbols that
99 * dual-mode code may links to.
100 * OBJC_NO_GC_API 1: Libraries need not export GC-related symbols.
102 #if defined(__OBJC_GC__)
103 # error Objective-C garbage collection is not supported.
105 /* GC is unsupported. GC API symbols are exported. */
106 # define OBJC_NO_GC 1
107 # undef OBJC_NO_GC_API
109 /* GC is unsupported. GC API symbols are not exported. */
110 # define OBJC_NO_GC 1
111 # define OBJC_NO_GC_API 1
115 /* NS_ENFORCE_NSOBJECT_DESIGNATED_INITIALIZER == 1
116 * marks -[NSObject init] as a designated initializer. */
117 #if !defined(NS_ENFORCE_NSOBJECT_DESIGNATED_INITIALIZER)
118 # define NS_ENFORCE_NSOBJECT_DESIGNATED_INITIALIZER 1
121 /* The arm64 ABI requires proper casting to ensure arguments are passed
123 #if defined(__arm64__) && !__swift__
124 # undef OBJC_OLD_DISPATCH_PROTOTYPES
125 # define OBJC_OLD_DISPATCH_PROTOTYPES 0
128 /* OBJC_OLD_DISPATCH_PROTOTYPES == 0 enforces the rule that the dispatch
129 * functions must be cast to an appropriate function pointer type. */
130 #if !defined(OBJC_OLD_DISPATCH_PROTOTYPES)
132 // Existing Swift code expects IMP to be Comparable.
133 // Variadic IMP is comparable via OpaquePointer; non-variadic IMP isn't.
134 # define OBJC_OLD_DISPATCH_PROTOTYPES 1
136 # define OBJC_OLD_DISPATCH_PROTOTYPES 0
141 /* OBJC_AVAILABLE: shorthand for all-OS availability */
142 #ifndef __APPLE_BLEACH_SDK__
143 # if !defined(OBJC_AVAILABLE)
144 # define OBJC_AVAILABLE(x, i, t, w, b) \
145 __OSX_AVAILABLE(x) __IOS_AVAILABLE(i) __TVOS_AVAILABLE(t) \
146 __WATCHOS_AVAILABLE(w) __BRIDGEOS_AVAILABLE(b)
149 # if !defined(OBJC_AVAILABLE)
150 # define OBJC_AVAILABLE(x, i, t, w, b) \
151 __OSX_AVAILABLE(x) __IOS_AVAILABLE(i) __TVOS_AVAILABLE(t) \
152 __WATCHOS_AVAILABLE(w)
157 /* OBJC_OSX_DEPRECATED_OTHERS_UNAVAILABLE: Deprecated on OS X,
158 * unavailable everywhere else. */
159 #ifndef __APPLE_BLEACH_SDK__
160 # if !defined(OBJC_OSX_DEPRECATED_OTHERS_UNAVAILABLE)
161 # define OBJC_OSX_DEPRECATED_OTHERS_UNAVAILABLE(_start, _dep, _msg) \
162 __OSX_DEPRECATED(_start, _dep, _msg) \
163 __IOS_UNAVAILABLE __TVOS_UNAVAILABLE \
164 __WATCHOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE
167 # if !defined(OBJC_OSX_DEPRECATED_OTHERS_UNAVAILABLE)
168 # define OBJC_OSX_DEPRECATED_OTHERS_UNAVAILABLE(_start, _dep, _msg) \
169 __OSX_DEPRECATED(_start, _dep, _msg) \
170 __IOS_UNAVAILABLE __TVOS_UNAVAILABLE \
171 __WATCHOS_UNAVAILABLE
176 /* OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE: Available on OS X,
177 * unavailable everywhere else. */
178 #ifndef __APPLE_BLEACH_SDK__
179 # if !defined(OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE)
180 # define OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE(vers) \
181 __OSX_AVAILABLE(vers) \
182 __IOS_UNAVAILABLE __TVOS_UNAVAILABLE \
183 __WATCHOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE
186 # if !defined(OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE)
187 # define OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE(vers) \
188 __OSX_AVAILABLE(vers) \
189 __IOS_UNAVAILABLE __TVOS_UNAVAILABLE \
190 __WATCHOS_UNAVAILABLE
195 /* OBJC_ISA_AVAILABILITY: `isa` will be deprecated or unavailable
197 #if !defined(OBJC_ISA_AVAILABILITY)
199 # define OBJC_ISA_AVAILABILITY __attribute__((deprecated))
201 # define OBJC_ISA_AVAILABILITY /* still available */
206 /* OBJC2_UNAVAILABLE: unavailable in objc 2.0, deprecated in Leopard */
207 #if !defined(OBJC2_UNAVAILABLE)
209 # define OBJC2_UNAVAILABLE UNAVAILABLE_ATTRIBUTE
211 /* plain C code also falls here, but this is close enough */
212 # define OBJC2_UNAVAILABLE \
213 __OSX_DEPRECATED(10.5, 10.5, "not available in __OBJC2__") \
214 __IOS_DEPRECATED(2.0, 2.0, "not available in __OBJC2__") \
215 __TVOS_UNAVAILABLE __WATCHOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE
219 /* OBJC_UNAVAILABLE: unavailable, with a message where supported */
220 #if !defined(OBJC_UNAVAILABLE)
221 # if __has_extension(attribute_unavailable_with_message)
222 # define OBJC_UNAVAILABLE(_msg) __attribute__((unavailable(_msg)))
224 # define OBJC_UNAVAILABLE(_msg) __attribute__((unavailable))
228 /* OBJC_DEPRECATED: deprecated, with a message where supported */
229 #if !defined(OBJC_DEPRECATED)
230 # if __has_extension(attribute_deprecated_with_message)
231 # define OBJC_DEPRECATED(_msg) __attribute__((deprecated(_msg)))
233 # define OBJC_DEPRECATED(_msg) __attribute__((deprecated))
237 /* OBJC_ARC_UNAVAILABLE: unavailable with -fobjc-arc */
238 #if !defined(OBJC_ARC_UNAVAILABLE)
239 # if __has_feature(objc_arc)
240 # define OBJC_ARC_UNAVAILABLE OBJC_UNAVAILABLE("not available in automatic reference counting mode")
242 # define OBJC_ARC_UNAVAILABLE
246 /* OBJC_SWIFT_UNAVAILABLE: unavailable in Swift */
247 #if !defined(OBJC_SWIFT_UNAVAILABLE)
248 # if __has_feature(attribute_availability_swift)
249 # define OBJC_SWIFT_UNAVAILABLE(_msg) __attribute__((availability(swift, unavailable, message=_msg)))
251 # define OBJC_SWIFT_UNAVAILABLE(_msg)
255 /* OBJC_ARM64_UNAVAILABLE: unavailable on arm64 (i.e. stret dispatch) */
256 #if !defined(OBJC_ARM64_UNAVAILABLE)
257 # if defined(__arm64__)
258 # define OBJC_ARM64_UNAVAILABLE OBJC_UNAVAILABLE("not available in arm64")
260 # define OBJC_ARM64_UNAVAILABLE
264 /* OBJC_GC_UNAVAILABLE: unavailable with -fobjc-gc or -fobjc-gc-only */
265 #if !defined(OBJC_GC_UNAVAILABLE)
266 # define OBJC_GC_UNAVAILABLE
269 #if !defined(OBJC_EXTERN)
270 # if defined(__cplusplus)
271 # define OBJC_EXTERN extern "C"
273 # define OBJC_EXTERN extern
277 #if !defined(OBJC_VISIBLE)
279 # if defined(BUILDING_OBJC)
280 # define OBJC_VISIBLE __declspec(dllexport)
282 # define OBJC_VISIBLE __declspec(dllimport)
285 # define OBJC_VISIBLE __attribute__((visibility("default")))
289 #if !defined(OBJC_EXPORT)
290 # define OBJC_EXPORT OBJC_EXTERN OBJC_VISIBLE
293 #if !defined(OBJC_IMPORT)
294 # define OBJC_IMPORT extern
297 #if !defined(OBJC_ROOT_CLASS)
298 # if __has_attribute(objc_root_class)
299 # define OBJC_ROOT_CLASS __attribute__((objc_root_class))
301 # define OBJC_ROOT_CLASS
305 #ifndef __DARWIN_NULL
306 #define __DARWIN_NULL NULL
309 #if !defined(OBJC_INLINE)
310 # define OBJC_INLINE __inline
313 // Declares an enum type or option bits type as appropriate for each language.
314 #if (__cplusplus && __cplusplus >= 201103L && (__has_extension(cxx_strong_enums) || __has_feature(objc_fixed_enum))) || (!__cplusplus && __has_feature(objc_fixed_enum))
315 #define OBJC_ENUM(_type, _name) enum _name : _type _name; enum _name : _type
317 #define OBJC_OPTIONS(_type, _name) _type _name; enum : _type
319 #define OBJC_OPTIONS(_type, _name) enum _name : _type _name; enum _name : _type
322 #define OBJC_ENUM(_type, _name) _type _name; enum
323 #define OBJC_OPTIONS(_type, _name) _type _name; enum
326 #if !defined(OBJC_RETURNS_RETAINED)
327 # if __OBJC__ && __has_attribute(ns_returns_retained)
328 # define OBJC_RETURNS_RETAINED __attribute__((ns_returns_retained))
330 # define OBJC_RETURNS_RETAINED