gflags

编译安装

1. git clone https://github.com/gflags/gflags
2. 进入源码目录
3. cmake .
4. make -j 24
5. sudo make install

解析命令行参数

  只有使用 google::ParseCommandLineFlags(&argc, &argv, true) 函数才会去解析命令行参数，否则命令行参数不会对 gflag变量赋值。

 google::ParseCommandLineFlags(&argc, &argv, true);
 第三个参数 为true 表示从argv 命令行参数中剔除 gflag变量
           为false 不会剔除gflag变量，但是会重新对命令行参数进行排序，把gflag变量提前

定义gflags

  我们可以在每个源文件内都定义一个gflags变量，但是在整个程序的角度来看各个源文件内定义的gflags变量不能有重名的否则会链接失败，所以一半使用的时候会在一个源文件内使用DEFINE_ 宏定义相应的gflags变量，然后在头文件内使用DECLARE_ 宏去声明变量，这样使用到同一变量的其他源文件内都有了相应gflags变量的声明所以不会报链接错误

使用DEFINE 宏

  gflags支持的变量类型如下

• bool
• int32
• int64
• uint64
• double
• string c++的string

  使用的时候我们用如下语句去定义，后面的描述信息当我们在启动程序的时候 使用 - -help 时会显示相应描述的信息。

定义
DEFINE_TYPE(Var_Name,Value,DescribeInformation); 
这个是一个定义的模板 Type 指类型  Name指定的变量名  Value 指默认值 DescribeInformation指描述信息
DEFINE_bool(compress,false,"是否打开了压缩功能");
DEFINE_string(people,"man","操作对象是男人还是女人"); 
声明
DECLARE_bool(compress); 即声明compress gflags变量
...

使用gflags变量

  使用gflags变量很简单只要在定义的变量名前加 FLAGS_前缀即可。使用变量时，该变量就当中相应类型的变量操作即可，比如string类型就是c++的string类型，所以我们可以使用string的成员函数去操作它。
  或者操作SetCommandLineOption(“Varname”,”value”)去设置变量，通过这个函数设置变量会触发检测函数，检测失败时变量值不会被更新。

DEFINE_string(people,"man","操作对象");
if(FLAGS_people.find("woman") != string::npos)
       HandleWoman();
else
       HandleMan();

验证gflag变量

  我们可以定义一个函数去验证gflag变量。在启动程序的时候或者通过SetCommandLineOption函数去设置gflag变量的时候就会进行检测。如果程序启动的时候验证失败程序会启动失败会输出错误描述信息（前提是调用了ParseCommandLineFlags函数去解析命令行参数），如果调用SetCommandLineOption函数去修改gflag变量，那么会修改失败gflag变量保存原来的值。那么我们如何验证呢? 只要进行如下步骤即可:

1. 写一个相应的check函数
2. 定义一个全局bool变量，通过google::RegisterFlagValidator函数进行注册

不同类型的变量，其check函数的第二个参数不同
static bool check(const char * filename,google::int32 age)
{
      return (age > 20)? true : false;
}
DEFINE_int32(age,14,"the people age");
bool Valid = google::RegisterFlagValidator(&FLAGS_age,&check);
int main(int argc , char *argv[])
{
     google::ParseCommandLineFlags(&argc,&argv,true);
     return 0;
}

通过命令行设置gflag变量

• 非bool类型 - - varname = value
• bool 类型 - -varname / - - novarname / - -varname = true/false

   使用 - - 代表结束 gflag变量设置，然后我们可以设置一些其他的非gflag变量的命令行参数

特殊选项

• - -help 显示该可执行文件的所有flag
• - -helpfull 如上相同
• - -helpshort 只显示包含main函数文件的gflag变量
• - -helpxml 类型- -help但是输出的信息转换为xml格式
• - -helppackage 显示与包含main文件同一目录的其他相应源文件的gflag变量
• - -undefok=varname,varname2 它列出的变量名可以在源文件内定义相应变量名的情况下不输出错误信息，否则 使用 - -varname = value 设置一个未定义的varname 会报错。
• - -fromenv=varname

需要提前对varname在环境变量中进行定义，如果没有定义会报错
export FLAGS_varname = xxx; 
或者
setenv FLAGS_varname  xxx;

• - -tryfromenv=varname

该选项和上面那个选项一样，只不过如果环境变量没有进行 varname=value的设置不会报错
但是还是需要在源文件内定义过 gflag变量否则会报错

辅助函数

SetVersionString

  调用SetVersionString函数后，我们启动程序使用 ./a.out -version 的时候就会打印我们设置的这个版本信息

SetVersionString(const char * version); 

ShowUsageWithFlagsRestrict

  输出错误信息函数，常用来检测命令行参数数量是否正确。调用这个函数必须得调用SetUsageMessage进行设置错误信息，否则会打印Warning: SetUsageMessage() never called。
  第一个参数必须设置为argv[0]否则出现call dump

ShowUsageWithFlagsRestrict(argv[0], "gflags_test");

SetUsageMessage

  用户手册函数，这个函数可以输出用户手册，当参数数量函数检测发现参数数量不正确的时候，就会调用这个函数打印相应用户手册信息

SetUsageMessage(const char * usagemessage);
列子：
SetUsageMessage("Please Enter 1 2 3 4");