usage.h 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  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. ABSL_NAMESPACE_BEGIN
  23. // Sets the "usage" message to be used by help reporting routines.
  24. // For example:
  25. // absl::SetProgramUsageMessage(
  26. // absl::StrCat("This program does nothing. Sample usage:\n", argv[0],
  27. // " <uselessarg1> <uselessarg2>"));
  28. // Do not include commandline flags in the usage: we do that for you!
  29. // Note: Calling SetProgramUsageMessage twice will trigger a call to std::exit.
  30. void SetProgramUsageMessage(absl::string_view new_usage_message);
  31. // Returns the usage message set by SetProgramUsageMessage().
  32. absl::string_view ProgramUsageMessage();
  33. ABSL_NAMESPACE_END
  34. } // namespace absl
  35. #endif // ABSL_FLAGS_USAGE_H_