Keychain/KCExceptions.h

   1 /*
   2  * Copyright (c) 2000-2001 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * The contents of this file constitute Original Code as defined in and are
   5  * subject to the Apple Public Source License Version 1.2 (the 'License').
   6  * You may not use this file except in compliance with the License. Please obtain
   7  * a copy of the License at http://www.apple.com/publicsource and read it before
   8  * using this file.
   9  *
  10  * This Original Code and all software distributed under the License are
  11  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
  12  * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
  13  * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  14  * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
  15  * specific language governing rights and limitations under the License.
  16  */
  17
  18
  19 /*
  20     KCExceptions.h
  21 */
  22
  23 #ifndef _H_KCEXCEPTIONS
  24 #define _H_KCEXCEPTIONS
  25
  26 #include <CoreServices/../Frameworks/CarbonCore.framework/Headers/MacErrors.h>
  27
  28 #ifdef lock
  29 #undef lock
  30 #endif
  31 #include <Security/utilities.h>
  32
  33 #ifdef check
  34 #undef check
  35 #endif
  36
  37 namespace Security
  38 {
  39
  40 namespace KeychainCore
  41 {
  42
  43 //
  44 // Helpers for memory pointer validation
  45 //
  46
  47 /*      remove RequiredParam when cdsa does namespaces
  48 template <class T>
  49 inline T &Required(T *ptr,OSStatus err = paramErr)
  50 {
  51     return Required(ptr,err);
  52 }
  53 */
  54
  55 template <class T>
  56 inline void KCThrowIfMemFail_(const T *ptr)
  57 {
  58     if (ptr==NULL)
  59                 MacOSError::throwMe(memFullErr);
  60 }
  61
  62 inline void KCThrowIf_(OSStatus theErr)
  63 {
  64         // will also work for OSErr
  65     if (theErr!=noErr)
  66         MacOSError::throwMe(theErr);
  67 }
  68
  69 inline void KCThrowIf_(bool test,OSStatus theErr)
  70 {
  71         // will also work for OSErr
  72     if (test)
  73         MacOSError::throwMe(theErr);
  74 }
  75
  76 inline void KCThrowParamErrIf_(bool test)
  77 {
  78     if (test)
  79         MacOSError::throwMe(paramErr);
  80 }
  81
  82 inline void KCUnimplemented_()
  83 {
  84         MacOSError::throwMe(unimpErr);
  85 }
  86
  87 } // end namespace KeychainCore
  88
  89 } // end namespace Security
  90
  91 #endif /* _H_KCEXCEPTIONS */