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// Must be included last.
41#include <google/protobuf/port_def.inc>
42
43namespace google {
44namespace protobuf {
45
46class FieldDescriptor;
47class Message;
48
49namespace internal {
50
51extern const char kAnyFullTypeName[]; // "google.protobuf.Any".
52extern const char kTypeGoogleApisComPrefix[]; // "type.googleapis.com/".
53extern const char kTypeGoogleProdComPrefix[]; // "type.googleprod.com/".
54
55std::string GetTypeUrl(StringPiece message_name,
56 StringPiece type_url_prefix);
57
58// Helper class used to implement google::protobuf::Any.
59class 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 : type_url_(type_url), value_(value) {}
66
67 // Packs a message using the default type URL prefix: "type.googleapis.com".
68 // The resulted type URL will be "type.googleapis.com/<message_full_name>".
69 // Returns false if serializing the message failed.
70 template <typename T>
71 bool PackFrom(Arena* arena, const T& message) {
72 return InternalPackFrom(arena, message, type_url_prefix: kTypeGoogleApisComPrefix,
73 type_name: T::FullMessageName());
74 }
75
76 bool PackFrom(Arena* arena, const Message& message);
77
78 // Packs a message using the given type URL prefix. The type URL will be
79 // constructed by concatenating the message type's full name to the prefix
80 // with an optional "/" separator if the prefix doesn't already end with "/".
81 // For example, both PackFrom(message, "type.googleapis.com") and
82 // PackFrom(message, "type.googleapis.com/") yield the same result type
83 // URL: "type.googleapis.com/<message_full_name>".
84 // Returns false if serializing the message failed.
85 template <typename T>
86 bool PackFrom(Arena* arena, const T& message,
87 StringPiece type_url_prefix) {
88 return InternalPackFrom(arena, message, type_url_prefix,
89 type_name: T::FullMessageName());
90 }
91
92 bool PackFrom(Arena* arena, const Message& message,
93 StringPiece type_url_prefix);
94
95 // Unpacks the payload into the given message. Returns false if the message's
96 // type doesn't match the type specified in the type URL (i.e., the full
97 // name after the last "/" of the type URL doesn't match the message's actual
98 // full name) or parsing the payload has failed.
99 template <typename T>
100 bool UnpackTo(T* message) const {
101 return InternalUnpackTo(type_name: T::FullMessageName(), message);
102 }
103
104 bool UnpackTo(Message* message) const;
105
106 // Checks whether the type specified in the type URL matches the given type.
107 // A type is considered matching if its full name matches the full name after
108 // the last "/" in the type URL.
109 template <typename T>
110 bool Is() const {
111 return InternalIs(type_name: T::FullMessageName());
112 }
113
114 private:
115 bool InternalPackFrom(Arena* arena, const MessageLite& message,
116 StringPiece type_url_prefix,
117 StringPiece type_name);
118 bool InternalUnpackTo(StringPiece type_name,
119 MessageLite* message) const;
120 bool InternalIs(StringPiece type_name) const;
121
122 UrlType* type_url_;
123 ValueType* value_;
124
125 GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(AnyMetadata);
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()
135bool ParseAnyTypeUrl(StringPiece 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.
142bool ParseAnyTypeUrl(StringPiece 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.
147bool 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__
158