merge(3p/absl): subtree merge of Abseil up to e19260f
... notably, this includes Abseil's own StatusOr type, which conflicted with our implementation (that was taken from TensorFlow). Change-Id: Ie7d6764b64055caaeb8dc7b6b9d066291e6b538f
This commit is contained in:
parent
cc27324d02
commit
082c006c04
854 changed files with 11260 additions and 5296 deletions
26
third_party/abseil_cpp/absl/flags/internal/commandlineflag.cc
vendored
Normal file
26
third_party/abseil_cpp/absl/flags/internal/commandlineflag.cc
vendored
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
//
|
||||
// Copyright 2020 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.
|
||||
|
||||
#include "absl/flags/internal/commandlineflag.h"
|
||||
|
||||
namespace absl {
|
||||
ABSL_NAMESPACE_BEGIN
|
||||
namespace flags_internal {
|
||||
|
||||
FlagStateInterface::~FlagStateInterface() {}
|
||||
|
||||
} // namespace flags_internal
|
||||
ABSL_NAMESPACE_END
|
||||
} // namespace absl
|
||||
|
|
@ -482,7 +482,8 @@ class FlagImpl final : public CommandLineFlag {
|
|||
friend class FlagState;
|
||||
|
||||
// Ensures that `data_guard_` is initialized and returns it.
|
||||
absl::Mutex* DataGuard() const ABSL_LOCK_RETURNED((absl::Mutex*)&data_guard_);
|
||||
absl::Mutex* DataGuard() const
|
||||
ABSL_LOCK_RETURNED(reinterpret_cast<absl::Mutex*>(data_guard_));
|
||||
// Returns heap allocated value of type T initialized with default value.
|
||||
std::unique_ptr<void, DynValueDeleter> MakeInitValue() const
|
||||
ABSL_EXCLUSIVE_LOCKS_REQUIRED(*DataGuard());
|
||||
|
|
@ -631,20 +632,9 @@ class Flag {
|
|||
std::string CurrentValue() const { return impl_.CurrentValue(); }
|
||||
|
||||
private:
|
||||
template <typename U, bool do_register>
|
||||
template <typename, bool>
|
||||
friend class FlagRegistrar;
|
||||
|
||||
#if !defined(_MSC_VER) || defined(__clang__)
|
||||
template <typename U>
|
||||
friend U absl::GetFlag(const flags_internal::Flag<U>& flag);
|
||||
template <typename U>
|
||||
friend void absl::SetFlag(flags_internal::Flag<U>* flag, const U& v);
|
||||
template <typename U, typename V>
|
||||
friend void absl::SetFlag(flags_internal::Flag<U>* flag, const V& v);
|
||||
#else
|
||||
template <typename U>
|
||||
friend class absl::Flag;
|
||||
#endif
|
||||
friend class FlagImplPeer;
|
||||
|
||||
T Get() const {
|
||||
// See implementation notes in CommandLineFlag::Get().
|
||||
|
|
@ -667,10 +657,6 @@ class Flag {
|
|||
impl_.Write(&v);
|
||||
}
|
||||
|
||||
template <typename U>
|
||||
friend const CommandLineFlag& absl::GetFlagReflectionHandle(
|
||||
const absl::Flag<U>& f);
|
||||
|
||||
// Access to the reflection.
|
||||
const CommandLineFlag& Reflect() const { return impl_; }
|
||||
|
||||
|
|
@ -682,6 +668,25 @@ class Flag {
|
|||
FlagValue<T> value_;
|
||||
};
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////////
|
||||
// Trampoline for friend access
|
||||
|
||||
class FlagImplPeer {
|
||||
public:
|
||||
template <typename T, typename FlagType>
|
||||
static T InvokeGet(const FlagType& flag) {
|
||||
return flag.Get();
|
||||
}
|
||||
template <typename FlagType, typename T>
|
||||
static void InvokeSet(FlagType& flag, const T& v) {
|
||||
flag.Set(v);
|
||||
}
|
||||
template <typename FlagType>
|
||||
static const CommandLineFlag& InvokeReflect(const FlagType& f) {
|
||||
return f.Reflect();
|
||||
}
|
||||
};
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////////
|
||||
// Implementation of Flag value specific operations routine.
|
||||
template <typename T>
|
||||
|
|
|
|||
|
|
@ -30,9 +30,6 @@ namespace absl {
|
|||
ABSL_NAMESPACE_BEGIN
|
||||
namespace flags_internal {
|
||||
|
||||
// Executes specified visitor for each non-retired flag in the registry.
|
||||
// Requires the caller hold the registry lock.
|
||||
void ForEachFlagUnlocked(std::function<void(CommandLineFlag&)> visitor);
|
||||
// Executes specified visitor for each non-retired flag in the registry. While
|
||||
// callback are executed, the registry is locked and can't be changed.
|
||||
void ForEachFlag(std::function<void(CommandLineFlag&)> visitor);
|
||||
|
|
@ -41,6 +38,8 @@ void ForEachFlag(std::function<void(CommandLineFlag&)> visitor);
|
|||
|
||||
bool RegisterCommandLineFlag(CommandLineFlag&);
|
||||
|
||||
void FinalizeRegistry();
|
||||
|
||||
//-----------------------------------------------------------------------------
|
||||
// Retired registrations:
|
||||
//
|
||||
|
|
@ -74,13 +73,22 @@ bool RegisterCommandLineFlag(CommandLineFlag&);
|
|||
//
|
||||
|
||||
// Retire flag with name "name" and type indicated by ops.
|
||||
bool Retire(const char* name, FlagFastTypeId type_id);
|
||||
void Retire(const char* name, FlagFastTypeId type_id, char* buf);
|
||||
|
||||
constexpr size_t kRetiredFlagObjSize = 3 * sizeof(void*);
|
||||
constexpr size_t kRetiredFlagObjAlignment = alignof(void*);
|
||||
|
||||
// Registered a retired flag with name 'flag_name' and type 'T'.
|
||||
template <typename T>
|
||||
inline bool RetiredFlag(const char* flag_name) {
|
||||
return flags_internal::Retire(flag_name, base_internal::FastTypeId<T>());
|
||||
}
|
||||
class RetiredFlag {
|
||||
public:
|
||||
void Retire(const char* flag_name) {
|
||||
flags_internal::Retire(flag_name, base_internal::FastTypeId<T>(), buf_);
|
||||
}
|
||||
|
||||
private:
|
||||
alignas(kRetiredFlagObjAlignment) char buf_[kRetiredFlagObjSize];
|
||||
};
|
||||
|
||||
} // namespace flags_internal
|
||||
ABSL_NAMESPACE_END
|
||||
|
|
|
|||
289
third_party/abseil_cpp/absl/flags/internal/usage.cc
vendored
289
third_party/abseil_cpp/absl/flags/internal/usage.cc
vendored
|
|
@ -37,26 +37,26 @@
|
|||
#include "absl/strings/str_split.h"
|
||||
#include "absl/strings/string_view.h"
|
||||
|
||||
ABSL_FLAG(bool, help, false,
|
||||
"show help on important flags for this binary [tip: all flags can "
|
||||
"have two dashes]");
|
||||
ABSL_FLAG(bool, helpfull, false, "show help on all flags");
|
||||
ABSL_FLAG(bool, helpshort, false,
|
||||
"show help on only the main module for this program");
|
||||
ABSL_FLAG(bool, helppackage, false,
|
||||
"show help on all modules in the main package");
|
||||
ABSL_FLAG(bool, version, false, "show version and build info and exit");
|
||||
ABSL_FLAG(bool, only_check_args, false, "exit after checking all flags");
|
||||
ABSL_FLAG(std::string, helpon, "",
|
||||
"show help on the modules named by this flag value");
|
||||
ABSL_FLAG(std::string, helpmatch, "",
|
||||
"show help on modules whose name contains the specified substr");
|
||||
// Dummy global variables to prevent anyone else defining these.
|
||||
bool FLAGS_help = false;
|
||||
bool FLAGS_helpfull = false;
|
||||
bool FLAGS_helpshort = false;
|
||||
bool FLAGS_helppackage = false;
|
||||
bool FLAGS_version = false;
|
||||
bool FLAGS_only_check_args = false;
|
||||
bool FLAGS_helpon = false;
|
||||
bool FLAGS_helpmatch = false;
|
||||
|
||||
namespace absl {
|
||||
ABSL_NAMESPACE_BEGIN
|
||||
namespace flags_internal {
|
||||
namespace {
|
||||
|
||||
using PerFlagFilter = std::function<bool(const absl::CommandLineFlag&)>;
|
||||
|
||||
// Maximum length size in a human readable format.
|
||||
constexpr size_t kHrfMaxLineLength = 80;
|
||||
|
||||
// This class is used to emit an XML element with `tag` and `text`.
|
||||
// It adds opening and closing tags and escapes special characters in the text.
|
||||
// For example:
|
||||
|
|
@ -109,9 +109,12 @@ class FlagHelpPrettyPrinter {
|
|||
public:
|
||||
// Pretty printer holds on to the std::ostream& reference to direct an output
|
||||
// to that stream.
|
||||
FlagHelpPrettyPrinter(int max_line_len, std::ostream& out)
|
||||
FlagHelpPrettyPrinter(size_t max_line_len, size_t min_line_len,
|
||||
size_t wrapped_line_indent, std::ostream& out)
|
||||
: out_(out),
|
||||
max_line_len_(max_line_len),
|
||||
min_line_len_(min_line_len),
|
||||
wrapped_line_indent_(wrapped_line_indent),
|
||||
line_len_(0),
|
||||
first_line_(true) {}
|
||||
|
||||
|
|
@ -145,7 +148,8 @@ class FlagHelpPrettyPrinter {
|
|||
}
|
||||
|
||||
// Write the token, ending the string first if necessary/possible.
|
||||
if (!new_line && (line_len_ + token.size() >= max_line_len_)) {
|
||||
if (!new_line &&
|
||||
(line_len_ + static_cast<int>(token.size()) >= max_line_len_)) {
|
||||
EndLine();
|
||||
new_line = true;
|
||||
}
|
||||
|
|
@ -164,13 +168,12 @@ class FlagHelpPrettyPrinter {
|
|||
|
||||
void StartLine() {
|
||||
if (first_line_) {
|
||||
out_ << " ";
|
||||
line_len_ = 4;
|
||||
line_len_ = min_line_len_;
|
||||
first_line_ = false;
|
||||
} else {
|
||||
out_ << " ";
|
||||
line_len_ = 6;
|
||||
line_len_ = min_line_len_ + wrapped_line_indent_;
|
||||
}
|
||||
out_ << std::string(line_len_, ' ');
|
||||
}
|
||||
void EndLine() {
|
||||
out_ << '\n';
|
||||
|
|
@ -179,13 +182,15 @@ class FlagHelpPrettyPrinter {
|
|||
|
||||
private:
|
||||
std::ostream& out_;
|
||||
const int max_line_len_;
|
||||
int line_len_;
|
||||
const size_t max_line_len_;
|
||||
const size_t min_line_len_;
|
||||
const size_t wrapped_line_indent_;
|
||||
size_t line_len_;
|
||||
bool first_line_;
|
||||
};
|
||||
|
||||
void FlagHelpHumanReadable(const CommandLineFlag& flag, std::ostream& out) {
|
||||
FlagHelpPrettyPrinter printer(80, out); // Max line length is 80.
|
||||
FlagHelpPrettyPrinter printer(kHrfMaxLineLength, 4, 2, out);
|
||||
|
||||
// Flag name.
|
||||
printer.Write(absl::StrCat("--", flag.Name()));
|
||||
|
|
@ -221,7 +226,7 @@ void FlagHelpHumanReadable(const CommandLineFlag& flag, std::ostream& out) {
|
|||
// If a flag's help message has been stripped (e.g. by adding '#define
|
||||
// STRIP_FLAG_HELP 1' then this flag will not be displayed by '--help'
|
||||
// and its variants.
|
||||
void FlagsHelpImpl(std::ostream& out, flags_internal::FlagKindFilter filter_cb,
|
||||
void FlagsHelpImpl(std::ostream& out, PerFlagFilter filter_cb,
|
||||
HelpFormat format, absl::string_view program_usage_message) {
|
||||
if (format == HelpFormat::kHumanReadable) {
|
||||
out << flags_internal::ShortProgramInvocationName() << ": "
|
||||
|
|
@ -250,8 +255,6 @@ void FlagsHelpImpl(std::ostream& out, flags_internal::FlagKindFilter filter_cb,
|
|||
matching_flags;
|
||||
|
||||
flags_internal::ForEachFlag([&](absl::CommandLineFlag& flag) {
|
||||
std::string flag_filename = flag.Filename();
|
||||
|
||||
// Ignore retired flags.
|
||||
if (flag.IsRetired()) return;
|
||||
|
||||
|
|
@ -259,7 +262,9 @@ void FlagsHelpImpl(std::ostream& out, flags_internal::FlagKindFilter filter_cb,
|
|||
if (flag.Help() == flags_internal::kStrippedFlagHelp) return;
|
||||
|
||||
// Make sure flag satisfies the filter
|
||||
if (!filter_cb || !filter_cb(flag_filename)) return;
|
||||
if (!filter_cb(flag)) return;
|
||||
|
||||
std::string flag_filename = flag.Filename();
|
||||
|
||||
matching_flags[std::string(flags_internal::Package(flag_filename))]
|
||||
[flag_filename]
|
||||
|
|
@ -289,15 +294,34 @@ void FlagsHelpImpl(std::ostream& out, flags_internal::FlagKindFilter filter_cb,
|
|||
}
|
||||
|
||||
if (format == HelpFormat::kHumanReadable) {
|
||||
FlagHelpPrettyPrinter printer(kHrfMaxLineLength, 0, 0, out);
|
||||
|
||||
if (filter_cb && matching_flags.empty()) {
|
||||
out << " No modules matched: use -helpfull\n";
|
||||
printer.Write("No flags matched.\n", true);
|
||||
}
|
||||
printer.EndLine();
|
||||
printer.Write(
|
||||
"Try --helpfull to get a list of all flags or --help=substring "
|
||||
"shows help for flags which include specified substring in either "
|
||||
"in the name, or description or path.\n",
|
||||
true);
|
||||
} else {
|
||||
// The end of the document.
|
||||
out << "</AllFlags>\n";
|
||||
}
|
||||
}
|
||||
|
||||
void FlagsHelpImpl(std::ostream& out,
|
||||
flags_internal::FlagKindFilter filename_filter_cb,
|
||||
HelpFormat format, absl::string_view program_usage_message) {
|
||||
FlagsHelpImpl(
|
||||
out,
|
||||
[&](const absl::CommandLineFlag& flag) {
|
||||
return filename_filter_cb && filename_filter_cb(flag.Filename());
|
||||
},
|
||||
format, program_usage_message);
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
// --------------------------------------------------------------------
|
||||
|
|
@ -309,7 +333,7 @@ void FlagHelp(std::ostream& out, const CommandLineFlag& flag,
|
|||
}
|
||||
|
||||
// --------------------------------------------------------------------
|
||||
// Produces the help messages for all flags matching the filter.
|
||||
// Produces the help messages for all flags matching the filename filter.
|
||||
// If filter is empty produces help messages for all flags.
|
||||
void FlagsHelp(std::ostream& out, absl::string_view filter, HelpFormat format,
|
||||
absl::string_view program_usage_message) {
|
||||
|
|
@ -324,68 +348,177 @@ void FlagsHelp(std::ostream& out, absl::string_view filter, HelpFormat format,
|
|||
// If so, handles them appropriately.
|
||||
int HandleUsageFlags(std::ostream& out,
|
||||
absl::string_view program_usage_message) {
|
||||
if (absl::GetFlag(FLAGS_helpshort)) {
|
||||
flags_internal::FlagsHelpImpl(
|
||||
out, flags_internal::GetUsageConfig().contains_helpshort_flags,
|
||||
HelpFormat::kHumanReadable, program_usage_message);
|
||||
return 1;
|
||||
}
|
||||
switch (GetFlagsHelpMode()) {
|
||||
case HelpMode::kNone:
|
||||
break;
|
||||
case HelpMode::kImportant:
|
||||
flags_internal::FlagsHelpImpl(
|
||||
out, flags_internal::GetUsageConfig().contains_help_flags,
|
||||
GetFlagsHelpFormat(), program_usage_message);
|
||||
return 1;
|
||||
|
||||
if (absl::GetFlag(FLAGS_helpfull)) {
|
||||
// show all options
|
||||
flags_internal::FlagsHelp(out, "", HelpFormat::kHumanReadable,
|
||||
program_usage_message);
|
||||
return 1;
|
||||
}
|
||||
case HelpMode::kShort:
|
||||
flags_internal::FlagsHelpImpl(
|
||||
out, flags_internal::GetUsageConfig().contains_helpshort_flags,
|
||||
GetFlagsHelpFormat(), program_usage_message);
|
||||
return 1;
|
||||
|
||||
if (!absl::GetFlag(FLAGS_helpon).empty()) {
|
||||
flags_internal::FlagsHelp(
|
||||
out, absl::StrCat("/", absl::GetFlag(FLAGS_helpon), "."),
|
||||
HelpFormat::kHumanReadable, program_usage_message);
|
||||
return 1;
|
||||
}
|
||||
case HelpMode::kFull:
|
||||
flags_internal::FlagsHelp(out, "", GetFlagsHelpFormat(),
|
||||
program_usage_message);
|
||||
return 1;
|
||||
|
||||
if (!absl::GetFlag(FLAGS_helpmatch).empty()) {
|
||||
flags_internal::FlagsHelp(out, absl::GetFlag(FLAGS_helpmatch),
|
||||
HelpFormat::kHumanReadable,
|
||||
program_usage_message);
|
||||
return 1;
|
||||
}
|
||||
case HelpMode::kPackage:
|
||||
flags_internal::FlagsHelpImpl(
|
||||
out, flags_internal::GetUsageConfig().contains_helppackage_flags,
|
||||
GetFlagsHelpFormat(), program_usage_message);
|
||||
|
||||
if (absl::GetFlag(FLAGS_help)) {
|
||||
flags_internal::FlagsHelpImpl(
|
||||
out, flags_internal::GetUsageConfig().contains_help_flags,
|
||||
HelpFormat::kHumanReadable, program_usage_message);
|
||||
return 1;
|
||||
|
||||
out << "\nTry --helpfull to get a list of all flags.\n";
|
||||
case HelpMode::kMatch: {
|
||||
std::string substr = GetFlagsHelpMatchSubstr();
|
||||
if (substr.empty()) {
|
||||
// show all options
|
||||
flags_internal::FlagsHelp(out, substr, GetFlagsHelpFormat(),
|
||||
program_usage_message);
|
||||
} else {
|
||||
auto filter_cb = [&substr](const absl::CommandLineFlag& flag) {
|
||||
if (absl::StrContains(flag.Name(), substr)) return true;
|
||||
if (absl::StrContains(flag.Filename(), substr)) return true;
|
||||
if (absl::StrContains(flag.Help(), substr)) return true;
|
||||
|
||||
return 1;
|
||||
}
|
||||
return false;
|
||||
};
|
||||
flags_internal::FlagsHelpImpl(
|
||||
out, filter_cb, HelpFormat::kHumanReadable, program_usage_message);
|
||||
}
|
||||
|
||||
if (absl::GetFlag(FLAGS_helppackage)) {
|
||||
flags_internal::FlagsHelpImpl(
|
||||
out, flags_internal::GetUsageConfig().contains_helppackage_flags,
|
||||
HelpFormat::kHumanReadable, program_usage_message);
|
||||
return 1;
|
||||
}
|
||||
case HelpMode::kVersion:
|
||||
if (flags_internal::GetUsageConfig().version_string)
|
||||
out << flags_internal::GetUsageConfig().version_string();
|
||||
// Unlike help, we may be asking for version in a script, so return 0
|
||||
return 0;
|
||||
|
||||
out << "\nTry --helpfull to get a list of all flags.\n";
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
if (absl::GetFlag(FLAGS_version)) {
|
||||
if (flags_internal::GetUsageConfig().version_string)
|
||||
out << flags_internal::GetUsageConfig().version_string();
|
||||
// Unlike help, we may be asking for version in a script, so return 0
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (absl::GetFlag(FLAGS_only_check_args)) {
|
||||
return 0;
|
||||
case HelpMode::kOnlyCheckArgs:
|
||||
return 0;
|
||||
}
|
||||
|
||||
return -1;
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------
|
||||
// Globals representing usage reporting flags
|
||||
|
||||
namespace {
|
||||
|
||||
ABSL_CONST_INIT absl::Mutex help_attributes_guard(absl::kConstInit);
|
||||
ABSL_CONST_INIT std::string* match_substr
|
||||
ABSL_GUARDED_BY(help_attributes_guard) = nullptr;
|
||||
ABSL_CONST_INIT HelpMode help_mode ABSL_GUARDED_BY(help_attributes_guard) =
|
||||
HelpMode::kNone;
|
||||
ABSL_CONST_INIT HelpFormat help_format ABSL_GUARDED_BY(help_attributes_guard) =
|
||||
HelpFormat::kHumanReadable;
|
||||
|
||||
} // namespace
|
||||
|
||||
std::string GetFlagsHelpMatchSubstr() {
|
||||
absl::MutexLock l(&help_attributes_guard);
|
||||
if (match_substr == nullptr) return "";
|
||||
return *match_substr;
|
||||
}
|
||||
|
||||
void SetFlagsHelpMatchSubstr(absl::string_view substr) {
|
||||
absl::MutexLock l(&help_attributes_guard);
|
||||
if (match_substr == nullptr) match_substr = new std::string;
|
||||
match_substr->assign(substr.data(), substr.size());
|
||||
}
|
||||
|
||||
HelpMode GetFlagsHelpMode() {
|
||||
absl::MutexLock l(&help_attributes_guard);
|
||||
// Refer to dummy variales to prevent linker dropping them
|
||||
if (FLAGS_help || FLAGS_helpfull || FLAGS_helpshort || FLAGS_helppackage ||
|
||||
FLAGS_version || FLAGS_only_check_args || FLAGS_helpon ||
|
||||
FLAGS_helpmatch) {
|
||||
help_mode = HelpMode::kNone;
|
||||
}
|
||||
return help_mode;
|
||||
}
|
||||
|
||||
void SetFlagsHelpMode(HelpMode mode) {
|
||||
absl::MutexLock l(&help_attributes_guard);
|
||||
help_mode = mode;
|
||||
}
|
||||
|
||||
HelpFormat GetFlagsHelpFormat() {
|
||||
absl::MutexLock l(&help_attributes_guard);
|
||||
return help_format;
|
||||
}
|
||||
|
||||
void SetFlagsHelpFormat(HelpFormat format) {
|
||||
absl::MutexLock l(&help_attributes_guard);
|
||||
help_format = format;
|
||||
}
|
||||
|
||||
// Deduces usage flags from the input argument in a form --name=value or
|
||||
// --name. argument is already split into name and value before we call this
|
||||
// function.
|
||||
bool DeduceUsageFlags(absl::string_view name, absl::string_view value) {
|
||||
if (absl::ConsumePrefix(&name, "help")) {
|
||||
if (name == "") {
|
||||
if (value.empty()) {
|
||||
SetFlagsHelpMode(HelpMode::kImportant);
|
||||
} else {
|
||||
SetFlagsHelpMode(HelpMode::kMatch);
|
||||
SetFlagsHelpMatchSubstr(value);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
if (name == "match") {
|
||||
SetFlagsHelpMode(HelpMode::kMatch);
|
||||
SetFlagsHelpMatchSubstr(value);
|
||||
return true;
|
||||
}
|
||||
|
||||
if (name == "on") {
|
||||
SetFlagsHelpMode(HelpMode::kMatch);
|
||||
SetFlagsHelpMatchSubstr(absl::StrCat("/", value, "."));
|
||||
return true;
|
||||
}
|
||||
|
||||
if (name == "full") {
|
||||
SetFlagsHelpMode(HelpMode::kFull);
|
||||
return true;
|
||||
}
|
||||
|
||||
if (name == "short") {
|
||||
SetFlagsHelpMode(HelpMode::kShort);
|
||||
return true;
|
||||
}
|
||||
|
||||
if (name == "package") {
|
||||
SetFlagsHelpMode(HelpMode::kPackage);
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
if (name == "version") {
|
||||
SetFlagsHelpMode(HelpMode::kVersion);
|
||||
return true;
|
||||
}
|
||||
|
||||
if (name == "only_check_args") {
|
||||
SetFlagsHelpMode(HelpMode::kOnlyCheckArgs);
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
} // namespace flags_internal
|
||||
ABSL_NAMESPACE_END
|
||||
} // namespace absl
|
||||
|
|
|
|||
|
|
@ -36,7 +36,8 @@ enum class HelpFormat {
|
|||
kHumanReadable,
|
||||
};
|
||||
|
||||
// Outputs the help message describing specific flag.
|
||||
// Streams the help message describing `flag` to `out`.
|
||||
// The default value for `flag` is included in the output.
|
||||
void FlagHelp(std::ostream& out, const CommandLineFlag& flag,
|
||||
HelpFormat format = HelpFormat::kHumanReadable);
|
||||
|
||||
|
|
@ -65,17 +66,39 @@ void FlagsHelp(std::ostream& out, absl::string_view filter,
|
|||
int HandleUsageFlags(std::ostream& out,
|
||||
absl::string_view program_usage_message);
|
||||
|
||||
// --------------------------------------------------------------------
|
||||
// Globals representing usage reporting flags
|
||||
|
||||
enum class HelpMode {
|
||||
kNone,
|
||||
kImportant,
|
||||
kShort,
|
||||
kFull,
|
||||
kPackage,
|
||||
kMatch,
|
||||
kVersion,
|
||||
kOnlyCheckArgs
|
||||
};
|
||||
|
||||
// Returns substring to filter help output (--help=substr argument)
|
||||
std::string GetFlagsHelpMatchSubstr();
|
||||
// Returns the requested help mode.
|
||||
HelpMode GetFlagsHelpMode();
|
||||
// Returns the requested help format.
|
||||
HelpFormat GetFlagsHelpFormat();
|
||||
|
||||
// These are corresponding setters to the attributes above.
|
||||
void SetFlagsHelpMatchSubstr(absl::string_view);
|
||||
void SetFlagsHelpMode(HelpMode);
|
||||
void SetFlagsHelpFormat(HelpFormat);
|
||||
|
||||
// Deduces usage flags from the input argument in a form --name=value or
|
||||
// --name. argument is already split into name and value before we call this
|
||||
// function.
|
||||
bool DeduceUsageFlags(absl::string_view name, absl::string_view value);
|
||||
|
||||
} // namespace flags_internal
|
||||
ABSL_NAMESPACE_END
|
||||
} // namespace absl
|
||||
|
||||
ABSL_DECLARE_FLAG(bool, help);
|
||||
ABSL_DECLARE_FLAG(bool, helpfull);
|
||||
ABSL_DECLARE_FLAG(bool, helpshort);
|
||||
ABSL_DECLARE_FLAG(bool, helppackage);
|
||||
ABSL_DECLARE_FLAG(bool, version);
|
||||
ABSL_DECLARE_FLAG(bool, only_check_args);
|
||||
ABSL_DECLARE_FLAG(std::string, helpon);
|
||||
ABSL_DECLARE_FLAG(std::string, helpmatch);
|
||||
|
||||
#endif // ABSL_FLAGS_INTERNAL_USAGE_H_
|
||||
|
|
|
|||
|
|
@ -87,6 +87,11 @@ class UsageReportingTest : public testing::Test {
|
|||
default_config.normalize_filename = &NormalizeFileName;
|
||||
absl::SetFlagsUsageConfig(default_config);
|
||||
}
|
||||
~UsageReportingTest() override {
|
||||
flags::SetFlagsHelpMode(flags::HelpMode::kNone);
|
||||
flags::SetFlagsHelpMatchSubstr("");
|
||||
flags::SetFlagsHelpFormat(flags::HelpFormat::kHumanReadable);
|
||||
}
|
||||
|
||||
private:
|
||||
absl::FlagSaver flag_saver_;
|
||||
|
|
@ -191,6 +196,10 @@ TEST_F(UsageReportingTest, TestFlagsHelpHRF) {
|
|||
Some more help.
|
||||
Even more long long long long long long long long long long long long help
|
||||
message.); default: "";
|
||||
|
||||
Try --helpfull to get a list of all flags or --help=substring shows help for
|
||||
flags which include specified substring in either in the name, or description or
|
||||
path.
|
||||
)";
|
||||
|
||||
std::stringstream test_buf_01;
|
||||
|
|
@ -214,7 +223,11 @@ TEST_F(UsageReportingTest, TestFlagsHelpHRF) {
|
|||
EXPECT_EQ(test_buf_04.str(),
|
||||
R"(usage_test: Custom usage message
|
||||
|
||||
No modules matched: use -helpfull
|
||||
No flags matched.
|
||||
|
||||
Try --helpfull to get a list of all flags or --help=substring shows help for
|
||||
flags which include specified substring in either in the name, or description or
|
||||
path.
|
||||
)");
|
||||
|
||||
std::stringstream test_buf_05;
|
||||
|
|
@ -226,12 +239,8 @@ TEST_F(UsageReportingTest, TestFlagsHelpHRF) {
|
|||
absl::StartsWith(test_out_str, "usage_test: Custom usage message"));
|
||||
EXPECT_TRUE(absl::StrContains(
|
||||
test_out_str, "Flags from absl/flags/internal/usage_test.cc:"));
|
||||
EXPECT_TRUE(absl::StrContains(test_out_str,
|
||||
"Flags from absl/flags/internal/usage.cc:"));
|
||||
EXPECT_TRUE(
|
||||
absl::StrContains(test_out_str, "-usage_reporting_test_flag_01 "));
|
||||
EXPECT_TRUE(absl::StrContains(test_out_str, "-help (show help"))
|
||||
<< test_out_str;
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------
|
||||
|
|
@ -244,7 +253,7 @@ TEST_F(UsageReportingTest, TestNoUsageFlags) {
|
|||
// --------------------------------------------------------------------
|
||||
|
||||
TEST_F(UsageReportingTest, TestUsageFlag_helpshort) {
|
||||
absl::SetFlag(&FLAGS_helpshort, true);
|
||||
flags::SetFlagsHelpMode(flags::HelpMode::kShort);
|
||||
|
||||
std::stringstream test_buf;
|
||||
EXPECT_EQ(flags::HandleUsageFlags(test_buf, kTestUsageMessage), 1);
|
||||
|
|
@ -267,13 +276,17 @@ TEST_F(UsageReportingTest, TestUsageFlag_helpshort) {
|
|||
Some more help.
|
||||
Even more long long long long long long long long long long long long help
|
||||
message.); default: "";
|
||||
|
||||
Try --helpfull to get a list of all flags or --help=substring shows help for
|
||||
flags which include specified substring in either in the name, or description or
|
||||
path.
|
||||
)");
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------
|
||||
|
||||
TEST_F(UsageReportingTest, TestUsageFlag_help) {
|
||||
absl::SetFlag(&FLAGS_help, true);
|
||||
TEST_F(UsageReportingTest, TestUsageFlag_help_simple) {
|
||||
flags::SetFlagsHelpMode(flags::HelpMode::kImportant);
|
||||
|
||||
std::stringstream test_buf;
|
||||
EXPECT_EQ(flags::HandleUsageFlags(test_buf, kTestUsageMessage), 1);
|
||||
|
|
@ -297,14 +310,74 @@ TEST_F(UsageReportingTest, TestUsageFlag_help) {
|
|||
Even more long long long long long long long long long long long long help
|
||||
message.); default: "";
|
||||
|
||||
Try --helpfull to get a list of all flags.
|
||||
Try --helpfull to get a list of all flags or --help=substring shows help for
|
||||
flags which include specified substring in either in the name, or description or
|
||||
path.
|
||||
)");
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------
|
||||
|
||||
TEST_F(UsageReportingTest, TestUsageFlag_help_one_flag) {
|
||||
flags::SetFlagsHelpMode(flags::HelpMode::kMatch);
|
||||
flags::SetFlagsHelpMatchSubstr("usage_reporting_test_flag_06");
|
||||
|
||||
std::stringstream test_buf;
|
||||
EXPECT_EQ(flags::HandleUsageFlags(test_buf, kTestUsageMessage), 1);
|
||||
EXPECT_EQ(test_buf.str(),
|
||||
R"(usage_test: Custom usage message
|
||||
|
||||
Flags from absl/flags/internal/usage_test.cc:
|
||||
--usage_reporting_test_flag_06 (usage_reporting_test_flag_06 help message.
|
||||
|
||||
Some more help.
|
||||
Even more long long long long long long long long long long long long help
|
||||
message.); default: "";
|
||||
|
||||
Try --helpfull to get a list of all flags or --help=substring shows help for
|
||||
flags which include specified substring in either in the name, or description or
|
||||
path.
|
||||
)");
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------
|
||||
|
||||
TEST_F(UsageReportingTest, TestUsageFlag_help_multiple_flag) {
|
||||
flags::SetFlagsHelpMode(flags::HelpMode::kMatch);
|
||||
flags::SetFlagsHelpMatchSubstr("test_flag");
|
||||
|
||||
std::stringstream test_buf;
|
||||
EXPECT_EQ(flags::HandleUsageFlags(test_buf, kTestUsageMessage), 1);
|
||||
EXPECT_EQ(test_buf.str(),
|
||||
R"(usage_test: Custom usage message
|
||||
|
||||
Flags from absl/flags/internal/usage_test.cc:
|
||||
--usage_reporting_test_flag_01 (usage_reporting_test_flag_01 help message);
|
||||
default: 101;
|
||||
--usage_reporting_test_flag_02 (usage_reporting_test_flag_02 help message);
|
||||
default: false;
|
||||
--usage_reporting_test_flag_03 (usage_reporting_test_flag_03 help message);
|
||||
default: 1.03;
|
||||
--usage_reporting_test_flag_04 (usage_reporting_test_flag_04 help message);
|
||||
default: 1000000000000004;
|
||||
--usage_reporting_test_flag_05 (usage_reporting_test_flag_05 help message);
|
||||
default: UDT{};
|
||||
--usage_reporting_test_flag_06 (usage_reporting_test_flag_06 help message.
|
||||
|
||||
Some more help.
|
||||
Even more long long long long long long long long long long long long help
|
||||
message.); default: "";
|
||||
|
||||
Try --helpfull to get a list of all flags or --help=substring shows help for
|
||||
flags which include specified substring in either in the name, or description or
|
||||
path.
|
||||
)");
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------
|
||||
|
||||
TEST_F(UsageReportingTest, TestUsageFlag_helppackage) {
|
||||
absl::SetFlag(&FLAGS_helppackage, true);
|
||||
flags::SetFlagsHelpMode(flags::HelpMode::kPackage);
|
||||
|
||||
std::stringstream test_buf;
|
||||
EXPECT_EQ(flags::HandleUsageFlags(test_buf, kTestUsageMessage), 1);
|
||||
|
|
@ -328,14 +401,16 @@ TEST_F(UsageReportingTest, TestUsageFlag_helppackage) {
|
|||
Even more long long long long long long long long long long long long help
|
||||
message.); default: "";
|
||||
|
||||
Try --helpfull to get a list of all flags.
|
||||
Try --helpfull to get a list of all flags or --help=substring shows help for
|
||||
flags which include specified substring in either in the name, or description or
|
||||
path.
|
||||
)");
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------
|
||||
|
||||
TEST_F(UsageReportingTest, TestUsageFlag_version) {
|
||||
absl::SetFlag(&FLAGS_version, true);
|
||||
flags::SetFlagsHelpMode(flags::HelpMode::kVersion);
|
||||
|
||||
std::stringstream test_buf;
|
||||
EXPECT_EQ(flags::HandleUsageFlags(test_buf, kTestUsageMessage), 0);
|
||||
|
|
@ -349,7 +424,7 @@ TEST_F(UsageReportingTest, TestUsageFlag_version) {
|
|||
// --------------------------------------------------------------------
|
||||
|
||||
TEST_F(UsageReportingTest, TestUsageFlag_only_check_args) {
|
||||
absl::SetFlag(&FLAGS_only_check_args, true);
|
||||
flags::SetFlagsHelpMode(flags::HelpMode::kOnlyCheckArgs);
|
||||
|
||||
std::stringstream test_buf;
|
||||
EXPECT_EQ(flags::HandleUsageFlags(test_buf, kTestUsageMessage), 0);
|
||||
|
|
@ -359,17 +434,22 @@ TEST_F(UsageReportingTest, TestUsageFlag_only_check_args) {
|
|||
// --------------------------------------------------------------------
|
||||
|
||||
TEST_F(UsageReportingTest, TestUsageFlag_helpon) {
|
||||
absl::SetFlag(&FLAGS_helpon, "bla-bla");
|
||||
flags::SetFlagsHelpMode(flags::HelpMode::kMatch);
|
||||
flags::SetFlagsHelpMatchSubstr("/bla-bla.");
|
||||
|
||||
std::stringstream test_buf_01;
|
||||
EXPECT_EQ(flags::HandleUsageFlags(test_buf_01, kTestUsageMessage), 1);
|
||||
EXPECT_EQ(test_buf_01.str(),
|
||||
R"(usage_test: Custom usage message
|
||||
|
||||
No modules matched: use -helpfull
|
||||
No flags matched.
|
||||
|
||||
Try --helpfull to get a list of all flags or --help=substring shows help for
|
||||
flags which include specified substring in either in the name, or description or
|
||||
path.
|
||||
)");
|
||||
|
||||
absl::SetFlag(&FLAGS_helpon, "usage_test");
|
||||
flags::SetFlagsHelpMatchSubstr("/usage_test.");
|
||||
|
||||
std::stringstream test_buf_02;
|
||||
EXPECT_EQ(flags::HandleUsageFlags(test_buf_02, kTestUsageMessage), 1);
|
||||
|
|
@ -392,6 +472,10 @@ TEST_F(UsageReportingTest, TestUsageFlag_helpon) {
|
|||
Some more help.
|
||||
Even more long long long long long long long long long long long long help
|
||||
message.); default: "";
|
||||
|
||||
Try --helpfull to get a list of all flags or --help=substring shows help for
|
||||
flags which include specified substring in either in the name, or description or
|
||||
path.
|
||||
)");
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue