protocol/SecProtocolObject.h

   1 /*
   2  * Copyright (c) 2018 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #ifndef SecProtocolObject_h
  25 #define SecProtocolObject_h
  26
  27 #include <sys/cdefs.h>
  28 #include <os/object.h>
  29
  30 #if OS_OBJECT_USE_OBJC
  31 #  define SEC_OBJECT_DECL(type) OS_OBJECT_DECL(type)
  32 #else // OS_OBJECT_USE_OBJC
  33 #  define SEC_OBJECT_DECL(type)                \
  34 struct type;                        \
  35 typedef    struct type *type##_t
  36 #endif // OS_OBJECT_USE_OBJC
  37
  38 #if __has_feature(assume_nonnull)
  39 #  define SEC_ASSUME_NONNULL_BEGIN _Pragma("clang assume_nonnull begin")
  40 #  define SEC_ASSUME_NONNULL_END   _Pragma("clang assume_nonnull end")
  41 #else // !__has_feature(assume_nonnull)
  42 #  define SEC_ASSUME_NONNULL_BEGIN
  43 #  define SEC_ASSUME_NONNULL_END
  44 #endif // !__has_feature(assume_nonnull)
  45
  46 #if defined(__OBJC__) && __has_attribute(ns_returns_retained)
  47 #  define SEC_RETURNS_RETAINED __attribute__((__ns_returns_retained__))
  48 #else // __OBJC__ && ns_returns_retained
  49 #  define SEC_RETURNS_RETAINED
  50 #endif // __OBJC__ && ns_returns_retained
  51
  52 #if !OS_OBJECT_USE_OBJC_RETAIN_RELEASE
  53 __BEGIN_DECLS
  54 __attribute__((visibility("default"))) void *sec_retain(void *obj);
  55 __attribute__((visibility("default"))) void sec_release(void *obj);
  56 __END_DECLS
  57 #else // !OS_OBJECT_USE_OBJC_RETAIN_RELEASE
  58 #undef sec_retain
  59 #undef sec_release
  60 #define sec_retain(object) [(object) retain]
  61 #define sec_release(object) [(object) release]
  62 #endif // !OS_OBJECT_USE_OBJC_RETAIN_RELEASE
  63
  64 #ifndef SEC_OBJECT_IMPL
  65 /*!
  66  * A `sec_object` is a generic, ARC-able type wrapper for common CoreFoundation Security types.
  67  */
  68 SEC_OBJECT_DECL(sec_object);
  69 #endif // !SEC_OBJECT_IMPL
  70
  71 #endif // SecProtocolObject_h