map_entry.h 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  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_MAP_ENTRY_H__
  31. #define GOOGLE_PROTOBUF_MAP_ENTRY_H__
  32. #include <google/protobuf/generated_message_reflection.h>
  33. #include <google/protobuf/map_entry_lite.h>
  34. #include <google/protobuf/map_type_handler.h>
  35. #include <google/protobuf/metadata.h>
  36. #include <google/protobuf/reflection_ops.h>
  37. #include <google/protobuf/unknown_field_set.h>
  38. #include <google/protobuf/wire_format_lite_inl.h>
  39. namespace google {
  40. namespace protobuf {
  41. class Arena;
  42. namespace internal {
  43. template <typename Derived, typename Key, typename Value,
  44. WireFormatLite::FieldType kKeyFieldType,
  45. WireFormatLite::FieldType kValueFieldType, int default_enum_value>
  46. class MapField;
  47. }
  48. }
  49. namespace protobuf {
  50. namespace internal {
  51. // MapEntry is the returned google::protobuf::Message when calling AddMessage of
  52. // google::protobuf::Reflection. In order to let it work with generated message
  53. // reflection, its in-memory type is the same as generated message with the same
  54. // fields. However, in order to decide the in-memory type of key/value, we need
  55. // to know both their cpp type in generated api and proto type. In
  56. // implementation, all in-memory types have related wire format functions to
  57. // support except ArenaStringPtr. Therefore, we need to define another type with
  58. // supporting wire format functions. Since this type is only used as return type
  59. // of MapEntry accessors, it's named MapEntry accessor type.
  60. //
  61. // cpp type: the type visible to users in public API.
  62. // proto type: WireFormatLite::FieldType of the field.
  63. // in-memory type: type of the data member used to stored this field.
  64. // MapEntry accessor type: type used in MapEntry getters/mutators to access the
  65. // field.
  66. //
  67. // cpp type | proto type | in-memory type | MapEntry accessor type
  68. // int32 TYPE_INT32 int32 int32
  69. // int32 TYPE_FIXED32 int32 int32
  70. // string TYPE_STRING ArenaStringPtr string
  71. // FooEnum TYPE_ENUM int int
  72. // FooMessage TYPE_MESSAGE FooMessage* FooMessage
  73. //
  74. // The in-memory types of primitive types can be inferred from its proto type,
  75. // while we need to explicitly specify the cpp type if proto type is
  76. // TYPE_MESSAGE to infer the in-memory type. Moreover, default_enum_value is
  77. // used to initialize enum field in proto2.
  78. template <typename Derived, typename Key, typename Value,
  79. WireFormatLite::FieldType kKeyFieldType,
  80. WireFormatLite::FieldType kValueFieldType, int default_enum_value>
  81. class MapEntry
  82. : public MapEntryImpl<Derived, Message, Key, Value, kKeyFieldType,
  83. kValueFieldType, default_enum_value> {
  84. public:
  85. MapEntry() : _internal_metadata_(NULL) {}
  86. explicit MapEntry(Arena* arena)
  87. : MapEntryImpl<Derived, Message, Key, Value, kKeyFieldType,
  88. kValueFieldType, default_enum_value>(arena),
  89. _internal_metadata_(arena) {}
  90. typedef void InternalArenaConstructable_;
  91. typedef void DestructorSkippable_;
  92. InternalMetadataWithArena _internal_metadata_;
  93. private:
  94. friend class ::google::protobuf::Arena;
  95. template <typename C, typename K, typename V,
  96. WireFormatLite::FieldType k_wire_type, WireFormatLite::FieldType,
  97. int default_enum>
  98. friend class internal::MapField;
  99. friend class internal::GeneratedMessageReflection;
  100. GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(MapEntry);
  101. };
  102. // Specialization for the full runtime
  103. template <typename Derived, typename Key, typename Value,
  104. WireFormatLite::FieldType kKeyFieldType,
  105. WireFormatLite::FieldType kValueFieldType, int default_enum_value>
  106. struct MapEntryHelper<MapEntry<Derived, Key, Value, kKeyFieldType,
  107. kValueFieldType, default_enum_value> >
  108. : MapEntryHelper<MapEntryLite<Derived, Key, Value, kKeyFieldType,
  109. kValueFieldType, default_enum_value> > {
  110. explicit MapEntryHelper(const MapPair<Key, Value>& map_pair)
  111. : MapEntryHelper<MapEntryLite<Derived, Key, Value, kKeyFieldType,
  112. kValueFieldType, default_enum_value> >(
  113. map_pair) {}
  114. };
  115. template <typename Derived, typename K, typename V,
  116. WireFormatLite::FieldType key, WireFormatLite::FieldType value,
  117. int default_enum>
  118. struct DeconstructMapEntry<MapEntry<Derived, K, V, key, value, default_enum> > {
  119. typedef K Key;
  120. typedef V Value;
  121. static const WireFormatLite::FieldType kKeyFieldType = key;
  122. static const WireFormatLite::FieldType kValueFieldType = value;
  123. static const int default_enum_value = default_enum;
  124. };
  125. } // namespace internal
  126. } // namespace protobuf
  127. } // namespace google
  128. #endif // GOOGLE_PROTOBUF_MAP_ENTRY_H__