message_map_container.h 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  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. #ifndef GOOGLE_PROTOBUF_PYTHON_CPP_MESSAGE_MAP_CONTAINER_H__
  31. #define GOOGLE_PROTOBUF_PYTHON_CPP_MESSAGE_MAP_CONTAINER_H__
  32. #include <Python.h>
  33. #include <memory>
  34. #ifndef _SHARED_PTR_H
  35. #include <google/protobuf/stubs/shared_ptr.h>
  36. #endif
  37. #include <google/protobuf/descriptor.h>
  38. namespace google {
  39. namespace protobuf {
  40. class Message;
  41. #ifdef _SHARED_PTR_H
  42. using std::shared_ptr;
  43. #else
  44. using internal::shared_ptr;
  45. #endif
  46. namespace python {
  47. struct CMessage;
  48. struct MessageMapContainer {
  49. PyObject_HEAD;
  50. // This is the top-level C++ Message object that owns the whole
  51. // proto tree. Every Python MessageMapContainer holds a
  52. // reference to it in order to keep it alive as long as there's a
  53. // Python object that references any part of the tree.
  54. shared_ptr<Message> owner;
  55. // Pointer to the C++ Message that contains this container. The
  56. // MessageMapContainer does not own this pointer.
  57. Message* message;
  58. // Weak reference to a parent CMessage object (i.e. may be NULL.)
  59. //
  60. // Used to make sure all ancestors are also mutable when first
  61. // modifying the container.
  62. CMessage* parent;
  63. // Pointer to the parent's descriptor that describes this
  64. // field. Used together with the parent's message when making a
  65. // default message instance mutable.
  66. // The pointer is owned by the global DescriptorPool.
  67. const FieldDescriptor* parent_field_descriptor;
  68. const FieldDescriptor* key_field_descriptor;
  69. const FieldDescriptor* value_field_descriptor;
  70. // A callable that is used to create new child messages.
  71. PyObject* subclass_init;
  72. // A dict mapping Message* -> CMessage.
  73. PyObject* message_dict;
  74. // We bump this whenever we perform a mutation, to invalidate existing
  75. // iterators.
  76. uint64 version;
  77. };
  78. #if PY_MAJOR_VERSION >= 3
  79. extern PyObject *MessageMapContainer_Type;
  80. extern PyType_Spec MessageMapContainer_Type_spec;
  81. #else
  82. extern PyTypeObject MessageMapContainer_Type;
  83. #endif
  84. extern PyTypeObject MessageMapIterator_Type;
  85. namespace message_map_container {
  86. // Builds a MessageMapContainer object, from a parent message and a
  87. // field descriptor.
  88. extern PyObject* NewContainer(CMessage* parent,
  89. const FieldDescriptor* parent_field_descriptor,
  90. PyObject* concrete_class);
  91. // Releases the messages in the container to a new message.
  92. //
  93. // Returns 0 on success, -1 on failure.
  94. int Release(MessageMapContainer* self);
  95. // Set the owner field of self and any children of self.
  96. void SetOwner(MessageMapContainer* self,
  97. const shared_ptr<Message>& new_owner);
  98. } // namespace message_map_container
  99. } // namespace python
  100. } // namespace protobuf
  101. } // namespace google
  102. #endif // GOOGLE_PROTOBUF_PYTHON_CPP_MESSAGE_MAP_CONTAINER_H__