Debian Codegraph @

third_party/protobuf-lite/google/protobuf/any.h

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