GPBMessage_PackagePrivate.h 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  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. // This header is private to the ProtobolBuffers library and must NOT be
  31. // included by any sources outside this library. The contents of this file are
  32. // subject to change at any time without notice.
  33. #import "GPBMessage.h"
  34. // TODO: Remove this import. Older generated code use the OSAtomic* apis,
  35. // so anyone that hasn't regenerated says building by having this. After
  36. // enough time has passed, this likely can be removed as folks should have
  37. // regenerated.
  38. #import <libkern/OSAtomic.h>
  39. #import "GPBBootstrap.h"
  40. typedef struct GPBMessage_Storage {
  41. uint32_t _has_storage_[0];
  42. } GPBMessage_Storage;
  43. typedef struct GPBMessage_Storage *GPBMessage_StoragePtr;
  44. @interface GPBMessage () {
  45. @package
  46. // NOTE: Because of the +allocWithZone code using NSAllocateObject(),
  47. // this structure should ideally always be kept pointer aligned where the
  48. // real storage starts is also pointer aligned. The compiler/runtime already
  49. // do this, but it may not be documented.
  50. // A pointer to the actual fields of the subclasses. The actual structure
  51. // pointed to by this pointer will depend on the subclass.
  52. // All of the actual structures will start the same as
  53. // GPBMessage_Storage with _has_storage__ as the first field.
  54. // Kept public because static functions need to access it.
  55. GPBMessage_StoragePtr messageStorage_;
  56. }
  57. // Gets an extension value without autocreating the result if not found. (i.e.
  58. // returns nil if the extension is not set)
  59. - (id)getExistingExtension:(GPBExtensionDescriptor *)extension;
  60. // Parses a message of this type from the input and merges it with this
  61. // message.
  62. //
  63. // Warning: This does not verify that all required fields are present in
  64. // the input message.
  65. // Note: The caller should call
  66. // -[CodedInputStream checkLastTagWas:] after calling this to
  67. // verify that the last tag seen was the appropriate end-group tag,
  68. // or zero for EOF.
  69. // NOTE: This will throw if there is an error while parsing.
  70. - (void)mergeFromCodedInputStream:(GPBCodedInputStream *)input
  71. extensionRegistry:(GPBExtensionRegistry *)extensionRegistry;
  72. // Parses the next delimited message of this type from the input and merges it
  73. // with this message.
  74. - (void)mergeDelimitedFromCodedInputStream:(GPBCodedInputStream *)input
  75. extensionRegistry:
  76. (GPBExtensionRegistry *)extensionRegistry;
  77. - (void)addUnknownMapEntry:(int32_t)fieldNum value:(NSData *)data;
  78. @end
  79. CF_EXTERN_C_BEGIN
  80. // Call this before using the readOnlySemaphore_. This ensures it is created only once.
  81. void GPBPrepareReadOnlySemaphore(GPBMessage *self);
  82. // Returns a new instance that was automatically created by |autocreator| for
  83. // its field |field|.
  84. GPBMessage *GPBCreateMessageWithAutocreator(Class msgClass,
  85. GPBMessage *autocreator,
  86. GPBFieldDescriptor *field)
  87. __attribute__((ns_returns_retained));
  88. // Returns whether |message| autocreated this message. This is NO if the message
  89. // was not autocreated by |message| or if it has been mutated since
  90. // autocreation.
  91. BOOL GPBWasMessageAutocreatedBy(GPBMessage *message, GPBMessage *parent);
  92. // Call this when you mutate a message. It will cause the message to become
  93. // visible to its autocreator.
  94. void GPBBecomeVisibleToAutocreator(GPBMessage *self);
  95. // Call this when an array/dictionary is mutated so the parent message that
  96. // autocreated it can react.
  97. void GPBAutocreatedArrayModified(GPBMessage *self, id array);
  98. void GPBAutocreatedDictionaryModified(GPBMessage *self, id dictionary);
  99. // Clear the autocreator, if any. Asserts if the autocreator still has an
  100. // autocreated reference to this message.
  101. void GPBClearMessageAutocreator(GPBMessage *self);
  102. CF_EXTERN_C_END