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
  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 TARGET_OS_EMBEDDED  ||  TARGET_OS_IPHONE  ||  TARGET_OS_WIN32
  67     /* GC is unsupported. GC API symbols are not exported. */
  68 #   define OBJC_NO_GC 1
  69 #   define OBJC_NO_GC_API 1
  70 #elif TARGET_OS_MAC && __x86_64h__
  71     /* GC is unsupported. GC API symbols are exported. */
  72 #   define OBJC_NO_GC 1
  73 #   undef  OBJC_NO_GC_API
  74 #else
  75     /* GC is supported. */
  76 #   undef  OBJC_NO_GC
  77 #   undef  OBJC_GC_API
  78 #endif
  79
  80
  81 /* NS_ENFORCE_NSOBJECT_DESIGNATED_INITIALIZER == 1
  82  * marks -[NSObject init] as a designated initializer. */
  83 #if !defined(NS_ENFORCE_NSOBJECT_DESIGNATED_INITIALIZER)
  84 #   define NS_ENFORCE_NSOBJECT_DESIGNATED_INITIALIZER 1
  85 #endif
  86
  87
  88 /* OBJC_OLD_DISPATCH_PROTOTYPES == 0 enforces the rule that the dispatch
  89  * functions must be cast to an appropriate function pointer type. */
  90 #if !defined(OBJC_OLD_DISPATCH_PROTOTYPES)
  91 #   define OBJC_OLD_DISPATCH_PROTOTYPES 1
  92 #endif
  93
  94
  95 /* OBJC_ISA_AVAILABILITY: `isa` will be deprecated or unavailable
  96  * in the future */
  97 #if !defined(OBJC_ISA_AVAILABILITY)
  98 #   if __OBJC2__
  99 #       define OBJC_ISA_AVAILABILITY  __attribute__((deprecated))
 100 #   else
 101 #       define OBJC_ISA_AVAILABILITY  /* still available */
 102 #   endif
 103 #endif
 104
 105
 106 /* OBJC2_UNAVAILABLE: unavailable in objc 2.0, deprecated in Leopard */
 107 #if !defined(OBJC2_UNAVAILABLE)
 108 #   if __OBJC2__
 109 #       define OBJC2_UNAVAILABLE UNAVAILABLE_ATTRIBUTE
 110 #   else
 111         /* plain C code also falls here, but this is close enough */
 112 #       define OBJC2_UNAVAILABLE __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_5,__MAC_10_5, __IPHONE_2_0,__IPHONE_2_0)
 113 #   endif
 114 #endif
 115
 116 /* OBJC_ARC_UNAVAILABLE: unavailable with -fobjc-arc */
 117 #if !defined(OBJC_ARC_UNAVAILABLE)
 118 #   if __has_feature(objc_arc)
 119 #       if __has_extension(attribute_unavailable_with_message)
 120 #           define OBJC_ARC_UNAVAILABLE __attribute__((unavailable("not available in automatic reference counting mode")))
 121 #       else
 122 #           define OBJC_ARC_UNAVAILABLE __attribute__((unavailable))
 123 #       endif
 124 #   else
 125 #       define OBJC_ARC_UNAVAILABLE
 126 #   endif
 127 #endif
 128
 129 /* OBJC_SWIFT_UNAVAILABLE: unavailable in Swift */
 130 #if !defined(OBJC_SWIFT_UNAVAILABLE)
 131 #   if __has_feature(attribute_availability_swift)
 132 #       define OBJC_SWIFT_UNAVAILABLE(_msg) __attribute__((availability(swift, unavailable, message=_msg)))
 133 #   else
 134 #       define OBJC_SWIFT_UNAVAILABLE(_msg)
 135 #   endif
 136 #endif
 137
 138 /* OBJC_ARM64_UNAVAILABLE: unavailable on arm64 (i.e. stret dispatch) */
 139 #if !defined(OBJC_ARM64_UNAVAILABLE)
 140 #   if defined(__arm64__)
 141 #       define OBJC_ARM64_UNAVAILABLE __attribute__((unavailable("not available in arm64")))
 142 #   else
 143 #       define OBJC_ARM64_UNAVAILABLE
 144 #   endif
 145 #endif
 146
 147 /* OBJC_GC_UNAVAILABLE: unavailable with -fobjc-gc or -fobjc-gc-only */
 148 #if !defined(OBJC_GC_UNAVAILABLE)
 149 #   if __OBJC_GC__
 150 #       if __has_extension(attribute_unavailable_with_message)
 151 #           define OBJC_GC_UNAVAILABLE __attribute__((unavailable("not available in garbage collecting mode")))
 152 #       else
 153 #           define OBJC_GC_UNAVAILABLE __attribute__((unavailable))
 154 #       endif
 155 #   else
 156 #       define OBJC_GC_UNAVAILABLE
 157 #   endif
 158 #endif
 159
 160 #if !defined(OBJC_EXTERN)
 161 #   if defined(__cplusplus)
 162 #       define OBJC_EXTERN extern "C"
 163 #   else
 164 #       define OBJC_EXTERN extern
 165 #   endif
 166 #endif
 167
 168 #if !defined(OBJC_VISIBLE)
 169 #   if TARGET_OS_WIN32
 170 #       if defined(BUILDING_OBJC)
 171 #           define OBJC_VISIBLE __declspec(dllexport)
 172 #       else
 173 #           define OBJC_VISIBLE __declspec(dllimport)
 174 #       endif
 175 #   else
 176 #       define OBJC_VISIBLE  __attribute__((visibility("default")))
 177 #   endif
 178 #endif
 179
 180 #if !defined(OBJC_EXPORT)
 181 #   define OBJC_EXPORT  OBJC_EXTERN OBJC_VISIBLE
 182 #endif
 183
 184 #if !defined(OBJC_IMPORT)
 185 #   define OBJC_IMPORT extern
 186 #endif
 187
 188 #if !defined(OBJC_ROOT_CLASS)
 189 #   if __has_attribute(objc_root_class)
 190 #       define OBJC_ROOT_CLASS __attribute__((objc_root_class))
 191 #   else
 192 #       define OBJC_ROOT_CLASS
 193 #   endif
 194 #endif
 195
 196 #ifndef __DARWIN_NULL
 197 #define __DARWIN_NULL NULL
 198 #endif
 199
 200 #if !defined(OBJC_INLINE)
 201 #   define OBJC_INLINE __inline
 202 #endif
 203
 204 // Declares an enum type or option bits type as appropriate for each language.
 205 #if (__cplusplus && __cplusplus >= 201103L && (__has_extension(cxx_strong_enums) || __has_feature(objc_fixed_enum))) || (!__cplusplus && __has_feature(objc_fixed_enum))
 206 #define OBJC_ENUM(_type, _name) enum _name : _type _name; enum _name : _type
 207 #if (__cplusplus)
 208 #define OBJC_OPTIONS(_type, _name) _type _name; enum : _type
 209 #else
 210 #define OBJC_OPTIONS(_type, _name) enum _name : _type _name; enum _name : _type
 211 #endif
 212 #else
 213 #define OBJC_ENUM(_type, _name) _type _name; enum
 214 #define OBJC_OPTIONS(_type, _name) _type _name; enum
 215 #endif
 216
 217 #endif