1 // Protocol Buffers - Google's data interchange format 2 // Copyright 2008 Google Inc. All rights reserved. 3 // https://developers.google.com/protocol-buffers/ 4 // 5 // Redistribution and use in source and binary forms, with or without 6 // modification, are permitted provided that the following conditions are 7 // met: 8 // 9 // * Redistributions of source code must retain the above copyright 10 // notice, this list of conditions and the following disclaimer. 11 // * Redistributions in binary form must reproduce the above 12 // copyright notice, this list of conditions and the following disclaimer 13 // in the documentation and/or other materials provided with the 14 // distribution. 15 // * Neither the name of Google Inc. nor the names of its 16 // contributors may be used to endorse or promote products derived from 17 // this software without specific prior written permission. 18 // 19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 31 /** 32 * The Objective C runtime has complete enough info that most protos don’t end 33 * up using this, so leaving it on is no cost or very little cost. If you 34 * happen to see it causing bloat, this is the way to disable it. If you do 35 * need to disable it, try only disabling it for Release builds as having 36 * full TextFormat can be useful for debugging. 37 **/ 38 #ifndef GPBOBJC_SKIP_MESSAGE_TEXTFORMAT_EXTRAS 39 #define GPBOBJC_SKIP_MESSAGE_TEXTFORMAT_EXTRAS 0 40 #endif 41 42 // Used in the generated code to give sizes to enums. int32_t was chosen based 43 // on the fact that Protocol Buffers enums are limited to this range. 44 #if !__has_feature(objc_fixed_enum) 45 #error All supported Xcode versions should support objc_fixed_enum. 46 #endif 47 48 // If the headers are imported into Objective-C++, we can run into an issue 49 // where the defintion of NS_ENUM (really CF_ENUM) changes based on the C++ 50 // standard that is in effect. If it isn't C++11 or higher, the definition 51 // doesn't allow us to forward declare. We work around this one case by 52 // providing a local definition. The default case has to use NS_ENUM for the 53 // magic that is Swift bridging of enums. 54 #if (defined(__cplusplus) && __cplusplus && __cplusplus < 201103L) 55 #define GPB_ENUM(X) enum X : int32_t X; enum X : int32_t 56 #else 57 #define GPB_ENUM(X) NS_ENUM(int32_t, X) 58 #endif 59 60 /** 61 * GPB_ENUM_FWD_DECLARE is used for forward declaring enums, for example: 62 * 63 * ``` 64 * GPB_ENUM_FWD_DECLARE(Foo_Enum) 65 * 66 * @interface BarClass : NSObject 67 * @property (nonatomic) enum Foo_Enum value; 68 * - (void)bazMethod:(enum Foo_Enum):value; 69 * @end 70 * ``` 71 **/ 72 #define GPB_ENUM_FWD_DECLARE(X) enum X : int32_t 73 74 /** 75 * Based upon CF_INLINE. Forces inlining in non DEBUG builds. 76 **/ 77 #if !defined(DEBUG) 78 #define GPB_INLINE static __inline__ __attribute__((always_inline)) 79 #else 80 #define GPB_INLINE static __inline__ 81 #endif 82 83 /** 84 * For use in public headers that might need to deal with ARC. 85 **/ 86 #ifndef GPB_UNSAFE_UNRETAINED 87 #if __has_feature(objc_arc) 88 #define GPB_UNSAFE_UNRETAINED __unsafe_unretained 89 #else 90 #define GPB_UNSAFE_UNRETAINED 91 #endif 92 #endif 93 94 /** 95 * Attribute used for Objective-C proto interface deprecations without messages. 96 **/ 97 #ifndef GPB_DEPRECATED 98 #define GPB_DEPRECATED __attribute__((deprecated)) 99 #endif 100 101 /** 102 * Attribute used for Objective-C proto interface deprecations with messages. 103 **/ 104 #ifndef GPB_DEPRECATED_MSG 105 #if __has_extension(attribute_deprecated_with_message) 106 #define GPB_DEPRECATED_MSG(msg) __attribute__((deprecated(msg))) 107 #else 108 #define GPB_DEPRECATED_MSG(msg) __attribute__((deprecated)) 109 #endif 110 #endif 111 112 // If property name starts with init we need to annotate it to get past ARC. 113 // http://stackoverflow.com/questions/18723226/how-do-i-annotate-an-objective-c-property-with-an-objc-method-family/18723227#18723227 114 // 115 // Meant to be used internally by generated code. 116 #define GPB_METHOD_FAMILY_NONE __attribute__((objc_method_family(none))) 117 118 // ---------------------------------------------------------------------------- 119 // These version numbers are all internal to the ObjC Protobuf runtime; they 120 // are used to ensure compatibility between the generated sources and the 121 // headers being compiled against and/or the version of sources being run 122 // against. 123 // 124 // They are all #defines so the values are captured into every .o file they 125 // are used in and to allow comparisons in the preprocessor. 126 127 // Current library runtime version. 128 // - Gets bumped when the runtime makes changes to the interfaces between the 129 // generated code and runtime (things added/removed, etc). 130 #define GOOGLE_PROTOBUF_OBJC_VERSION 30002 131 132 // Minimum runtime version supported for compiling/running against. 133 // - Gets changed when support for the older generated code is dropped. 134 #define GOOGLE_PROTOBUF_OBJC_MIN_SUPPORTED_VERSION 30001 135 136 137 // This is a legacy constant now frozen in time for old generated code. If 138 // GOOGLE_PROTOBUF_OBJC_MIN_SUPPORTED_VERSION ever gets moved above 30001 then 139 // this should also change to break code compiled with an old runtime that 140 // can't be supported any more. 141 #define GOOGLE_PROTOBUF_OBJC_GEN_VERSION 30001 142