1/*
2 * Copyright (c) 2007-2016 by Apple Inc.. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
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
11 * file.
12 *
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.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23
24#ifndef __AVAILABILITY__
25#define __AVAILABILITY__
26 /*
27 These macros are for use in OS header files. They enable function prototypes
28 and Objective-C methods to be tagged with the OS version in which they
29 were first available; and, if applicable, the OS version in which they
30 became deprecated.
31
32 The desktop Mac OS X and iOS each have different version numbers.
33 The __OSX_AVAILABLE_STARTING() macro allows you to specify both the desktop
34 and iOS version numbers. For instance:
35 __OSX_AVAILABLE_STARTING(__MAC_10_2,__IPHONE_2_0)
36 means the function/method was first available on Mac OS X 10.2 on the desktop
37 and first available in iOS 2.0 on the iPhone.
38
39 If a function is available on one platform, but not the other a _NA (not
40 applicable) parameter is used. For instance:
41 __OSX_AVAILABLE_STARTING(__MAC_10_3,__IPHONE_NA)
42 means that the function/method was first available on Mac OS X 10.3, and it
43 currently not implemented on the iPhone.
44
45 At some point, a function/method may be deprecated. That means Apple
46 recommends applications stop using the function, either because there is a
47 better replacement or the functionality is being phased out. Deprecated
48 functions/methods can be tagged with a __OSX_AVAILABLE_BUT_DEPRECATED()
49 macro which specifies the OS version where the function became available
50 as well as the OS version in which it became deprecated. For instance:
51 __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_5,__IPHONE_NA,__IPHONE_NA)
52 means that the function/method was introduced in Mac OS X 10.0, then
53 became deprecated beginning in Mac OS X 10.5. On iOS the function
54 has never been available.
55
56 For these macros to function properly, a program must specify the OS version range
57 it is targeting. The min OS version is specified as an option to the compiler:
58 -mmacosx-version-min=10.x when building for Mac OS X, and -miphoneos-version-min=y.z
59 when building for the iPhone. The upper bound for the OS version is rarely needed,
60 but it can be set on the command line via: -D__MAC_OS_X_VERSION_MAX_ALLOWED=10x0 for
61 Mac OS X and __IPHONE_OS_VERSION_MAX_ALLOWED = y0z00 for iOS.
62
63 Examples:
64
65 A function available in Mac OS X 10.5 and later, but not on the phone:
66
67 extern void mymacfunc() __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_NA);
68
69
70 An Objective-C method in Mac OS X 10.5 and later, but not on the phone:
71
72 @interface MyClass : NSObject
73 -(void) mymacmethod __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_NA);
74 @end
75
76
77 An enum available on the phone, but not available on Mac OS X:
78
79 #if __IPHONE_OS_VERSION_MIN_REQUIRED
80 enum { myEnum = 1 };
81 #endif
82 Note: this works when targeting the Mac OS X platform because
83 __IPHONE_OS_VERSION_MIN_REQUIRED is undefined which evaluates to zero.
84
85
86 An enum with values added in different iPhoneOS versions:
87
88 enum {
89 myX = 1, // Usable on iPhoneOS 2.1 and later
90 myY = 2, // Usable on iPhoneOS 3.0 and later
91 myZ = 3, // Usable on iPhoneOS 3.0 and later
92 ...
93 Note: you do not want to use #if with enumeration values
94 when a client needs to see all values at compile time
95 and use runtime logic to only use the viable values.
96
97
98 It is also possible to use the *_VERSION_MIN_REQUIRED in source code to make one
99 source base that can be compiled to target a range of OS versions. It is best
100 to not use the _MAC_* and __IPHONE_* macros for comparisons, but rather their values.
101 That is because you might get compiled on an old OS that does not define a later
102 OS version macro, and in the C preprocessor undefined values evaluate to zero
103 in expresssions, which could cause the #if expression to evaluate in an unexpected
104 way.
105
106 #ifdef __MAC_OS_X_VERSION_MIN_REQUIRED
107 // code only compiled when targeting Mac OS X and not iPhone
108 // note use of 1050 instead of __MAC_10_5
109 #if __MAC_OS_X_VERSION_MIN_REQUIRED < 1050
110 // code in here might run on pre-Leopard OS
111 #else
112 // code here can assume Leopard or later
113 #endif
114 #endif
115
116
117*/
118
119/*
120 * __API_TO_BE_DEPRECATED is used as a version number in API that will be deprecated
121 * in an upcoming release. This soft deprecation is an intermediate step before formal
122 * deprecation to notify developers about the API before compiler warnings are generated.
123 * You can find all places in your code that use soft deprecated API by redefining the
124 * value of this macro to your current minimum deployment target, for example:
125 * (macOS)
126 * clang -D__API_TO_BE_DEPRECATED=10.12 <other compiler flags>
127 * (iOS)
128 * clang -D__API_TO_BE_DEPRECATED=11.0 <other compiler flags>
129 */
130
131#ifndef __API_TO_BE_DEPRECATED
132#define __API_TO_BE_DEPRECATED 100000
133#endif
134
135#define __MAC_10_0 1000
136#define __MAC_10_1 1010
137#define __MAC_10_2 1020
138#define __MAC_10_3 1030
139#define __MAC_10_4 1040
140#define __MAC_10_5 1050
141#define __MAC_10_6 1060
142#define __MAC_10_7 1070
143#define __MAC_10_8 1080
144#define __MAC_10_9 1090
145#define __MAC_10_10 101000
146#define __MAC_10_10_2 101002
147#define __MAC_10_10_3 101003
148#define __MAC_10_11 101100
149#define __MAC_10_11_2 101102
150#define __MAC_10_11_3 101103
151#define __MAC_10_11_4 101104
152#define __MAC_10_12 101200
153#define __MAC_10_12_1 101201
154#define __MAC_10_12_2 101202
155#define __MAC_10_12_4 101204
156#define __MAC_10_13 101300
157#define __MAC_10_13_1 101301
158#define __MAC_10_13_2 101302
159#define __MAC_10_13_4 101304
160#define __MAC_10_14 101400
161#define __MAC_10_14_1 101401
162#define __MAC_10_14_4 101404
163/* __MAC_NA is not defined to a value but is uses as a token by macros to indicate that the API is unavailable */
164
165#define __IPHONE_2_0 20000
166#define __IPHONE_2_1 20100
167#define __IPHONE_2_2 20200
168#define __IPHONE_3_0 30000
169#define __IPHONE_3_1 30100
170#define __IPHONE_3_2 30200
171#define __IPHONE_4_0 40000
172#define __IPHONE_4_1 40100
173#define __IPHONE_4_2 40200
174#define __IPHONE_4_3 40300
175#define __IPHONE_5_0 50000
176#define __IPHONE_5_1 50100
177#define __IPHONE_6_0 60000
178#define __IPHONE_6_1 60100
179#define __IPHONE_7_0 70000
180#define __IPHONE_7_1 70100
181#define __IPHONE_8_0 80000
182#define __IPHONE_8_1 80100
183#define __IPHONE_8_2 80200
184#define __IPHONE_8_3 80300
185#define __IPHONE_8_4 80400
186#define __IPHONE_9_0 90000
187#define __IPHONE_9_1 90100
188#define __IPHONE_9_2 90200
189#define __IPHONE_9_3 90300
190#define __IPHONE_10_0 100000
191#define __IPHONE_10_1 100100
192#define __IPHONE_10_2 100200
193#define __IPHONE_10_3 100300
194#define __IPHONE_11_0 110000
195#define __IPHONE_11_1 110100
196#define __IPHONE_11_2 110200
197#define __IPHONE_11_3 110300
198#define __IPHONE_11_4 110400
199#define __IPHONE_12_0 120000
200#define __IPHONE_12_1 120100
201#define __IPHONE_12_2 120200
202/* __IPHONE_NA is not defined to a value but is uses as a token by macros to indicate that the API is unavailable */
203
204#define __TVOS_9_0 90000
205#define __TVOS_9_1 90100
206#define __TVOS_9_2 90200
207#define __TVOS_10_0 100000
208#define __TVOS_10_0_1 100001
209#define __TVOS_10_1 100100
210#define __TVOS_10_2 100200
211#define __TVOS_11_0 110000
212#define __TVOS_11_1 110100
213#define __TVOS_11_2 110200
214#define __TVOS_11_3 110300
215#define __TVOS_11_4 110400
216#define __TVOS_12_0 120000
217#define __TVOS_12_1 120100
218#define __TVOS_12_2 120200
219
220#define __WATCHOS_1_0 10000
221#define __WATCHOS_2_0 20000
222#define __WATCHOS_2_1 20100
223#define __WATCHOS_2_2 20200
224#define __WATCHOS_3_0 30000
225#define __WATCHOS_3_1 30100
226#define __WATCHOS_3_1_1 30101
227#define __WATCHOS_3_2 30200
228#define __WATCHOS_4_0 40000
229#define __WATCHOS_4_1 40100
230#define __WATCHOS_4_2 40200
231#define __WATCHOS_4_3 40300
232#define __WATCHOS_5_0 50000
233#define __WATCHOS_5_1 50100
234#define __WATCHOS_5_2 50200
235
236#include <AvailabilityInternal.h>
237
238#ifdef __IPHONE_OS_VERSION_MIN_REQUIRED
239 #define __OSX_AVAILABLE_STARTING(_osx, _ios) __AVAILABILITY_INTERNAL##_ios
240 #define __OSX_AVAILABLE_BUT_DEPRECATED(_osxIntro, _osxDep, _iosIntro, _iosDep) \
241 __AVAILABILITY_INTERNAL##_iosIntro##_DEP##_iosDep
242 #define __OSX_AVAILABLE_BUT_DEPRECATED_MSG(_osxIntro, _osxDep, _iosIntro, _iosDep, _msg) \
243 __AVAILABILITY_INTERNAL##_iosIntro##_DEP##_iosDep##_MSG(_msg)
244
245#elif defined(__MAC_OS_X_VERSION_MIN_REQUIRED)
246 #define __OSX_AVAILABLE_STARTING(_osx, _ios) __AVAILABILITY_INTERNAL##_osx
247 #define __OSX_AVAILABLE_BUT_DEPRECATED(_osxIntro, _osxDep, _iosIntro, _iosDep) \
248 __AVAILABILITY_INTERNAL##_osxIntro##_DEP##_osxDep
249 #define __OSX_AVAILABLE_BUT_DEPRECATED_MSG(_osxIntro, _osxDep, _iosIntro, _iosDep, _msg) \
250 __AVAILABILITY_INTERNAL##_osxIntro##_DEP##_osxDep##_MSG(_msg)
251
252#else
253 #define __OSX_AVAILABLE_STARTING(_osx, _ios)
254 #define __OSX_AVAILABLE_BUT_DEPRECATED(_osxIntro, _osxDep, _iosIntro, _iosDep)
255 #define __OSX_AVAILABLE_BUT_DEPRECATED_MSG(_osxIntro, _osxDep, _iosIntro, _iosDep, _msg)
256#endif
257
258
259#if defined(__has_feature)
260 #if __has_feature(attribute_availability_with_message)
261 #define __OS_AVAILABILITY(_target, _availability) __attribute__((availability(_target,_availability)))
262 #define __OS_AVAILABILITY_MSG(_target, _availability, _msg) __attribute__((availability(_target,_availability,message=_msg)))
263 #elif __has_feature(attribute_availability)
264 #define __OS_AVAILABILITY(_target, _availability) __attribute__((availability(_target,_availability)))
265 #define __OS_AVAILABILITY_MSG(_target, _availability, _msg) __attribute__((availability(_target,_availability)))
266 #else
267 #define __OS_AVAILABILITY(_target, _availability)
268 #define __OS_AVAILABILITY_MSG(_target, _availability, _msg)
269 #endif
270#else
271 #define __OS_AVAILABILITY(_target, _availability)
272 #define __OS_AVAILABILITY_MSG(_target, _availability, _msg)
273#endif
274
275
276/* for use to document app extension usage */
277#if defined(__has_feature)
278 #if __has_feature(attribute_availability_app_extension)
279 #define __OSX_EXTENSION_UNAVAILABLE(_msg) __OS_AVAILABILITY_MSG(macosx_app_extension,unavailable,_msg)
280 #define __IOS_EXTENSION_UNAVAILABLE(_msg) __OS_AVAILABILITY_MSG(ios_app_extension,unavailable,_msg)
281 #else
282 #define __OSX_EXTENSION_UNAVAILABLE(_msg)
283 #define __IOS_EXTENSION_UNAVAILABLE(_msg)
284 #endif
285#else
286 #define __OSX_EXTENSION_UNAVAILABLE(_msg)
287 #define __IOS_EXTENSION_UNAVAILABLE(_msg)
288#endif
289
290#define __OS_EXTENSION_UNAVAILABLE(_msg) __OSX_EXTENSION_UNAVAILABLE(_msg) __IOS_EXTENSION_UNAVAILABLE(_msg)
291
292
293
294/* for use marking APIs available info for Mac OSX */
295#if defined(__has_attribute)
296 #if __has_attribute(availability)
297 #define __OSX_UNAVAILABLE __OS_AVAILABILITY(macosx,unavailable)
298 #define __OSX_AVAILABLE(_vers) __OS_AVAILABILITY(macosx,introduced=_vers)
299 #define __OSX_DEPRECATED(_start, _dep, _msg) __OSX_AVAILABLE(_start) __OS_AVAILABILITY_MSG(macosx,deprecated=_dep,_msg)
300 #endif
301#endif
302
303#ifndef __OSX_UNAVAILABLE
304 #define __OSX_UNAVAILABLE
305#endif
306
307#ifndef __OSX_AVAILABLE
308 #define __OSX_AVAILABLE(_vers)
309#endif
310
311#ifndef __OSX_DEPRECATED
312 #define __OSX_DEPRECATED(_start, _dep, _msg)
313#endif
314
315
316/* for use marking APIs available info for iOS */
317#if defined(__has_attribute)
318 #if __has_attribute(availability)
319 #define __IOS_UNAVAILABLE __OS_AVAILABILITY(ios,unavailable)
320 #define __IOS_PROHIBITED __OS_AVAILABILITY(ios,unavailable)
321 #define __IOS_AVAILABLE(_vers) __OS_AVAILABILITY(ios,introduced=_vers)
322 #define __IOS_DEPRECATED(_start, _dep, _msg) __IOS_AVAILABLE(_start) __OS_AVAILABILITY_MSG(ios,deprecated=_dep,_msg)
323 #endif
324#endif
325
326#ifndef __IOS_UNAVAILABLE
327 #define __IOS_UNAVAILABLE
328#endif
329
330#ifndef __IOS_PROHIBITED
331 #define __IOS_PROHIBITED
332#endif
333
334#ifndef __IOS_AVAILABLE
335 #define __IOS_AVAILABLE(_vers)
336#endif
337
338#ifndef __IOS_DEPRECATED
339 #define __IOS_DEPRECATED(_start, _dep, _msg)
340#endif
341
342
343/* for use marking APIs available info for tvOS */
344#if defined(__has_feature)
345 #if __has_feature(attribute_availability_tvos)
346 #define __TVOS_UNAVAILABLE __OS_AVAILABILITY(tvos,unavailable)
347 #define __TVOS_PROHIBITED __OS_AVAILABILITY(tvos,unavailable)
348 #define __TVOS_AVAILABLE(_vers) __OS_AVAILABILITY(tvos,introduced=_vers)
349 #define __TVOS_DEPRECATED(_start, _dep, _msg) __TVOS_AVAILABLE(_start) __OS_AVAILABILITY_MSG(tvos,deprecated=_dep,_msg)
350 #endif
351#endif
352
353#ifndef __TVOS_UNAVAILABLE
354 #define __TVOS_UNAVAILABLE
355#endif
356
357#ifndef __TVOS_PROHIBITED
358 #define __TVOS_PROHIBITED
359#endif
360
361#ifndef __TVOS_AVAILABLE
362 #define __TVOS_AVAILABLE(_vers)
363#endif
364
365#ifndef __TVOS_DEPRECATED
366 #define __TVOS_DEPRECATED(_start, _dep, _msg)
367#endif
368
369
370/* for use marking APIs available info for Watch OS */
371#if defined(__has_feature)
372 #if __has_feature(attribute_availability_watchos)
373 #define __WATCHOS_UNAVAILABLE __OS_AVAILABILITY(watchos,unavailable)
374 #define __WATCHOS_PROHIBITED __OS_AVAILABILITY(watchos,unavailable)
375 #define __WATCHOS_AVAILABLE(_vers) __OS_AVAILABILITY(watchos,introduced=_vers)
376 #define __WATCHOS_DEPRECATED(_start, _dep, _msg) __WATCHOS_AVAILABLE(_start) __OS_AVAILABILITY_MSG(watchos,deprecated=_dep,_msg)
377 #endif
378#endif
379
380#ifndef __WATCHOS_UNAVAILABLE
381 #define __WATCHOS_UNAVAILABLE
382#endif
383
384#ifndef __WATCHOS_PROHIBITED
385 #define __WATCHOS_PROHIBITED
386#endif
387
388#ifndef __WATCHOS_AVAILABLE
389 #define __WATCHOS_AVAILABLE(_vers)
390#endif
391
392#ifndef __WATCHOS_DEPRECATED
393 #define __WATCHOS_DEPRECATED(_start, _dep, _msg)
394#endif
395
396
397/* for use marking APIs unavailable for swift */
398#if defined(__has_feature)
399 #if __has_feature(attribute_availability_swift)
400 #define __SWIFT_UNAVAILABLE __OS_AVAILABILITY(swift,unavailable)
401 #define __SWIFT_UNAVAILABLE_MSG(_msg) __OS_AVAILABILITY_MSG(swift,unavailable,_msg)
402 #endif
403#endif
404
405#ifndef __SWIFT_UNAVAILABLE
406 #define __SWIFT_UNAVAILABLE
407#endif
408
409#ifndef __SWIFT_UNAVAILABLE_MSG
410 #define __SWIFT_UNAVAILABLE_MSG(_msg)
411#endif
412
413/*
414 Macros for defining which versions/platform a given symbol can be used.
415
416 @see http://clang.llvm.org/docs/AttributeReference.html#availability
417
418 * Note that these macros are only compatible with clang compilers that
419 * support the following target selection options:
420 *
421 * -mmacosx-version-min
422 * -miphoneos-version-min
423 * -mwatchos-version-min
424 * -mtvos-version-min
425 */
426
427#if defined(__has_feature) && defined(__has_attribute)
428 #if __has_attribute(availability)
429
430 /*
431 * API Introductions
432 *
433 * Use to specify the release that a particular API became available.
434 *
435 * Platform names:
436 * macos, ios, tvos, watchos
437 *
438 * Examples:
439 * __API_AVAILABLE(macos(10.10))
440 * __API_AVAILABLE(macos(10.9), ios(10.0))
441 * __API_AVAILABLE(macos(10.4), ios(8.0), watchos(2.0), tvos(10.0))
442 */
443 #define __API_AVAILABLE(...) __API_AVAILABLE_GET_MACRO(__VA_ARGS__,__API_AVAILABLE6, __API_AVAILABLE5, __API_AVAILABLE4, __API_AVAILABLE3, __API_AVAILABLE2, __API_AVAILABLE1, 0)(__VA_ARGS__)
444
445
446 /*
447 * API Deprecations
448 *
449 * Use to specify the release that a particular API became unavailable.
450 *
451 * Platform names:
452 * macos, ios, tvos, watchos
453 *
454 * Examples:
455 *
456 * __API_DEPRECATED("No longer supported", macos(10.4, 10.8))
457 * __API_DEPRECATED("No longer supported", macos(10.4, 10.8), ios(2.0, 3.0), watchos(2.0, 3.0), tvos(9.0, 10.0))
458 *
459 * __API_DEPRECATED_WITH_REPLACEMENT("-setName:", tvos(10.0, 10.4), ios(9.0, 10.0))
460 * __API_DEPRECATED_WITH_REPLACEMENT("SomeClassName", macos(10.4, 10.6), watchos(2.0, 3.0))
461 */
462 #define __API_DEPRECATED(...) __API_DEPRECATED_MSG_GET_MACRO(__VA_ARGS__,__API_DEPRECATED_MSG7,__API_DEPRECATED_MSG6,__API_DEPRECATED_MSG5,__API_DEPRECATED_MSG4,__API_DEPRECATED_MSG3,__API_DEPRECATED_MSG2,__API_DEPRECATED_MSG1, 0)(__VA_ARGS__)
463 #define __API_DEPRECATED_WITH_REPLACEMENT(...) __API_DEPRECATED_REP_GET_MACRO(__VA_ARGS__,__API_DEPRECATED_REP7,__API_DEPRECATED_REP6,__API_DEPRECATED_REP5,__API_DEPRECATED_REP4,__API_DEPRECATED_REP3,__API_DEPRECATED_REP2,__API_DEPRECATED_REP1, 0)(__VA_ARGS__)
464
465 /*
466 * API Unavailability
467 * Use to specify that an API is unavailable for a particular platform.
468 *
469 * Example:
470 * __API_UNAVAILABLE(macos)
471 * __API_UNAVAILABLE(watchos, tvos)
472 */
473 #define __API_UNAVAILABLE(...) __API_UNAVAILABLE_GET_MACRO(__VA_ARGS__,__API_UNAVAILABLE6,__API_UNAVAILABLE5,__API_UNAVAILABLE4,__API_UNAVAILABLE3,__API_UNAVAILABLE2,__API_UNAVAILABLE1, 0)(__VA_ARGS__)
474 #else
475
476 /*
477 * Evaluate to nothing for compilers that don't support availability.
478 */
479
480 #define __API_AVAILABLE(...)
481 #define __API_DEPRECATED(...)
482 #define __API_DEPRECATED_WITH_REPLACEMENT(...)
483 #define __API_UNAVAILABLE(...)
484 #endif /* __has_attribute(availability) */
485#else
486
487 /*
488 * Evaluate to nothing for compilers that don't support clang language extensions.
489 */
490
491 #define __API_AVAILABLE(...)
492 #define __API_DEPRECATED(...)
493 #define __API_DEPRECATED_WITH_REPLACEMENT(...)
494 #define __API_UNAVAILABLE(...)
495#endif /* #if defined(__has_feature) && defined(__has_attribute) */
496
497#if __has_include(<AvailabilityProhibitedInternal.h>)
498 #include <AvailabilityProhibitedInternal.h>
499#endif
500
501#endif /* __AVAILABILITY__ */
502
503