path: root/contrib/restricted/abseil-cpp-tstring/y_absl/flags/marshalling.h

//
//  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>`
// * `std::optional<T>`
// * `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.)
//
// -----------------------------------------------------------------------------
// Optional Flags
// -----------------------------------------------------------------------------
//
// The Abseil flags library supports flags of type `std::optional<T>` where
// `T` is a type of one of the supported flags. We refer to this flag type as
// an "optional flag." An optional flag is either "valueless", holding no value
// of type `T` (indicating that the flag has not been set) or a value of type
// `T`. The valueless state in C++ code is represented by a value of
// `std::nullopt` for the optional flag.
//
// Using `std::nullopt` as an optional flag's default value allows you to check
// whether such a flag was ever specified on the command line:
//
//   if (y_absl::GetFlag(FLAGS_foo).has_value()) {
//     // flag was set on command line
//   } else {
//     // flag was not passed on command line
//   }
//
// Using an optional flag in this manner avoids common workarounds for
// indicating such an unset flag (such as using sentinel values to indicate this
// state).
//
// An optional flag also allows a developer to pass a flag in an "unset"
// valueless state on the command line, allowing the flag to later be set in
// binary logic. An optional flag's valueless state is indicated by the special
// notation of passing the value as an empty string through the syntax `--flag=`
// or `--flag ""`.
//
//   $ binary_with_optional --flag_in_unset_state=
//   $ binary_with_optional --flag_in_unset_state ""
//
// Note: as a result of the above syntax requirements, an optional flag cannot
// be set to a `T` of any value which unparses to the empty string.
//
// -----------------------------------------------------------------------------
// 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 "y_absl/base/config.h"
#include "y_absl/numeric/int128.h"

#if defined(Y_ABSL_HAVE_STD_OPTIONAL) && !defined(Y_ABSL_USES_STD_OPTIONAL)
#include <optional>
#endif
#include <util/generic/string.h>
#include <vector>

#include "y_absl/strings/string_view.h"
#include "y_absl/types/optional.h"

namespace y_absl {
Y_ABSL_NAMESPACE_BEGIN

// Forward declaration to be used inside composable flag parse/unparse
// implementations
template <typename T>
inline bool ParseFlag(y_absl::string_view input, T* dst, TString* error);
template <typename T>
inline TString UnparseFlag(const T& v);

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, y_absl::int128*, TString*);    // NOLINT
bool AbslParseFlag(y_absl::string_view, y_absl::uint128*, TString*);   // NOLINT
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 AbslParseFlag(y_absl::string_view text, y_absl::optional<T>* f,
                   TString* err) {
  if (text.empty()) {
    *f = y_absl::nullopt;
    return true;
  }
  T value;
  if (!y_absl::ParseFlag(text, &value, err)) return false;

  *f = std::move(value);
  return true;
}

#if defined(Y_ABSL_HAVE_STD_OPTIONAL) && !defined(Y_ABSL_USES_STD_OPTIONAL)
template <typename T>
bool AbslParseFlag(y_absl::string_view text, std::optional<T>* f,
                   TString* err) {
  if (text.empty()) {
    *f = std::nullopt;
    return true;
  }
  T value;
  if (!y_absl::ParseFlag(text, &value, err)) return false;

  *f = std::move(value);
  return true;
}
#endif

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 AbslUnparseFlag(const y_absl::optional<T>& f) {
  return f.has_value() ? y_absl::UnparseFlag(*f) : "";
}

#if defined(Y_ABSL_HAVE_STD_OPTIONAL) && !defined(Y_ABSL_USES_STD_OPTIONAL)
template <typename T>
TString AbslUnparseFlag(const std::optional<T>& f) {
  return f.has_value() ? y_absl::UnparseFlag(*f) : "";
}
#endif

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(y_absl::int128 v);
TString Unparse(y_absl::uint128 v);
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_