/*
- * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
- *
- * @APPLE_LICENSE_HEADER_START@
+ * Copyright (c) 1999-2007 Apple Inc. All Rights Reserved.
*
- * Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
+ * @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
#ifndef _OBJC_OBJC_H_
#define _OBJC_OBJC_H_
-#import <objc/objc-api.h> // for OBJC_EXPORT
+#include <sys/types.h> // for __DARWIN_NULL
+#include <Availability.h>
+#include <objc/objc-api.h>
+#include <stdbool.h>
+#if !OBJC_TYPES_DEFINED
+/// An opaque type that represents an Objective-C class.
typedef struct objc_class *Class;
-typedef struct objc_object {
- Class isa;
-} *id;
+/// Represents an instance of a class.
+struct objc_object {
+ Class _Nonnull isa OBJC_ISA_AVAILABILITY;
+};
+
+/// A pointer to an instance of a class.
+typedef struct objc_object *id;
+#endif
+
+/// An opaque type that represents a method selector.
+typedef struct objc_selector *SEL;
+
+/// A pointer to the function of a method implementation.
+#if !OBJC_OLD_DISPATCH_PROTOTYPES
+typedef void (*IMP)(void /* id, SEL, ... */ );
+#else
+typedef id _Nullable (*IMP)(id _Nonnull, SEL _Nonnull, ...);
+#endif
+
+/// Type to represent a boolean value.
-typedef struct objc_selector *SEL;
-typedef id (*IMP)(id, SEL, ...);
-typedef signed char BOOL;
-// BOOL is explicitly signed so @encode(BOOL) == "c" rather than "C"
-// even if -funsigned-char is used.
+#if defined(__OBJC_BOOL_IS_BOOL)
+ // Honor __OBJC_BOOL_IS_BOOL when available.
+# if __OBJC_BOOL_IS_BOOL
+# define OBJC_BOOL_IS_BOOL 1
+# else
+# define OBJC_BOOL_IS_BOOL 0
+# endif
+#else
+ // __OBJC_BOOL_IS_BOOL not set.
+# if TARGET_OS_OSX || TARGET_OS_MACCATALYST || ((TARGET_OS_IOS || TARGET_OS_BRIDGE) && !__LP64__ && !__ARM_ARCH_7K)
+# define OBJC_BOOL_IS_BOOL 0
+# else
+# define OBJC_BOOL_IS_BOOL 1
+# endif
+#endif
+#if OBJC_BOOL_IS_BOOL
+ typedef bool BOOL;
+#else
+# define OBJC_BOOL_IS_CHAR 1
+ typedef signed char BOOL;
+ // BOOL is explicitly signed so @encode(BOOL) == "c" rather than "C"
+ // even if -funsigned-char is used.
+#endif
-#define YES (BOOL)1
-#define NO (BOOL)0
+#define OBJC_BOOL_DEFINED
+
+#if __has_feature(objc_bool)
+#define YES __objc_yes
+#define NO __objc_no
+#else
+#define YES ((BOOL)1)
+#define NO ((BOOL)0)
+#endif
#ifndef Nil
-#define Nil 0 /* id of Nil class */
+# if __has_feature(cxx_nullptr)
+# define Nil nullptr
+# else
+# define Nil __DARWIN_NULL
+# endif
#endif
#ifndef nil
-#define nil 0 /* id of Nil instance */
+# if __has_feature(cxx_nullptr)
+# define nil nullptr
+# else
+# define nil __DARWIN_NULL
+# endif
#endif
-#ifndef __OBJC_GC__
-# define __strong
+#ifndef __strong
+# if !__has_feature(objc_arc)
+# define __strong /* empty */
+# endif
#endif
-#if !defined(STRICT_OPENSTEP)
+#ifndef __unsafe_unretained
+# if !__has_feature(objc_arc)
+# define __unsafe_unretained /* empty */
+# endif
+#endif
-typedef char *STR;
+#ifndef __autoreleasing
+# if !__has_feature(objc_arc)
+# define __autoreleasing /* empty */
+# endif
+#endif
-OBJC_EXPORT BOOL sel_isMapped(SEL sel);
-OBJC_EXPORT const char *sel_getName(SEL sel);
-OBJC_EXPORT SEL sel_getUid(const char *str);
-OBJC_EXPORT SEL sel_registerName(const char *str);
-OBJC_EXPORT const char *object_getClassName(id obj);
-OBJC_EXPORT void *object_getIndexedIvars(id obj);
-#define ISSELECTOR(sel) sel_isMapped(sel)
-#define SELNAME(sel) sel_getName(sel)
-#define SELUID(str) sel_getUid(str)
-#define NAMEOF(obj) object_getClassName(obj)
-#define IV(obj) object_getIndexedIvars(obj)
+/**
+ * Returns the name of the method specified by a given selector.
+ *
+ * @param sel A pointer of type \c SEL. Pass the selector whose name you wish to determine.
+ *
+ * @return A C string indicating the name of the selector.
+ */
+OBJC_EXPORT const char * _Nonnull sel_getName(SEL _Nonnull sel)
+ OBJC_AVAILABLE(10.0, 2.0, 9.0, 1.0, 2.0);
+
+/**
+ * Registers a method with the Objective-C runtime system, maps the method
+ * name to a selector, and returns the selector value.
+ *
+ * @param str A pointer to a C string. Pass the name of the method you wish to register.
+ *
+ * @return A pointer of type SEL specifying the selector for the named method.
+ *
+ * @note You must register a method name with the Objective-C runtime system to obtain the
+ * method’s selector before you can add the method to a class definition. If the method name
+ * has already been registered, this function simply returns the selector.
+ */
+OBJC_EXPORT SEL _Nonnull sel_registerName(const char * _Nonnull str)
+ OBJC_AVAILABLE(10.0, 2.0, 9.0, 1.0, 2.0);
+
+/**
+ * Returns the class name of a given object.
+ *
+ * @param obj An Objective-C object.
+ *
+ * @return The name of the class of which \e obj is an instance.
+ */
+OBJC_EXPORT const char * _Nonnull object_getClassName(id _Nullable obj)
+ OBJC_AVAILABLE(10.0, 2.0, 9.0, 1.0, 2.0);
+
+/**
+ * Returns a pointer to any extra bytes allocated with an instance given object.
+ *
+ * @param obj An Objective-C object.
+ *
+ * @return A pointer to any extra bytes allocated with \e obj. If \e obj was
+ * not allocated with any extra bytes, then dereferencing the returned pointer is undefined.
+ *
+ * @note This function returns a pointer to any extra bytes allocated with the instance
+ * (as specified by \c class_createInstance with extraBytes>0). This memory follows the
+ * object's ordinary ivars, but may not be adjacent to the last ivar.
+ * @note The returned pointer is guaranteed to be pointer-size aligned, even if the area following
+ * the object's last ivar is less aligned than that. Alignment greater than pointer-size is never
+ * guaranteed, even if the area following the object's last ivar is more aligned than that.
+ * @note In a garbage-collected environment, the memory is scanned conservatively.
+ */
+OBJC_EXPORT void * _Nullable object_getIndexedIvars(id _Nullable obj)
+ OBJC_AVAILABLE(10.0, 2.0, 9.0, 1.0, 2.0);
+
+/**
+ * Identifies a selector as being valid or invalid.
+ *
+ * @param sel The selector you want to identify.
+ *
+ * @return YES if selector is valid and has a function implementation, NO otherwise.
+ *
+ * @warning On some platforms, an invalid reference (to invalid memory addresses) can cause
+ * a crash.
+ */
+OBJC_EXPORT BOOL sel_isMapped(SEL _Nonnull sel)
+ OBJC_AVAILABLE(10.0, 2.0, 9.0, 1.0, 2.0);
+
+/**
+ * Registers a method name with the Objective-C runtime system.
+ *
+ * @param str A pointer to a C string. Pass the name of the method you wish to register.
+ *
+ * @return A pointer of type SEL specifying the selector for the named method.
+ *
+ * @note The implementation of this method is identical to the implementation of \c sel_registerName.
+ * @note Prior to OS X version 10.0, this method tried to find the selector mapped to the given name
+ * and returned \c NULL if the selector was not found. This was changed for safety, because it was
+ * observed that many of the callers of this function did not check the return value for \c NULL.
+ */
+OBJC_EXPORT SEL _Nonnull sel_getUid(const char * _Nonnull str)
+ OBJC_AVAILABLE(10.0, 2.0, 9.0, 1.0, 2.0);
+
+typedef const void* objc_objectptr_t;
+
-#if defined(__osf__) && defined(__alpha__)
+// Obsolete ARC conversions.
+
+OBJC_EXPORT id _Nullable objc_retainedObject(objc_objectptr_t _Nullable obj)
+#if !OBJC_DECLARE_SYMBOLS
+ OBJC_UNAVAILABLE("use CFBridgingRelease() or a (__bridge_transfer id) cast instead")
+#endif
+ ;
+OBJC_EXPORT id _Nullable objc_unretainedObject(objc_objectptr_t _Nullable obj)
+#if !OBJC_DECLARE_SYMBOLS
+ OBJC_UNAVAILABLE("use a (__bridge id) cast instead")
+#endif
+ ;
+OBJC_EXPORT objc_objectptr_t _Nullable objc_unretainedPointer(id _Nullable obj)
+#if !OBJC_DECLARE_SYMBOLS
+ OBJC_UNAVAILABLE("use a __bridge cast instead")
+#endif
+ ;
+
+
+#if !__OBJC2__
+
+// The following declarations are provided here for source compatibility.
+
+#if defined(__LP64__)
typedef long arith_t;
typedef unsigned long uarith_t;
# define ARITH_SHIFT 32
# define ARITH_SHIFT 16
#endif
-#endif /* !STRICT_OPENSTEP */
+typedef char *STR;
+
+#define ISSELECTOR(sel) sel_isMapped(sel)
+#define SELNAME(sel) sel_getName(sel)
+#define SELUID(str) sel_getUid(str)
+#define NAMEOF(obj) object_getClassName(obj)
+#define IV(obj) object_getIndexedIvars(obj)
+
+#endif
-#endif /* _OBJC_OBJC_H_ */
+#endif /* _OBJC_OBJC_H_ */
projects / apple / objc4.git / blobdiff