Updated third_party/gflags.
WebRTC portion (gyp build) now checked in because separate repository is no longer available due to transition to git. Change-Id: I56436cbbc3f02a5f77112917d6229aea69f21d97
This commit is contained in:
parent
f169bccdc9
commit
d059b27a69
|
@ -15,7 +15,7 @@
|
||||||
/packager/testing/gtest/
|
/packager/testing/gtest/
|
||||||
/packager/third_party/boringssl/src/
|
/packager/third_party/boringssl/src/
|
||||||
/packager/third_party/curl/source/
|
/packager/third_party/curl/source/
|
||||||
/packager/third_party/gflags/
|
/packager/third_party/gflags/src/
|
||||||
/packager/third_party/gold/
|
/packager/third_party/gold/
|
||||||
/packager/third_party/icu/
|
/packager/third_party/icu/
|
||||||
/packager/third_party/libwebm/src/
|
/packager/third_party/libwebm/src/
|
||||||
|
|
5
DEPS
5
DEPS
|
@ -36,11 +36,10 @@ deps = {
|
||||||
"src/packager/third_party/curl/source":
|
"src/packager/third_party/curl/source":
|
||||||
Var("curl_url") + "@curl-7_50_0",
|
Var("curl_url") + "@curl-7_50_0",
|
||||||
|
|
||||||
"src/packager/third_party/gflags":
|
|
||||||
Var("chromium_git") + "/external/webrtc/trunk/third_party/gflags@cc7e9a4b374ff7b6a1cae4d76161113ea985b624",
|
|
||||||
|
|
||||||
"src/packager/third_party/gflags/src":
|
"src/packager/third_party/gflags/src":
|
||||||
Var("chromium_git") + "/external/gflags/src@e7390f9185c75f8d902c05ed7d20bb94eb914d0c", #82
|
Var("chromium_git") + "/external/github.com/gflags/gflags@03bebcb065c83beff83d50ae025a55a4bf94dfca",
|
||||||
|
|
||||||
|
|
||||||
# Required by libxml.
|
# Required by libxml.
|
||||||
"src/packager/third_party/icu":
|
"src/packager/third_party/icu":
|
||||||
|
|
|
@ -0,0 +1,73 @@
|
||||||
|
# Copyright (c) 2014 The WebRTC project authors. All Rights Reserved.
|
||||||
|
#
|
||||||
|
# Use of this source code is governed by a BSD-style license
|
||||||
|
# that can be found in the LICENSE file in the root of the source
|
||||||
|
# tree. An additional intellectual property rights grant can be found
|
||||||
|
# in the file PATENTS. All contributing project authors may
|
||||||
|
# be found in the AUTHORS file in the root of the source tree.
|
||||||
|
|
||||||
|
if (is_win) {
|
||||||
|
gflags_gen_arch_root = "gen/win"
|
||||||
|
} else {
|
||||||
|
gflags_gen_arch_root = "gen/posix"
|
||||||
|
}
|
||||||
|
|
||||||
|
config("gflags_config") {
|
||||||
|
include_dirs = [
|
||||||
|
"$gflags_gen_arch_root/include", # For configured files.
|
||||||
|
"src/src", # For everything else.
|
||||||
|
]
|
||||||
|
|
||||||
|
defines = [
|
||||||
|
# These macros exist so flags and symbols are properly exported when
|
||||||
|
# building DLLs. Since we don't build DLLs, we need to disable them.
|
||||||
|
"GFLAGS_DLL_DECL=",
|
||||||
|
"GFLAGS_DLL_DECLARE_FLAG=",
|
||||||
|
"GFLAGS_DLL_DEFINE_FLAG=",
|
||||||
|
]
|
||||||
|
|
||||||
|
# GN orders flags on a target before flags from configs. The default config
|
||||||
|
# adds -Wall, and this flag have to be after -Wall -- so they need to
|
||||||
|
# come from a config and can't be on the target directly.
|
||||||
|
if (is_clang) {
|
||||||
|
cflags = [ "-Wno-unused-local-typedef" ]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
source_set("gflags") {
|
||||||
|
cflags = []
|
||||||
|
sources = [
|
||||||
|
"src/src/gflags.cc",
|
||||||
|
"src/src/gflags_completions.cc",
|
||||||
|
"src/src/gflags_reporting.cc",
|
||||||
|
]
|
||||||
|
if (is_win) {
|
||||||
|
sources += [ "src/src/windows_port.cc" ]
|
||||||
|
|
||||||
|
cflags += [
|
||||||
|
"/wd4005", # WIN32_LEAN_AND_MEAN.
|
||||||
|
"/wd4267", # Conversion from size_t to "type".
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
include_dirs = [
|
||||||
|
"$gflags_gen_arch_root/include/gflags", # For configured files.
|
||||||
|
"$gflags_gen_arch_root/include/private", # For config.h
|
||||||
|
]
|
||||||
|
|
||||||
|
public_configs = [ ":gflags_config" ]
|
||||||
|
|
||||||
|
configs -= [ "//build/config/compiler:chromium_code" ]
|
||||||
|
configs += [ "//build/config/compiler:no_chromium_code" ]
|
||||||
|
|
||||||
|
if (is_win) {
|
||||||
|
configs -= [ "//build/config/win:unicode" ]
|
||||||
|
}
|
||||||
|
|
||||||
|
if (is_clang) {
|
||||||
|
# TODO(andrew): Look into fixing this warning upstream:
|
||||||
|
# http://code.google.com/p/webrtc/issues/detail?id=760
|
||||||
|
configs -= [ "//build/config/clang:extra_warnings" ]
|
||||||
|
cflags += [ "-Wno-microsoft-include" ]
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,28 @@
|
||||||
|
Copyright (c) 2006, Google Inc.
|
||||||
|
All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are
|
||||||
|
met:
|
||||||
|
|
||||||
|
* Redistributions of source code must retain the above copyright
|
||||||
|
notice, this list of conditions and the following disclaimer.
|
||||||
|
* Redistributions in binary form must reproduce the above
|
||||||
|
copyright notice, this list of conditions and the following disclaimer
|
||||||
|
in the documentation and/or other materials provided with the
|
||||||
|
distribution.
|
||||||
|
* Neither the name of Google Inc. nor the names of its
|
||||||
|
contributors may be used to endorse or promote products derived from
|
||||||
|
this software without specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
@ -0,0 +1,6 @@
|
||||||
|
kjellander@webrtc.org
|
||||||
|
|
||||||
|
# These are for the common case of adding or renaming files. If you're doing
|
||||||
|
# structural changes, please get a review from a reviewer in this file.
|
||||||
|
per-file *.gyp=*
|
||||||
|
per-file *.gypi=*
|
|
@ -0,0 +1,28 @@
|
||||||
|
URL: https://github.com/gflags/gflags
|
||||||
|
Version: 2.1.2
|
||||||
|
License: New BSD
|
||||||
|
License File: LICENSE
|
||||||
|
|
||||||
|
Description:
|
||||||
|
The gflags package contains a library that implements commandline
|
||||||
|
flags processing. As such it's a replacement for getopt(). It has
|
||||||
|
increased flexibility, including built-in support for C++ types like
|
||||||
|
string, and the ability to define flags in the source file in which
|
||||||
|
they're used.
|
||||||
|
|
||||||
|
Local Modifications: None
|
||||||
|
|
||||||
|
|
||||||
|
How to update platform configuration files:
|
||||||
|
The gen/ directory contains pre-generated configuration header files.
|
||||||
|
Historically, all operating systems and architectures have generated
|
||||||
|
similar configurations except for Windows. This is why there's only
|
||||||
|
posix and win directories below gen/.
|
||||||
|
When rolling gflags to a newer version, it's a good idea to check if
|
||||||
|
new configuration files needs to be generated as well.
|
||||||
|
Do this by running cmake in the newly checked out version of
|
||||||
|
gflags. Then diff the generated files with the ones below gen/.
|
||||||
|
If you notice a diff, update the files with the updated ones.
|
||||||
|
If you suspect platform dependend changes other than Windows, you'll
|
||||||
|
have to checkout gflags on the other platforms as well and run
|
||||||
|
cmake there too.
|
|
@ -0,0 +1,573 @@
|
||||||
|
// Copyright (c) 2006, Google Inc.
|
||||||
|
// All rights reserved.
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
// ---
|
||||||
|
// Revamped and reorganized by Craig Silverstein
|
||||||
|
//
|
||||||
|
// This is the file that should be included by any file which declares
|
||||||
|
// or defines a command line flag or wants to parse command line flags
|
||||||
|
// or print a program usage message (which will include information about
|
||||||
|
// flags). Executive summary, in the form of an example foo.cc file:
|
||||||
|
//
|
||||||
|
// #include "foo.h" // foo.h has a line "DECLARE_int32(start);"
|
||||||
|
// #include "validators.h" // hypothetical file defining ValidateIsFile()
|
||||||
|
//
|
||||||
|
// DEFINE_int32(end, 1000, "The last record to read");
|
||||||
|
//
|
||||||
|
// DEFINE_string(filename, "my_file.txt", "The file to read");
|
||||||
|
// // Crash if the specified file does not exist.
|
||||||
|
// static bool dummy = RegisterFlagValidator(&FLAGS_filename,
|
||||||
|
// &ValidateIsFile);
|
||||||
|
//
|
||||||
|
// DECLARE_bool(verbose); // some other file has a DEFINE_bool(verbose, ...)
|
||||||
|
//
|
||||||
|
// void MyFunc() {
|
||||||
|
// if (FLAGS_verbose) printf("Records %d-%d\n", FLAGS_start, FLAGS_end);
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Then, at the command-line:
|
||||||
|
// ./foo --noverbose --start=5 --end=100
|
||||||
|
//
|
||||||
|
// For more details, see
|
||||||
|
// doc/gflags.html
|
||||||
|
//
|
||||||
|
// --- A note about thread-safety:
|
||||||
|
//
|
||||||
|
// We describe many functions in this routine as being thread-hostile,
|
||||||
|
// thread-compatible, or thread-safe. Here are the meanings we use:
|
||||||
|
//
|
||||||
|
// thread-safe: it is safe for multiple threads to call this routine
|
||||||
|
// (or, when referring to a class, methods of this class)
|
||||||
|
// concurrently.
|
||||||
|
// thread-hostile: it is not safe for multiple threads to call this
|
||||||
|
// routine (or methods of this class) concurrently. In gflags,
|
||||||
|
// most thread-hostile routines are intended to be called early in,
|
||||||
|
// or even before, main() -- that is, before threads are spawned.
|
||||||
|
// thread-compatible: it is safe for multiple threads to read from
|
||||||
|
// this variable (when applied to variables), or to call const
|
||||||
|
// methods of this class (when applied to classes), as long as no
|
||||||
|
// other thread is writing to the variable or calling non-const
|
||||||
|
// methods of this class.
|
||||||
|
|
||||||
|
#ifndef GFLAGS_GFLAGS_H_
|
||||||
|
#define GFLAGS_GFLAGS_H_
|
||||||
|
|
||||||
|
#include <string>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
#include "gflags_declare.h" // IWYU pragma: export
|
||||||
|
|
||||||
|
|
||||||
|
// We always want to export variables defined in user code
|
||||||
|
#ifndef GFLAGS_DLL_DEFINE_FLAG
|
||||||
|
# ifdef _MSC_VER
|
||||||
|
# define GFLAGS_DLL_DEFINE_FLAG __declspec(dllexport)
|
||||||
|
# else
|
||||||
|
# define GFLAGS_DLL_DEFINE_FLAG
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
namespace GFLAGS_NAMESPACE {
|
||||||
|
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// To actually define a flag in a file, use DEFINE_bool,
|
||||||
|
// DEFINE_string, etc. at the bottom of this file. You may also find
|
||||||
|
// it useful to register a validator with the flag. This ensures that
|
||||||
|
// when the flag is parsed from the commandline, or is later set via
|
||||||
|
// SetCommandLineOption, we call the validation function. It is _not_
|
||||||
|
// called when you assign the value to the flag directly using the = operator.
|
||||||
|
//
|
||||||
|
// The validation function should return true if the flag value is valid, and
|
||||||
|
// false otherwise. If the function returns false for the new setting of the
|
||||||
|
// flag, the flag will retain its current value. If it returns false for the
|
||||||
|
// default value, ParseCommandLineFlags() will die.
|
||||||
|
//
|
||||||
|
// This function is safe to call at global construct time (as in the
|
||||||
|
// example below).
|
||||||
|
//
|
||||||
|
// Example use:
|
||||||
|
// static bool ValidatePort(const char* flagname, int32 value) {
|
||||||
|
// if (value > 0 && value < 32768) // value is ok
|
||||||
|
// return true;
|
||||||
|
// printf("Invalid value for --%s: %d\n", flagname, (int)value);
|
||||||
|
// return false;
|
||||||
|
// }
|
||||||
|
// DEFINE_int32(port, 0, "What port to listen on");
|
||||||
|
// static bool dummy = RegisterFlagValidator(&FLAGS_port, &ValidatePort);
|
||||||
|
|
||||||
|
// Returns true if successfully registered, false if not (because the
|
||||||
|
// first argument doesn't point to a command-line flag, or because a
|
||||||
|
// validator is already registered for this flag).
|
||||||
|
extern GFLAGS_DLL_DECL bool RegisterFlagValidator(const bool* flag, bool (*validate_fn)(const char*, bool));
|
||||||
|
extern GFLAGS_DLL_DECL bool RegisterFlagValidator(const int32* flag, bool (*validate_fn)(const char*, int32));
|
||||||
|
extern GFLAGS_DLL_DECL bool RegisterFlagValidator(const int64* flag, bool (*validate_fn)(const char*, int64));
|
||||||
|
extern GFLAGS_DLL_DECL bool RegisterFlagValidator(const uint64* flag, bool (*validate_fn)(const char*, uint64));
|
||||||
|
extern GFLAGS_DLL_DECL bool RegisterFlagValidator(const double* flag, bool (*validate_fn)(const char*, double));
|
||||||
|
extern GFLAGS_DLL_DECL bool RegisterFlagValidator(const std::string* flag, bool (*validate_fn)(const char*, const std::string&));
|
||||||
|
|
||||||
|
// Convenience macro for the registration of a flag validator
|
||||||
|
#define DEFINE_validator(name, validator) \
|
||||||
|
static const bool name##_validator_registered = \
|
||||||
|
GFLAGS_NAMESPACE::RegisterFlagValidator(&FLAGS_##name, validator)
|
||||||
|
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// These methods are the best way to get access to info about the
|
||||||
|
// list of commandline flags. Note that these routines are pretty slow.
|
||||||
|
// GetAllFlags: mostly-complete info about the list, sorted by file.
|
||||||
|
// ShowUsageWithFlags: pretty-prints the list to stdout (what --help does)
|
||||||
|
// ShowUsageWithFlagsRestrict: limit to filenames with restrict as a substr
|
||||||
|
//
|
||||||
|
// In addition to accessing flags, you can also access argv[0] (the program
|
||||||
|
// name) and argv (the entire commandline), which we sock away a copy of.
|
||||||
|
// These variables are static, so you should only set them once.
|
||||||
|
//
|
||||||
|
// No need to export this data only structure from DLL, avoiding VS warning 4251.
|
||||||
|
struct CommandLineFlagInfo {
|
||||||
|
std::string name; // the name of the flag
|
||||||
|
std::string type; // the type of the flag: int32, etc
|
||||||
|
std::string description; // the "help text" associated with the flag
|
||||||
|
std::string current_value; // the current value, as a string
|
||||||
|
std::string default_value; // the default value, as a string
|
||||||
|
std::string filename; // 'cleaned' version of filename holding the flag
|
||||||
|
bool has_validator_fn; // true if RegisterFlagValidator called on this flag
|
||||||
|
bool is_default; // true if the flag has the default value and
|
||||||
|
// has not been set explicitly from the cmdline
|
||||||
|
// or via SetCommandLineOption
|
||||||
|
const void* flag_ptr; // pointer to the flag's current value (i.e. FLAGS_foo)
|
||||||
|
};
|
||||||
|
|
||||||
|
// Using this inside of a validator is a recipe for a deadlock.
|
||||||
|
// TODO(user) Fix locking when validators are running, to make it safe to
|
||||||
|
// call validators during ParseAllFlags.
|
||||||
|
// Also make sure then to uncomment the corresponding unit test in
|
||||||
|
// gflags_unittest.sh
|
||||||
|
extern GFLAGS_DLL_DECL void GetAllFlags(std::vector<CommandLineFlagInfo>* OUTPUT);
|
||||||
|
// These two are actually defined in gflags_reporting.cc.
|
||||||
|
extern GFLAGS_DLL_DECL void ShowUsageWithFlags(const char *argv0); // what --help does
|
||||||
|
extern GFLAGS_DLL_DECL void ShowUsageWithFlagsRestrict(const char *argv0, const char *restrict);
|
||||||
|
|
||||||
|
// Create a descriptive string for a flag.
|
||||||
|
// Goes to some trouble to make pretty line breaks.
|
||||||
|
extern GFLAGS_DLL_DECL std::string DescribeOneFlag(const CommandLineFlagInfo& flag);
|
||||||
|
|
||||||
|
// Thread-hostile; meant to be called before any threads are spawned.
|
||||||
|
extern GFLAGS_DLL_DECL void SetArgv(int argc, const char** argv);
|
||||||
|
|
||||||
|
// The following functions are thread-safe as long as SetArgv() is
|
||||||
|
// only called before any threads start.
|
||||||
|
extern GFLAGS_DLL_DECL const std::vector<std::string>& GetArgvs();
|
||||||
|
extern GFLAGS_DLL_DECL const char* GetArgv(); // all of argv as a string
|
||||||
|
extern GFLAGS_DLL_DECL const char* GetArgv0(); // only argv0
|
||||||
|
extern GFLAGS_DLL_DECL uint32 GetArgvSum(); // simple checksum of argv
|
||||||
|
extern GFLAGS_DLL_DECL const char* ProgramInvocationName(); // argv0, or "UNKNOWN" if not set
|
||||||
|
extern GFLAGS_DLL_DECL const char* ProgramInvocationShortName(); // basename(argv0)
|
||||||
|
|
||||||
|
// ProgramUsage() is thread-safe as long as SetUsageMessage() is only
|
||||||
|
// called before any threads start.
|
||||||
|
extern GFLAGS_DLL_DECL const char* ProgramUsage(); // string set by SetUsageMessage()
|
||||||
|
|
||||||
|
// VersionString() is thread-safe as long as SetVersionString() is only
|
||||||
|
// called before any threads start.
|
||||||
|
extern GFLAGS_DLL_DECL const char* VersionString(); // string set by SetVersionString()
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// Normally you access commandline flags by just saying "if (FLAGS_foo)"
|
||||||
|
// or whatever, and set them by calling "FLAGS_foo = bar" (or, more
|
||||||
|
// commonly, via the DEFINE_foo macro). But if you need a bit more
|
||||||
|
// control, we have programmatic ways to get/set the flags as well.
|
||||||
|
// These programmatic ways to access flags are thread-safe, but direct
|
||||||
|
// access is only thread-compatible.
|
||||||
|
|
||||||
|
// Return true iff the flagname was found.
|
||||||
|
// OUTPUT is set to the flag's value, or unchanged if we return false.
|
||||||
|
extern GFLAGS_DLL_DECL bool GetCommandLineOption(const char* name, std::string* OUTPUT);
|
||||||
|
|
||||||
|
// Return true iff the flagname was found. OUTPUT is set to the flag's
|
||||||
|
// CommandLineFlagInfo or unchanged if we return false.
|
||||||
|
extern GFLAGS_DLL_DECL bool GetCommandLineFlagInfo(const char* name, CommandLineFlagInfo* OUTPUT);
|
||||||
|
|
||||||
|
// Return the CommandLineFlagInfo of the flagname. exit() if name not found.
|
||||||
|
// Example usage, to check if a flag's value is currently the default value:
|
||||||
|
// if (GetCommandLineFlagInfoOrDie("foo").is_default) ...
|
||||||
|
extern GFLAGS_DLL_DECL CommandLineFlagInfo GetCommandLineFlagInfoOrDie(const char* name);
|
||||||
|
|
||||||
|
enum GFLAGS_DLL_DECL FlagSettingMode {
|
||||||
|
// update the flag's value (can call this multiple times).
|
||||||
|
SET_FLAGS_VALUE,
|
||||||
|
// update the flag's value, but *only if* it has not yet been updated
|
||||||
|
// with SET_FLAGS_VALUE, SET_FLAG_IF_DEFAULT, or "FLAGS_xxx = nondef".
|
||||||
|
SET_FLAG_IF_DEFAULT,
|
||||||
|
// set the flag's default value to this. If the flag has not yet updated
|
||||||
|
// yet (via SET_FLAGS_VALUE, SET_FLAG_IF_DEFAULT, or "FLAGS_xxx = nondef")
|
||||||
|
// change the flag's current value to the new default value as well.
|
||||||
|
SET_FLAGS_DEFAULT
|
||||||
|
};
|
||||||
|
|
||||||
|
// Set a particular flag ("command line option"). Returns a string
|
||||||
|
// describing the new value that the option has been set to. The
|
||||||
|
// return value API is not well-specified, so basically just depend on
|
||||||
|
// it to be empty if the setting failed for some reason -- the name is
|
||||||
|
// not a valid flag name, or the value is not a valid value -- and
|
||||||
|
// non-empty else.
|
||||||
|
|
||||||
|
// SetCommandLineOption uses set_mode == SET_FLAGS_VALUE (the common case)
|
||||||
|
extern GFLAGS_DLL_DECL std::string SetCommandLineOption (const char* name, const char* value);
|
||||||
|
extern GFLAGS_DLL_DECL std::string SetCommandLineOptionWithMode(const char* name, const char* value, FlagSettingMode set_mode);
|
||||||
|
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// Saves the states (value, default value, whether the user has set
|
||||||
|
// the flag, registered validators, etc) of all flags, and restores
|
||||||
|
// them when the FlagSaver is destroyed. This is very useful in
|
||||||
|
// tests, say, when you want to let your tests change the flags, but
|
||||||
|
// make sure that they get reverted to the original states when your
|
||||||
|
// test is complete.
|
||||||
|
//
|
||||||
|
// Example usage:
|
||||||
|
// void TestFoo() {
|
||||||
|
// FlagSaver s1;
|
||||||
|
// FLAG_foo = false;
|
||||||
|
// FLAG_bar = "some value";
|
||||||
|
//
|
||||||
|
// // test happens here. You can return at any time
|
||||||
|
// // without worrying about restoring the FLAG values.
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Note: This class is marked with GFLAGS_ATTRIBUTE_UNUSED because all
|
||||||
|
// the work is done in the constructor and destructor, so in the standard
|
||||||
|
// usage example above, the compiler would complain that it's an
|
||||||
|
// unused variable.
|
||||||
|
//
|
||||||
|
// This class is thread-safe. However, its destructor writes to
|
||||||
|
// exactly the set of flags that have changed value during its
|
||||||
|
// lifetime, so concurrent _direct_ access to those flags
|
||||||
|
// (i.e. FLAGS_foo instead of {Get,Set}CommandLineOption()) is unsafe.
|
||||||
|
|
||||||
|
class GFLAGS_DLL_DECL FlagSaver {
|
||||||
|
public:
|
||||||
|
FlagSaver();
|
||||||
|
~FlagSaver();
|
||||||
|
|
||||||
|
private:
|
||||||
|
class FlagSaverImpl* impl_; // we use pimpl here to keep API steady
|
||||||
|
|
||||||
|
FlagSaver(const FlagSaver&); // no copying!
|
||||||
|
void operator=(const FlagSaver&);
|
||||||
|
}__attribute((unused));
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// Some deprecated or hopefully-soon-to-be-deprecated functions.
|
||||||
|
|
||||||
|
// This is often used for logging. TODO(csilvers): figure out a better way
|
||||||
|
extern GFLAGS_DLL_DECL std::string CommandlineFlagsIntoString();
|
||||||
|
// Usually where this is used, a FlagSaver should be used instead.
|
||||||
|
extern GFLAGS_DLL_DECL
|
||||||
|
bool ReadFlagsFromString(const std::string& flagfilecontents,
|
||||||
|
const char* prog_name,
|
||||||
|
bool errors_are_fatal); // uses SET_FLAGS_VALUE
|
||||||
|
|
||||||
|
// These let you manually implement --flagfile functionality.
|
||||||
|
// DEPRECATED.
|
||||||
|
extern GFLAGS_DLL_DECL bool AppendFlagsIntoFile(const std::string& filename, const char* prog_name);
|
||||||
|
extern GFLAGS_DLL_DECL bool ReadFromFlagsFile(const std::string& filename, const char* prog_name, bool errors_are_fatal); // uses SET_FLAGS_VALUE
|
||||||
|
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// Useful routines for initializing flags from the environment.
|
||||||
|
// In each case, if 'varname' does not exist in the environment
|
||||||
|
// return defval. If 'varname' does exist but is not valid
|
||||||
|
// (e.g., not a number for an int32 flag), abort with an error.
|
||||||
|
// Otherwise, return the value. NOTE: for booleans, for true use
|
||||||
|
// 't' or 'T' or 'true' or '1', for false 'f' or 'F' or 'false' or '0'.
|
||||||
|
|
||||||
|
extern GFLAGS_DLL_DECL bool BoolFromEnv(const char *varname, bool defval);
|
||||||
|
extern GFLAGS_DLL_DECL int32 Int32FromEnv(const char *varname, int32 defval);
|
||||||
|
extern GFLAGS_DLL_DECL int64 Int64FromEnv(const char *varname, int64 defval);
|
||||||
|
extern GFLAGS_DLL_DECL uint64 Uint64FromEnv(const char *varname, uint64 defval);
|
||||||
|
extern GFLAGS_DLL_DECL double DoubleFromEnv(const char *varname, double defval);
|
||||||
|
extern GFLAGS_DLL_DECL const char *StringFromEnv(const char *varname, const char *defval);
|
||||||
|
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// The next two functions parse gflags from main():
|
||||||
|
|
||||||
|
// Set the "usage" message for this program. For example:
|
||||||
|
// string usage("This program does nothing. Sample usage:\n");
|
||||||
|
// usage += argv[0] + " <uselessarg1> <uselessarg2>";
|
||||||
|
// SetUsageMessage(usage);
|
||||||
|
// Do not include commandline flags in the usage: we do that for you!
|
||||||
|
// Thread-hostile; meant to be called before any threads are spawned.
|
||||||
|
extern GFLAGS_DLL_DECL void SetUsageMessage(const std::string& usage);
|
||||||
|
|
||||||
|
// Sets the version string, which is emitted with --version.
|
||||||
|
// For instance: SetVersionString("1.3");
|
||||||
|
// Thread-hostile; meant to be called before any threads are spawned.
|
||||||
|
extern GFLAGS_DLL_DECL void SetVersionString(const std::string& version);
|
||||||
|
|
||||||
|
|
||||||
|
// Looks for flags in argv and parses them. Rearranges argv to put
|
||||||
|
// flags first, or removes them entirely if remove_flags is true.
|
||||||
|
// If a flag is defined more than once in the command line or flag
|
||||||
|
// file, the last definition is used. Returns the index (into argv)
|
||||||
|
// of the first non-flag argument.
|
||||||
|
// See top-of-file for more details on this function.
|
||||||
|
#ifndef SWIG // In swig, use ParseCommandLineFlagsScript() instead.
|
||||||
|
extern GFLAGS_DLL_DECL uint32 ParseCommandLineFlags(int *argc, char*** argv, bool remove_flags);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
// Calls to ParseCommandLineNonHelpFlags and then to
|
||||||
|
// HandleCommandLineHelpFlags can be used instead of a call to
|
||||||
|
// ParseCommandLineFlags during initialization, in order to allow for
|
||||||
|
// changing default values for some FLAGS (via
|
||||||
|
// e.g. SetCommandLineOptionWithMode calls) between the time of
|
||||||
|
// command line parsing and the time of dumping help information for
|
||||||
|
// the flags as a result of command line parsing. If a flag is
|
||||||
|
// defined more than once in the command line or flag file, the last
|
||||||
|
// definition is used. Returns the index (into argv) of the first
|
||||||
|
// non-flag argument. (If remove_flags is true, will always return 1.)
|
||||||
|
extern GFLAGS_DLL_DECL uint32 ParseCommandLineNonHelpFlags(int *argc, char*** argv, bool remove_flags);
|
||||||
|
|
||||||
|
// This is actually defined in gflags_reporting.cc.
|
||||||
|
// This function is misnamed (it also handles --version, etc.), but
|
||||||
|
// it's too late to change that now. :-(
|
||||||
|
extern GFLAGS_DLL_DECL void HandleCommandLineHelpFlags(); // in gflags_reporting.cc
|
||||||
|
|
||||||
|
// Allow command line reparsing. Disables the error normally
|
||||||
|
// generated when an unknown flag is found, since it may be found in a
|
||||||
|
// later parse. Thread-hostile; meant to be called before any threads
|
||||||
|
// are spawned.
|
||||||
|
extern GFLAGS_DLL_DECL void AllowCommandLineReparsing();
|
||||||
|
|
||||||
|
// Reparse the flags that have not yet been recognized. Only flags
|
||||||
|
// registered since the last parse will be recognized. Any flag value
|
||||||
|
// must be provided as part of the argument using "=", not as a
|
||||||
|
// separate command line argument that follows the flag argument.
|
||||||
|
// Intended for handling flags from dynamically loaded libraries,
|
||||||
|
// since their flags are not registered until they are loaded.
|
||||||
|
extern GFLAGS_DLL_DECL void ReparseCommandLineNonHelpFlags();
|
||||||
|
|
||||||
|
// Clean up memory allocated by flags. This is only needed to reduce
|
||||||
|
// the quantity of "potentially leaked" reports emitted by memory
|
||||||
|
// debugging tools such as valgrind. It is not required for normal
|
||||||
|
// operation, or for the google perftools heap-checker. It must only
|
||||||
|
// be called when the process is about to exit, and all threads that
|
||||||
|
// might access flags are quiescent. Referencing flags after this is
|
||||||
|
// called will have unexpected consequences. This is not safe to run
|
||||||
|
// when multiple threads might be running: the function is
|
||||||
|
// thread-hostile.
|
||||||
|
extern GFLAGS_DLL_DECL void ShutDownCommandLineFlags();
|
||||||
|
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// Now come the command line flag declaration/definition macros that
|
||||||
|
// will actually be used. They're kind of hairy. A major reason
|
||||||
|
// for this is initialization: we want people to be able to access
|
||||||
|
// variables in global constructors and have that not crash, even if
|
||||||
|
// their global constructor runs before the global constructor here.
|
||||||
|
// (Obviously, we can't guarantee the flags will have the correct
|
||||||
|
// default value in that case, but at least accessing them is safe.)
|
||||||
|
// The only way to do that is have flags point to a static buffer.
|
||||||
|
// So we make one, using a union to ensure proper alignment, and
|
||||||
|
// then use placement-new to actually set up the flag with the
|
||||||
|
// correct default value. In the same vein, we have to worry about
|
||||||
|
// flag access in global destructors, so FlagRegisterer has to be
|
||||||
|
// careful never to destroy the flag-values it constructs.
|
||||||
|
//
|
||||||
|
// Note that when we define a flag variable FLAGS_<name>, we also
|
||||||
|
// preemptively define a junk variable, FLAGS_no<name>. This is to
|
||||||
|
// cause a link-time error if someone tries to define 2 flags with
|
||||||
|
// names like "logging" and "nologging". We do this because a bool
|
||||||
|
// flag FLAG can be set from the command line to true with a "-FLAG"
|
||||||
|
// argument, and to false with a "-noFLAG" argument, and so this can
|
||||||
|
// potentially avert confusion.
|
||||||
|
//
|
||||||
|
// We also put flags into their own namespace. It is purposefully
|
||||||
|
// named in an opaque way that people should have trouble typing
|
||||||
|
// directly. The idea is that DEFINE puts the flag in the weird
|
||||||
|
// namespace, and DECLARE imports the flag from there into the current
|
||||||
|
// namespace. The net result is to force people to use DECLARE to get
|
||||||
|
// access to a flag, rather than saying "extern GFLAGS_DLL_DECL bool FLAGS_whatever;"
|
||||||
|
// or some such instead. We want this so we can put extra
|
||||||
|
// functionality (like sanity-checking) in DECLARE if we want, and
|
||||||
|
// make sure it is picked up everywhere.
|
||||||
|
//
|
||||||
|
// We also put the type of the variable in the namespace, so that
|
||||||
|
// people can't DECLARE_int32 something that they DEFINE_bool'd
|
||||||
|
// elsewhere.
|
||||||
|
|
||||||
|
class GFLAGS_DLL_DECL FlagRegisterer {
|
||||||
|
public:
|
||||||
|
FlagRegisterer(const char* name, const char* type,
|
||||||
|
const char* help, const char* filename,
|
||||||
|
void* current_storage, void* defvalue_storage);
|
||||||
|
};
|
||||||
|
|
||||||
|
// If your application #defines STRIP_FLAG_HELP to a non-zero value
|
||||||
|
// before #including this file, we remove the help message from the
|
||||||
|
// binary file. This can reduce the size of the resulting binary
|
||||||
|
// somewhat, and may also be useful for security reasons.
|
||||||
|
|
||||||
|
extern GFLAGS_DLL_DECL const char kStrippedFlagHelp[];
|
||||||
|
|
||||||
|
|
||||||
|
} // namespace GFLAGS_NAMESPACE
|
||||||
|
|
||||||
|
|
||||||
|
#ifndef SWIG // In swig, ignore the main flag declarations
|
||||||
|
|
||||||
|
#if defined(STRIP_FLAG_HELP) && STRIP_FLAG_HELP > 0
|
||||||
|
// Need this construct to avoid the 'defined but not used' warning.
|
||||||
|
#define MAYBE_STRIPPED_HELP(txt) \
|
||||||
|
(false ? (txt) : GFLAGS_NAMESPACE::kStrippedFlagHelp)
|
||||||
|
#else
|
||||||
|
#define MAYBE_STRIPPED_HELP(txt) txt
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// Each command-line flag has two variables associated with it: one
|
||||||
|
// with the current value, and one with the default value. However,
|
||||||
|
// we have a third variable, which is where value is assigned; it's a
|
||||||
|
// constant. This guarantees that FLAG_##value is initialized at
|
||||||
|
// static initialization time (e.g. before program-start) rather than
|
||||||
|
// than global construction time (which is after program-start but
|
||||||
|
// before main), at least when 'value' is a compile-time constant. We
|
||||||
|
// use a small trick for the "default value" variable, and call it
|
||||||
|
// FLAGS_no<name>. This serves the second purpose of assuring a
|
||||||
|
// compile error if someone tries to define a flag named no<name>
|
||||||
|
// which is illegal (--foo and --nofoo both affect the "foo" flag).
|
||||||
|
#define DEFINE_VARIABLE(type, shorttype, name, value, help) \
|
||||||
|
namespace fL##shorttype { \
|
||||||
|
static const type FLAGS_nono##name = value; \
|
||||||
|
/* We always want to export defined variables, dll or no */ \
|
||||||
|
GFLAGS_DLL_DEFINE_FLAG type FLAGS_##name = FLAGS_nono##name; \
|
||||||
|
type FLAGS_no##name = FLAGS_nono##name; \
|
||||||
|
static GFLAGS_NAMESPACE::FlagRegisterer o_##name( \
|
||||||
|
#name, #type, MAYBE_STRIPPED_HELP(help), __FILE__, \
|
||||||
|
&FLAGS_##name, &FLAGS_no##name); \
|
||||||
|
} \
|
||||||
|
using fL##shorttype::FLAGS_##name
|
||||||
|
|
||||||
|
// For DEFINE_bool, we want to do the extra check that the passed-in
|
||||||
|
// value is actually a bool, and not a string or something that can be
|
||||||
|
// coerced to a bool. These declarations (no definition needed!) will
|
||||||
|
// help us do that, and never evaluate From, which is important.
|
||||||
|
// We'll use 'sizeof(IsBool(val))' to distinguish. This code requires
|
||||||
|
// that the compiler have different sizes for bool & double. Since
|
||||||
|
// this is not guaranteed by the standard, we check it with a
|
||||||
|
// COMPILE_ASSERT.
|
||||||
|
namespace fLB {
|
||||||
|
struct CompileAssert {};
|
||||||
|
typedef CompileAssert expected_sizeof_double_neq_sizeof_bool[
|
||||||
|
(sizeof(double) != sizeof(bool)) ? 1 : -1];
|
||||||
|
template<typename From> double GFLAGS_DLL_DECL IsBoolFlag(const From& from);
|
||||||
|
GFLAGS_DLL_DECL bool IsBoolFlag(bool from);
|
||||||
|
} // namespace fLB
|
||||||
|
|
||||||
|
// Here are the actual DEFINE_*-macros. The respective DECLARE_*-macros
|
||||||
|
// are in a separate include, gflags_declare.h, for reducing
|
||||||
|
// the physical transitive size for DECLARE use.
|
||||||
|
#define DEFINE_bool(name, val, txt) \
|
||||||
|
namespace fLB { \
|
||||||
|
typedef ::fLB::CompileAssert FLAG_##name##_value_is_not_a_bool[ \
|
||||||
|
(sizeof(::fLB::IsBoolFlag(val)) != sizeof(double))? 1: -1]; \
|
||||||
|
} \
|
||||||
|
DEFINE_VARIABLE(bool, B, name, val, txt)
|
||||||
|
|
||||||
|
#define DEFINE_int32(name, val, txt) \
|
||||||
|
DEFINE_VARIABLE(GFLAGS_NAMESPACE::int32, I, \
|
||||||
|
name, val, txt)
|
||||||
|
|
||||||
|
#define DEFINE_int64(name, val, txt) \
|
||||||
|
DEFINE_VARIABLE(GFLAGS_NAMESPACE::int64, I64, \
|
||||||
|
name, val, txt)
|
||||||
|
|
||||||
|
#define DEFINE_uint64(name,val, txt) \
|
||||||
|
DEFINE_VARIABLE(GFLAGS_NAMESPACE::uint64, U64, \
|
||||||
|
name, val, txt)
|
||||||
|
|
||||||
|
#define DEFINE_double(name, val, txt) \
|
||||||
|
DEFINE_VARIABLE(double, D, name, val, txt)
|
||||||
|
|
||||||
|
// Strings are trickier, because they're not a POD, so we can't
|
||||||
|
// construct them at static-initialization time (instead they get
|
||||||
|
// constructed at global-constructor time, which is much later). To
|
||||||
|
// try to avoid crashes in that case, we use a char buffer to store
|
||||||
|
// the string, which we can static-initialize, and then placement-new
|
||||||
|
// into it later. It's not perfect, but the best we can do.
|
||||||
|
|
||||||
|
namespace fLS {
|
||||||
|
|
||||||
|
inline clstring* dont_pass0toDEFINE_string(char *stringspot,
|
||||||
|
const char *value) {
|
||||||
|
return new(stringspot) clstring(value);
|
||||||
|
}
|
||||||
|
inline clstring* dont_pass0toDEFINE_string(char *stringspot,
|
||||||
|
const clstring &value) {
|
||||||
|
return new(stringspot) clstring(value);
|
||||||
|
}
|
||||||
|
inline clstring* dont_pass0toDEFINE_string(char *stringspot,
|
||||||
|
int value);
|
||||||
|
} // namespace fLS
|
||||||
|
|
||||||
|
// We need to define a var named FLAGS_no##name so people don't define
|
||||||
|
// --string and --nostring. And we need a temporary place to put val
|
||||||
|
// so we don't have to evaluate it twice. Two great needs that go
|
||||||
|
// great together!
|
||||||
|
// The weird 'using' + 'extern' inside the fLS namespace is to work around
|
||||||
|
// an unknown compiler bug/issue with the gcc 4.2.1 on SUSE 10. See
|
||||||
|
// http://code.google.com/p/google-gflags/issues/detail?id=20
|
||||||
|
#define DEFINE_string(name, val, txt) \
|
||||||
|
namespace fLS { \
|
||||||
|
using ::fLS::clstring; \
|
||||||
|
static union { void* align; char s[sizeof(clstring)]; } s_##name[2]; \
|
||||||
|
clstring* const FLAGS_no##name = ::fLS:: \
|
||||||
|
dont_pass0toDEFINE_string(s_##name[0].s, \
|
||||||
|
val); \
|
||||||
|
static GFLAGS_NAMESPACE::FlagRegisterer o_##name( \
|
||||||
|
#name, "string", MAYBE_STRIPPED_HELP(txt), __FILE__, \
|
||||||
|
s_##name[0].s, new (s_##name[1].s) clstring(*FLAGS_no##name)); \
|
||||||
|
extern GFLAGS_DLL_DEFINE_FLAG clstring& FLAGS_##name; \
|
||||||
|
using fLS::FLAGS_##name; \
|
||||||
|
clstring& FLAGS_##name = *FLAGS_no##name; \
|
||||||
|
} \
|
||||||
|
using fLS::FLAGS_##name
|
||||||
|
|
||||||
|
#endif // SWIG
|
||||||
|
|
||||||
|
|
||||||
|
// Import gflags library symbols into alternative/deprecated namespace(s)
|
||||||
|
#include "gflags_gflags.h"
|
||||||
|
|
||||||
|
|
||||||
|
#endif // GFLAGS_GFLAGS_H_
|
|
@ -0,0 +1,121 @@
|
||||||
|
// Copyright (c) 2008, Google Inc.
|
||||||
|
// All rights reserved.
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
//
|
||||||
|
// ---
|
||||||
|
|
||||||
|
//
|
||||||
|
// Implement helpful bash-style command line flag completions
|
||||||
|
//
|
||||||
|
// ** Functional API:
|
||||||
|
// HandleCommandLineCompletions() should be called early during
|
||||||
|
// program startup, but after command line flag code has been
|
||||||
|
// initialized, such as the beginning of HandleCommandLineHelpFlags().
|
||||||
|
// It checks the value of the flag --tab_completion_word. If this
|
||||||
|
// flag is empty, nothing happens here. If it contains a string,
|
||||||
|
// however, then HandleCommandLineCompletions() will hijack the
|
||||||
|
// process, attempting to identify the intention behind this
|
||||||
|
// completion. Regardless of the outcome of this deduction, the
|
||||||
|
// process will be terminated, similar to --helpshort flag
|
||||||
|
// handling.
|
||||||
|
//
|
||||||
|
// ** Overview of Bash completions:
|
||||||
|
// Bash can be told to programatically determine completions for the
|
||||||
|
// current 'cursor word'. It does this by (in this case) invoking a
|
||||||
|
// command with some additional arguments identifying the command
|
||||||
|
// being executed, the word being completed, and the previous word
|
||||||
|
// (if any). Bash then expects a sequence of output lines to be
|
||||||
|
// printed to stdout. If these lines all contain a common prefix
|
||||||
|
// longer than the cursor word, bash will replace the cursor word
|
||||||
|
// with that common prefix, and display nothing. If there isn't such
|
||||||
|
// a common prefix, bash will display the lines in pages using 'more'.
|
||||||
|
//
|
||||||
|
// ** Strategy taken for command line completions:
|
||||||
|
// If we can deduce either the exact flag intended, or a common flag
|
||||||
|
// prefix, we'll output exactly that. Otherwise, if information
|
||||||
|
// must be displayed to the user, we'll take the opportunity to add
|
||||||
|
// some helpful information beyond just the flag name (specifically,
|
||||||
|
// we'll include the default flag value and as much of the flag's
|
||||||
|
// description as can fit on a single terminal line width, as specified
|
||||||
|
// by the flag --tab_completion_columns). Furthermore, we'll try to
|
||||||
|
// make bash order the output such that the most useful or relevent
|
||||||
|
// flags are the most likely to be shown at the top.
|
||||||
|
//
|
||||||
|
// ** Additional features:
|
||||||
|
// To assist in finding that one really useful flag, substring matching
|
||||||
|
// was implemented. Before pressing a <TAB> to get completion for the
|
||||||
|
// current word, you can append one or more '?' to the flag to do
|
||||||
|
// substring matching. Here's the semantics:
|
||||||
|
// --foo<TAB> Show me all flags with names prefixed by 'foo'
|
||||||
|
// --foo?<TAB> Show me all flags with 'foo' somewhere in the name
|
||||||
|
// --foo??<TAB> Same as prior case, but also search in module
|
||||||
|
// definition path for 'foo'
|
||||||
|
// --foo???<TAB> Same as prior case, but also search in flag
|
||||||
|
// descriptions for 'foo'
|
||||||
|
// Finally, we'll trim the output to a relatively small number of
|
||||||
|
// flags to keep bash quiet about the verbosity of output. If one
|
||||||
|
// really wanted to see all possible matches, appending a '+' to the
|
||||||
|
// search word will force the exhaustive list of matches to be printed.
|
||||||
|
//
|
||||||
|
// ** How to have bash accept completions from a binary:
|
||||||
|
// Bash requires that it be informed about each command that programmatic
|
||||||
|
// completion should be enabled for. Example addition to a .bashrc
|
||||||
|
// file would be (your path to gflags_completions.sh file may differ):
|
||||||
|
|
||||||
|
/*
|
||||||
|
$ complete -o bashdefault -o default -o nospace -C \
|
||||||
|
'/home/build/eng/bash/bash_completions.sh --tab_completion_columns $COLUMNS' \
|
||||||
|
time env binary_name another_binary [...]
|
||||||
|
*/
|
||||||
|
|
||||||
|
// This would allow the following to work:
|
||||||
|
// $ /path/to/binary_name --vmodule<TAB>
|
||||||
|
// Or:
|
||||||
|
// $ ./bin/path/another_binary --gfs_u<TAB>
|
||||||
|
// (etc)
|
||||||
|
//
|
||||||
|
// Sadly, it appears that bash gives no easy way to force this behavior for
|
||||||
|
// all commands. That's where the "time" in the above example comes in.
|
||||||
|
// If you haven't specifically added a command to the list of completion
|
||||||
|
// supported commands, you can still get completions by prefixing the
|
||||||
|
// entire command with "env".
|
||||||
|
// $ env /some/brand/new/binary --vmod<TAB>
|
||||||
|
// Assuming that "binary" is a newly compiled binary, this should still
|
||||||
|
// produce the expected completion output.
|
||||||
|
|
||||||
|
|
||||||
|
#ifndef GFLAGS_COMPLETIONS_H_
|
||||||
|
#define GFLAGS_COMPLETIONS_H_
|
||||||
|
|
||||||
|
namespace google {
|
||||||
|
|
||||||
|
extern void HandleCommandLineCompletions(void);
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
#endif // GFLAGS_COMPLETIONS_H_
|
|
@ -0,0 +1,141 @@
|
||||||
|
// Copyright (c) 1999, Google Inc.
|
||||||
|
// All rights reserved.
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
// ---
|
||||||
|
//
|
||||||
|
// Revamped and reorganized by Craig Silverstein
|
||||||
|
//
|
||||||
|
// This is the file that should be included by any file which declares
|
||||||
|
// command line flag.
|
||||||
|
|
||||||
|
#ifndef GFLAGS_DECLARE_H_
|
||||||
|
#define GFLAGS_DECLARE_H_
|
||||||
|
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Namespace of gflags library symbols.
|
||||||
|
#define GFLAGS_NAMESPACE google
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Windows DLL import/export.
|
||||||
|
|
||||||
|
// We always want to import the symbols of the gflags library
|
||||||
|
#ifndef GFLAGS_DLL_DECL
|
||||||
|
# if 0 && defined(_MSC_VER)
|
||||||
|
# define GFLAGS_DLL_DECL __declspec(dllimport)
|
||||||
|
# else
|
||||||
|
# define GFLAGS_DLL_DECL
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// We always want to import variables declared in user code
|
||||||
|
#ifndef GFLAGS_DLL_DECLARE_FLAG
|
||||||
|
# ifdef _MSC_VER
|
||||||
|
# define GFLAGS_DLL_DECLARE_FLAG __declspec(dllimport)
|
||||||
|
# else
|
||||||
|
# define GFLAGS_DLL_DECLARE_FLAG
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Flag types
|
||||||
|
#include <string>
|
||||||
|
#if 1
|
||||||
|
# include <stdint.h> // the normal place uint32_t is defined
|
||||||
|
#elif 1
|
||||||
|
# include <sys/types.h> // the normal place u_int32_t is defined
|
||||||
|
#elif 1
|
||||||
|
# include <inttypes.h> // a third place for uint32_t or u_int32_t
|
||||||
|
#endif
|
||||||
|
|
||||||
|
namespace GFLAGS_NAMESPACE {
|
||||||
|
|
||||||
|
#if 1 // C99
|
||||||
|
typedef int32_t int32;
|
||||||
|
typedef uint32_t uint32;
|
||||||
|
typedef int64_t int64;
|
||||||
|
typedef uint64_t uint64;
|
||||||
|
#elif 0 // BSD
|
||||||
|
typedef int32_t int32;
|
||||||
|
typedef u_int32_t uint32;
|
||||||
|
typedef int64_t int64;
|
||||||
|
typedef u_int64_t uint64;
|
||||||
|
#elif 0 // Windows
|
||||||
|
typedef __int32 int32;
|
||||||
|
typedef unsigned __int32 uint32;
|
||||||
|
typedef __int64 int64;
|
||||||
|
typedef unsigned __int64 uint64;
|
||||||
|
#else
|
||||||
|
# error Do not know how to define a 32-bit integer quantity on your system
|
||||||
|
#endif
|
||||||
|
|
||||||
|
} // namespace GFLAGS_NAMESPACE
|
||||||
|
|
||||||
|
|
||||||
|
namespace fLS {
|
||||||
|
|
||||||
|
// The meaning of "string" might be different between now and when the
|
||||||
|
// macros below get invoked (e.g., if someone is experimenting with
|
||||||
|
// other string implementations that get defined after this file is
|
||||||
|
// included). Save the current meaning now and use it in the macros.
|
||||||
|
typedef std::string clstring;
|
||||||
|
|
||||||
|
} // namespace fLS
|
||||||
|
|
||||||
|
|
||||||
|
#define DECLARE_VARIABLE(type, shorttype, name) \
|
||||||
|
/* We always want to import declared variables, dll or no */ \
|
||||||
|
namespace fL##shorttype { extern GFLAGS_DLL_DECLARE_FLAG type FLAGS_##name; } \
|
||||||
|
using fL##shorttype::FLAGS_##name
|
||||||
|
|
||||||
|
#define DECLARE_bool(name) \
|
||||||
|
DECLARE_VARIABLE(bool, B, name)
|
||||||
|
|
||||||
|
#define DECLARE_int32(name) \
|
||||||
|
DECLARE_VARIABLE(::GFLAGS_NAMESPACE::int32, I, name)
|
||||||
|
|
||||||
|
#define DECLARE_int64(name) \
|
||||||
|
DECLARE_VARIABLE(::GFLAGS_NAMESPACE::int64, I64, name)
|
||||||
|
|
||||||
|
#define DECLARE_uint64(name) \
|
||||||
|
DECLARE_VARIABLE(::GFLAGS_NAMESPACE::uint64, U64, name)
|
||||||
|
|
||||||
|
#define DECLARE_double(name) \
|
||||||
|
DECLARE_VARIABLE(double, D, name)
|
||||||
|
|
||||||
|
#define DECLARE_string(name) \
|
||||||
|
/* We always want to import declared variables, dll or no */ \
|
||||||
|
namespace fLS { \
|
||||||
|
using ::fLS::clstring; \
|
||||||
|
extern GFLAGS_DLL_DECLARE_FLAG ::fLS::clstring& FLAGS_##name; \
|
||||||
|
} \
|
||||||
|
using fLS::FLAGS_##name
|
||||||
|
|
||||||
|
|
||||||
|
#endif // GFLAGS_DECLARE_H_
|
|
@ -0,0 +1,101 @@
|
||||||
|
// Copyright (c) 2014, Andreas Schuh
|
||||||
|
// All rights reserved.
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
// Imports the gflags library symbols into an alternative/deprecated namespace.
|
||||||
|
|
||||||
|
#ifndef GFLAGS_GFLAGS_H_
|
||||||
|
# error The internal header gflags_gflags.h may only be included by gflags.h
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef GFLAGS_NS_GFLAGS_H_
|
||||||
|
#define GFLAGS_NS_GFLAGS_H_
|
||||||
|
|
||||||
|
|
||||||
|
namespace gflags {
|
||||||
|
|
||||||
|
|
||||||
|
using GFLAGS_NAMESPACE::int32;
|
||||||
|
using GFLAGS_NAMESPACE::uint32;
|
||||||
|
using GFLAGS_NAMESPACE::int64;
|
||||||
|
using GFLAGS_NAMESPACE::uint64;
|
||||||
|
|
||||||
|
using GFLAGS_NAMESPACE::RegisterFlagValidator;
|
||||||
|
using GFLAGS_NAMESPACE::CommandLineFlagInfo;
|
||||||
|
using GFLAGS_NAMESPACE::GetAllFlags;
|
||||||
|
using GFLAGS_NAMESPACE::ShowUsageWithFlags;
|
||||||
|
using GFLAGS_NAMESPACE::ShowUsageWithFlagsRestrict;
|
||||||
|
using GFLAGS_NAMESPACE::DescribeOneFlag;
|
||||||
|
using GFLAGS_NAMESPACE::SetArgv;
|
||||||
|
using GFLAGS_NAMESPACE::GetArgvs;
|
||||||
|
using GFLAGS_NAMESPACE::GetArgv;
|
||||||
|
using GFLAGS_NAMESPACE::GetArgv0;
|
||||||
|
using GFLAGS_NAMESPACE::GetArgvSum;
|
||||||
|
using GFLAGS_NAMESPACE::ProgramInvocationName;
|
||||||
|
using GFLAGS_NAMESPACE::ProgramInvocationShortName;
|
||||||
|
using GFLAGS_NAMESPACE::ProgramUsage;
|
||||||
|
using GFLAGS_NAMESPACE::VersionString;
|
||||||
|
using GFLAGS_NAMESPACE::GetCommandLineOption;
|
||||||
|
using GFLAGS_NAMESPACE::GetCommandLineFlagInfo;
|
||||||
|
using GFLAGS_NAMESPACE::GetCommandLineFlagInfoOrDie;
|
||||||
|
using GFLAGS_NAMESPACE::FlagSettingMode;
|
||||||
|
using GFLAGS_NAMESPACE::SET_FLAGS_VALUE;
|
||||||
|
using GFLAGS_NAMESPACE::SET_FLAG_IF_DEFAULT;
|
||||||
|
using GFLAGS_NAMESPACE::SET_FLAGS_DEFAULT;
|
||||||
|
using GFLAGS_NAMESPACE::SetCommandLineOption;
|
||||||
|
using GFLAGS_NAMESPACE::SetCommandLineOptionWithMode;
|
||||||
|
using GFLAGS_NAMESPACE::FlagSaver;
|
||||||
|
using GFLAGS_NAMESPACE::CommandlineFlagsIntoString;
|
||||||
|
using GFLAGS_NAMESPACE::ReadFlagsFromString;
|
||||||
|
using GFLAGS_NAMESPACE::AppendFlagsIntoFile;
|
||||||
|
using GFLAGS_NAMESPACE::ReadFromFlagsFile;
|
||||||
|
using GFLAGS_NAMESPACE::BoolFromEnv;
|
||||||
|
using GFLAGS_NAMESPACE::Int32FromEnv;
|
||||||
|
using GFLAGS_NAMESPACE::Int64FromEnv;
|
||||||
|
using GFLAGS_NAMESPACE::Uint64FromEnv;
|
||||||
|
using GFLAGS_NAMESPACE::DoubleFromEnv;
|
||||||
|
using GFLAGS_NAMESPACE::StringFromEnv;
|
||||||
|
using GFLAGS_NAMESPACE::SetUsageMessage;
|
||||||
|
using GFLAGS_NAMESPACE::SetVersionString;
|
||||||
|
using GFLAGS_NAMESPACE::ParseCommandLineNonHelpFlags;
|
||||||
|
using GFLAGS_NAMESPACE::HandleCommandLineHelpFlags;
|
||||||
|
using GFLAGS_NAMESPACE::AllowCommandLineReparsing;
|
||||||
|
using GFLAGS_NAMESPACE::ReparseCommandLineNonHelpFlags;
|
||||||
|
using GFLAGS_NAMESPACE::ShutDownCommandLineFlags;
|
||||||
|
using GFLAGS_NAMESPACE::FlagRegisterer;
|
||||||
|
|
||||||
|
#ifndef SWIG
|
||||||
|
using GFLAGS_NAMESPACE::ParseCommandLineFlags;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
} // namespace gflags
|
||||||
|
|
||||||
|
|
||||||
|
#endif // GFLAGS_NS_GFLAGS_H_
|
|
@ -0,0 +1,112 @@
|
||||||
|
/* Generated from config.h.in during build configuration using CMake. */
|
||||||
|
|
||||||
|
// Note: This header file is only used internally. It is not part of public interface!
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// System checks
|
||||||
|
|
||||||
|
// Define if you build this library for a MS Windows OS.
|
||||||
|
/* #undef OS_WINDOWS */
|
||||||
|
|
||||||
|
// Define if you have the <stdint.h> header file.
|
||||||
|
#define HAVE_STDINT_H
|
||||||
|
|
||||||
|
// Define if you have the <sys/types.h> header file.
|
||||||
|
#define HAVE_SYS_TYPES_H
|
||||||
|
|
||||||
|
// Define if you have the <inttypes.h> header file.
|
||||||
|
#define HAVE_INTTYPES_H
|
||||||
|
|
||||||
|
// Define if you have the <sys/stat.h> header file.
|
||||||
|
#define HAVE_SYS_STAT_H
|
||||||
|
|
||||||
|
// Define if you have the <unistd.h> header file.
|
||||||
|
#define HAVE_UNISTD_H
|
||||||
|
|
||||||
|
// Define if you have the <fnmatch.h> header file.
|
||||||
|
#define HAVE_FNMATCH_H
|
||||||
|
|
||||||
|
// Define if you have the <shlwapi.h> header file (Windows 2000/XP).
|
||||||
|
/* #undef HAVE_SHLWAPI_H */
|
||||||
|
|
||||||
|
// Define if you have the strtoll function.
|
||||||
|
#define HAVE_STRTOLL
|
||||||
|
|
||||||
|
// Define if you have the strtoq function.
|
||||||
|
/* #undef HAVE_STRTOQ */
|
||||||
|
|
||||||
|
// Define if you have the <pthread.h> header file.
|
||||||
|
#define HAVE_PTHREAD
|
||||||
|
|
||||||
|
// Define if your pthread library defines the type pthread_rwlock_t
|
||||||
|
#define HAVE_RWLOCK
|
||||||
|
|
||||||
|
// gcc requires this to get PRId64, etc.
|
||||||
|
#if defined(HAVE_INTTYPES_H) && !defined(__STDC_FORMAT_MACROS)
|
||||||
|
# define __STDC_FORMAT_MACROS 1
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Package information
|
||||||
|
|
||||||
|
// Name of package.
|
||||||
|
#define PACKAGE gflags
|
||||||
|
|
||||||
|
// Define to the full name of this package.
|
||||||
|
#define PACKAGE_NAME gflags
|
||||||
|
|
||||||
|
// Define to the full name and version of this package.
|
||||||
|
#define PACKAGE_STRING gflags 2.2.0
|
||||||
|
|
||||||
|
// Define to the one symbol short name of this package.
|
||||||
|
#define PACKAGE_TARNAME gflags-2.2.0
|
||||||
|
|
||||||
|
// Define to the version of this package.
|
||||||
|
#define PACKAGE_VERSION 2.2.0
|
||||||
|
|
||||||
|
// Version number of package.
|
||||||
|
#define VERSION PACKAGE_VERSION
|
||||||
|
|
||||||
|
// Define to the address where bug reports for this package should be sent.
|
||||||
|
#define PACKAGE_BUGREPORT https://github.com/schuhschuh/gflags/issues
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Path separator
|
||||||
|
#ifndef PATH_SEPARATOR
|
||||||
|
# ifdef OS_WINDOWS
|
||||||
|
# define PATH_SEPARATOR '\\'
|
||||||
|
# else
|
||||||
|
# define PATH_SEPARATOR '/'
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Windows
|
||||||
|
|
||||||
|
// Whether gflags library is a DLL.
|
||||||
|
#ifndef GFLAGS_IS_A_DLL
|
||||||
|
# define GFLAGS_IS_A_DLL 0
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// Always export symbols when compiling a shared library as this file is only
|
||||||
|
// included by internal modules when building the gflags library itself.
|
||||||
|
// The gflags_declare.h header file will set it to import these symbols otherwise.
|
||||||
|
#ifndef GFLAGS_DLL_DECL
|
||||||
|
# if GFLAGS_IS_A_DLL && defined(_MSC_VER)
|
||||||
|
# define GFLAGS_DLL_DECL __declspec(dllexport)
|
||||||
|
# else
|
||||||
|
# define GFLAGS_DLL_DECL
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
// Flags defined by the gflags library itself must be exported
|
||||||
|
#ifndef GFLAGS_DLL_DEFINE_FLAG
|
||||||
|
# define GFLAGS_DLL_DEFINE_FLAG GFLAGS_DLL_DECL
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifdef OS_WINDOWS
|
||||||
|
// The unittests import the symbols of the shared gflags library
|
||||||
|
# if GFLAGS_IS_A_DLL && defined(_MSC_VER)
|
||||||
|
# define GFLAGS_DLL_DECL_FOR_UNITTESTS __declspec(dllimport)
|
||||||
|
# endif
|
||||||
|
# include "windows_port.h"
|
||||||
|
#endif
|
|
@ -0,0 +1,573 @@
|
||||||
|
// Copyright (c) 2006, Google Inc.
|
||||||
|
// All rights reserved.
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
// ---
|
||||||
|
// Revamped and reorganized by Craig Silverstein
|
||||||
|
//
|
||||||
|
// This is the file that should be included by any file which declares
|
||||||
|
// or defines a command line flag or wants to parse command line flags
|
||||||
|
// or print a program usage message (which will include information about
|
||||||
|
// flags). Executive summary, in the form of an example foo.cc file:
|
||||||
|
//
|
||||||
|
// #include "foo.h" // foo.h has a line "DECLARE_int32(start);"
|
||||||
|
// #include "validators.h" // hypothetical file defining ValidateIsFile()
|
||||||
|
//
|
||||||
|
// DEFINE_int32(end, 1000, "The last record to read");
|
||||||
|
//
|
||||||
|
// DEFINE_string(filename, "my_file.txt", "The file to read");
|
||||||
|
// // Crash if the specified file does not exist.
|
||||||
|
// static bool dummy = RegisterFlagValidator(&FLAGS_filename,
|
||||||
|
// &ValidateIsFile);
|
||||||
|
//
|
||||||
|
// DECLARE_bool(verbose); // some other file has a DEFINE_bool(verbose, ...)
|
||||||
|
//
|
||||||
|
// void MyFunc() {
|
||||||
|
// if (FLAGS_verbose) printf("Records %d-%d\n", FLAGS_start, FLAGS_end);
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Then, at the command-line:
|
||||||
|
// ./foo --noverbose --start=5 --end=100
|
||||||
|
//
|
||||||
|
// For more details, see
|
||||||
|
// doc/gflags.html
|
||||||
|
//
|
||||||
|
// --- A note about thread-safety:
|
||||||
|
//
|
||||||
|
// We describe many functions in this routine as being thread-hostile,
|
||||||
|
// thread-compatible, or thread-safe. Here are the meanings we use:
|
||||||
|
//
|
||||||
|
// thread-safe: it is safe for multiple threads to call this routine
|
||||||
|
// (or, when referring to a class, methods of this class)
|
||||||
|
// concurrently.
|
||||||
|
// thread-hostile: it is not safe for multiple threads to call this
|
||||||
|
// routine (or methods of this class) concurrently. In gflags,
|
||||||
|
// most thread-hostile routines are intended to be called early in,
|
||||||
|
// or even before, main() -- that is, before threads are spawned.
|
||||||
|
// thread-compatible: it is safe for multiple threads to read from
|
||||||
|
// this variable (when applied to variables), or to call const
|
||||||
|
// methods of this class (when applied to classes), as long as no
|
||||||
|
// other thread is writing to the variable or calling non-const
|
||||||
|
// methods of this class.
|
||||||
|
|
||||||
|
#ifndef GFLAGS_GFLAGS_H_
|
||||||
|
#define GFLAGS_GFLAGS_H_
|
||||||
|
|
||||||
|
#include <string>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
#include "gflags_declare.h" // IWYU pragma: export
|
||||||
|
|
||||||
|
|
||||||
|
// We always want to export variables defined in user code
|
||||||
|
#ifndef GFLAGS_DLL_DEFINE_FLAG
|
||||||
|
# ifdef _MSC_VER
|
||||||
|
# define GFLAGS_DLL_DEFINE_FLAG __declspec(dllexport)
|
||||||
|
# else
|
||||||
|
# define GFLAGS_DLL_DEFINE_FLAG
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
namespace GFLAGS_NAMESPACE {
|
||||||
|
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// To actually define a flag in a file, use DEFINE_bool,
|
||||||
|
// DEFINE_string, etc. at the bottom of this file. You may also find
|
||||||
|
// it useful to register a validator with the flag. This ensures that
|
||||||
|
// when the flag is parsed from the commandline, or is later set via
|
||||||
|
// SetCommandLineOption, we call the validation function. It is _not_
|
||||||
|
// called when you assign the value to the flag directly using the = operator.
|
||||||
|
//
|
||||||
|
// The validation function should return true if the flag value is valid, and
|
||||||
|
// false otherwise. If the function returns false for the new setting of the
|
||||||
|
// flag, the flag will retain its current value. If it returns false for the
|
||||||
|
// default value, ParseCommandLineFlags() will die.
|
||||||
|
//
|
||||||
|
// This function is safe to call at global construct time (as in the
|
||||||
|
// example below).
|
||||||
|
//
|
||||||
|
// Example use:
|
||||||
|
// static bool ValidatePort(const char* flagname, int32 value) {
|
||||||
|
// if (value > 0 && value < 32768) // value is ok
|
||||||
|
// return true;
|
||||||
|
// printf("Invalid value for --%s: %d\n", flagname, (int)value);
|
||||||
|
// return false;
|
||||||
|
// }
|
||||||
|
// DEFINE_int32(port, 0, "What port to listen on");
|
||||||
|
// static bool dummy = RegisterFlagValidator(&FLAGS_port, &ValidatePort);
|
||||||
|
|
||||||
|
// Returns true if successfully registered, false if not (because the
|
||||||
|
// first argument doesn't point to a command-line flag, or because a
|
||||||
|
// validator is already registered for this flag).
|
||||||
|
extern GFLAGS_DLL_DECL bool RegisterFlagValidator(const bool* flag, bool (*validate_fn)(const char*, bool));
|
||||||
|
extern GFLAGS_DLL_DECL bool RegisterFlagValidator(const int32* flag, bool (*validate_fn)(const char*, int32));
|
||||||
|
extern GFLAGS_DLL_DECL bool RegisterFlagValidator(const int64* flag, bool (*validate_fn)(const char*, int64));
|
||||||
|
extern GFLAGS_DLL_DECL bool RegisterFlagValidator(const uint64* flag, bool (*validate_fn)(const char*, uint64));
|
||||||
|
extern GFLAGS_DLL_DECL bool RegisterFlagValidator(const double* flag, bool (*validate_fn)(const char*, double));
|
||||||
|
extern GFLAGS_DLL_DECL bool RegisterFlagValidator(const std::string* flag, bool (*validate_fn)(const char*, const std::string&));
|
||||||
|
|
||||||
|
// Convenience macro for the registration of a flag validator
|
||||||
|
#define DEFINE_validator(name, validator) \
|
||||||
|
static const bool name##_validator_registered = \
|
||||||
|
GFLAGS_NAMESPACE::RegisterFlagValidator(&FLAGS_##name, validator)
|
||||||
|
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// These methods are the best way to get access to info about the
|
||||||
|
// list of commandline flags. Note that these routines are pretty slow.
|
||||||
|
// GetAllFlags: mostly-complete info about the list, sorted by file.
|
||||||
|
// ShowUsageWithFlags: pretty-prints the list to stdout (what --help does)
|
||||||
|
// ShowUsageWithFlagsRestrict: limit to filenames with restrict as a substr
|
||||||
|
//
|
||||||
|
// In addition to accessing flags, you can also access argv[0] (the program
|
||||||
|
// name) and argv (the entire commandline), which we sock away a copy of.
|
||||||
|
// These variables are static, so you should only set them once.
|
||||||
|
//
|
||||||
|
// No need to export this data only structure from DLL, avoiding VS warning 4251.
|
||||||
|
struct CommandLineFlagInfo {
|
||||||
|
std::string name; // the name of the flag
|
||||||
|
std::string type; // the type of the flag: int32, etc
|
||||||
|
std::string description; // the "help text" associated with the flag
|
||||||
|
std::string current_value; // the current value, as a string
|
||||||
|
std::string default_value; // the default value, as a string
|
||||||
|
std::string filename; // 'cleaned' version of filename holding the flag
|
||||||
|
bool has_validator_fn; // true if RegisterFlagValidator called on this flag
|
||||||
|
bool is_default; // true if the flag has the default value and
|
||||||
|
// has not been set explicitly from the cmdline
|
||||||
|
// or via SetCommandLineOption
|
||||||
|
const void* flag_ptr; // pointer to the flag's current value (i.e. FLAGS_foo)
|
||||||
|
};
|
||||||
|
|
||||||
|
// Using this inside of a validator is a recipe for a deadlock.
|
||||||
|
// TODO(user) Fix locking when validators are running, to make it safe to
|
||||||
|
// call validators during ParseAllFlags.
|
||||||
|
// Also make sure then to uncomment the corresponding unit test in
|
||||||
|
// gflags_unittest.sh
|
||||||
|
extern GFLAGS_DLL_DECL void GetAllFlags(std::vector<CommandLineFlagInfo>* OUTPUT);
|
||||||
|
// These two are actually defined in gflags_reporting.cc.
|
||||||
|
extern GFLAGS_DLL_DECL void ShowUsageWithFlags(const char *argv0); // what --help does
|
||||||
|
extern GFLAGS_DLL_DECL void ShowUsageWithFlagsRestrict(const char *argv0, const char *restrict);
|
||||||
|
|
||||||
|
// Create a descriptive string for a flag.
|
||||||
|
// Goes to some trouble to make pretty line breaks.
|
||||||
|
extern GFLAGS_DLL_DECL std::string DescribeOneFlag(const CommandLineFlagInfo& flag);
|
||||||
|
|
||||||
|
// Thread-hostile; meant to be called before any threads are spawned.
|
||||||
|
extern GFLAGS_DLL_DECL void SetArgv(int argc, const char** argv);
|
||||||
|
|
||||||
|
// The following functions are thread-safe as long as SetArgv() is
|
||||||
|
// only called before any threads start.
|
||||||
|
extern GFLAGS_DLL_DECL const std::vector<std::string>& GetArgvs();
|
||||||
|
extern GFLAGS_DLL_DECL const char* GetArgv(); // all of argv as a string
|
||||||
|
extern GFLAGS_DLL_DECL const char* GetArgv0(); // only argv0
|
||||||
|
extern GFLAGS_DLL_DECL uint32 GetArgvSum(); // simple checksum of argv
|
||||||
|
extern GFLAGS_DLL_DECL const char* ProgramInvocationName(); // argv0, or "UNKNOWN" if not set
|
||||||
|
extern GFLAGS_DLL_DECL const char* ProgramInvocationShortName(); // basename(argv0)
|
||||||
|
|
||||||
|
// ProgramUsage() is thread-safe as long as SetUsageMessage() is only
|
||||||
|
// called before any threads start.
|
||||||
|
extern GFLAGS_DLL_DECL const char* ProgramUsage(); // string set by SetUsageMessage()
|
||||||
|
|
||||||
|
// VersionString() is thread-safe as long as SetVersionString() is only
|
||||||
|
// called before any threads start.
|
||||||
|
extern GFLAGS_DLL_DECL const char* VersionString(); // string set by SetVersionString()
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// Normally you access commandline flags by just saying "if (FLAGS_foo)"
|
||||||
|
// or whatever, and set them by calling "FLAGS_foo = bar" (or, more
|
||||||
|
// commonly, via the DEFINE_foo macro). But if you need a bit more
|
||||||
|
// control, we have programmatic ways to get/set the flags as well.
|
||||||
|
// These programmatic ways to access flags are thread-safe, but direct
|
||||||
|
// access is only thread-compatible.
|
||||||
|
|
||||||
|
// Return true iff the flagname was found.
|
||||||
|
// OUTPUT is set to the flag's value, or unchanged if we return false.
|
||||||
|
extern GFLAGS_DLL_DECL bool GetCommandLineOption(const char* name, std::string* OUTPUT);
|
||||||
|
|
||||||
|
// Return true iff the flagname was found. OUTPUT is set to the flag's
|
||||||
|
// CommandLineFlagInfo or unchanged if we return false.
|
||||||
|
extern GFLAGS_DLL_DECL bool GetCommandLineFlagInfo(const char* name, CommandLineFlagInfo* OUTPUT);
|
||||||
|
|
||||||
|
// Return the CommandLineFlagInfo of the flagname. exit() if name not found.
|
||||||
|
// Example usage, to check if a flag's value is currently the default value:
|
||||||
|
// if (GetCommandLineFlagInfoOrDie("foo").is_default) ...
|
||||||
|
extern GFLAGS_DLL_DECL CommandLineFlagInfo GetCommandLineFlagInfoOrDie(const char* name);
|
||||||
|
|
||||||
|
enum GFLAGS_DLL_DECL FlagSettingMode {
|
||||||
|
// update the flag's value (can call this multiple times).
|
||||||
|
SET_FLAGS_VALUE,
|
||||||
|
// update the flag's value, but *only if* it has not yet been updated
|
||||||
|
// with SET_FLAGS_VALUE, SET_FLAG_IF_DEFAULT, or "FLAGS_xxx = nondef".
|
||||||
|
SET_FLAG_IF_DEFAULT,
|
||||||
|
// set the flag's default value to this. If the flag has not yet updated
|
||||||
|
// yet (via SET_FLAGS_VALUE, SET_FLAG_IF_DEFAULT, or "FLAGS_xxx = nondef")
|
||||||
|
// change the flag's current value to the new default value as well.
|
||||||
|
SET_FLAGS_DEFAULT
|
||||||
|
};
|
||||||
|
|
||||||
|
// Set a particular flag ("command line option"). Returns a string
|
||||||
|
// describing the new value that the option has been set to. The
|
||||||
|
// return value API is not well-specified, so basically just depend on
|
||||||
|
// it to be empty if the setting failed for some reason -- the name is
|
||||||
|
// not a valid flag name, or the value is not a valid value -- and
|
||||||
|
// non-empty else.
|
||||||
|
|
||||||
|
// SetCommandLineOption uses set_mode == SET_FLAGS_VALUE (the common case)
|
||||||
|
extern GFLAGS_DLL_DECL std::string SetCommandLineOption (const char* name, const char* value);
|
||||||
|
extern GFLAGS_DLL_DECL std::string SetCommandLineOptionWithMode(const char* name, const char* value, FlagSettingMode set_mode);
|
||||||
|
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// Saves the states (value, default value, whether the user has set
|
||||||
|
// the flag, registered validators, etc) of all flags, and restores
|
||||||
|
// them when the FlagSaver is destroyed. This is very useful in
|
||||||
|
// tests, say, when you want to let your tests change the flags, but
|
||||||
|
// make sure that they get reverted to the original states when your
|
||||||
|
// test is complete.
|
||||||
|
//
|
||||||
|
// Example usage:
|
||||||
|
// void TestFoo() {
|
||||||
|
// FlagSaver s1;
|
||||||
|
// FLAG_foo = false;
|
||||||
|
// FLAG_bar = "some value";
|
||||||
|
//
|
||||||
|
// // test happens here. You can return at any time
|
||||||
|
// // without worrying about restoring the FLAG values.
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Note: This class is marked with GFLAGS_ATTRIBUTE_UNUSED because all
|
||||||
|
// the work is done in the constructor and destructor, so in the standard
|
||||||
|
// usage example above, the compiler would complain that it's an
|
||||||
|
// unused variable.
|
||||||
|
//
|
||||||
|
// This class is thread-safe. However, its destructor writes to
|
||||||
|
// exactly the set of flags that have changed value during its
|
||||||
|
// lifetime, so concurrent _direct_ access to those flags
|
||||||
|
// (i.e. FLAGS_foo instead of {Get,Set}CommandLineOption()) is unsafe.
|
||||||
|
|
||||||
|
class GFLAGS_DLL_DECL FlagSaver {
|
||||||
|
public:
|
||||||
|
FlagSaver();
|
||||||
|
~FlagSaver();
|
||||||
|
|
||||||
|
private:
|
||||||
|
class FlagSaverImpl* impl_; // we use pimpl here to keep API steady
|
||||||
|
|
||||||
|
FlagSaver(const FlagSaver&); // no copying!
|
||||||
|
void operator=(const FlagSaver&);
|
||||||
|
};
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// Some deprecated or hopefully-soon-to-be-deprecated functions.
|
||||||
|
|
||||||
|
// This is often used for logging. TODO(csilvers): figure out a better way
|
||||||
|
extern GFLAGS_DLL_DECL std::string CommandlineFlagsIntoString();
|
||||||
|
// Usually where this is used, a FlagSaver should be used instead.
|
||||||
|
extern GFLAGS_DLL_DECL
|
||||||
|
bool ReadFlagsFromString(const std::string& flagfilecontents,
|
||||||
|
const char* prog_name,
|
||||||
|
bool errors_are_fatal); // uses SET_FLAGS_VALUE
|
||||||
|
|
||||||
|
// These let you manually implement --flagfile functionality.
|
||||||
|
// DEPRECATED.
|
||||||
|
extern GFLAGS_DLL_DECL bool AppendFlagsIntoFile(const std::string& filename, const char* prog_name);
|
||||||
|
extern GFLAGS_DLL_DECL bool ReadFromFlagsFile(const std::string& filename, const char* prog_name, bool errors_are_fatal); // uses SET_FLAGS_VALUE
|
||||||
|
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// Useful routines for initializing flags from the environment.
|
||||||
|
// In each case, if 'varname' does not exist in the environment
|
||||||
|
// return defval. If 'varname' does exist but is not valid
|
||||||
|
// (e.g., not a number for an int32 flag), abort with an error.
|
||||||
|
// Otherwise, return the value. NOTE: for booleans, for true use
|
||||||
|
// 't' or 'T' or 'true' or '1', for false 'f' or 'F' or 'false' or '0'.
|
||||||
|
|
||||||
|
extern GFLAGS_DLL_DECL bool BoolFromEnv(const char *varname, bool defval);
|
||||||
|
extern GFLAGS_DLL_DECL int32 Int32FromEnv(const char *varname, int32 defval);
|
||||||
|
extern GFLAGS_DLL_DECL int64 Int64FromEnv(const char *varname, int64 defval);
|
||||||
|
extern GFLAGS_DLL_DECL uint64 Uint64FromEnv(const char *varname, uint64 defval);
|
||||||
|
extern GFLAGS_DLL_DECL double DoubleFromEnv(const char *varname, double defval);
|
||||||
|
extern GFLAGS_DLL_DECL const char *StringFromEnv(const char *varname, const char *defval);
|
||||||
|
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// The next two functions parse gflags from main():
|
||||||
|
|
||||||
|
// Set the "usage" message for this program. For example:
|
||||||
|
// string usage("This program does nothing. Sample usage:\n");
|
||||||
|
// usage += argv[0] + " <uselessarg1> <uselessarg2>";
|
||||||
|
// SetUsageMessage(usage);
|
||||||
|
// Do not include commandline flags in the usage: we do that for you!
|
||||||
|
// Thread-hostile; meant to be called before any threads are spawned.
|
||||||
|
extern GFLAGS_DLL_DECL void SetUsageMessage(const std::string& usage);
|
||||||
|
|
||||||
|
// Sets the version string, which is emitted with --version.
|
||||||
|
// For instance: SetVersionString("1.3");
|
||||||
|
// Thread-hostile; meant to be called before any threads are spawned.
|
||||||
|
extern GFLAGS_DLL_DECL void SetVersionString(const std::string& version);
|
||||||
|
|
||||||
|
|
||||||
|
// Looks for flags in argv and parses them. Rearranges argv to put
|
||||||
|
// flags first, or removes them entirely if remove_flags is true.
|
||||||
|
// If a flag is defined more than once in the command line or flag
|
||||||
|
// file, the last definition is used. Returns the index (into argv)
|
||||||
|
// of the first non-flag argument.
|
||||||
|
// See top-of-file for more details on this function.
|
||||||
|
#ifndef SWIG // In swig, use ParseCommandLineFlagsScript() instead.
|
||||||
|
extern GFLAGS_DLL_DECL uint32 ParseCommandLineFlags(int *argc, char*** argv, bool remove_flags);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
// Calls to ParseCommandLineNonHelpFlags and then to
|
||||||
|
// HandleCommandLineHelpFlags can be used instead of a call to
|
||||||
|
// ParseCommandLineFlags during initialization, in order to allow for
|
||||||
|
// changing default values for some FLAGS (via
|
||||||
|
// e.g. SetCommandLineOptionWithMode calls) between the time of
|
||||||
|
// command line parsing and the time of dumping help information for
|
||||||
|
// the flags as a result of command line parsing. If a flag is
|
||||||
|
// defined more than once in the command line or flag file, the last
|
||||||
|
// definition is used. Returns the index (into argv) of the first
|
||||||
|
// non-flag argument. (If remove_flags is true, will always return 1.)
|
||||||
|
extern GFLAGS_DLL_DECL uint32 ParseCommandLineNonHelpFlags(int *argc, char*** argv, bool remove_flags);
|
||||||
|
|
||||||
|
// This is actually defined in gflags_reporting.cc.
|
||||||
|
// This function is misnamed (it also handles --version, etc.), but
|
||||||
|
// it's too late to change that now. :-(
|
||||||
|
extern GFLAGS_DLL_DECL void HandleCommandLineHelpFlags(); // in gflags_reporting.cc
|
||||||
|
|
||||||
|
// Allow command line reparsing. Disables the error normally
|
||||||
|
// generated when an unknown flag is found, since it may be found in a
|
||||||
|
// later parse. Thread-hostile; meant to be called before any threads
|
||||||
|
// are spawned.
|
||||||
|
extern GFLAGS_DLL_DECL void AllowCommandLineReparsing();
|
||||||
|
|
||||||
|
// Reparse the flags that have not yet been recognized. Only flags
|
||||||
|
// registered since the last parse will be recognized. Any flag value
|
||||||
|
// must be provided as part of the argument using "=", not as a
|
||||||
|
// separate command line argument that follows the flag argument.
|
||||||
|
// Intended for handling flags from dynamically loaded libraries,
|
||||||
|
// since their flags are not registered until they are loaded.
|
||||||
|
extern GFLAGS_DLL_DECL void ReparseCommandLineNonHelpFlags();
|
||||||
|
|
||||||
|
// Clean up memory allocated by flags. This is only needed to reduce
|
||||||
|
// the quantity of "potentially leaked" reports emitted by memory
|
||||||
|
// debugging tools such as valgrind. It is not required for normal
|
||||||
|
// operation, or for the google perftools heap-checker. It must only
|
||||||
|
// be called when the process is about to exit, and all threads that
|
||||||
|
// might access flags are quiescent. Referencing flags after this is
|
||||||
|
// called will have unexpected consequences. This is not safe to run
|
||||||
|
// when multiple threads might be running: the function is
|
||||||
|
// thread-hostile.
|
||||||
|
extern GFLAGS_DLL_DECL void ShutDownCommandLineFlags();
|
||||||
|
|
||||||
|
|
||||||
|
// --------------------------------------------------------------------
|
||||||
|
// Now come the command line flag declaration/definition macros that
|
||||||
|
// will actually be used. They're kind of hairy. A major reason
|
||||||
|
// for this is initialization: we want people to be able to access
|
||||||
|
// variables in global constructors and have that not crash, even if
|
||||||
|
// their global constructor runs before the global constructor here.
|
||||||
|
// (Obviously, we can't guarantee the flags will have the correct
|
||||||
|
// default value in that case, but at least accessing them is safe.)
|
||||||
|
// The only way to do that is have flags point to a static buffer.
|
||||||
|
// So we make one, using a union to ensure proper alignment, and
|
||||||
|
// then use placement-new to actually set up the flag with the
|
||||||
|
// correct default value. In the same vein, we have to worry about
|
||||||
|
// flag access in global destructors, so FlagRegisterer has to be
|
||||||
|
// careful never to destroy the flag-values it constructs.
|
||||||
|
//
|
||||||
|
// Note that when we define a flag variable FLAGS_<name>, we also
|
||||||
|
// preemptively define a junk variable, FLAGS_no<name>. This is to
|
||||||
|
// cause a link-time error if someone tries to define 2 flags with
|
||||||
|
// names like "logging" and "nologging". We do this because a bool
|
||||||
|
// flag FLAG can be set from the command line to true with a "-FLAG"
|
||||||
|
// argument, and to false with a "-noFLAG" argument, and so this can
|
||||||
|
// potentially avert confusion.
|
||||||
|
//
|
||||||
|
// We also put flags into their own namespace. It is purposefully
|
||||||
|
// named in an opaque way that people should have trouble typing
|
||||||
|
// directly. The idea is that DEFINE puts the flag in the weird
|
||||||
|
// namespace, and DECLARE imports the flag from there into the current
|
||||||
|
// namespace. The net result is to force people to use DECLARE to get
|
||||||
|
// access to a flag, rather than saying "extern GFLAGS_DLL_DECL bool FLAGS_whatever;"
|
||||||
|
// or some such instead. We want this so we can put extra
|
||||||
|
// functionality (like sanity-checking) in DECLARE if we want, and
|
||||||
|
// make sure it is picked up everywhere.
|
||||||
|
//
|
||||||
|
// We also put the type of the variable in the namespace, so that
|
||||||
|
// people can't DECLARE_int32 something that they DEFINE_bool'd
|
||||||
|
// elsewhere.
|
||||||
|
|
||||||
|
class GFLAGS_DLL_DECL FlagRegisterer {
|
||||||
|
public:
|
||||||
|
FlagRegisterer(const char* name, const char* type,
|
||||||
|
const char* help, const char* filename,
|
||||||
|
void* current_storage, void* defvalue_storage);
|
||||||
|
};
|
||||||
|
|
||||||
|
// If your application #defines STRIP_FLAG_HELP to a non-zero value
|
||||||
|
// before #including this file, we remove the help message from the
|
||||||
|
// binary file. This can reduce the size of the resulting binary
|
||||||
|
// somewhat, and may also be useful for security reasons.
|
||||||
|
|
||||||
|
extern GFLAGS_DLL_DECL const char kStrippedFlagHelp[];
|
||||||
|
|
||||||
|
|
||||||
|
} // namespace GFLAGS_NAMESPACE
|
||||||
|
|
||||||
|
|
||||||
|
#ifndef SWIG // In swig, ignore the main flag declarations
|
||||||
|
|
||||||
|
#if defined(STRIP_FLAG_HELP) && STRIP_FLAG_HELP > 0
|
||||||
|
// Need this construct to avoid the 'defined but not used' warning.
|
||||||
|
#define MAYBE_STRIPPED_HELP(txt) \
|
||||||
|
(false ? (txt) : GFLAGS_NAMESPACE::kStrippedFlagHelp)
|
||||||
|
#else
|
||||||
|
#define MAYBE_STRIPPED_HELP(txt) txt
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// Each command-line flag has two variables associated with it: one
|
||||||
|
// with the current value, and one with the default value. However,
|
||||||
|
// we have a third variable, which is where value is assigned; it's a
|
||||||
|
// constant. This guarantees that FLAG_##value is initialized at
|
||||||
|
// static initialization time (e.g. before program-start) rather than
|
||||||
|
// than global construction time (which is after program-start but
|
||||||
|
// before main), at least when 'value' is a compile-time constant. We
|
||||||
|
// use a small trick for the "default value" variable, and call it
|
||||||
|
// FLAGS_no<name>. This serves the second purpose of assuring a
|
||||||
|
// compile error if someone tries to define a flag named no<name>
|
||||||
|
// which is illegal (--foo and --nofoo both affect the "foo" flag).
|
||||||
|
#define DEFINE_VARIABLE(type, shorttype, name, value, help) \
|
||||||
|
namespace fL##shorttype { \
|
||||||
|
static const type FLAGS_nono##name = value; \
|
||||||
|
/* We always want to export defined variables, dll or no */ \
|
||||||
|
GFLAGS_DLL_DEFINE_FLAG type FLAGS_##name = FLAGS_nono##name; \
|
||||||
|
type FLAGS_no##name = FLAGS_nono##name; \
|
||||||
|
static GFLAGS_NAMESPACE::FlagRegisterer o_##name( \
|
||||||
|
#name, #type, MAYBE_STRIPPED_HELP(help), __FILE__, \
|
||||||
|
&FLAGS_##name, &FLAGS_no##name); \
|
||||||
|
} \
|
||||||
|
using fL##shorttype::FLAGS_##name
|
||||||
|
|
||||||
|
// For DEFINE_bool, we want to do the extra check that the passed-in
|
||||||
|
// value is actually a bool, and not a string or something that can be
|
||||||
|
// coerced to a bool. These declarations (no definition needed!) will
|
||||||
|
// help us do that, and never evaluate From, which is important.
|
||||||
|
// We'll use 'sizeof(IsBool(val))' to distinguish. This code requires
|
||||||
|
// that the compiler have different sizes for bool & double. Since
|
||||||
|
// this is not guaranteed by the standard, we check it with a
|
||||||
|
// COMPILE_ASSERT.
|
||||||
|
namespace fLB {
|
||||||
|
struct CompileAssert {};
|
||||||
|
typedef CompileAssert expected_sizeof_double_neq_sizeof_bool[
|
||||||
|
(sizeof(double) != sizeof(bool)) ? 1 : -1];
|
||||||
|
template<typename From> double GFLAGS_DLL_DECL IsBoolFlag(const From& from);
|
||||||
|
GFLAGS_DLL_DECL bool IsBoolFlag(bool from);
|
||||||
|
} // namespace fLB
|
||||||
|
|
||||||
|
// Here are the actual DEFINE_*-macros. The respective DECLARE_*-macros
|
||||||
|
// are in a separate include, gflags_declare.h, for reducing
|
||||||
|
// the physical transitive size for DECLARE use.
|
||||||
|
#define DEFINE_bool(name, val, txt) \
|
||||||
|
namespace fLB { \
|
||||||
|
typedef ::fLB::CompileAssert FLAG_##name##_value_is_not_a_bool[ \
|
||||||
|
(sizeof(::fLB::IsBoolFlag(val)) != sizeof(double))? 1: -1]; \
|
||||||
|
} \
|
||||||
|
DEFINE_VARIABLE(bool, B, name, val, txt)
|
||||||
|
|
||||||
|
#define DEFINE_int32(name, val, txt) \
|
||||||
|
DEFINE_VARIABLE(GFLAGS_NAMESPACE::int32, I, \
|
||||||
|
name, val, txt)
|
||||||
|
|
||||||
|
#define DEFINE_int64(name, val, txt) \
|
||||||
|
DEFINE_VARIABLE(GFLAGS_NAMESPACE::int64, I64, \
|
||||||
|
name, val, txt)
|
||||||
|
|
||||||
|
#define DEFINE_uint64(name,val, txt) \
|
||||||
|
DEFINE_VARIABLE(GFLAGS_NAMESPACE::uint64, U64, \
|
||||||
|
name, val, txt)
|
||||||
|
|
||||||
|
#define DEFINE_double(name, val, txt) \
|
||||||
|
DEFINE_VARIABLE(double, D, name, val, txt)
|
||||||
|
|
||||||
|
// Strings are trickier, because they're not a POD, so we can't
|
||||||
|
// construct them at static-initialization time (instead they get
|
||||||
|
// constructed at global-constructor time, which is much later). To
|
||||||
|
// try to avoid crashes in that case, we use a char buffer to store
|
||||||
|
// the string, which we can static-initialize, and then placement-new
|
||||||
|
// into it later. It's not perfect, but the best we can do.
|
||||||
|
|
||||||
|
namespace fLS {
|
||||||
|
|
||||||
|
inline clstring* dont_pass0toDEFINE_string(char *stringspot,
|
||||||
|
const char *value) {
|
||||||
|
return new(stringspot) clstring(value);
|
||||||
|
}
|
||||||
|
inline clstring* dont_pass0toDEFINE_string(char *stringspot,
|
||||||
|
const clstring &value) {
|
||||||
|
return new(stringspot) clstring(value);
|
||||||
|
}
|
||||||
|
inline clstring* dont_pass0toDEFINE_string(char *stringspot,
|
||||||
|
int value);
|
||||||
|
} // namespace fLS
|
||||||
|
|
||||||
|
// We need to define a var named FLAGS_no##name so people don't define
|
||||||
|
// --string and --nostring. And we need a temporary place to put val
|
||||||
|
// so we don't have to evaluate it twice. Two great needs that go
|
||||||
|
// great together!
|
||||||
|
// The weird 'using' + 'extern' inside the fLS namespace is to work around
|
||||||
|
// an unknown compiler bug/issue with the gcc 4.2.1 on SUSE 10. See
|
||||||
|
// http://code.google.com/p/google-gflags/issues/detail?id=20
|
||||||
|
#define DEFINE_string(name, val, txt) \
|
||||||
|
namespace fLS { \
|
||||||
|
using ::fLS::clstring; \
|
||||||
|
static union { void* align; char s[sizeof(clstring)]; } s_##name[2]; \
|
||||||
|
clstring* const FLAGS_no##name = ::fLS:: \
|
||||||
|
dont_pass0toDEFINE_string(s_##name[0].s, \
|
||||||
|
val); \
|
||||||
|
static GFLAGS_NAMESPACE::FlagRegisterer o_##name( \
|
||||||
|
#name, "string", MAYBE_STRIPPED_HELP(txt), __FILE__, \
|
||||||
|
s_##name[0].s, new (s_##name[1].s) clstring(*FLAGS_no##name)); \
|
||||||
|
extern GFLAGS_DLL_DEFINE_FLAG clstring& FLAGS_##name; \
|
||||||
|
using fLS::FLAGS_##name; \
|
||||||
|
clstring& FLAGS_##name = *FLAGS_no##name; \
|
||||||
|
} \
|
||||||
|
using fLS::FLAGS_##name
|
||||||
|
|
||||||
|
#endif // SWIG
|
||||||
|
|
||||||
|
|
||||||
|
// Import gflags library symbols into alternative/deprecated namespace(s)
|
||||||
|
#include "gflags_gflags.h"
|
||||||
|
|
||||||
|
|
||||||
|
#endif // GFLAGS_GFLAGS_H_
|
|
@ -0,0 +1,121 @@
|
||||||
|
// Copyright (c) 2008, Google Inc.
|
||||||
|
// All rights reserved.
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
//
|
||||||
|
// ---
|
||||||
|
|
||||||
|
//
|
||||||
|
// Implement helpful bash-style command line flag completions
|
||||||
|
//
|
||||||
|
// ** Functional API:
|
||||||
|
// HandleCommandLineCompletions() should be called early during
|
||||||
|
// program startup, but after command line flag code has been
|
||||||
|
// initialized, such as the beginning of HandleCommandLineHelpFlags().
|
||||||
|
// It checks the value of the flag --tab_completion_word. If this
|
||||||
|
// flag is empty, nothing happens here. If it contains a string,
|
||||||
|
// however, then HandleCommandLineCompletions() will hijack the
|
||||||
|
// process, attempting to identify the intention behind this
|
||||||
|
// completion. Regardless of the outcome of this deduction, the
|
||||||
|
// process will be terminated, similar to --helpshort flag
|
||||||
|
// handling.
|
||||||
|
//
|
||||||
|
// ** Overview of Bash completions:
|
||||||
|
// Bash can be told to programatically determine completions for the
|
||||||
|
// current 'cursor word'. It does this by (in this case) invoking a
|
||||||
|
// command with some additional arguments identifying the command
|
||||||
|
// being executed, the word being completed, and the previous word
|
||||||
|
// (if any). Bash then expects a sequence of output lines to be
|
||||||
|
// printed to stdout. If these lines all contain a common prefix
|
||||||
|
// longer than the cursor word, bash will replace the cursor word
|
||||||
|
// with that common prefix, and display nothing. If there isn't such
|
||||||
|
// a common prefix, bash will display the lines in pages using 'more'.
|
||||||
|
//
|
||||||
|
// ** Strategy taken for command line completions:
|
||||||
|
// If we can deduce either the exact flag intended, or a common flag
|
||||||
|
// prefix, we'll output exactly that. Otherwise, if information
|
||||||
|
// must be displayed to the user, we'll take the opportunity to add
|
||||||
|
// some helpful information beyond just the flag name (specifically,
|
||||||
|
// we'll include the default flag value and as much of the flag's
|
||||||
|
// description as can fit on a single terminal line width, as specified
|
||||||
|
// by the flag --tab_completion_columns). Furthermore, we'll try to
|
||||||
|
// make bash order the output such that the most useful or relevent
|
||||||
|
// flags are the most likely to be shown at the top.
|
||||||
|
//
|
||||||
|
// ** Additional features:
|
||||||
|
// To assist in finding that one really useful flag, substring matching
|
||||||
|
// was implemented. Before pressing a <TAB> to get completion for the
|
||||||
|
// current word, you can append one or more '?' to the flag to do
|
||||||
|
// substring matching. Here's the semantics:
|
||||||
|
// --foo<TAB> Show me all flags with names prefixed by 'foo'
|
||||||
|
// --foo?<TAB> Show me all flags with 'foo' somewhere in the name
|
||||||
|
// --foo??<TAB> Same as prior case, but also search in module
|
||||||
|
// definition path for 'foo'
|
||||||
|
// --foo???<TAB> Same as prior case, but also search in flag
|
||||||
|
// descriptions for 'foo'
|
||||||
|
// Finally, we'll trim the output to a relatively small number of
|
||||||
|
// flags to keep bash quiet about the verbosity of output. If one
|
||||||
|
// really wanted to see all possible matches, appending a '+' to the
|
||||||
|
// search word will force the exhaustive list of matches to be printed.
|
||||||
|
//
|
||||||
|
// ** How to have bash accept completions from a binary:
|
||||||
|
// Bash requires that it be informed about each command that programmatic
|
||||||
|
// completion should be enabled for. Example addition to a .bashrc
|
||||||
|
// file would be (your path to gflags_completions.sh file may differ):
|
||||||
|
|
||||||
|
/*
|
||||||
|
$ complete -o bashdefault -o default -o nospace -C \
|
||||||
|
'/home/build/eng/bash/bash_completions.sh --tab_completion_columns $COLUMNS' \
|
||||||
|
time env binary_name another_binary [...]
|
||||||
|
*/
|
||||||
|
|
||||||
|
// This would allow the following to work:
|
||||||
|
// $ /path/to/binary_name --vmodule<TAB>
|
||||||
|
// Or:
|
||||||
|
// $ ./bin/path/another_binary --gfs_u<TAB>
|
||||||
|
// (etc)
|
||||||
|
//
|
||||||
|
// Sadly, it appears that bash gives no easy way to force this behavior for
|
||||||
|
// all commands. That's where the "time" in the above example comes in.
|
||||||
|
// If you haven't specifically added a command to the list of completion
|
||||||
|
// supported commands, you can still get completions by prefixing the
|
||||||
|
// entire command with "env".
|
||||||
|
// $ env /some/brand/new/binary --vmod<TAB>
|
||||||
|
// Assuming that "binary" is a newly compiled binary, this should still
|
||||||
|
// produce the expected completion output.
|
||||||
|
|
||||||
|
|
||||||
|
#ifndef GFLAGS_COMPLETIONS_H_
|
||||||
|
#define GFLAGS_COMPLETIONS_H_
|
||||||
|
|
||||||
|
namespace google {
|
||||||
|
|
||||||
|
extern void HandleCommandLineCompletions(void);
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
#endif // GFLAGS_COMPLETIONS_H_
|
|
@ -0,0 +1,141 @@
|
||||||
|
// Copyright (c) 1999, Google Inc.
|
||||||
|
// All rights reserved.
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
// ---
|
||||||
|
//
|
||||||
|
// Revamped and reorganized by Craig Silverstein
|
||||||
|
//
|
||||||
|
// This is the file that should be included by any file which declares
|
||||||
|
// command line flag.
|
||||||
|
|
||||||
|
#ifndef GFLAGS_DECLARE_H_
|
||||||
|
#define GFLAGS_DECLARE_H_
|
||||||
|
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Namespace of gflags library symbols.
|
||||||
|
#define GFLAGS_NAMESPACE google
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Windows DLL import/export.
|
||||||
|
|
||||||
|
// We always want to import the symbols of the gflags library
|
||||||
|
#ifndef GFLAGS_DLL_DECL
|
||||||
|
# if 0 && defined(_MSC_VER)
|
||||||
|
# define GFLAGS_DLL_DECL __declspec(dllimport)
|
||||||
|
# else
|
||||||
|
# define GFLAGS_DLL_DECL
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// We always want to import variables declared in user code
|
||||||
|
#ifndef GFLAGS_DLL_DECLARE_FLAG
|
||||||
|
# ifdef _MSC_VER
|
||||||
|
# define GFLAGS_DLL_DECLARE_FLAG __declspec(dllimport)
|
||||||
|
# else
|
||||||
|
# define GFLAGS_DLL_DECLARE_FLAG
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Flag types
|
||||||
|
#include <string>
|
||||||
|
#if 1
|
||||||
|
# include <stdint.h> // the normal place uint32_t is defined
|
||||||
|
#elif 1
|
||||||
|
# include <sys/types.h> // the normal place u_int32_t is defined
|
||||||
|
#elif 0
|
||||||
|
# include <inttypes.h> // a third place for uint32_t or u_int32_t
|
||||||
|
#endif
|
||||||
|
|
||||||
|
namespace GFLAGS_NAMESPACE {
|
||||||
|
|
||||||
|
#if 0 // C99
|
||||||
|
typedef int32_t int32;
|
||||||
|
typedef uint32_t uint32;
|
||||||
|
typedef int64_t int64;
|
||||||
|
typedef uint64_t uint64;
|
||||||
|
#elif 0 // BSD
|
||||||
|
typedef int32_t int32;
|
||||||
|
typedef u_int32_t uint32;
|
||||||
|
typedef int64_t int64;
|
||||||
|
typedef u_int64_t uint64;
|
||||||
|
#elif 1 // Windows
|
||||||
|
typedef __int32 int32;
|
||||||
|
typedef unsigned __int32 uint32;
|
||||||
|
typedef __int64 int64;
|
||||||
|
typedef unsigned __int64 uint64;
|
||||||
|
#else
|
||||||
|
# error Do not know how to define a 32-bit integer quantity on your system
|
||||||
|
#endif
|
||||||
|
|
||||||
|
} // namespace GFLAGS_NAMESPACE
|
||||||
|
|
||||||
|
|
||||||
|
namespace fLS {
|
||||||
|
|
||||||
|
// The meaning of "string" might be different between now and when the
|
||||||
|
// macros below get invoked (e.g., if someone is experimenting with
|
||||||
|
// other string implementations that get defined after this file is
|
||||||
|
// included). Save the current meaning now and use it in the macros.
|
||||||
|
typedef std::string clstring;
|
||||||
|
|
||||||
|
} // namespace fLS
|
||||||
|
|
||||||
|
|
||||||
|
#define DECLARE_VARIABLE(type, shorttype, name) \
|
||||||
|
/* We always want to import declared variables, dll or no */ \
|
||||||
|
namespace fL##shorttype { extern GFLAGS_DLL_DECLARE_FLAG type FLAGS_##name; } \
|
||||||
|
using fL##shorttype::FLAGS_##name
|
||||||
|
|
||||||
|
#define DECLARE_bool(name) \
|
||||||
|
DECLARE_VARIABLE(bool, B, name)
|
||||||
|
|
||||||
|
#define DECLARE_int32(name) \
|
||||||
|
DECLARE_VARIABLE(::GFLAGS_NAMESPACE::int32, I, name)
|
||||||
|
|
||||||
|
#define DECLARE_int64(name) \
|
||||||
|
DECLARE_VARIABLE(::GFLAGS_NAMESPACE::int64, I64, name)
|
||||||
|
|
||||||
|
#define DECLARE_uint64(name) \
|
||||||
|
DECLARE_VARIABLE(::GFLAGS_NAMESPACE::uint64, U64, name)
|
||||||
|
|
||||||
|
#define DECLARE_double(name) \
|
||||||
|
DECLARE_VARIABLE(double, D, name)
|
||||||
|
|
||||||
|
#define DECLARE_string(name) \
|
||||||
|
/* We always want to import declared variables, dll or no */ \
|
||||||
|
namespace fLS { \
|
||||||
|
using ::fLS::clstring; \
|
||||||
|
extern GFLAGS_DLL_DECLARE_FLAG ::fLS::clstring& FLAGS_##name; \
|
||||||
|
} \
|
||||||
|
using fLS::FLAGS_##name
|
||||||
|
|
||||||
|
|
||||||
|
#endif // GFLAGS_DECLARE_H_
|
|
@ -0,0 +1,101 @@
|
||||||
|
// Copyright (c) 2014, Andreas Schuh
|
||||||
|
// All rights reserved.
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
// Imports the gflags library symbols into an alternative/deprecated namespace.
|
||||||
|
|
||||||
|
#ifndef GFLAGS_GFLAGS_H_
|
||||||
|
# error The internal header gflags_gflags.h may only be included by gflags.h
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef GFLAGS_NS_GFLAGS_H_
|
||||||
|
#define GFLAGS_NS_GFLAGS_H_
|
||||||
|
|
||||||
|
|
||||||
|
namespace gflags {
|
||||||
|
|
||||||
|
|
||||||
|
using GFLAGS_NAMESPACE::int32;
|
||||||
|
using GFLAGS_NAMESPACE::uint32;
|
||||||
|
using GFLAGS_NAMESPACE::int64;
|
||||||
|
using GFLAGS_NAMESPACE::uint64;
|
||||||
|
|
||||||
|
using GFLAGS_NAMESPACE::RegisterFlagValidator;
|
||||||
|
using GFLAGS_NAMESPACE::CommandLineFlagInfo;
|
||||||
|
using GFLAGS_NAMESPACE::GetAllFlags;
|
||||||
|
using GFLAGS_NAMESPACE::ShowUsageWithFlags;
|
||||||
|
using GFLAGS_NAMESPACE::ShowUsageWithFlagsRestrict;
|
||||||
|
using GFLAGS_NAMESPACE::DescribeOneFlag;
|
||||||
|
using GFLAGS_NAMESPACE::SetArgv;
|
||||||
|
using GFLAGS_NAMESPACE::GetArgvs;
|
||||||
|
using GFLAGS_NAMESPACE::GetArgv;
|
||||||
|
using GFLAGS_NAMESPACE::GetArgv0;
|
||||||
|
using GFLAGS_NAMESPACE::GetArgvSum;
|
||||||
|
using GFLAGS_NAMESPACE::ProgramInvocationName;
|
||||||
|
using GFLAGS_NAMESPACE::ProgramInvocationShortName;
|
||||||
|
using GFLAGS_NAMESPACE::ProgramUsage;
|
||||||
|
using GFLAGS_NAMESPACE::VersionString;
|
||||||
|
using GFLAGS_NAMESPACE::GetCommandLineOption;
|
||||||
|
using GFLAGS_NAMESPACE::GetCommandLineFlagInfo;
|
||||||
|
using GFLAGS_NAMESPACE::GetCommandLineFlagInfoOrDie;
|
||||||
|
using GFLAGS_NAMESPACE::FlagSettingMode;
|
||||||
|
using GFLAGS_NAMESPACE::SET_FLAGS_VALUE;
|
||||||
|
using GFLAGS_NAMESPACE::SET_FLAG_IF_DEFAULT;
|
||||||
|
using GFLAGS_NAMESPACE::SET_FLAGS_DEFAULT;
|
||||||
|
using GFLAGS_NAMESPACE::SetCommandLineOption;
|
||||||
|
using GFLAGS_NAMESPACE::SetCommandLineOptionWithMode;
|
||||||
|
using GFLAGS_NAMESPACE::FlagSaver;
|
||||||
|
using GFLAGS_NAMESPACE::CommandlineFlagsIntoString;
|
||||||
|
using GFLAGS_NAMESPACE::ReadFlagsFromString;
|
||||||
|
using GFLAGS_NAMESPACE::AppendFlagsIntoFile;
|
||||||
|
using GFLAGS_NAMESPACE::ReadFromFlagsFile;
|
||||||
|
using GFLAGS_NAMESPACE::BoolFromEnv;
|
||||||
|
using GFLAGS_NAMESPACE::Int32FromEnv;
|
||||||
|
using GFLAGS_NAMESPACE::Int64FromEnv;
|
||||||
|
using GFLAGS_NAMESPACE::Uint64FromEnv;
|
||||||
|
using GFLAGS_NAMESPACE::DoubleFromEnv;
|
||||||
|
using GFLAGS_NAMESPACE::StringFromEnv;
|
||||||
|
using GFLAGS_NAMESPACE::SetUsageMessage;
|
||||||
|
using GFLAGS_NAMESPACE::SetVersionString;
|
||||||
|
using GFLAGS_NAMESPACE::ParseCommandLineNonHelpFlags;
|
||||||
|
using GFLAGS_NAMESPACE::HandleCommandLineHelpFlags;
|
||||||
|
using GFLAGS_NAMESPACE::AllowCommandLineReparsing;
|
||||||
|
using GFLAGS_NAMESPACE::ReparseCommandLineNonHelpFlags;
|
||||||
|
using GFLAGS_NAMESPACE::ShutDownCommandLineFlags;
|
||||||
|
using GFLAGS_NAMESPACE::FlagRegisterer;
|
||||||
|
|
||||||
|
#ifndef SWIG
|
||||||
|
using GFLAGS_NAMESPACE::ParseCommandLineFlags;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
} // namespace gflags
|
||||||
|
|
||||||
|
|
||||||
|
#endif // GFLAGS_NS_GFLAGS_H_
|
|
@ -0,0 +1,112 @@
|
||||||
|
/* Generated from config.h.in during build configuration using CMake. */
|
||||||
|
|
||||||
|
// Note: This header file is only used internally. It is not part of public interface!
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// System checks
|
||||||
|
|
||||||
|
// Define if you build this library for a MS Windows OS.
|
||||||
|
#define OS_WINDOWS
|
||||||
|
|
||||||
|
// Define if you have the <stdint.h> header file.
|
||||||
|
#define HAVE_STDINT_H
|
||||||
|
|
||||||
|
// Define if you have the <sys/types.h> header file.
|
||||||
|
#define HAVE_SYS_TYPES_H
|
||||||
|
|
||||||
|
// Define if you have the <inttypes.h> header file.
|
||||||
|
/* #undef HAVE_INTTYPES_H */
|
||||||
|
|
||||||
|
// Define if you have the <sys/stat.h> header file.
|
||||||
|
#define HAVE_SYS_STAT_H
|
||||||
|
|
||||||
|
// Define if you have the <unistd.h> header file.
|
||||||
|
/* #undef HAVE_UNISTD_H */
|
||||||
|
|
||||||
|
// Define if you have the <fnmatch.h> header file.
|
||||||
|
/* #undef HAVE_FNMATCH_H */
|
||||||
|
|
||||||
|
// Define if you have the <shlwapi.h> header file (Windows 2000/XP).
|
||||||
|
#define HAVE_SHLWAPI_H
|
||||||
|
|
||||||
|
// Define if you have the strtoll function.
|
||||||
|
/* #undef HAVE_STRTOLL */
|
||||||
|
|
||||||
|
// Define if you have the strtoq function.
|
||||||
|
/* #undef HAVE_STRTOQ */
|
||||||
|
|
||||||
|
// Define if you have the <pthread.h> header file.
|
||||||
|
/* #undef HAVE_PTHREAD */
|
||||||
|
|
||||||
|
// Define if your pthread library defines the type pthread_rwlock_t
|
||||||
|
/* #undef HAVE_RWLOCK */
|
||||||
|
|
||||||
|
// gcc requires this to get PRId64, etc.
|
||||||
|
#if defined(HAVE_INTTYPES_H) && !defined(__STDC_FORMAT_MACROS)
|
||||||
|
# define __STDC_FORMAT_MACROS 1
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Package information
|
||||||
|
|
||||||
|
// Name of package.
|
||||||
|
#define PACKAGE gflags
|
||||||
|
|
||||||
|
// Define to the full name of this package.
|
||||||
|
#define PACKAGE_NAME gflags
|
||||||
|
|
||||||
|
// Define to the full name and version of this package.
|
||||||
|
#define PACKAGE_STRING gflags 2.2.0
|
||||||
|
|
||||||
|
// Define to the one symbol short name of this package.
|
||||||
|
#define PACKAGE_TARNAME gflags-2.2.0
|
||||||
|
|
||||||
|
// Define to the version of this package.
|
||||||
|
#define PACKAGE_VERSION 2.2.0
|
||||||
|
|
||||||
|
// Version number of package.
|
||||||
|
#define VERSION PACKAGE_VERSION
|
||||||
|
|
||||||
|
// Define to the address where bug reports for this package should be sent.
|
||||||
|
#define PACKAGE_BUGREPORT https://github.com/schuhschuh/gflags/issues
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Path separator
|
||||||
|
#ifndef PATH_SEPARATOR
|
||||||
|
# ifdef OS_WINDOWS
|
||||||
|
# define PATH_SEPARATOR '\\'
|
||||||
|
# else
|
||||||
|
# define PATH_SEPARATOR '/'
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Windows
|
||||||
|
|
||||||
|
// Whether gflags library is a DLL.
|
||||||
|
#ifndef GFLAGS_IS_A_DLL
|
||||||
|
# define GFLAGS_IS_A_DLL 0
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// Always export symbols when compiling a shared library as this file is only
|
||||||
|
// included by internal modules when building the gflags library itself.
|
||||||
|
// The gflags_declare.h header file will set it to import these symbols otherwise.
|
||||||
|
#ifndef GFLAGS_DLL_DECL
|
||||||
|
# if GFLAGS_IS_A_DLL && defined(_MSC_VER)
|
||||||
|
# define GFLAGS_DLL_DECL __declspec(dllexport)
|
||||||
|
# else
|
||||||
|
# define GFLAGS_DLL_DECL
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
// Flags defined by the gflags library itself must be exported
|
||||||
|
#ifndef GFLAGS_DLL_DEFINE_FLAG
|
||||||
|
# define GFLAGS_DLL_DEFINE_FLAG GFLAGS_DLL_DECL
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifdef OS_WINDOWS
|
||||||
|
// The unittests import the symbols of the shared gflags library
|
||||||
|
# if GFLAGS_IS_A_DLL && defined(_MSC_VER)
|
||||||
|
# define GFLAGS_DLL_DECL_FOR_UNITTESTS __declspec(dllimport)
|
||||||
|
# endif
|
||||||
|
# include "windows_port.h"
|
||||||
|
#endif
|
|
@ -0,0 +1,90 @@
|
||||||
|
# Copyright 2011 Google Inc.
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
|
||||||
|
{
|
||||||
|
'variables': {
|
||||||
|
'gflags_root': '<(DEPTH)/third_party/gflags',
|
||||||
|
'conditions': [
|
||||||
|
['OS=="win"', {
|
||||||
|
'gflags_gen_arch_root': '<(gflags_root)/gen/win',
|
||||||
|
}, {
|
||||||
|
'gflags_gen_arch_root': '<(gflags_root)/gen/posix',
|
||||||
|
}],
|
||||||
|
],
|
||||||
|
},
|
||||||
|
'targets': [
|
||||||
|
{
|
||||||
|
'target_name': 'gflags',
|
||||||
|
'type': 'static_library',
|
||||||
|
'include_dirs': [
|
||||||
|
'<(gflags_gen_arch_root)/include/gflags', # For configured files.
|
||||||
|
'<(gflags_gen_arch_root)/include/private', # For config.h
|
||||||
|
'<(gflags_root)/src/src', # For everything else.
|
||||||
|
],
|
||||||
|
'defines': [
|
||||||
|
# These macros exist so flags and symbols are properly
|
||||||
|
# exported when building DLLs. Since we don't build DLLs, we
|
||||||
|
# need to disable them.
|
||||||
|
'GFLAGS_DLL_DECL=',
|
||||||
|
'GFLAGS_DLL_DECLARE_FLAG=',
|
||||||
|
'GFLAGS_DLL_DEFINE_FLAG=',
|
||||||
|
],
|
||||||
|
'direct_dependent_settings': {
|
||||||
|
'include_dirs': [
|
||||||
|
'<(gflags_gen_arch_root)/include', # For configured files.
|
||||||
|
'<(gflags_root)/src/src', # For everything else.
|
||||||
|
],
|
||||||
|
'defines': [
|
||||||
|
'GFLAGS_DLL_DECL=',
|
||||||
|
'GFLAGS_DLL_DECLARE_FLAG=',
|
||||||
|
'GFLAGS_DLL_DEFINE_FLAG=',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
'sources': [
|
||||||
|
'src/src/gflags.cc',
|
||||||
|
'src/src/gflags_completions.cc',
|
||||||
|
'src/src/gflags_reporting.cc',
|
||||||
|
],
|
||||||
|
'conditions': [
|
||||||
|
['OS=="win"', {
|
||||||
|
'sources': [
|
||||||
|
'src/src/windows_port.cc',
|
||||||
|
],
|
||||||
|
'msvs_disabled_warnings': [
|
||||||
|
4005, # WIN32_LEAN_AND_MEAN redefinition.
|
||||||
|
4267, # Conversion from size_t to "type".
|
||||||
|
],
|
||||||
|
'configurations': {
|
||||||
|
'Common_Base': {
|
||||||
|
'msvs_configuration_attributes': {
|
||||||
|
'CharacterSet': '2', # Use Multi-byte Character Set.
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}],
|
||||||
|
# TODO(andrew): Look into fixing this warning upstream:
|
||||||
|
# http://code.google.com/p/webrtc/issues/detail?id=760
|
||||||
|
['OS=="win" and clang==1', {
|
||||||
|
'msvs_settings': {
|
||||||
|
'VCCLCompilerTool': {
|
||||||
|
'AdditionalOptions': [
|
||||||
|
'-Wno-microsoft-include',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}],
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}
|
Loading…
Reference in New Issue