home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-2.iso / Developer / resources / classes / AppExceptions.README next >
Encoding:
Text File  |  1993-03-22  |  2.0 KB  |  92 lines
  1. Copyright X 1992 by Scott Hess.
  2.  
  3. AppExceptions
  4.  
  5. CATEGORY OF    Application
  6.  
  7. DECLARED IN    AppExceptions.h
  8.  
  9.  
  10.  
  11. CLASS DESCRIPTION
  12.  
  13. AppExceptions provides for a clearing house of named NeXTSTEP exceptions.  Simply link it into your app, and call it using NXApp.
  14.  
  15. AppExceptions is free.  Use it and abuse it as you see fit.
  16.  
  17. Scott Hess
  18. 12901 Upton Avenue South, #326
  19. Burnsville, MN  55337
  20. (612) 895-1208
  21. scott@gac.edu
  22. shess@ssesco.com
  23.  
  24.  
  25.  
  26. CATEGORY VARIABLES
  27.  
  28. Inherited from Application    id    NXApp;
  29.  
  30. Declared in AppExceptions    HashTable *    exceptionTable;
  31.     int    exceptionBase;
  32.  
  33. exceptionTable     Maps exception names to numbers.
  34.  
  35. exceptionBase     Next exception that -exceptionFor: will pass out.
  36.  
  37.  
  38.  
  39. METHOD TYPES
  40.  
  41. Mapping names to numbers    - exceptionFor:
  42.  
  43. Raising exceptions    - raiseException:
  44.     - raiseException:with:
  45.     - raiseException:with:with:
  46.  
  47.  
  48.  
  49. INSTANCE METHODS
  50.  
  51.  
  52. exceptionFor:
  53. -(int)exceptionFor:(const char *)name
  54.  
  55. Returns the mapping for name.  If there is no current mapping for name, create such a mapping.  The mappings are created from NX_APPBASE to NX_APPBASE+999.
  56.  
  57.  
  58. raiseException:
  59. - raiseException:(const char *)name
  60.  
  61. Calls -raiseException:with:with: with NULL for both data parameters.
  62.  
  63.  
  64. raiseException:with:
  65. - raiseException:(const char *)name with:(const void *)data1
  66.  
  67. Calls -raiseException:with:with: with NULL as the data2 parameter.
  68.  
  69.  
  70. raiseException:with:with:
  71. - raiseException:(const char *)name with:(const void *)data1 with:(const void *)data2
  72.  
  73. Calls on -exceptionFor: to get the exception number for name and raises the exception with data1as the first data parameter and data2as the second.
  74.  
  75.  
  76.  
  77. USAGE
  78.  
  79.  
  80.     NX_DURING
  81.     /* Do some work, and end up in a situation which requires an exception. */
  82.     [NXApp raiseException:"Cancel"];
  83.     /* This is the stuff the exception will skip over. */
  84.     NX_HANDLER
  85.     /* Perhaps do some recovery here, such as freeing memory or whatever. */
  86.     if( NXLocalHandler.code==[NXApp exceptionFor:"Cancel"]) {
  87.         /* Handle the exception. */
  88.     } else {
  89.         NX_RERAISE();
  90.     }
  91.     NX_ENDHANDLER
  92.