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