runtime/objc-api.h

   1 /*
   2  * Copyright (c) 1999-2006 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 // Copyright 1988-1996 NeXT Software, Inc.
  24
  25 #ifndef _OBJC_OBJC_API_H_
  26 #define _OBJC_OBJC_API_H_
  27
  28 #include <Availability.h>
  29 #include <AvailabilityMacros.h>
  30 #include <TargetConditionals.h>
  31 #include <sys/types.h>
  32
  33 #ifndef __has_feature
  34 #   define __has_feature(x) 0
  35 #endif
  36
  37 #ifndef __has_extension
  38 #   define __has_extension __has_feature
  39 #endif
  40
  41 #ifndef __has_attribute
  42 #   define __has_attribute(x) 0
  43 #endif
  44
  45 #if !__has_feature(nullability)
  46 #   ifndef _Nullable
  47 #       define _Nullable
  48 #   endif
  49 #   ifndef _Nonnull
  50 #       define _Nonnull
  51 #   endif
  52 #   ifndef _Null_unspecified
  53 #       define _Null_unspecified
  54 #   endif
  55 #endif
  56
  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)
  61 #   endif
  62 #   ifndef __BRIDGEOS_DEPRECATED
  63 #       define __BRIDGEOS_DEPRECATED(_start, _dep, _msg) __BRIDGEOS_AVAILABLE(_start) __OS_AVAILABILITY_MSG(bridgeos,deprecated=_dep,_msg)
  64 #   endif
  65 #   ifndef __BRIDGEOS_UNAVAILABLE
  66 #       define __BRIDGEOS_UNAVAILABLE __OS_AVAILABILITY(bridgeos,unavailable)
  67 #   endif
  68 # else
  69 #   ifndef __BRIDGEOS_AVAILABLE
  70 #       define __BRIDGEOS_AVAILABLE(_vers)
  71 #   endif
  72 #   ifndef __BRIDGEOS_DEPRECATED
  73 #       define __BRIDGEOS_DEPRECATED(_start, _dep, _msg)
  74 #   endif
  75 #   ifndef __BRIDGEOS_UNAVAILABLE
  76 #       define __BRIDGEOS_UNAVAILABLE
  77 #   endif
  78 # endif
  79 #endif
  80
  81 /*
  82  * OBJC_API_VERSION 0 or undef: Tiger and earlier API only
  83  * OBJC_API_VERSION 2: Leopard and later API available
  84  */
  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
  88 #   else
  89 #       define OBJC_API_VERSION 2
  90 #   endif
  91 #endif
  92
  93
  94 /*
  95  * OBJC_NO_GC 1: GC is not supported
  96  * OBJC_NO_GC undef: GC is supported. This SDK no longer supports this mode.
  97  *
  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.
 101  */
 102 #if defined(__OBJC_GC__)
 103 #   error Objective-C garbage collection is not supported.
 104 #elif TARGET_OS_OSX
 105     /* GC is unsupported. GC API symbols are exported. */
 106 #   define OBJC_NO_GC 1
 107 #   undef  OBJC_NO_GC_API
 108 #else
 109     /* GC is unsupported. GC API symbols are not exported. */
 110 #   define OBJC_NO_GC 1
 111 #   define OBJC_NO_GC_API 1
 112 #endif
 113
 114
 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
 119 #endif
 120
 121
 122 /* OBJC_OLD_DISPATCH_PROTOTYPES == 0 enforces the rule that the dispatch
 123  * functions must be cast to an appropriate function pointer type. */
 124 #if !defined(OBJC_OLD_DISPATCH_PROTOTYPES)
 125 #   if __swift__
 126         // Existing Swift code expects IMP to be Comparable.
 127         // Variadic IMP is comparable via OpaquePointer; non-variadic IMP isn't.
 128 #       define OBJC_OLD_DISPATCH_PROTOTYPES 1
 129 #   else
 130 #       define OBJC_OLD_DISPATCH_PROTOTYPES 0
 131 #   endif
 132 #endif
 133
 134
 135 /* OBJC_AVAILABLE: shorthand for all-OS availability */
 136 #ifndef __APPLE_BLEACH_SDK__
 137 #   if !defined(OBJC_AVAILABLE)
 138 #       define OBJC_AVAILABLE(x, i, t, w, b)                            \
 139             __OSX_AVAILABLE(x)  __IOS_AVAILABLE(i)  __TVOS_AVAILABLE(t) \
 140             __WATCHOS_AVAILABLE(w)  __BRIDGEOS_AVAILABLE(b)
 141 #   endif
 142 #else
 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)
 147 #   endif
 148 #endif
 149
 150
 151 /* OBJC_OSX_DEPRECATED_OTHERS_UNAVAILABLE: Deprecated on OS X,
 152  * unavailable everywhere else. */
 153 #ifndef __APPLE_BLEACH_SDK__
 154 #   if !defined(OBJC_OSX_DEPRECATED_OTHERS_UNAVAILABLE)
 155 #       define OBJC_OSX_DEPRECATED_OTHERS_UNAVAILABLE(_start, _dep, _msg) \
 156             __OSX_DEPRECATED(_start, _dep, _msg)                          \
 157             __IOS_UNAVAILABLE __TVOS_UNAVAILABLE                          \
 158             __WATCHOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE
 159 #   endif
 160 #else
 161 #   if !defined(OBJC_OSX_DEPRECATED_OTHERS_UNAVAILABLE)
 162 #       define OBJC_OSX_DEPRECATED_OTHERS_UNAVAILABLE(_start, _dep, _msg) \
 163             __OSX_DEPRECATED(_start, _dep, _msg)                          \
 164             __IOS_UNAVAILABLE __TVOS_UNAVAILABLE                          \
 165             __WATCHOS_UNAVAILABLE
 166 #   endif
 167 #endif
 168
 169
 170 /* OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE: Available on OS X,
 171  * unavailable everywhere else. */
 172 #ifndef __APPLE_BLEACH_SDK__
 173 #   if !defined(OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE)
 174 #       define OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE(vers) \
 175             __OSX_AVAILABLE(vers)                          \
 176             __IOS_UNAVAILABLE __TVOS_UNAVAILABLE           \
 177             __WATCHOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE
 178 #    endif
 179 #else
 180 #   if !defined(OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE)
 181 #       define OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE(vers) \
 182             __OSX_AVAILABLE(vers)                          \
 183             __IOS_UNAVAILABLE __TVOS_UNAVAILABLE           \
 184             __WATCHOS_UNAVAILABLE
 185 #    endif
 186 #endif
 187
 188
 189 /* OBJC_ISA_AVAILABILITY: `isa` will be deprecated or unavailable
 190  * in the future */
 191 #if !defined(OBJC_ISA_AVAILABILITY)
 192 #   if __OBJC2__
 193 #       define OBJC_ISA_AVAILABILITY  __attribute__((deprecated))
 194 #   else
 195 #       define OBJC_ISA_AVAILABILITY  /* still available */
 196 #   endif
 197 #endif
 198
 199
 200 /* OBJC2_UNAVAILABLE: unavailable in objc 2.0, deprecated in Leopard */
 201 #if !defined(OBJC2_UNAVAILABLE)
 202 #   if __OBJC2__
 203 #       define OBJC2_UNAVAILABLE UNAVAILABLE_ATTRIBUTE
 204 #   else
 205         /* plain C code also falls here, but this is close enough */
 206 #       define OBJC2_UNAVAILABLE                                       \
 207             __OSX_DEPRECATED(10.5, 10.5, "not available in __OBJC2__") \
 208             __IOS_DEPRECATED(2.0, 2.0, "not available in __OBJC2__")   \
 209             __TVOS_UNAVAILABLE __WATCHOS_UNAVAILABLE __BRIDGEOS_UNAVAILABLE
 210 #   endif
 211 #endif
 212
 213 /* OBJC_UNAVAILABLE: unavailable, with a message where supported */
 214 #if !defined(OBJC_UNAVAILABLE)
 215 #   if __has_extension(attribute_unavailable_with_message)
 216 #       define OBJC_UNAVAILABLE(_msg) __attribute__((unavailable(_msg)))
 217 #   else
 218 #       define OBJC_UNAVAILABLE(_msg) __attribute__((unavailable))
 219 #   endif
 220 #endif
 221
 222 /* OBJC_DEPRECATED: deprecated, with a message where supported */
 223 #if !defined(OBJC_DEPRECATED)
 224 #   if __has_extension(attribute_deprecated_with_message)
 225 #       define OBJC_DEPRECATED(_msg) __attribute__((deprecated(_msg)))
 226 #   else
 227 #       define OBJC_DEPRECATED(_msg) __attribute__((deprecated))
 228 #   endif
 229 #endif
 230
 231 /* OBJC_ARC_UNAVAILABLE: unavailable with -fobjc-arc */
 232 #if !defined(OBJC_ARC_UNAVAILABLE)
 233 #   if __has_feature(objc_arc)
 234 #       define OBJC_ARC_UNAVAILABLE OBJC_UNAVAILABLE("not available in automatic reference counting mode")
 235 #   else
 236 #       define OBJC_ARC_UNAVAILABLE
 237 #   endif
 238 #endif
 239
 240 /* OBJC_SWIFT_UNAVAILABLE: unavailable in Swift */
 241 #if !defined(OBJC_SWIFT_UNAVAILABLE)
 242 #   if __has_feature(attribute_availability_swift)
 243 #       define OBJC_SWIFT_UNAVAILABLE(_msg) __attribute__((availability(swift, unavailable, message=_msg)))
 244 #   else
 245 #       define OBJC_SWIFT_UNAVAILABLE(_msg)
 246 #   endif
 247 #endif
 248
 249 /* OBJC_ARM64_UNAVAILABLE: unavailable on arm64 (i.e. stret dispatch) */
 250 #if !defined(OBJC_ARM64_UNAVAILABLE)
 251 #   if defined(__arm64__)
 252 #       define OBJC_ARM64_UNAVAILABLE OBJC_UNAVAILABLE("not available in arm64")
 253 #   else
 254 #       define OBJC_ARM64_UNAVAILABLE
 255 #   endif
 256 #endif
 257
 258 /* OBJC_GC_UNAVAILABLE: unavailable with -fobjc-gc or -fobjc-gc-only */
 259 #if !defined(OBJC_GC_UNAVAILABLE)
 260 #   define OBJC_GC_UNAVAILABLE
 261 #endif
 262
 263 #if !defined(OBJC_EXTERN)
 264 #   if defined(__cplusplus)
 265 #       define OBJC_EXTERN extern "C"
 266 #   else
 267 #       define OBJC_EXTERN extern
 268 #   endif
 269 #endif
 270
 271 #if !defined(OBJC_VISIBLE)
 272 #   if TARGET_OS_WIN32
 273 #       if defined(BUILDING_OBJC)
 274 #           define OBJC_VISIBLE __declspec(dllexport)
 275 #       else
 276 #           define OBJC_VISIBLE __declspec(dllimport)
 277 #       endif
 278 #   else
 279 #       define OBJC_VISIBLE  __attribute__((visibility("default")))
 280 #   endif
 281 #endif
 282
 283 #if !defined(OBJC_EXPORT)
 284 #   define OBJC_EXPORT  OBJC_EXTERN OBJC_VISIBLE
 285 #endif
 286
 287 #if !defined(OBJC_IMPORT)
 288 #   define OBJC_IMPORT extern
 289 #endif
 290
 291 #if !defined(OBJC_ROOT_CLASS)
 292 #   if __has_attribute(objc_root_class)
 293 #       define OBJC_ROOT_CLASS __attribute__((objc_root_class))
 294 #   else
 295 #       define OBJC_ROOT_CLASS
 296 #   endif
 297 #endif
 298
 299 #ifndef __DARWIN_NULL
 300 #define __DARWIN_NULL NULL
 301 #endif
 302
 303 #if !defined(OBJC_INLINE)
 304 #   define OBJC_INLINE __inline
 305 #endif
 306
 307 // Declares an enum type or option bits type as appropriate for each language.
 308 #if (__cplusplus && __cplusplus >= 201103L && (__has_extension(cxx_strong_enums) || __has_feature(objc_fixed_enum))) || (!__cplusplus && __has_feature(objc_fixed_enum))
 309 #define OBJC_ENUM(_type, _name) enum _name : _type _name; enum _name : _type
 310 #if (__cplusplus)
 311 #define OBJC_OPTIONS(_type, _name) _type _name; enum : _type
 312 #else
 313 #define OBJC_OPTIONS(_type, _name) enum _name : _type _name; enum _name : _type
 314 #endif
 315 #else
 316 #define OBJC_ENUM(_type, _name) _type _name; enum
 317 #define OBJC_OPTIONS(_type, _name) _type _name; enum
 318 #endif
 319
 320 #if !defined(OBJC_RETURNS_RETAINED)
 321 #   if __OBJC__ && __has_attribute(ns_returns_retained)
 322 #       define OBJC_RETURNS_RETAINED __attribute__((ns_returns_retained))
 323 #   else
 324 #       define OBJC_RETURNS_RETAINED
 325 #   endif
 326 #endif
 327
 328 #endif