gflags.h File Reference

#include <string>
#include <vector>
#include "gflags_declare.h"
#include "gflags_gflags.h"

Go to the source code of this file.

Classes
struct	GFLAGS_NAMESPACE::CommandLineFlagInfo
class	GFLAGS_NAMESPACE::FlagSaver
class	GFLAGS_NAMESPACE::FlagRegisterer
struct	fLB::CompileAssert

Namespaces
	GFLAGS_NAMESPACE
	fLB
	fLS

Macros
#define	GFLAGS_DLL_DEFINE_FLAG
#define	DEFINE_validator(name, validator)
#define	MAYBE_STRIPPED_HELP(txt)   txt
#define	DEFINE_VARIABLE(type, shorttype, name, value, help)
#define	DEFINE_bool(name, val, txt)
#define	DEFINE_int32(name, val, txt)
#define	DEFINE_int64(name, val, txt)
#define	DEFINE_uint64(name, val, txt)
#define	DEFINE_double(name, val, txt)   DEFINE_VARIABLE(double, D, name, val, txt)
#define	DEFINE_string(name, val, txt)

Functions
GFLAGS_DLL_DECL bool	GFLAGS_NAMESPACE::RegisterFlagValidator (const bool *flag, bool(*validate_fn)(const char *, bool))
GFLAGS_DLL_DECL bool	GFLAGS_NAMESPACE::RegisterFlagValidator (const int32 *flag, bool(*validate_fn)(const char *, int32))
GFLAGS_DLL_DECL bool	GFLAGS_NAMESPACE::RegisterFlagValidator (const int64 *flag, bool(*validate_fn)(const char *, int64))
GFLAGS_DLL_DECL bool	GFLAGS_NAMESPACE::RegisterFlagValidator (const uint64 *flag, bool(*validate_fn)(const char *, uint64))
GFLAGS_DLL_DECL bool	GFLAGS_NAMESPACE::RegisterFlagValidator (const double *flag, bool(*validate_fn)(const char *, double))
GFLAGS_DLL_DECL bool	GFLAGS_NAMESPACE::RegisterFlagValidator (const std::string *flag, bool(*validate_fn)(const char *, const std::string &))
GFLAGS_DLL_DECL void	GFLAGS_NAMESPACE::GetAllFlags (std::vector< CommandLineFlagInfo > *OUTPUT)
GFLAGS_DLL_DECL void	GFLAGS_NAMESPACE::ShowUsageWithFlags (const char *argv0)
GFLAGS_DLL_DECL void	GFLAGS_NAMESPACE::ShowUsageWithFlagsRestrict (const char *argv0, const char *restrict)
GFLAGS_DLL_DECL std::string	GFLAGS_NAMESPACE::DescribeOneFlag (const CommandLineFlagInfo &flag)
GFLAGS_DLL_DECL void	GFLAGS_NAMESPACE::SetArgv (int argc, const char **argv)
GFLAGS_DLL_DECL const std::vector< std::string > &	GFLAGS_NAMESPACE::GetArgvs ()
GFLAGS_DLL_DECL const char *	GFLAGS_NAMESPACE::GetArgv ()
GFLAGS_DLL_DECL const char *	GFLAGS_NAMESPACE::GetArgv0 ()
GFLAGS_DLL_DECL uint32	GFLAGS_NAMESPACE::GetArgvSum ()
GFLAGS_DLL_DECL const char *	GFLAGS_NAMESPACE::ProgramInvocationName ()
GFLAGS_DLL_DECL const char *	GFLAGS_NAMESPACE::ProgramInvocationShortName ()
GFLAGS_DLL_DECL const char *	GFLAGS_NAMESPACE::ProgramUsage ()
GFLAGS_DLL_DECL const char *	GFLAGS_NAMESPACE::VersionString ()
GFLAGS_DLL_DECL bool	GFLAGS_NAMESPACE::GetCommandLineOption (const char *name, std::string *OUTPUT)
GFLAGS_DLL_DECL bool	GFLAGS_NAMESPACE::GetCommandLineFlagInfo (const char *name, CommandLineFlagInfo *OUTPUT)
GFLAGS_DLL_DECL CommandLineFlagInfo	GFLAGS_NAMESPACE::GetCommandLineFlagInfoOrDie (const char *name)
GFLAGS_DLL_DECL std::string	GFLAGS_NAMESPACE::SetCommandLineOption (const char *name, const char *value)
GFLAGS_DLL_DECL std::string	GFLAGS_NAMESPACE::SetCommandLineOptionWithMode (const char *name, const char *value, FlagSettingMode set_mode)
GFLAGS_DLL_DECL std::string	GFLAGS_NAMESPACE::CommandlineFlagsIntoString ()
GFLAGS_DLL_DECL bool	GFLAGS_NAMESPACE::ReadFlagsFromString (const std::string &flagfilecontents, const char *prog_name, bool errors_are_fatal)
GFLAGS_DLL_DECL bool	GFLAGS_NAMESPACE::AppendFlagsIntoFile (const std::string &filename, const char *prog_name)
GFLAGS_DLL_DECL bool	GFLAGS_NAMESPACE::ReadFromFlagsFile (const std::string &filename, const char *prog_name, bool errors_are_fatal)
GFLAGS_DLL_DECL bool	GFLAGS_NAMESPACE::BoolFromEnv (const char *varname, bool defval)
GFLAGS_DLL_DECL int32	GFLAGS_NAMESPACE::Int32FromEnv (const char *varname, int32 defval)
GFLAGS_DLL_DECL int64	GFLAGS_NAMESPACE::Int64FromEnv (const char *varname, int64 defval)
GFLAGS_DLL_DECL uint64	GFLAGS_NAMESPACE::Uint64FromEnv (const char *varname, uint64 defval)
GFLAGS_DLL_DECL double	GFLAGS_NAMESPACE::DoubleFromEnv (const char *varname, double defval)
GFLAGS_DLL_DECL const char *	GFLAGS_NAMESPACE::StringFromEnv (const char *varname, const char *defval)
GFLAGS_DLL_DECL void	GFLAGS_NAMESPACE::SetUsageMessage (const std::string &usage)
GFLAGS_DLL_DECL void	GFLAGS_NAMESPACE::SetVersionString (const std::string &version)
GFLAGS_DLL_DECL uint32	GFLAGS_NAMESPACE::ParseCommandLineFlags (int *argc, char ***argv, bool remove_flags)
GFLAGS_DLL_DECL uint32	GFLAGS_NAMESPACE::ParseCommandLineNonHelpFlags (int *argc, char ***argv, bool remove_flags)
GFLAGS_DLL_DECL void	GFLAGS_NAMESPACE::HandleCommandLineHelpFlags ()
GFLAGS_DLL_DECL void	GFLAGS_NAMESPACE::AllowCommandLineReparsing ()
GFLAGS_DLL_DECL void	GFLAGS_NAMESPACE::ReparseCommandLineNonHelpFlags ()
GFLAGS_DLL_DECL void	GFLAGS_NAMESPACE::ShutDownCommandLineFlags ()
template<typename From >
double GFLAGS_DLL_DECL	fLB::IsBoolFlag (const From &from)
GFLAGS_DLL_DECL bool	fLB::IsBoolFlag (bool from)
clstring *	fLS::dont_pass0toDEFINE_string (char *stringspot, const char *value)
clstring *	fLS::dont_pass0toDEFINE_string (char *stringspot, const clstring &value)
clstring *	fLS::dont_pass0toDEFINE_string (char *stringspot, int value)

