GPBUtilities_PackagePrivate.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356
  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. #import <Foundation/Foundation.h>
  31. #import "GPBUtilities.h"
  32. #import "GPBDescriptor_PackagePrivate.h"
  33. // Macros for stringifying library symbols. These are used in the generated
  34. // PB descriptor classes wherever a library symbol name is represented as a
  35. // string. See README.google for more information.
  36. #define GPBStringify(S) #S
  37. #define GPBStringifySymbol(S) GPBStringify(S)
  38. #define GPBNSStringify(S) @#S
  39. #define GPBNSStringifySymbol(S) GPBNSStringify(S)
  40. // Constant to internally mark when there is no has bit.
  41. #define GPBNoHasBit INT32_MAX
  42. CF_EXTERN_C_BEGIN
  43. // These two are used to inject a runtime check for version mismatch into the
  44. // generated sources to make sure they are linked with a supporting runtime.
  45. void GPBCheckRuntimeVersionSupport(int32_t objcRuntimeVersion);
  46. GPB_INLINE void GPB_DEBUG_CHECK_RUNTIME_VERSIONS() {
  47. // NOTE: By being inline here, this captures the value from the library's
  48. // headers at the time the generated code was compiled.
  49. #if defined(DEBUG) && DEBUG
  50. GPBCheckRuntimeVersionSupport(GOOGLE_PROTOBUF_OBJC_VERSION);
  51. #endif
  52. }
  53. // Legacy version of the checks, remove when GOOGLE_PROTOBUF_OBJC_GEN_VERSION
  54. // goes away (see more info in GPBBootstrap.h).
  55. void GPBCheckRuntimeVersionInternal(int32_t version);
  56. GPB_INLINE void GPBDebugCheckRuntimeVersion() {
  57. #if defined(DEBUG) && DEBUG
  58. GPBCheckRuntimeVersionInternal(GOOGLE_PROTOBUF_OBJC_GEN_VERSION);
  59. #endif
  60. }
  61. // Conversion functions for de/serializing floating point types.
  62. GPB_INLINE int64_t GPBConvertDoubleToInt64(double v) {
  63. GPBInternalCompileAssert(sizeof(double) == sizeof(int64_t), double_not_64_bits);
  64. int64_t result;
  65. memcpy(&result, &v, sizeof(result));
  66. return result;
  67. }
  68. GPB_INLINE int32_t GPBConvertFloatToInt32(float v) {
  69. GPBInternalCompileAssert(sizeof(float) == sizeof(int32_t), float_not_32_bits);
  70. int32_t result;
  71. memcpy(&result, &v, sizeof(result));
  72. return result;
  73. }
  74. GPB_INLINE double GPBConvertInt64ToDouble(int64_t v) {
  75. GPBInternalCompileAssert(sizeof(double) == sizeof(int64_t), double_not_64_bits);
  76. double result;
  77. memcpy(&result, &v, sizeof(result));
  78. return result;
  79. }
  80. GPB_INLINE float GPBConvertInt32ToFloat(int32_t v) {
  81. GPBInternalCompileAssert(sizeof(float) == sizeof(int32_t), float_not_32_bits);
  82. float result;
  83. memcpy(&result, &v, sizeof(result));
  84. return result;
  85. }
  86. GPB_INLINE int32_t GPBLogicalRightShift32(int32_t value, int32_t spaces) {
  87. return (int32_t)((uint32_t)(value) >> spaces);
  88. }
  89. GPB_INLINE int64_t GPBLogicalRightShift64(int64_t value, int32_t spaces) {
  90. return (int64_t)((uint64_t)(value) >> spaces);
  91. }
  92. // Decode a ZigZag-encoded 32-bit value. ZigZag encodes signed integers
  93. // into values that can be efficiently encoded with varint. (Otherwise,
  94. // negative values must be sign-extended to 64 bits to be varint encoded,
  95. // thus always taking 10 bytes on the wire.)
  96. GPB_INLINE int32_t GPBDecodeZigZag32(uint32_t n) {
  97. return (int32_t)(GPBLogicalRightShift32((int32_t)n, 1) ^ -((int32_t)(n) & 1));
  98. }
  99. // Decode a ZigZag-encoded 64-bit value. ZigZag encodes signed integers
  100. // into values that can be efficiently encoded with varint. (Otherwise,
  101. // negative values must be sign-extended to 64 bits to be varint encoded,
  102. // thus always taking 10 bytes on the wire.)
  103. GPB_INLINE int64_t GPBDecodeZigZag64(uint64_t n) {
  104. return (int64_t)(GPBLogicalRightShift64((int64_t)n, 1) ^ -((int64_t)(n) & 1));
  105. }
  106. // Encode a ZigZag-encoded 32-bit value. ZigZag encodes signed integers
  107. // into values that can be efficiently encoded with varint. (Otherwise,
  108. // negative values must be sign-extended to 64 bits to be varint encoded,
  109. // thus always taking 10 bytes on the wire.)
  110. GPB_INLINE uint32_t GPBEncodeZigZag32(int32_t n) {
  111. // Note: the right-shift must be arithmetic
  112. return ((uint32_t)n << 1) ^ (uint32_t)(n >> 31);
  113. }
  114. // Encode a ZigZag-encoded 64-bit value. ZigZag encodes signed integers
  115. // into values that can be efficiently encoded with varint. (Otherwise,
  116. // negative values must be sign-extended to 64 bits to be varint encoded,
  117. // thus always taking 10 bytes on the wire.)
  118. GPB_INLINE uint64_t GPBEncodeZigZag64(int64_t n) {
  119. // Note: the right-shift must be arithmetic
  120. return ((uint64_t)n << 1) ^ (uint64_t)(n >> 63);
  121. }
  122. #pragma clang diagnostic push
  123. #pragma clang diagnostic ignored "-Wswitch-enum"
  124. #pragma clang diagnostic ignored "-Wdirect-ivar-access"
  125. GPB_INLINE BOOL GPBDataTypeIsObject(GPBDataType type) {
  126. switch (type) {
  127. case GPBDataTypeBytes:
  128. case GPBDataTypeString:
  129. case GPBDataTypeMessage:
  130. case GPBDataTypeGroup:
  131. return YES;
  132. default:
  133. return NO;
  134. }
  135. }
  136. GPB_INLINE BOOL GPBDataTypeIsMessage(GPBDataType type) {
  137. switch (type) {
  138. case GPBDataTypeMessage:
  139. case GPBDataTypeGroup:
  140. return YES;
  141. default:
  142. return NO;
  143. }
  144. }
  145. GPB_INLINE BOOL GPBFieldDataTypeIsMessage(GPBFieldDescriptor *field) {
  146. return GPBDataTypeIsMessage(field->description_->dataType);
  147. }
  148. GPB_INLINE BOOL GPBFieldDataTypeIsObject(GPBFieldDescriptor *field) {
  149. return GPBDataTypeIsObject(field->description_->dataType);
  150. }
  151. GPB_INLINE BOOL GPBExtensionIsMessage(GPBExtensionDescriptor *ext) {
  152. return GPBDataTypeIsMessage(ext->description_->dataType);
  153. }
  154. // The field is an array/map or it has an object value.
  155. GPB_INLINE BOOL GPBFieldStoresObject(GPBFieldDescriptor *field) {
  156. GPBMessageFieldDescription *desc = field->description_;
  157. if ((desc->flags & (GPBFieldRepeated | GPBFieldMapKeyMask)) != 0) {
  158. return YES;
  159. }
  160. return GPBDataTypeIsObject(desc->dataType);
  161. }
  162. BOOL GPBGetHasIvar(GPBMessage *self, int32_t index, uint32_t fieldNumber);
  163. void GPBSetHasIvar(GPBMessage *self, int32_t idx, uint32_t fieldNumber,
  164. BOOL value);
  165. uint32_t GPBGetHasOneof(GPBMessage *self, int32_t index);
  166. GPB_INLINE BOOL
  167. GPBGetHasIvarField(GPBMessage *self, GPBFieldDescriptor *field) {
  168. GPBMessageFieldDescription *fieldDesc = field->description_;
  169. return GPBGetHasIvar(self, fieldDesc->hasIndex, fieldDesc->number);
  170. }
  171. GPB_INLINE void GPBSetHasIvarField(GPBMessage *self, GPBFieldDescriptor *field,
  172. BOOL value) {
  173. GPBMessageFieldDescription *fieldDesc = field->description_;
  174. GPBSetHasIvar(self, fieldDesc->hasIndex, fieldDesc->number, value);
  175. }
  176. void GPBMaybeClearOneof(GPBMessage *self, GPBOneofDescriptor *oneof,
  177. int32_t oneofHasIndex, uint32_t fieldNumberNotToClear);
  178. #pragma clang diagnostic pop
  179. //%PDDM-DEFINE GPB_IVAR_SET_DECL(NAME, TYPE)
  180. //%void GPBSet##NAME##IvarWithFieldInternal(GPBMessage *self,
  181. //% NAME$S GPBFieldDescriptor *field,
  182. //% NAME$S TYPE value,
  183. //% NAME$S GPBFileSyntax syntax);
  184. //%PDDM-EXPAND GPB_IVAR_SET_DECL(Bool, BOOL)
  185. // This block of code is generated, do not edit it directly.
  186. void GPBSetBoolIvarWithFieldInternal(GPBMessage *self,
  187. GPBFieldDescriptor *field,
  188. BOOL value,
  189. GPBFileSyntax syntax);
  190. //%PDDM-EXPAND GPB_IVAR_SET_DECL(Int32, int32_t)
  191. // This block of code is generated, do not edit it directly.
  192. void GPBSetInt32IvarWithFieldInternal(GPBMessage *self,
  193. GPBFieldDescriptor *field,
  194. int32_t value,
  195. GPBFileSyntax syntax);
  196. //%PDDM-EXPAND GPB_IVAR_SET_DECL(UInt32, uint32_t)
  197. // This block of code is generated, do not edit it directly.
  198. void GPBSetUInt32IvarWithFieldInternal(GPBMessage *self,
  199. GPBFieldDescriptor *field,
  200. uint32_t value,
  201. GPBFileSyntax syntax);
  202. //%PDDM-EXPAND GPB_IVAR_SET_DECL(Int64, int64_t)
  203. // This block of code is generated, do not edit it directly.
  204. void GPBSetInt64IvarWithFieldInternal(GPBMessage *self,
  205. GPBFieldDescriptor *field,
  206. int64_t value,
  207. GPBFileSyntax syntax);
  208. //%PDDM-EXPAND GPB_IVAR_SET_DECL(UInt64, uint64_t)
  209. // This block of code is generated, do not edit it directly.
  210. void GPBSetUInt64IvarWithFieldInternal(GPBMessage *self,
  211. GPBFieldDescriptor *field,
  212. uint64_t value,
  213. GPBFileSyntax syntax);
  214. //%PDDM-EXPAND GPB_IVAR_SET_DECL(Float, float)
  215. // This block of code is generated, do not edit it directly.
  216. void GPBSetFloatIvarWithFieldInternal(GPBMessage *self,
  217. GPBFieldDescriptor *field,
  218. float value,
  219. GPBFileSyntax syntax);
  220. //%PDDM-EXPAND GPB_IVAR_SET_DECL(Double, double)
  221. // This block of code is generated, do not edit it directly.
  222. void GPBSetDoubleIvarWithFieldInternal(GPBMessage *self,
  223. GPBFieldDescriptor *field,
  224. double value,
  225. GPBFileSyntax syntax);
  226. //%PDDM-EXPAND GPB_IVAR_SET_DECL(Enum, int32_t)
  227. // This block of code is generated, do not edit it directly.
  228. void GPBSetEnumIvarWithFieldInternal(GPBMessage *self,
  229. GPBFieldDescriptor *field,
  230. int32_t value,
  231. GPBFileSyntax syntax);
  232. //%PDDM-EXPAND-END (8 expansions)
  233. int32_t GPBGetEnumIvarWithFieldInternal(GPBMessage *self,
  234. GPBFieldDescriptor *field,
  235. GPBFileSyntax syntax);
  236. id GPBGetObjectIvarWithField(GPBMessage *self, GPBFieldDescriptor *field);
  237. void GPBSetObjectIvarWithFieldInternal(GPBMessage *self,
  238. GPBFieldDescriptor *field, id value,
  239. GPBFileSyntax syntax);
  240. void GPBSetRetainedObjectIvarWithFieldInternal(GPBMessage *self,
  241. GPBFieldDescriptor *field,
  242. id __attribute__((ns_consumed))
  243. value,
  244. GPBFileSyntax syntax);
  245. // GPBGetObjectIvarWithField will automatically create the field (message) if
  246. // it doesn't exist. GPBGetObjectIvarWithFieldNoAutocreate will return nil.
  247. id GPBGetObjectIvarWithFieldNoAutocreate(GPBMessage *self,
  248. GPBFieldDescriptor *field);
  249. void GPBSetAutocreatedRetainedObjectIvarWithField(
  250. GPBMessage *self, GPBFieldDescriptor *field,
  251. id __attribute__((ns_consumed)) value);
  252. // Clears and releases the autocreated message ivar, if it's autocreated. If
  253. // it's not set as autocreated, this method does nothing.
  254. void GPBClearAutocreatedMessageIvarWithField(GPBMessage *self,
  255. GPBFieldDescriptor *field);
  256. // Returns an Objective C encoding for |selector|. |instanceSel| should be
  257. // YES if it's an instance selector (as opposed to a class selector).
  258. // |selector| must be a selector from MessageSignatureProtocol.
  259. const char *GPBMessageEncodingForSelector(SEL selector, BOOL instanceSel);
  260. // Helper for text format name encoding.
  261. // decodeData is the data describing the sepecial decodes.
  262. // key and inputString are the input that needs decoding.
  263. NSString *GPBDecodeTextFormatName(const uint8_t *decodeData, int32_t key,
  264. NSString *inputString);
  265. // A series of selectors that are used solely to get @encoding values
  266. // for them by the dynamic protobuf runtime code. See
  267. // GPBMessageEncodingForSelector for details. GPBRootObject conforms to
  268. // the protocol so that it is encoded in the Objective C runtime.
  269. @protocol GPBMessageSignatureProtocol
  270. @optional
  271. #define GPB_MESSAGE_SIGNATURE_ENTRY(TYPE, NAME) \
  272. -(TYPE)get##NAME; \
  273. -(void)set##NAME : (TYPE)value; \
  274. -(TYPE)get##NAME##AtIndex : (NSUInteger)index;
  275. GPB_MESSAGE_SIGNATURE_ENTRY(BOOL, Bool)
  276. GPB_MESSAGE_SIGNATURE_ENTRY(uint32_t, Fixed32)
  277. GPB_MESSAGE_SIGNATURE_ENTRY(int32_t, SFixed32)
  278. GPB_MESSAGE_SIGNATURE_ENTRY(float, Float)
  279. GPB_MESSAGE_SIGNATURE_ENTRY(uint64_t, Fixed64)
  280. GPB_MESSAGE_SIGNATURE_ENTRY(int64_t, SFixed64)
  281. GPB_MESSAGE_SIGNATURE_ENTRY(double, Double)
  282. GPB_MESSAGE_SIGNATURE_ENTRY(int32_t, Int32)
  283. GPB_MESSAGE_SIGNATURE_ENTRY(int64_t, Int64)
  284. GPB_MESSAGE_SIGNATURE_ENTRY(int32_t, SInt32)
  285. GPB_MESSAGE_SIGNATURE_ENTRY(int64_t, SInt64)
  286. GPB_MESSAGE_SIGNATURE_ENTRY(uint32_t, UInt32)
  287. GPB_MESSAGE_SIGNATURE_ENTRY(uint64_t, UInt64)
  288. GPB_MESSAGE_SIGNATURE_ENTRY(NSData *, Bytes)
  289. GPB_MESSAGE_SIGNATURE_ENTRY(NSString *, String)
  290. GPB_MESSAGE_SIGNATURE_ENTRY(GPBMessage *, Message)
  291. GPB_MESSAGE_SIGNATURE_ENTRY(GPBMessage *, Group)
  292. GPB_MESSAGE_SIGNATURE_ENTRY(int32_t, Enum)
  293. #undef GPB_MESSAGE_SIGNATURE_ENTRY
  294. - (id)getArray;
  295. - (NSUInteger)getArrayCount;
  296. - (void)setArray:(NSArray *)array;
  297. + (id)getClassValue;
  298. @end
  299. BOOL GPBClassHasSel(Class aClass, SEL sel);
  300. CF_EXTERN_C_END