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
  32 #ifndef __has_feature
  33 #   define __has_feature(x) 0
  34 #endif
  35
  36 #ifndef __has_extension
  37 #   define __has_extension __has_feature
  38 #endif
  39
  40 #ifndef __has_attribute
  41 #   define __has_attribute(x) 0
  42 #endif
  43
  44
  45 /*
  46  * OBJC_API_VERSION 0 or undef: Tiger and earlier API only
  47  * OBJC_API_VERSION 2: Leopard and later API available
  48  */
  49 #if !defined(OBJC_API_VERSION)
  50 #   if defined(__MAC_OS_X_VERSION_MIN_REQUIRED)  &&  __MAC_OS_X_VERSION_MIN_REQUIRED < __MAC_10_5
  51 #       define OBJC_API_VERSION 0
  52 #   else
  53 #       define OBJC_API_VERSION 2
  54 #   endif
  55 #endif
  56
  57
  58 /*
  59  * OBJC_NO_GC 1: GC is not supported
  60  * OBJC_NO_GC undef: GC is supported. This SDK no longer supports this mode.
  61  *
  62  * OBJC_NO_GC_API undef: Libraries must export any symbols that
  63  *                       dual-mode code may links to.
  64  * OBJC_NO_GC_API 1: Libraries need not export GC-related symbols.
  65  */
  66 #if defined(__OBJC_GC__)
  67 #   error Objective-C garbage collection is not supported.
  68 #elif TARGET_OS_OSX
  69     /* GC is unsupported. GC API symbols are exported. */
  70 #   define OBJC_NO_GC 1
  71 #   undef  OBJC_NO_GC_API
  72 #else
  73     /* GC is unsupported. GC API symbols are not exported. */
  74 #   define OBJC_NO_GC 1
  75 #   define OBJC_NO_GC_API 1
  76 #endif
  77
  78
  79 /* NS_ENFORCE_NSOBJECT_DESIGNATED_INITIALIZER == 1
  80  * marks -[NSObject init] as a designated initializer. */
  81 #if !defined(NS_ENFORCE_NSOBJECT_DESIGNATED_INITIALIZER)
  82 #   define NS_ENFORCE_NSOBJECT_DESIGNATED_INITIALIZER 1
  83 #endif
  84
  85
  86 /* OBJC_OLD_DISPATCH_PROTOTYPES == 0 enforces the rule that the dispatch
  87  * functions must be cast to an appropriate function pointer type. */
  88 #if !defined(OBJC_OLD_DISPATCH_PROTOTYPES)
  89 #   define OBJC_OLD_DISPATCH_PROTOTYPES 1
  90 #endif
  91
  92
  93 /* OBJC_AVAILABLE: shorthand for all-OS availability */
  94 #if !defined(OBJC_AVAILABLE)
  95 #   define OBJC_AVAILABLE(x, i, t, w)                \
  96         __OSX_AVAILABLE(x)  __IOS_AVAILABLE(i)       \
  97         __TVOS_AVAILABLE(t) __WATCHOS_AVAILABLE(w)
  98 #endif
  99
 100
 101 /* OBJC_ISA_AVAILABILITY: `isa` will be deprecated or unavailable
 102  * in the future */
 103 #if !defined(OBJC_ISA_AVAILABILITY)
 104 #   if __OBJC2__
 105 #       define OBJC_ISA_AVAILABILITY  __attribute__((deprecated))
 106 #   else
 107 #       define OBJC_ISA_AVAILABILITY  /* still available */
 108 #   endif
 109 #endif
 110
 111
 112 /* OBJC2_UNAVAILABLE: unavailable in objc 2.0, deprecated in Leopard */
 113 #if !defined(OBJC2_UNAVAILABLE)
 114 #   if __OBJC2__
 115 #       define OBJC2_UNAVAILABLE UNAVAILABLE_ATTRIBUTE
 116 #   else
 117         /* plain C code also falls here, but this is close enough */
 118 #       define OBJC2_UNAVAILABLE                                       \
 119             __OSX_DEPRECATED(10.5, 10.5, "not available in __OBJC2__") \
 120             __IOS_DEPRECATED(2.0, 2.0, "not available in __OBJC2__")   \
 121             __TVOS_UNAVAILABLE __WATCHOS_UNAVAILABLE
 122 #   endif
 123 #endif
 124
 125 /* OBJC_UNAVAILABLE: unavailable, with a message where supported */
 126 #if !defined(OBJC_UNAVAILABLE)
 127 #   if __has_extension(attribute_unavailable_with_message)
 128 #       define OBJC_UNAVAILABLE(_msg) __attribute__((unavailable(_msg)))
 129 #   else
 130 #       define OBJC_UNAVAILABLE(_msg) __attribute__((unavailable))
 131 #   endif
 132 #endif
 133
 134 /* OBJC_DEPRECATED: deprecated, with a message where supported */
 135 #if !defined(OBJC_DEPRECATED)
 136 #   if __has_extension(attribute_deprecated_with_message)
 137 #       define OBJC_DEPRECATED(_msg) __attribute__((deprecated(_msg)))
 138 #   else
 139 #       define OBJC_DEPRECATED(_msg) __attribute__((deprecated))
 140 #   endif
 141 #endif
 142
 143 /* OBJC_ARC_UNAVAILABLE: unavailable with -fobjc-arc */
 144 #if !defined(OBJC_ARC_UNAVAILABLE)
 145 #   if __has_feature(objc_arc)
 146 #       define OBJC_ARC_UNAVAILABLE OBJC_UNAVAILABLE("not available in automatic reference counting mode")
 147 #   else
 148 #       define OBJC_ARC_UNAVAILABLE
 149 #   endif
 150 #endif
 151
 152 /* OBJC_SWIFT_UNAVAILABLE: unavailable in Swift */
 153 #if !defined(OBJC_SWIFT_UNAVAILABLE)
 154 #   if __has_feature(attribute_availability_swift)
 155 #       define OBJC_SWIFT_UNAVAILABLE(_msg) __attribute__((availability(swift, unavailable, message=_msg)))
 156 #   else
 157 #       define OBJC_SWIFT_UNAVAILABLE(_msg)
 158 #   endif
 159 #endif
 160
 161 /* OBJC_ARM64_UNAVAILABLE: unavailable on arm64 (i.e. stret dispatch) */
 162 #if !defined(OBJC_ARM64_UNAVAILABLE)
 163 #   if defined(__arm64__)
 164 #       define OBJC_ARM64_UNAVAILABLE OBJC_UNAVAILABLE("not available in arm64")
 165 #   else
 166 #       define OBJC_ARM64_UNAVAILABLE
 167 #   endif
 168 #endif
 169
 170 /* OBJC_GC_UNAVAILABLE: unavailable with -fobjc-gc or -fobjc-gc-only */
 171 #if !defined(OBJC_GC_UNAVAILABLE)
 172 #   define OBJC_GC_UNAVAILABLE
 173 #endif
 174
 175 #if !defined(OBJC_EXTERN)
 176 #   if defined(__cplusplus)
 177 #       define OBJC_EXTERN extern "C"
 178 #   else
 179 #       define OBJC_EXTERN extern
 180 #   endif
 181 #endif
 182
 183 #if !defined(OBJC_VISIBLE)
 184 #   if TARGET_OS_WIN32
 185 #       if defined(BUILDING_OBJC)
 186 #           define OBJC_VISIBLE __declspec(dllexport)
 187 #       else
 188 #           define OBJC_VISIBLE __declspec(dllimport)
 189 #       endif
 190 #   else
 191 #       define OBJC_VISIBLE  __attribute__((visibility("default")))
 192 #   endif
 193 #endif
 194
 195 #if !defined(OBJC_EXPORT)
 196 #   define OBJC_EXPORT  OBJC_EXTERN OBJC_VISIBLE
 197 #endif
 198
 199 #if !defined(OBJC_IMPORT)
 200 #   define OBJC_IMPORT extern
 201 #endif
 202
 203 #if !defined(OBJC_ROOT_CLASS)
 204 #   if __has_attribute(objc_root_class)
 205 #       define OBJC_ROOT_CLASS __attribute__((objc_root_class))
 206 #   else
 207 #       define OBJC_ROOT_CLASS
 208 #   endif
 209 #endif
 210
 211 #ifndef __DARWIN_NULL
 212 #define __DARWIN_NULL NULL
 213 #endif
 214
 215 #if !defined(OBJC_INLINE)
 216 #   define OBJC_INLINE __inline
 217 #endif
 218
 219 // Declares an enum type or option bits type as appropriate for each language.
 220 #if (__cplusplus && __cplusplus >= 201103L && (__has_extension(cxx_strong_enums) || __has_feature(objc_fixed_enum))) || (!__cplusplus && __has_feature(objc_fixed_enum))
 221 #define OBJC_ENUM(_type, _name) enum _name : _type _name; enum _name : _type
 222 #if (__cplusplus)
 223 #define OBJC_OPTIONS(_type, _name) _type _name; enum : _type
 224 #else
 225 #define OBJC_OPTIONS(_type, _name) enum _name : _type _name; enum _name : _type
 226 #endif
 227 #else
 228 #define OBJC_ENUM(_type, _name) _type _name; enum
 229 #define OBJC_OPTIONS(_type, _name) _type _name; enum
 230 #endif
 231
 232 #endif