Foundation/NSException/NSException.h

   1 /* Copyright (c) 2006-2007 Christopher J. W. Lloyd
   2
   3 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
   4
   5 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
   6
   7 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
   8
   9 #import <Foundation/NSObject.h>
  10 #include <setjmp.h>
  11
  12 @class NSDictionary, NSArray;
  13
  14 FOUNDATION_EXPORT NSString *const NSGenericException;
  15 FOUNDATION_EXPORT NSString *const NSInvalidArgumentException;
  16 FOUNDATION_EXPORT NSString *const NSRangeException;
  17
  18 FOUNDATION_EXPORT NSString *const NSInternalInconsistencyException;
  19 FOUNDATION_EXPORT NSString *const NSMallocException;
  20
  21 FOUNDATION_EXPORT NSString *const NSParseErrorException;
  22 FOUNDATION_EXPORT NSString *const NSInconsistentArchiveException;
  23
  24 @interface NSException : NSObject <NSCoding, NSCopying> {
  25     NSString *_name;
  26     NSString *_reason;
  27     NSDictionary *_userInfo;
  28     NSArray *_callStack;
  29 }
  30
  31 + (void)raise:(NSString *)name format:(NSString *)format, ...;
  32 + (void)raise:(NSString *)name format:(NSString *)format arguments:(va_list)arguments;
  33
  34 - initWithName:(NSString *)name reason:(NSString *)reason userInfo:(NSDictionary *)userInfo;
  35
  36 + (NSException *)exceptionWithName:(NSString *)name reason:(NSString *)reason userInfo:(NSDictionary *)userInfo;
  37
  38 - (void)raise;
  39
  40 - (NSString *)name;
  41 - (NSString *)reason;
  42 - (NSDictionary *)userInfo;
  43
  44 - (NSArray *)callStackReturnAddresses;
  45
  46 @end
  47
  48 typedef void NSUncaughtExceptionHandler(NSException *exception);
  49
  50 FOUNDATION_EXPORT NSUncaughtExceptionHandler *NSGetUncaughtExceptionHandler(void);
  51 FOUNDATION_EXPORT void NSSetUncaughtExceptionHandler(NSUncaughtExceptionHandler *);
  52
  53 typedef struct NSExceptionFrame {
  54     jmp_buf state;
  55     struct NSExceptionFrame *parent;
  56     NSException *exception;
  57 } NSExceptionFrame;
  58
  59 FOUNDATION_EXPORT void __NSPushExceptionFrame(NSExceptionFrame *frame);
  60 FOUNDATION_EXPORT void __NSPopExceptionFrame(NSExceptionFrame *frame);
  61
  62 #define NS_DURING                                  \
  63     {                                              \
  64         NSExceptionFrame __exceptionFrame;         \
  65         __NSPushExceptionFrame(&__exceptionFrame); \
  66         if(setjmp(__exceptionFrame.state) == 0) {
  67
  68 #define NS_HANDLER                                                             \
  69     __NSPopExceptionFrame(&__exceptionFrame);                                  \
  70     }                                                                          \
  71     else {                                                                     \
  72         NSException *localException = __exceptionFrame.exception;              \
  73         if(localException) { /* caller does not have to read localException */ \
  74         }
  75
  76 #define NS_ENDHANDLER \
  77     }                 \
  78     }
  79
  80 #define NS_VALUERETURN(val, type)                 \
  81     {                                             \
  82         __NSPopExceptionFrame(&__exceptionFrame); \
  83         return val;                               \
  84     }
  85
  86 #define NS_VOIDRETURN                             \
  87     {                                             \
  88         __NSPopExceptionFrame(&__exceptionFrame); \
  89         return;                                   \
  90     }
  91
  92 #import <Foundation/NSAssertionHandler.h>