Variables
	SET_FLAGS_VALUE
	SET_FLAG_IF_DEFAULT

Macro Definition Documentation

DEFINE_bool

#define DEFINE_bool	(		name,
			val,
			txt
	)

Value:

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_double

#define DEFINE_double	(		name,
			val,
			txt
	)		DEFINE_VARIABLE(double, D, name, val, txt)

DEFINE_int32

#define DEFINE_int32	(		name,
			val,
			txt
	)

Value:

DEFINE_VARIABLE(GFLAGS_NAMESPACE::int32, I, \
                   name, val, txt)

DEFINE_int64

#define DEFINE_int64	(		name,
			val,
			txt
	)

Value:

DEFINE_VARIABLE(GFLAGS_NAMESPACE::int64, I64, \
                   name, val, txt)

DEFINE_string

#define DEFINE_string	(		name,
			val,
			txt
	)

Value:

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

DEFINE_uint64

#define DEFINE_uint64	(		name,
			val,
			txt
	)

Value:

DEFINE_VARIABLE(GFLAGS_NAMESPACE::uint64, U64, \
                   name, val, txt)

DEFINE_validator

#define DEFINE_validator	(		name,
			validator
	)

Value:

static const bool name##_validator_registered = \
            GFLAGS_NAMESPACE::RegisterFlagValidator(&FLAGS_##name, validator)

DEFINE_VARIABLE

#define DEFINE_VARIABLE	(		type,
			shorttype,
			name,
			value,
			help
	)

Value:

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

GFLAGS_DLL_DEFINE_FLAG

#define GFLAGS_DLL_DEFINE_FLAG

MAYBE_STRIPPED_HELP

#define MAYBE_STRIPPED_HELP

(

txt

)

txt

Variable Documentation

SET_FLAG_IF_DEFAULT

SET_FLAG_IF_DEFAULT

SET_FLAGS_VALUE

SET_FLAGS_VALUE