Home | History | Annotate | Download | only in objectivec
      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 // The Objective C runtime has complete enough info that most protos dont end
     32 // up using this, so leaving it on is no cost or very little cost.  If you
     33 // happen to see it causing bloat, this is the way to disable it. If you do
     34 // need to disable it, try only disabling it for Release builds as having
     35 // full TextFormat can be useful for debugging.
     36 #ifndef GPBOBJC_SKIP_MESSAGE_TEXTFORMAT_EXTRAS
     37 #define GPBOBJC_SKIP_MESSAGE_TEXTFORMAT_EXTRAS 0
     38 #endif
     39 
     40 // Used in the generated code to give sizes to enums. int32_t was chosen based
     41 // on the fact that Protocol Buffers enums are limited to this range.
     42 #if !__has_feature(objc_fixed_enum)
     43  #error All supported Xcode versions should support objc_fixed_enum.
     44 #endif
     45 // If the headers are imported into Objective-C++, we can run into an issue
     46 // where the defintion of NS_ENUM (really CF_ENUM) changes based on the C++
     47 // standard that is in effect.  If it isn't C++11 or higher, the definition
     48 // doesn't allow us to forward declare. We work around this one case by
     49 // providing a local definition. The default case has to use NS_ENUM for the
     50 // magic that is Swift bridging of enums.
     51 #if (__cplusplus && __cplusplus < 201103L)
     52  #define GPB_ENUM(X) enum X : int32_t X; enum X : int32_t
     53 #else
     54  #define GPB_ENUM(X) NS_ENUM(int32_t, X)
     55 #endif
     56 // GPB_ENUM_FWD_DECLARE is used for forward declaring enums, ex:
     57 //   GPB_ENUM_FWD_DECLARE(Foo_Enum)
     58 //   @property (nonatomic) Foo_Enum value;
     59 #define GPB_ENUM_FWD_DECLARE(X) enum X : int32_t
     60 
     61 // Based upon CF_INLINE. Forces inlining in release.
     62 #if !defined(DEBUG)
     63 #define GPB_INLINE static __inline__ __attribute__((always_inline))
     64 #else
     65 #define GPB_INLINE static __inline__
     66 #endif
     67 
     68 // For use in public headers that might need to deal with ARC.
     69 #ifndef GPB_UNSAFE_UNRETAINED
     70 #if __has_feature(objc_arc)
     71 #define GPB_UNSAFE_UNRETAINED __unsafe_unretained
     72 #else
     73 #define GPB_UNSAFE_UNRETAINED
     74 #endif
     75 #endif
     76 
     77 // If property name starts with init we need to annotate it to get past ARC.
     78 // http://stackoverflow.com/questions/18723226/how-do-i-annotate-an-objective-c-property-with-an-objc-method-family/18723227#18723227
     79 #define GPB_METHOD_FAMILY_NONE __attribute__((objc_method_family(none)))
     80 
     81 // The protoc-gen-objc version which works with the current version of the
     82 // generated Objective C sources.  In general we don't want to change the
     83 // runtime interfaces (or this version) as it means everything has to be
     84 // regenerated.
     85 #define GOOGLE_PROTOBUF_OBJC_GEN_VERSION 30001
     86