Export of internal Abseil changes.
-- 78293ba4eb4981991ae7e6edd25eb9245fcd7515 by Andy Soffer <asoffer@google.com>: internal changes PiperOrigin-RevId: 247073879 -- 7bd97e3aad0c3012b89a39392a6ad3f254e9f3c3 by Derek Mauro <dmauro@google.com>: Release commandline flags PiperOrigin-RevId: 247065920 -- 2a991849fd7b140a43b073076d194b61533fd199 by Tom Manshreck <shreck@google.com>: Add documentation for built-in usage flags PiperOrigin-RevId: 247058863 -- 14157b0de45841706bbd631284191fd94c313db9 by Derek Mauro <dmauro@google.com>: Internal change PiperOrigin-RevId: 247058292 -- ed67e0a80468596e30540b367727a250fa415b68 by Abseil Team <absl-team@google.com>: Internal Change. PiperOrigin-RevId: 246828655 -- e1bc8c2aa3f90b3d56c55c5b7244e718c919265d by Abseil Team <absl-team@google.com>: Internal change PiperOrigin-RevId: 246822325 -- 907a68f287199f749cb9bdb48571b50bc34731e1 by Eric Fiselier <ericwf@google.com>: Accept vector<bool>::reference in StrCat and friends. Converting vector<bool>::reference to alphanum requires two user defined conversions, which isn't allowed. In order to accept this, we need a special constructor that is only enabled for the bool proxy types. PiperOrigin-RevId: 246626732 -- fe4295fa95cc65dee8c881ba12dd8f516e68c40d by Abseil Team <absl-team@google.com>: Clarify the proper way to define AbslHashValue, and fix confusing indentation. PiperOrigin-RevId: 246406528 -- d7174681a72d4a25c8fd2b4d9f515a0763eff87c by Gennadiy Rozental <rogeeff@google.com>: Internal change PiperOrigin-RevId: 246358214 -- a7fdc19683cf1a5885e9e1af52fcdb2db1eda53b by Abseil Team <absl-team@google.com>: Fix sample template instantiation. PiperOrigin-RevId: 246354617 -- 29a23c6835f872948d09b24d890385bf195bc995 by Abseil Team <absl-team@google.com>: Fix incorrectly copy-pasted static_assert in absl::optional::value_or The static_assert for a move-constructible type previously said the type must be copy-constructible. PiperOrigin-RevId: 246313827 -- 41884d5872d4ea2c67875b00144b8c8a5859a295 by Greg Falcon <gfalcon@google.com>: Import of CCTZ from GitHub. PiperOrigin-RevId: 245418790 -- 7f90a7f94cdd5e21232c749efe952a750b5c43a2 by Abseil Team <absl-team@google.com>: Internal change PiperOrigin-RevId: 245412658 -- 730a329cf047d54b46971fce1781edd857208c2a by Greg Falcon <gfalcon@google.com>: internal change PiperOrigin-RevId: 245293234 -- cf0216be6338200cbb18167d3f3b2e98e372be77 by Greg Falcon <gfalcon@google.com>: Internal change PiperOrigin-RevId: 245288164 GitOrigin-RevId: 78293ba4eb4981991ae7e6edd25eb9245fcd7515 Change-Id: I5ea9a852c36c722bae2d6be65fb7f72473d94ab6
This commit is contained in:
parent
cd86d0d20a
commit
aa468ad755
46 changed files with 8451 additions and 18 deletions
91
absl/flags/internal/usage.h
Normal file
91
absl/flags/internal/usage.h
Normal file
|
|
@ -0,0 +1,91 @@
|
|||
//
|
||||
// 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.
|
||||
|
||||
#ifndef ABSL_FLAGS_INTERNAL_USAGE_H_
|
||||
#define ABSL_FLAGS_INTERNAL_USAGE_H_
|
||||
|
||||
#include <iosfwd>
|
||||
#include <string>
|
||||
|
||||
#include "absl/flags/declare.h"
|
||||
#include "absl/flags/internal/commandlineflag.h"
|
||||
#include "absl/strings/string_view.h"
|
||||
|
||||
// --------------------------------------------------------------------
|
||||
// Usage reporting interfaces
|
||||
|
||||
namespace absl {
|
||||
namespace flags_internal {
|
||||
|
||||
// Sets the "usage" message to be used by help reporting routines.
|
||||
// For example:
|
||||
// absl::SetProgramUsageMessage(
|
||||
// absl::StrCat("This program does nothing. Sample usage:\n", argv[0],
|
||||
// " <uselessarg1> <uselessarg2>"));
|
||||
// Do not include commandline flags in the usage: we do that for you!
|
||||
// Note: Calling SetProgramUsageMessage twice will trigger a call to std::exit.
|
||||
void SetProgramUsageMessage(absl::string_view new_usage_message);
|
||||
|
||||
// Returns the usage message set by SetProgramUsageMessage().
|
||||
absl::string_view ProgramUsageMessage();
|
||||
|
||||
// --------------------------------------------------------------------
|
||||
|
||||
// The format to report the help messages in.
|
||||
enum class HelpFormat {
|
||||
kHumanReadable,
|
||||
};
|
||||
|
||||
// Outputs the help message describing specific flag.
|
||||
void FlagHelp(std::ostream& out, const flags_internal::CommandLineFlag& flag,
|
||||
HelpFormat format = HelpFormat::kHumanReadable);
|
||||
|
||||
// Produces the help messages for all flags matching the filter. A flag matches
|
||||
// the filter if it is defined in a file with a filename which includes
|
||||
// filter string as a substring. You can use '/' and '.' to restrict the
|
||||
// matching to a specific file names. For example:
|
||||
// FlagsHelp(out, "/path/to/file.");
|
||||
// restricts help to only flags which resides in files named like:
|
||||
// .../path/to/file.<ext>
|
||||
// for any extension 'ext'. If the filter is empty this function produces help
|
||||
// messages for all flags.
|
||||
void FlagsHelp(std::ostream& out, absl::string_view filter = {},
|
||||
HelpFormat format = HelpFormat::kHumanReadable);
|
||||
|
||||
// --------------------------------------------------------------------
|
||||
|
||||
// If any of the 'usage' related command line flags (listed on the bottom of
|
||||
// this file) has been set this routine produces corresponding help message in
|
||||
// the specified output stream and returns:
|
||||
// 0 - if "version" or "only_check_flags" flags were set and handled.
|
||||
// 1 - if some other 'usage' related flag was set and handled.
|
||||
// -1 - if no usage flags were set on a commmand line.
|
||||
// Non negative return values are expected to be used as an exit code for a
|
||||
// binary.
|
||||
int HandleUsageFlags(std::ostream& out);
|
||||
|
||||
} // namespace flags_internal
|
||||
} // 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_
|
||||
Loading…
Add table
Add a link
Reference in a new issue