1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
//
// Copyright 2019 The Abseil Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// -----------------------------------------------------------------------------
// File: marshalling.h
// -----------------------------------------------------------------------------
//
// This header file defines the API for extending Abseil flag support to
// custom types, and defines the set of overloads for fundamental types.
//
// Out of the box, the Abseil flags library supports the following types:
//
// * `bool`
// * `int16_t`
// * `uint16_t`
// * `int32_t`
// * `uint32_t`
// * `int64_t`
// * `uint64_t`
// * `float`
// * `double`
// * `TString`
// * `std::vector<TString>`
// * `y_absl::LogSeverity` (provided natively for layering reasons)
//
// Note that support for integral types is implemented using overloads for
// variable-width fundamental types (`short`, `int`, `long`, etc.). However,
// you should prefer the fixed-width integral types (`int32_t`, `uint64_t`,
// etc.) we've noted above within flag definitions.
//
// In addition, several Abseil libraries provide their own custom support for
// Abseil flags. Documentation for these formats is provided in the type's
// `AbslParseFlag()` definition.
//
// The Abseil time library provides the following support for civil time values:
//
// * `y_absl::CivilSecond`
// * `y_absl::CivilMinute`
// * `y_absl::CivilHour`
// * `y_absl::CivilDay`
// * `y_absl::CivilMonth`
// * `y_absl::CivilYear`
//
// and also provides support for the following absolute time values:
//
// * `y_absl::Duration`
// * `y_absl::Time`
//
// Additional support for Abseil types will be noted here as it is added.
//
// You can also provide your own custom flags by adding overloads for
// `AbslParseFlag()` and `AbslUnparseFlag()` to your type definitions. (See
// below.)
//
// -----------------------------------------------------------------------------
// Adding Type Support for Abseil Flags
// -----------------------------------------------------------------------------
//
// To add support for your user-defined type, add overloads of `AbslParseFlag()`
// and `AbslUnparseFlag()` as free (non-member) functions to your type. If `T`
// is a class type, these functions can be friend function definitions. These
// overloads must be added to the same namespace where the type is defined, so
// that they can be discovered by Argument-Dependent Lookup (ADL).
//
// Example:
//
// namespace foo {
//
// enum OutputMode { kPlainText, kHtml };
//
// // AbslParseFlag converts from a string to OutputMode.
// // Must be in same namespace as OutputMode.
//
// // Parses an OutputMode from the command line flag value `text`. Returns
// // `true` and sets `*mode` on success; returns `false` and sets `*error`
// // on failure.
// bool AbslParseFlag(y_absl::string_view text,
// OutputMode* mode,
// TString* error) {
// if (text == "plaintext") {
// *mode = kPlainText;
// return true;
// }
// if (text == "html") {
// *mode = kHtml;
// return true;
// }
// *error = "unknown value for enumeration";
// return false;
// }
//
// // AbslUnparseFlag converts from an OutputMode to a string.
// // Must be in same namespace as OutputMode.
//
// // Returns a textual flag value corresponding to the OutputMode `mode`.
// TString AbslUnparseFlag(OutputMode mode) {
// switch (mode) {
// case kPlainText: return "plaintext";
// case kHtml: return "html";
// }
// return y_absl::StrCat(mode);
// }
//
// Notice that neither `AbslParseFlag()` nor `AbslUnparseFlag()` are class
// members, but free functions. `AbslParseFlag/AbslUnparseFlag()` overloads
// for a type should only be declared in the same file and namespace as said
// type. The proper `AbslParseFlag/AbslUnparseFlag()` implementations for a
// given type will be discovered via Argument-Dependent Lookup (ADL).
//
// `AbslParseFlag()` may need, in turn, to parse simpler constituent types
// using `y_absl::ParseFlag()`. For example, a custom struct `MyFlagType`
// consisting of a `std::pair<int, TString>` would add an `AbslParseFlag()`
// overload for its `MyFlagType` like so:
//
// Example:
//
// namespace my_flag_type {
//
// struct MyFlagType {
// std::pair<int, TString> my_flag_data;
// };
//
// bool AbslParseFlag(y_absl::string_view text, MyFlagType* flag,
// TString* err);
//
// TString AbslUnparseFlag(const MyFlagType&);
//
// // Within the implementation, `AbslParseFlag()` will, in turn invoke
// // `y_absl::ParseFlag()` on its constituent `int` and `TString` types
// // (which have built-in Abseil flag support).
//
// bool AbslParseFlag(y_absl::string_view text, MyFlagType* flag,
// TString* err) {
// std::pair<y_absl::string_view, y_absl::string_view> tokens =
// y_absl::StrSplit(text, ',');
// if (!y_absl::ParseFlag(tokens.first, &flag->my_flag_data.first, err))
// return false;
// if (!y_absl::ParseFlag(tokens.second, &flag->my_flag_data.second, err))
// return false;
// return true;
// }
//
// // Similarly, for unparsing, we can simply invoke `y_absl::UnparseFlag()` on
// // the constituent types.
// TString AbslUnparseFlag(const MyFlagType& flag) {
// return y_absl::StrCat(y_absl::UnparseFlag(flag.my_flag_data.first),
// ",",
// y_absl::UnparseFlag(flag.my_flag_data.second));
// }
#ifndef Y_ABSL_FLAGS_MARSHALLING_H_
#define Y_ABSL_FLAGS_MARSHALLING_H_
#include <util/generic/string.h>
#include <vector>
#include "y_absl/base/config.h"
#include "y_absl/strings/string_view.h"
namespace y_absl {
Y_ABSL_NAMESPACE_BEGIN
namespace flags_internal {
// Overloads of `AbslParseFlag()` and `AbslUnparseFlag()` for fundamental types.
bool AbslParseFlag(y_absl::string_view, bool*, TString*);
bool AbslParseFlag(y_absl::string_view, short*, TString*); // NOLINT
bool AbslParseFlag(y_absl::string_view, unsigned short*, TString*); // NOLINT
bool AbslParseFlag(y_absl::string_view, int*, TString*); // NOLINT
bool AbslParseFlag(y_absl::string_view, unsigned int*, TString*); // NOLINT
bool AbslParseFlag(y_absl::string_view, long*, TString*); // NOLINT
bool AbslParseFlag(y_absl::string_view, unsigned long*, TString*); // NOLINT
bool AbslParseFlag(y_absl::string_view, long long*, TString*); // NOLINT
bool AbslParseFlag(y_absl::string_view, unsigned long long*, // NOLINT
TString*);
bool AbslParseFlag(y_absl::string_view, float*, TString*);
bool AbslParseFlag(y_absl::string_view, double*, TString*);
bool AbslParseFlag(y_absl::string_view, TString*, TString*);
bool AbslParseFlag(y_absl::string_view, std::vector<TString>*, TString*);
template <typename T>
bool InvokeParseFlag(y_absl::string_view input, T* dst, TString* err) {
// Comment on next line provides a good compiler error message if T
// does not have AbslParseFlag(y_absl::string_view, T*, TString*).
return AbslParseFlag(input, dst, err); // Is T missing AbslParseFlag?
}
// Strings and std:: containers do not have the same overload resolution
// considerations as fundamental types. Naming these 'AbslUnparseFlag' means we
// can avoid the need for additional specializations of Unparse (below).
TString AbslUnparseFlag(y_absl::string_view v);
TString AbslUnparseFlag(const std::vector<TString>&);
template <typename T>
TString Unparse(const T& v) {
// Comment on next line provides a good compiler error message if T does not
// have UnparseFlag.
return AbslUnparseFlag(v); // Is T missing AbslUnparseFlag?
}
// Overloads for builtin types.
TString Unparse(bool v);
TString Unparse(short v); // NOLINT
TString Unparse(unsigned short v); // NOLINT
TString Unparse(int v); // NOLINT
TString Unparse(unsigned int v); // NOLINT
TString Unparse(long v); // NOLINT
TString Unparse(unsigned long v); // NOLINT
TString Unparse(long long v); // NOLINT
TString Unparse(unsigned long long v); // NOLINT
TString Unparse(float v);
TString Unparse(double v);
} // namespace flags_internal
// ParseFlag()
//
// Parses a string value into a flag value of type `T`. Do not add overloads of
// this function for your type directly; instead, add an `AbslParseFlag()`
// free function as documented above.
//
// Some implementations of `AbslParseFlag()` for types which consist of other,
// constituent types which already have Abseil flag support, may need to call
// `y_absl::ParseFlag()` on those consituent string values. (See above.)
template <typename T>
inline bool ParseFlag(y_absl::string_view input, T* dst, TString* error) {
return flags_internal::InvokeParseFlag(input, dst, error);
}
// UnparseFlag()
//
// Unparses a flag value of type `T` into a string value. Do not add overloads
// of this function for your type directly; instead, add an `AbslUnparseFlag()`
// free function as documented above.
//
// Some implementations of `AbslUnparseFlag()` for types which consist of other,
// constituent types which already have Abseil flag support, may want to call
// `y_absl::UnparseFlag()` on those constituent types. (See above.)
template <typename T>
inline TString UnparseFlag(const T& v) {
return flags_internal::Unparse(v);
}
// Overloads for `y_absl::LogSeverity` can't (easily) appear alongside that type's
// definition because it is layered below flags. See proper documentation in
// base/log_severity.h.
enum class LogSeverity : int;
bool AbslParseFlag(y_absl::string_view, y_absl::LogSeverity*, TString*);
TString AbslUnparseFlag(y_absl::LogSeverity);
Y_ABSL_NAMESPACE_END
} // namespace y_absl
#endif // Y_ABSL_FLAGS_MARSHALLING_H_
|
