commandlineflags.h 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  1. // Copyright (c) 2008, Google Inc.
  2. // All rights reserved.
  3. //
  4. // Redistribution and use in source and binary forms, with or without
  5. // modification, are permitted provided that the following conditions are
  6. // met:
  7. //
  8. // * Redistributions of source code must retain the above copyright
  9. // notice, this list of conditions and the following disclaimer.
  10. // * Redistributions in binary form must reproduce the above
  11. // copyright notice, this list of conditions and the following disclaimer
  12. // in the documentation and/or other materials provided with the
  13. // distribution.
  14. // * Neither the name of Google Inc. nor the names of its
  15. // contributors may be used to endorse or promote products derived from
  16. // this software without specific prior written permission.
  17. //
  18. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29. // ---
  30. // This file is a compatibility layer that defines Google's version of
  31. // command line flags that are used for configuration.
  32. //
  33. // We put flags into their own namespace. It is purposefully
  34. // named in an opaque way that people should have trouble typing
  35. // directly. The idea is that DEFINE puts the flag in the weird
  36. // namespace, and DECLARE imports the flag from there into the
  37. // current namespace. The net result is to force people to use
  38. // DECLARE to get access to a flag, rather than saying
  39. // extern bool FLAGS_logtostderr;
  40. // or some such instead. We want this so we can put extra
  41. // functionality (like sanity-checking) in DECLARE if we want,
  42. // and make sure it is picked up everywhere.
  43. //
  44. // We also put the type of the variable in the namespace, so that
  45. // people can't DECLARE_int32 something that they DEFINE_bool'd
  46. // elsewhere.
  47. #ifndef BASE_COMMANDLINEFLAGS_H__
  48. #define BASE_COMMANDLINEFLAGS_H__
  49. #include "config.h"
  50. #include <string>
  51. #include <string.h> // for memchr
  52. #include <stdlib.h> // for getenv
  53. #ifdef HAVE_LIB_GFLAGS
  54. #include <gflags/gflags.h>
  55. #else
  56. #include "glog/logging.h"
  57. #define DECLARE_VARIABLE(type, name, tn) \
  58. namespace FLAG__namespace_do_not_use_directly_use_DECLARE_##tn##_instead { \
  59. extern GOOGLE_GLOG_DLL_DECL type FLAGS_##name; \
  60. } \
  61. using FLAG__namespace_do_not_use_directly_use_DECLARE_##tn##_instead::FLAGS_##name
  62. #define DEFINE_VARIABLE(type, name, value, meaning, tn) \
  63. namespace FLAG__namespace_do_not_use_directly_use_DECLARE_##tn##_instead { \
  64. GOOGLE_GLOG_DLL_DECL type FLAGS_##name(value); \
  65. char FLAGS_no##name; \
  66. } \
  67. using FLAG__namespace_do_not_use_directly_use_DECLARE_##tn##_instead::FLAGS_##name
  68. // bool specialization
  69. #define DECLARE_bool(name) \
  70. DECLARE_VARIABLE(bool, name, bool)
  71. #define DEFINE_bool(name, value, meaning) \
  72. DEFINE_VARIABLE(bool, name, value, meaning, bool)
  73. // int32 specialization
  74. #define DECLARE_int32(name) \
  75. DECLARE_VARIABLE(GOOGLE_NAMESPACE::int32, name, int32)
  76. #define DEFINE_int32(name, value, meaning) \
  77. DEFINE_VARIABLE(GOOGLE_NAMESPACE::int32, name, value, meaning, int32)
  78. // Special case for string, because we have to specify the namespace
  79. // std::string, which doesn't play nicely with our FLAG__namespace hackery.
  80. #define DECLARE_string(name) \
  81. namespace FLAG__namespace_do_not_use_directly_use_DECLARE_string_instead { \
  82. extern GOOGLE_GLOG_DLL_DECL std::string FLAGS_##name; \
  83. } \
  84. using FLAG__namespace_do_not_use_directly_use_DECLARE_string_instead::FLAGS_##name
  85. #define DEFINE_string(name, value, meaning) \
  86. namespace FLAG__namespace_do_not_use_directly_use_DECLARE_string_instead { \
  87. GOOGLE_GLOG_DLL_DECL std::string FLAGS_##name(value); \
  88. char FLAGS_no##name; \
  89. } \
  90. using FLAG__namespace_do_not_use_directly_use_DECLARE_string_instead::FLAGS_##name
  91. #endif // HAVE_LIB_GFLAGS
  92. // Define GLOG_DEFINE_* using DEFINE_* . By using these macros, we
  93. // have GLOG_* environ variables even if we have gflags installed.
  94. //
  95. // If both an environment variable and a flag are specified, the value
  96. // specified by a flag wins. E.g., if GLOG_v=0 and --v=1, the
  97. // verbosity will be 1, not 0.
  98. #define GLOG_DEFINE_bool(name, value, meaning) \
  99. DEFINE_bool(name, EnvToBool("GLOG_" #name, value), meaning)
  100. #define GLOG_DEFINE_int32(name, value, meaning) \
  101. DEFINE_int32(name, EnvToInt("GLOG_" #name, value), meaning)
  102. #define GLOG_DEFINE_string(name, value, meaning) \
  103. DEFINE_string(name, EnvToString("GLOG_" #name, value), meaning)
  104. // These macros (could be functions, but I don't want to bother with a .cc
  105. // file), make it easier to initialize flags from the environment.
  106. #define EnvToString(envname, dflt) \
  107. (!getenv(envname) ? (dflt) : getenv(envname))
  108. #define EnvToBool(envname, dflt) \
  109. (!getenv(envname) ? (dflt) : memchr("tTyY1\0", getenv(envname)[0], 6) != NULL)
  110. #define EnvToInt(envname, dflt) \
  111. (!getenv(envname) ? (dflt) : strtol(getenv(envname), NULL, 10))
  112. #endif // BASE_COMMANDLINEFLAGS_H__