blob: 530eb5cb640b7aa1034530d6a7a9e71b37a44a29 [file] [log] [blame]
Thomas Van Lenten30650d82015-05-01 08:57:16 -04001// 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 don’t 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// Most uses of protocol buffers don't need field options, by default the
41// static data will be compiled out, define this to 1 to include it. The only
42// time you need this is if you are doing introspection of the protocol buffers.
43#ifndef GPBOBJC_INCLUDE_FIELD_OPTIONS
44#define GPBOBJC_INCLUDE_FIELD_OPTIONS 0
45#endif
46
47// Used in the generated code to give sizes to enums. int32_t was chosen based
48// on the fact that Protocol Buffers enums are limited to this range.
49// The complexity and double definition here are so we get the nice name
50// for objective C, but also define the name with a trailing underscore so
51// the Swift bridge will have one where the names line up to support short
52// names since they are scoped to the enum.
53// https://developer.apple.com/library/ios/documentation/Swift/Conceptual/BuildingCocoaApps/InteractingWithCAPIs.html#//apple_ref/doc/uid/TP40014216-CH8-XID_11
54#define GPB_ENUM(X) enum X##_ : int32_t X; typedef NS_ENUM(int32_t, X##_)
55// GPB_ENUM_FWD_DECLARE is used for forward declaring enums ex:
56// GPB_ENUM_FWD_DECLARE(Foo_Enum)
57// @property (nonatomic) Foo_Enum value;
58#define GPB_ENUM_FWD_DECLARE(_name) enum _name : int32_t
59
60// Based upon CF_INLINE. Forces inlining in release.
61#if !defined(DEBUG)
62#define GPB_INLINE static __inline__ __attribute__((always_inline))
63#else
64#define GPB_INLINE static __inline__
65#endif
66
67// For use in public headers that might need to deal with ARC.
68#ifndef GPB_UNSAFE_UNRETAINED
69#if __has_feature(objc_arc)
70#define GPB_UNSAFE_UNRETAINED __unsafe_unretained
71#else
72#define GPB_UNSAFE_UNRETAINED
73#endif
74#endif
75
76// If property name starts with init we need to annotate it to get past ARC.
77// http://stackoverflow.com/questions/18723226/how-do-i-annotate-an-objective-c-property-with-an-objc-method-family/18723227#18723227
78#define GPB_METHOD_FAMILY_NONE __attribute__((objc_method_family(none)))
79
80// The protoc-gen-objc version which works with the current version of the
81// generated Objective C sources. In general we don't want to change the
82// runtime interfaces (or this version) as it means everything has to be
83// regenerated.
84#define GOOGLE_PROTOBUF_OBJC_GEN_VERSION 30000