any.h 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  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/stubs/common.h>
  34. #include <google/protobuf/descriptor.h>
  35. #include <google/protobuf/message.h>
  36. #include <google/protobuf/arenastring.h>
  37. namespace google {
  38. namespace protobuf {
  39. namespace internal {
  40. // Helper class used to implement google::protobuf::Any.
  41. class LIBPROTOBUF_EXPORT AnyMetadata {
  42. typedef ArenaStringPtr UrlType;
  43. typedef ArenaStringPtr ValueType;
  44. public:
  45. // AnyMetadata does not take ownership of "type_url" and "value".
  46. AnyMetadata(UrlType* type_url, ValueType* value);
  47. // Packs a message using the default type URL prefix: "type.googleapis.com".
  48. // The resulted type URL will be "type.googleapis.com/<message_full_name>".
  49. void PackFrom(const Message& message);
  50. // Packs a message using the given type URL prefix. The type URL will be
  51. // constructed by concatenating the message type's full name to the prefix
  52. // with an optional "/" separator if the prefix doesn't already end up "/".
  53. // For example, both PackFrom(message, "type.googleapis.com") and
  54. // PackFrom(message, "type.googleapis.com/") yield the same result type
  55. // URL: "type.googleapis.com/<message_full_name>".
  56. void PackFrom(const Message& message, const string& type_url_prefix);
  57. // Unpacks the payload into the given message. Returns false if the message's
  58. // type doesn't match the type specified in the type URL (i.e., the full
  59. // name after the last "/" of the type URL doesn't match the message's actual
  60. // full name) or parsing the payload has failed.
  61. bool UnpackTo(Message* message) const;
  62. // Checks whether the type specified in the type URL matches the given type.
  63. // A type is consdiered matching if its full name matches the full name after
  64. // the last "/" in the type URL.
  65. template<typename T>
  66. bool Is() const {
  67. return InternalIs(T::default_instance().GetDescriptor());
  68. }
  69. private:
  70. bool InternalIs(const Descriptor* message) const;
  71. UrlType* type_url_;
  72. ValueType* value_;
  73. GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(AnyMetadata);
  74. };
  75. extern const char kAnyFullTypeName[]; // "google.protobuf.Any".
  76. extern const char kTypeGoogleApisComPrefix[]; // "type.googleapis.com/".
  77. extern const char kTypeGoogleProdComPrefix[]; // "type.googleprod.com/".
  78. // Get the proto type name from Any::type_url value. For example, passing
  79. // "type.googleapis.com/rpc.QueryOrigin" will return "rpc.QueryOrigin" in
  80. // *full_type_name. Returns false if the type_url does not have a "/"
  81. // in the type url separating the full type name.
  82. //
  83. // NOTE: this function is available publicly as:
  84. // google::protobuf::Any() // static method on the generated message type.
  85. bool ParseAnyTypeUrl(const string& type_url, string* full_type_name);
  86. // Get the proto type name and prefix from Any::type_url value. For example,
  87. // passing "type.googleapis.com/rpc.QueryOrigin" will return
  88. // "type.googleapis.com/" in *url_prefix and "rpc.QueryOrigin" in
  89. // *full_type_name. Returns false if the type_url does not have a "/" in the
  90. // type url separating the full type name.
  91. bool ParseAnyTypeUrl(const string& type_url, string* url_prefix,
  92. string* full_type_name);
  93. // See if message is of type google.protobuf.Any, if so, return the descriptors
  94. // for "type_url" and "value" fields.
  95. bool GetAnyFieldDescriptors(const Message& message,
  96. const FieldDescriptor** type_url_field,
  97. const FieldDescriptor** value_field);
  98. } // namespace internal
  99. } // namespace protobuf
  100. } // namespace google
  101. #endif // GOOGLE_PROTOBUF_ANY_H__