objc4-818.2.tar.gz

[apple/objc4.git] / runtime / objc-exception.h

diff --git a/runtime/objc-exception.h b/runtime/objc-exception.h
index 02e907c8f375ca3a77550e33d6062705c992a3d1..c93b47b01867ebf9886d119209d683df3cb407eb 100644 (file)
--- a/runtime/objc-exception.h
+++ b/runtime/objc-exception.h
@@ -1,9 +1,7 @@
 /*
- * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
- *
- * @APPLE_LICENSE_HEADER_START@
+ * Copyright (c) 2002-2003, 2006-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
@@ -22,43 +20,119 @@
  * 
  * @APPLE_LICENSE_HEADER_END@
  */
- 
-//  objc_exception.h
-//  Support for Objective-C language Exceptions
-//
-//  Created by Blaine Garst on Fri Nov 01 2002.
-//  Copyright (c) 2002-3 Apple Computer, Inc. All rights reserved.
-//
 
 #ifndef __OBJC_EXCEPTION_H_
 #define __OBJC_EXCEPTION_H_
 
-#import "objc/objc-class.h"
+#include <objc/objc.h>
+#include <stdint.h>
+
+#if !__OBJC2__
 
 // compiler reserves a setjmp buffer + 4 words as localExceptionData
 
-OBJC_EXPORT void objc_exception_throw(id exception);
-OBJC_EXPORT void objc_exception_try_enter(void *localExceptionData);
-OBJC_EXPORT void objc_exception_try_exit(void *localExceptionData);
-OBJC_EXPORT id objc_exception_extract(void *localExceptionData);
-OBJC_EXPORT int objc_exception_match(Class exceptionClass, id exception);
+OBJC_EXPORT void
+objc_exception_throw(id _Nonnull exception)
+    OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE(10.3);
+
+OBJC_EXPORT void
+objc_exception_try_enter(void * _Nonnull localExceptionData)
+    OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE(10.3);
+
+OBJC_EXPORT void
+objc_exception_try_exit(void * _Nonnull localExceptionData)
+    OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE(10.3);
+
+OBJC_EXPORT id _Nonnull
+objc_exception_extract(void * _Nonnull localExceptionData)
+    OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE(10.3);
+
+OBJC_EXPORT int objc_exception_match(Class _Nonnull exceptionClass,
+                                     id _Nonnull exception)
+    OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE(10.3);
 
 
 typedef struct {
     int version;
-    void (*throw_exc)(id);             // version 0
-    void (*try_enter)(void *); // version 0
-    void (*try_exit)(void *);  // version 0
-    id  (*extract)(void *);    // version 0
-    int        (*match)(Class, id);    // version 0
-}
-    objc_exception_functions_t;
+    void (* _Nonnull throw_exc)(id _Nonnull);            // version 0
+    void (* _Nonnull try_enter)(void * _Nonnull);         // version 0
+    void (* _Nonnull try_exit)(void * _Nonnull);          // version 0
+    id _Nonnull (* _Nonnull extract)(void * _Nonnull);    // version 0
+    int        (* _Nonnull match)(Class _Nonnull, id _Nonnull);  // version 0
+} objc_exception_functions_t;
 
 // get table; version tells how many
-OBJC_EXPORT void objc_exception_get_functions(objc_exception_functions_t *table);
+OBJC_EXPORT void
+objc_exception_get_functions(objc_exception_functions_t * _Nullable table)
+    OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE(10.3);
 
 // set table
-OBJC_EXPORT void objc_exception_set_functions(objc_exception_functions_t *table);
+OBJC_EXPORT void
+objc_exception_set_functions(objc_exception_functions_t * _Nullable table)
+    OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE(10.3);
+
+
+// !__OBJC2__
+#else
+// __OBJC2__
+
+typedef id _Nonnull (*objc_exception_preprocessor)(id _Nonnull exception);
+typedef int (*objc_exception_matcher)(Class _Nonnull catch_type,
+                                      id _Nonnull exception);
+typedef void (*objc_uncaught_exception_handler)(id _Null_unspecified /* _Nonnull */ exception);
+typedef void (*objc_exception_handler)(id _Nullable unused,
+                                       void * _Nullable context);
+
+/** 
+ * Throw a runtime exception. This function is inserted by the compiler
+ * where \c @throw would otherwise be.
+ * 
+ * @param exception The exception to be thrown.
+ */
+OBJC_EXPORT void
+objc_exception_throw(id _Nonnull exception)
+    OBJC_AVAILABLE(10.5, 2.0, 9.0, 1.0, 2.0);
+
+OBJC_EXPORT void
+objc_exception_rethrow(void)
+    OBJC_AVAILABLE(10.5, 2.0, 9.0, 1.0, 2.0);
+
+OBJC_EXPORT id _Nonnull
+objc_begin_catch(void * _Nonnull exc_buf)
+    OBJC_AVAILABLE(10.5, 2.0, 9.0, 1.0, 2.0);
+
+OBJC_EXPORT void
+objc_end_catch(void)
+    OBJC_AVAILABLE(10.5, 2.0, 9.0, 1.0, 2.0);
+
+OBJC_EXPORT void
+objc_terminate(void)
+    OBJC_AVAILABLE(10.8, 6.0, 9.0, 1.0, 2.0);
+
+OBJC_EXPORT objc_exception_preprocessor _Nonnull
+objc_setExceptionPreprocessor(objc_exception_preprocessor _Nonnull fn)
+    OBJC_AVAILABLE(10.5, 2.0, 9.0, 1.0, 2.0);
+
+OBJC_EXPORT objc_exception_matcher _Nonnull
+objc_setExceptionMatcher(objc_exception_matcher _Nonnull fn)
+    OBJC_AVAILABLE(10.5, 2.0, 9.0, 1.0, 2.0);
+
+OBJC_EXPORT objc_uncaught_exception_handler _Nonnull
+objc_setUncaughtExceptionHandler(objc_uncaught_exception_handler _Nonnull fn)
+    OBJC_AVAILABLE(10.5, 2.0, 9.0, 1.0, 2.0);
+
+// Not for iOS.
+OBJC_EXPORT uintptr_t
+objc_addExceptionHandler(objc_exception_handler _Nonnull fn,
+                         void * _Nullable context)
+    OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE(10.5);
+
+OBJC_EXPORT void
+objc_removeExceptionHandler(uintptr_t token)
+    OBJC_OSX_AVAILABLE_OTHERS_UNAVAILABLE(10.5);
+
+// __OBJC2__
+#endif
 
 #endif  // __OBJC_EXCEPTION_H_