GTLDefines.h 5.04 KB
Newer Older
Google Inc's avatar
Google Inc committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
/* Copyright (c) 2011 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

//
// GTLDefines.h
//

// Ensure Apple's conditionals we depend on are defined.
#import <TargetConditionals.h>
#import <AvailabilityMacros.h>

//
// The developer may choose to define these in the project:
//
//   #define GTL_TARGET_NAMESPACE Xxx  // preface all GTL class names with Xxx (recommended for building plug-ins)
//   #define GTL_FOUNDATION_ONLY 1     // builds without AppKit or Carbon (default for iPhone builds)
//   #define STRIP_GTM_FETCH_LOGGING 1 // omit http logging code (default for iPhone release builds)
//
// Mac developers may find GTL_SIMPLE_DESCRIPTIONS and STRIP_GTM_FETCH_LOGGING useful for
// reducing code size.
//

// Define later OS versions when building on earlier versions
#ifdef MAC_OS_X_VERSION_10_0
  #ifndef MAC_OS_X_VERSION_10_6
    #define MAC_OS_X_VERSION_10_6 1060
  #endif
#endif


#ifdef GTL_TARGET_NAMESPACE
// prefix all GTL class names with GTL_TARGET_NAMESPACE for this target
  #import "GTLTargetNamespace.h"
#endif

// Provide a common definition for externing constants/functions
#if defined(__cplusplus)
  #define GTL_EXTERN extern "C"
#else
  #define GTL_EXTERN extern
#endif

#if TARGET_OS_IPHONE // iPhone SDK

  #define GTL_IPHONE 1

#endif

#if GTL_IPHONE

  #define GTL_FOUNDATION_ONLY 1

#endif

//
// GTL_ASSERT is like NSAssert, but takes a variable number of arguments:
//
//     GTL_ASSERT(condition, @"Problem in argument %@", argStr);
//
// GTL_DEBUG_ASSERT is similar, but compiles in only for debug builds
//

#ifndef GTL_ASSERT
  // we directly invoke the NSAssert handler so we can pass on the varargs
  #if !defined(NS_BLOCK_ASSERTIONS)
    #define GTL_ASSERT(condition, ...)                                       \
      do {                                                                     \
        if (!(condition)) {                                                    \
          [[NSAssertionHandler currentHandler]                                 \
              handleFailureInFunction:[NSString stringWithUTF8String:__PRETTY_FUNCTION__] \
                                 file:[NSString stringWithUTF8String:__FILE__] \
                           lineNumber:__LINE__                                 \
                          description:__VA_ARGS__];                            \
        }                                                                      \
      } while(0)
  #else
    #define GTL_ASSERT(condition, ...) do { } while (0)
  #endif // !defined(NS_BLOCK_ASSERTIONS)
#endif // GTL_ASSERT

#ifndef GTL_DEBUG_ASSERT
  #if DEBUG
    #define GTL_DEBUG_ASSERT(condition, ...) GTL_ASSERT(condition, __VA_ARGS__)
  #else
    #define GTL_DEBUG_ASSERT(condition, ...) do { } while (0)
  #endif
#endif

#ifndef GTL_DEBUG_LOG
  #if DEBUG
    #define GTL_DEBUG_LOG(...) NSLog(__VA_ARGS__)
  #else
    #define GTL_DEBUG_LOG(...) do { } while (0)
  #endif
#endif

#ifndef STRIP_GTM_FETCH_LOGGING
  #if GTL_IPHONE && !DEBUG
    #define STRIP_GTM_FETCH_LOGGING 1
  #else
    #define STRIP_GTM_FETCH_LOGGING 0
  #endif
#endif

// Some support for advanced clang static analysis functionality
// See http://clang-analyzer.llvm.org/annotations.html
#ifndef __has_feature      // Optional.
  #define __has_feature(x) 0 // Compatibility with non-clang compilers.
#endif
#ifndef NS_RETURNS_NOT_RETAINED
  #if __has_feature(attribute_ns_returns_not_retained)
    #define NS_RETURNS_NOT_RETAINED __attribute__((ns_returns_not_retained))
  #else
    #define NS_RETURNS_NOT_RETAINED
  #endif
#endif

#ifndef __has_attribute
  #define __has_attribute(x) 0
#endif

#ifndef GTL_NONNULL
  #if __has_attribute(nonnull)
    #define GTL_NONNULL(x) __attribute__((nonnull x))
  #else
    #define GTL_NONNULL(x)
  #endif
#endif

#ifndef GTL_DECLARE_GENERICS
  #if __has_feature(objc_generics) \
    && ((!TARGET_OS_IPHONE && defined(MAC_OS_X_VERSION_10_11) && MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_11) \
      || (TARGET_OS_IPHONE && defined(__IPHONE_9_0) && __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_9_0))
    #define GTL_DECLARE_GENERICS 1
  #else
    #define GTL_DECLARE_GENERICS 0
  #endif
#endif

#ifndef GTL_NSArrayOf
  #if GTL_DECLARE_GENERICS
    #define GTL_NSArrayOf(value) NSArray<value>
    #define GTL_NSDictionaryOf(key, value) NSDictionary<key, value>
    #define GTL_NSMutableDictionaryOf(key, value) NSMutableDictionary<key, value>
  #else
    #define GTL_NSArrayOf(value) NSArray
    #define GTL_NSDictionaryOf(key, value) NSDictionary
    #define GTL_NSMutableDictionaryOf(key, value) NSMutableDictionary
  #endif // GTL_DECLARE_GENERICS
#endif  // GTL_NSArrayOf