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_UTIL_CONVERTER_UTILITY_H__
32 #define GOOGLE_PROTOBUF_UTIL_CONVERTER_UTILITY_H__
33
34 #include <memory>
35 #include <string>
36 #include <utility>
37
38 #include <google/protobuf/stubs/common.h>
39 #include <google/protobuf/stubs/logging.h>
40 #include <google/protobuf/any.pb.h>
41 #include <google/protobuf/type.pb.h>
42 #include <google/protobuf/repeated_field.h>
43 #include <google/protobuf/stubs/strutil.h>
44 #include <google/protobuf/stubs/status.h>
45 #include <google/protobuf/stubs/statusor.h>
46
47 // Must be included last.
48 #include <google/protobuf/port_def.inc>
49
50 namespace google {
51 namespace protobuf {
52 namespace util {
53 namespace converter {
54
55 // Size of "type.googleapis.com"
56 static const int64 kTypeUrlSize = 19;
57
58 // Finds the tech option identified by option_name. Parses the boolean value and
59 // returns it.
60 // When the option with the given name is not found, default_value is returned.
61 PROTOBUF_EXPORT bool GetBoolOptionOrDefault(
62 const RepeatedPtrField<google::protobuf::Option>& options,
63 StringPiece option_name, bool default_value);
64
65 // Returns int64 option value. If the option isn't found, returns the
66 // default_value.
67 PROTOBUF_EXPORT int64 GetInt64OptionOrDefault(
68 const RepeatedPtrField<google::protobuf::Option>& options,
69 StringPiece option_name, int64 default_value);
70
71 // Returns double option value. If the option isn't found, returns the
72 // default_value.
73 PROTOBUF_EXPORT double GetDoubleOptionOrDefault(
74 const RepeatedPtrField<google::protobuf::Option>& options,
75 StringPiece option_name, double default_value);
76
77 // Returns string option value. If the option isn't found, returns the
78 // default_value.
79 PROTOBUF_EXPORT std::string GetStringOptionOrDefault(
80 const RepeatedPtrField<google::protobuf::Option>& options,
81 StringPiece option_name, StringPiece default_value);
82
83 // Returns a boolean value contained in Any type.
84 // TODO(skarvaje): Make these utilities dealing with Any types more generic,
85 // add more error checking and move to a more public/sharable location so others
86 // can use.
87 PROTOBUF_EXPORT bool GetBoolFromAny(const google::protobuf::Any& any);
88
89 // Returns int64 value contained in Any type.
90 PROTOBUF_EXPORT int64 GetInt64FromAny(const google::protobuf::Any& any);
91
92 // Returns double value contained in Any type.
93 PROTOBUF_EXPORT double GetDoubleFromAny(const google::protobuf::Any& any);
94
95 // Returns string value contained in Any type.
96 PROTOBUF_EXPORT std::string GetStringFromAny(const google::protobuf::Any& any);
97
98 // Returns the type string without the url prefix. e.g.: If the passed type is
99 // 'type.googleapis.com/tech.type.Bool', the returned value is 'tech.type.Bool'.
100 PROTOBUF_EXPORT const StringPiece GetTypeWithoutUrl(
101 StringPiece type_url);
102
103 // Returns the simple_type with the base type url (kTypeServiceBaseUrl)
104 // prefixed.
105 //
106 // E.g:
107 // GetFullTypeWithUrl("google.protobuf.Timestamp") returns the string
108 // "type.googleapis.com/google.protobuf.Timestamp".
109 PROTOBUF_EXPORT const std::string GetFullTypeWithUrl(
110 StringPiece simple_type);
111
112 // Finds and returns option identified by name and option_name within the
113 // provided map. Returns nullptr if none found.
114 const google::protobuf::Option* FindOptionOrNull(
115 const RepeatedPtrField<google::protobuf::Option>& options,
116 StringPiece option_name);
117
118 // Finds and returns the field identified by field_name in the passed tech Type
119 // object. Returns nullptr if none found.
120 const google::protobuf::Field* FindFieldInTypeOrNull(
121 const google::protobuf::Type* type, StringPiece field_name);
122
123 // Similar to FindFieldInTypeOrNull, but this looks up fields with given
124 // json_name.
125 const google::protobuf::Field* FindJsonFieldInTypeOrNull(
126 const google::protobuf::Type* type, StringPiece json_name);
127
128 // Similar to FindFieldInTypeOrNull, but this looks up fields by number.
129 const google::protobuf::Field* FindFieldInTypeByNumberOrNull(
130 const google::protobuf::Type* type, int32 number);
131
132 // Finds and returns the EnumValue identified by enum_name in the passed tech
133 // Enum object. Returns nullptr if none found.
134 const google::protobuf::EnumValue* FindEnumValueByNameOrNull(
135 const google::protobuf::Enum* enum_type, StringPiece enum_name);
136
137 // Finds and returns the EnumValue identified by value in the passed tech
138 // Enum object. Returns nullptr if none found.
139 const google::protobuf::EnumValue* FindEnumValueByNumberOrNull(
140 const google::protobuf::Enum* enum_type, int32 value);
141
142 // Finds and returns the EnumValue identified by enum_name without underscore in
143 // the passed tech Enum object. Returns nullptr if none found.
144 // For Ex. if enum_name is ACTIONANDADVENTURE it can get accepted if
145 // EnumValue's name is action_and_adventure or ACTION_AND_ADVENTURE.
146 const google::protobuf::EnumValue* FindEnumValueByNameWithoutUnderscoreOrNull(
147 const google::protobuf::Enum* enum_type, StringPiece enum_name);
148
149 // Converts input to camel-case and returns it.
150 PROTOBUF_EXPORT std::string ToCamelCase(const StringPiece input);
151
152 // Converts enum name string to camel-case and returns it.
153 std::string EnumValueNameToLowerCamelCase(const StringPiece input);
154
155 // Converts input to snake_case and returns it.
156 PROTOBUF_EXPORT std::string ToSnakeCase(StringPiece input);
157
158 // Returns true if type_name represents a well-known type.
159 PROTOBUF_EXPORT bool IsWellKnownType(const std::string& type_name);
160
161 // Returns true if 'bool_string' represents a valid boolean value. Only "true",
162 // "false", "0" and "1" are allowed.
163 PROTOBUF_EXPORT bool IsValidBoolString(StringPiece bool_string);
164
165 // Returns true if "field" is a protobuf map field based on its type.
166 PROTOBUF_EXPORT bool IsMap(const google::protobuf::Field& field,
167 const google::protobuf::Type& type);
168
169 // Returns true if the given type has special MessageSet wire format.
170 bool IsMessageSetWireFormat(const google::protobuf::Type& type);
171
172 // Infinity/NaN-aware conversion to string.
173 PROTOBUF_EXPORT std::string DoubleAsString(double value);
174 PROTOBUF_EXPORT std::string FloatAsString(float value);
175
176 // Convert from int32, int64, uint32, uint64, double or float to string.
177 template <typename T>
ValueAsString(T value)178 std::string ValueAsString(T value) {
179 return StrCat(value);
180 }
181
182 template <>
ValueAsString(float value)183 inline std::string ValueAsString(float value) {
184 return FloatAsString(value);
185 }
186
187 template <>
ValueAsString(double value)188 inline std::string ValueAsString(double value) {
189 return DoubleAsString(value);
190 }
191
192 // Converts a string to float. Unlike safe_strtof, conversion will fail if the
193 // value fits into double but not float (e.g., DBL_MAX).
194 PROTOBUF_EXPORT bool SafeStrToFloat(StringPiece str, float* value);
195
196 } // namespace converter
197 } // namespace util
198 } // namespace protobuf
199 } // namespace google
200
201 #include <google/protobuf/port_undef.inc>
202
203 #endif // GOOGLE_PROTOBUF_UTIL_CONVERTER_UTILITY_H__
204