declare.h 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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. //
  16. // -----------------------------------------------------------------------------
  17. // File: declare.h
  18. // -----------------------------------------------------------------------------
  19. //
  20. // This file defines the ABSL_DECLARE_FLAG macro, allowing you to declare an
  21. // `absl::Flag` for use within a translation unit. You should place this
  22. // declaration within the header file associated with the .cc file that defines
  23. // and owns the `Flag`.
  24. #ifndef ABSL_FLAGS_DECLARE_H_
  25. #define ABSL_FLAGS_DECLARE_H_
  26. #include "absl/base/config.h"
  27. namespace absl {
  28. ABSL_NAMESPACE_BEGIN
  29. namespace flags_internal {
  30. // absl::Flag<T> represents a flag of type 'T' created by ABSL_FLAG.
  31. template <typename T>
  32. class Flag;
  33. } // namespace flags_internal
  34. // Flag
  35. //
  36. // Forward declaration of the `absl::Flag` type for use in defining the macro.
  37. template <typename T>
  38. using Flag = flags_internal::Flag<T>;
  39. ABSL_NAMESPACE_END
  40. } // namespace absl
  41. // ABSL_DECLARE_FLAG()
  42. //
  43. // This macro is a convenience for declaring use of an `absl::Flag` within a
  44. // translation unit. This macro should be used within a header file to
  45. // declare usage of the flag within any .cc file including that header file.
  46. //
  47. // The ABSL_DECLARE_FLAG(type, name) macro expands to:
  48. //
  49. // extern absl::Flag<type> FLAGS_name;
  50. #define ABSL_DECLARE_FLAG(type, name) ABSL_DECLARE_FLAG_INTERNAL(type, name)
  51. // Internal implementation of ABSL_DECLARE_FLAG to allow macro expansion of its
  52. // arguments. Clients must use ABSL_DECLARE_FLAG instead.
  53. #define ABSL_DECLARE_FLAG_INTERNAL(type, name) \
  54. extern absl::Flag<type> FLAGS_##name; \
  55. namespace absl /* block flags in namespaces */ {} \
  56. /* second redeclaration is to allow applying attributes */ \
  57. extern absl::Flag<type> FLAGS_##name
  58. #endif // ABSL_FLAGS_DECLARE_H_