any.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  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_ANY_H__
  31. #define GOOGLE_PROTOBUF_ANY_H__
  32. #include <string>
  33. #include "google/protobuf/port.h"
  34. #include "google/protobuf/arenastring.h"
  35. #include "google/protobuf/message_lite.h"
  36. // Must be included last.
  37. #include "google/protobuf/port_def.inc"
  38. namespace google {
  39. namespace protobuf {
  40. class FieldDescriptor;
  41. class Message;
  42. namespace internal {
  43. extern const char kAnyFullTypeName[]; // "google.protobuf.Any".
  44. extern const char kTypeGoogleApisComPrefix[]; // "type.googleapis.com/".
  45. extern const char kTypeGoogleProdComPrefix[]; // "type.googleprod.com/".
  46. std::string GetTypeUrl(absl::string_view message_name,
  47. absl::string_view type_url_prefix);
  48. // Helper class used to implement google::protobuf::Any.
  49. class PROTOBUF_EXPORT AnyMetadata {
  50. typedef ArenaStringPtr UrlType;
  51. typedef ArenaStringPtr ValueType;
  52. public:
  53. // AnyMetadata does not take ownership of "type_url" and "value".
  54. constexpr AnyMetadata(UrlType* type_url, ValueType* value)
  55. : type_url_(type_url), value_(value) {}
  56. AnyMetadata(const AnyMetadata&) = delete;
  57. AnyMetadata& operator=(const AnyMetadata&) = delete;
  58. // Packs a message using the default type URL prefix: "type.googleapis.com".
  59. // The resulted type URL will be "type.googleapis.com/<message_full_name>".
  60. // Returns false if serializing the message failed.
  61. template <typename T>
  62. bool PackFrom(Arena* arena, const T& message) {
  63. return InternalPackFrom(arena, message, kTypeGoogleApisComPrefix,
  64. T::FullMessageName());
  65. }
  66. bool PackFrom(Arena* arena, const Message& message);
  67. // Packs a message using the given type URL prefix. The type URL will be
  68. // constructed by concatenating the message type's full name to the prefix
  69. // with an optional "/" separator if the prefix doesn't already end with "/".
  70. // For example, both PackFrom(message, "type.googleapis.com") and
  71. // PackFrom(message, "type.googleapis.com/") yield the same result type
  72. // URL: "type.googleapis.com/<message_full_name>".
  73. // Returns false if serializing the message failed.
  74. template <typename T>
  75. bool PackFrom(Arena* arena, const T& message,
  76. absl::string_view type_url_prefix) {
  77. return InternalPackFrom(arena, message, type_url_prefix,
  78. T::FullMessageName());
  79. }
  80. bool PackFrom(Arena* arena, const Message& message,
  81. absl::string_view type_url_prefix);
  82. // Unpacks the payload into the given message. Returns false if the message's
  83. // type doesn't match the type specified in the type URL (i.e., the full
  84. // name after the last "/" of the type URL doesn't match the message's actual
  85. // full name) or parsing the payload has failed.
  86. template <typename T>
  87. bool UnpackTo(T* message) const {
  88. return InternalUnpackTo(T::FullMessageName(), message);
  89. }
  90. bool UnpackTo(Message* message) const;
  91. // Checks whether the type specified in the type URL matches the given type.
  92. // A type is considered matching if its full name matches the full name after
  93. // the last "/" in the type URL.
  94. template <typename T>
  95. bool Is() const {
  96. return InternalIs(T::FullMessageName());
  97. }
  98. private:
  99. bool InternalPackFrom(Arena* arena, const MessageLite& message,
  100. absl::string_view type_url_prefix,
  101. absl::string_view type_name);
  102. bool InternalUnpackTo(absl::string_view type_name,
  103. MessageLite* message) const;
  104. bool InternalIs(absl::string_view type_name) const;
  105. UrlType* type_url_;
  106. ValueType* value_;
  107. };
  108. // Get the proto type name from Any::type_url value. For example, passing
  109. // "type.googleapis.com/rpc.QueryOrigin" will return "rpc.QueryOrigin" in
  110. // *full_type_name. Returns false if the type_url does not have a "/"
  111. // in the type url separating the full type name.
  112. //
  113. // NOTE: this function is available publicly as a static method on the
  114. // generated message type: google::protobuf::Any::ParseAnyTypeUrl()
  115. bool ParseAnyTypeUrl(absl::string_view type_url, std::string* full_type_name);
  116. // Get the proto type name and prefix from Any::type_url value. For example,
  117. // passing "type.googleapis.com/rpc.QueryOrigin" will return
  118. // "type.googleapis.com/" in *url_prefix and "rpc.QueryOrigin" in
  119. // *full_type_name. Returns false if the type_url does not have a "/" in the
  120. // type url separating the full type name.
  121. bool ParseAnyTypeUrl(absl::string_view type_url, std::string* url_prefix,
  122. std::string* full_type_name);
  123. // See if message is of type google.protobuf.Any, if so, return the descriptors
  124. // for "type_url" and "value" fields.
  125. bool GetAnyFieldDescriptors(const Message& message,
  126. const FieldDescriptor** type_url_field,
  127. const FieldDescriptor** value_field);
  128. } // namespace internal
  129. } // namespace protobuf
  130. } // namespace google
  131. #include "google/protobuf/port_undef.inc"
  132. #endif // GOOGLE_PROTOBUF_ANY_H__