usage.cc 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  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. #include "absl/flags/usage.h"
  16. #include <stdlib.h>
  17. #include <string>
  18. #include "absl/base/attributes.h"
  19. #include "absl/base/config.h"
  20. #include "absl/base/const_init.h"
  21. #include "absl/base/thread_annotations.h"
  22. #include "absl/flags/internal/usage.h"
  23. #include "absl/strings/string_view.h"
  24. #include "absl/synchronization/mutex.h"
  25. namespace absl {
  26. ABSL_NAMESPACE_BEGIN
  27. namespace flags_internal {
  28. namespace {
  29. ABSL_CONST_INIT absl::Mutex usage_message_guard(absl::kConstInit);
  30. ABSL_CONST_INIT std::string* program_usage_message
  31. ABSL_GUARDED_BY(usage_message_guard) = nullptr;
  32. } // namespace
  33. } // namespace flags_internal
  34. // --------------------------------------------------------------------
  35. // Sets the "usage" message to be used by help reporting routines.
  36. void SetProgramUsageMessage(absl::string_view new_usage_message) {
  37. absl::MutexLock l(&flags_internal::usage_message_guard);
  38. if (flags_internal::program_usage_message != nullptr) {
  39. ABSL_INTERNAL_LOG(FATAL, "SetProgramUsageMessage() called twice.");
  40. std::exit(1);
  41. }
  42. flags_internal::program_usage_message = new std::string(new_usage_message);
  43. }
  44. // --------------------------------------------------------------------
  45. // Returns the usage message set by SetProgramUsageMessage().
  46. // Note: We able to return string_view here only because calling
  47. // SetProgramUsageMessage twice is prohibited.
  48. absl::string_view ProgramUsageMessage() {
  49. absl::MutexLock l(&flags_internal::usage_message_guard);
  50. return flags_internal::program_usage_message != nullptr
  51. ? absl::string_view(*flags_internal::program_usage_message)
  52. : "Warning: SetProgramUsageMessage() never called";
  53. }
  54. ABSL_NAMESPACE_END
  55. } // namespace absl