You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

usage.h 1.6 kB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. //
  2. // Copyright 2019 The Abseil Authors.
  3. //
  4. // Licensed under the Apache License, Version 2.0 (the "License");
  5. // you may not use this file except in compliance with the License.
  6. // You may obtain a copy of the License at
  7. //
  8. // https://www.apache.org/licenses/LICENSE-2.0
  9. //
  10. // Unless required by applicable law or agreed to in writing, software
  11. // distributed under the License is distributed on an "AS IS" BASIS,
  12. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. // See the License for the specific language governing permissions and
  14. // limitations under the License.
  15. #ifndef ABSL_FLAGS_USAGE_H_
  16. #define ABSL_FLAGS_USAGE_H_
  17. #include "absl/base/config.h"
  18. #include "absl/strings/string_view.h"
  19. // --------------------------------------------------------------------
  20. // Usage reporting interfaces
  21. namespace absl
  22. {
  23. ABSL_NAMESPACE_BEGIN
  24. // Sets the "usage" message to be used by help reporting routines.
  25. // For example:
  26. // absl::SetProgramUsageMessage(
  27. // absl::StrCat("This program does nothing. Sample usage:\n", argv[0],
  28. // " <uselessarg1> <uselessarg2>"));
  29. // Do not include commandline flags in the usage: we do that for you!
  30. // Note: Calling SetProgramUsageMessage twice will trigger a call to std::exit.
  31. void SetProgramUsageMessage(absl::string_view new_usage_message);
  32. // Returns the usage message set by SetProgramUsageMessage().
  33. absl::string_view ProgramUsageMessage();
  34. ABSL_NAMESPACE_END
  35. } // namespace absl
  36. #endif // ABSL_FLAGS_USAGE_H_