how to use gflags
参考https://blog.csdn.net/jcjc918/article/details/50876613
安装:
git clone https://github.com/gflags/gflags.git # 下载源码 cd gflags mkdir build && cd build # 建立文件夹 cmake .. # 使用 cmake 编译生成 Makefile 文件 make # make 编译 sudo make install # 安装库
这时 gflags 库会默认安装在 /usr/local/lib/
下,头文件放在 /usr/local/include/gflags/
中。
使用:
假设有一个程序,需要知道服务器的IP地址和端口号,在程序中有默认的指定参数,同时也希望通过命令行来指定不同的值。
#include <iostream> #include <gflags/gflags.h> DEFINE_string(host, "127.0.0.1", "the server host"); DEFINE_int32(port, 12306, "the server port"); int main(int argc, char** argv) {
//程序使用说明
google::SetUsageMessage("\nusage\n"); // 解析命令行参数,一般都放在 main 函数中开始位置 gflags::ParseCommandLineFlags(&argc, &argv, true); // 访问参数变量,加上 FLAGS_ std::cout << "The server host is: " << FLAGS_host << ", the server port is: " << FLAGS_port << std::endl; return 0; }
编译运行:
CMakeLists.txt
cmake_minimum_required(VERSION 2.8) project(gflags_test) set( CMAKE_BUILD_TYPE "Debug" ) find_package (gflags REQUIRED) include_directories (${gflags_INCLUDE_DIR}) add_executable (gflags_test gflags_test.cc) target_link_libraries (gflags_test gflags)
cmake . && make
./gflags_test #不带任何参数 The server host is: 127.0.0.1, the server port is: 12306 ./gflags_test -host 10.123.78.90 #只带 host 参数 The server host is: 10.123.78.90, the server port is: 12306 ./gflags_test -port 8008 # 只带 port 参数 The server host is: 127.0.0.1, the server port is: 8008 ./gflags_test -host 10.123.78.90 -port 8008 # host 和 port 参数 The server host is: 10.123.78.90, the server port is: 8008 ./gflags_test --host 10.123.78.90 --port 8008 # 用 -- 指定 The server host is: 10.123.78.90, the server port is: 8008 ./gflags_test --host=10.123.78.90 --port=8008 # 用 = 连接参数值 The server host is: 10.123.78.90, the server port is: 8008 ./gflags_test --help # 用 help 查看可指定的参数及参数说明 gflags_test: Warning: SetUsageMessage() never called Flags from /home/rookie/code/gflags/src/gflags.cc: .... # 略 Flags from /home/rookie/code/gflags/src/gflags_reporting.cc: ..... # 略 Flags from gflags_test.cc: #这里是我们定义的参数说明和默认值 -host (the server host) type: string default: "127.0.0.1" -port (the server port) type: int32 default: 12306
在上面我们使用了两种类型的参数,string 和 int32,gflags 一共支持 5 种类型的命令行参数定义:
- DEFINE_bool: 布尔类型
- DEFINE_int32: 32 位整数
- DEFINE_int64: 64 位整数
- DEFINE_uint64: 无符号 64 位整数
- DEFINE_double: 浮点类型 double
- DEFINE_string: C++ string 类型
如果你希望支持更复杂的结构,比如 list,你需要通过自己做一定的定义和解析,比如字符串按某个分隔符分割得到一个列表。
每一种类型的定义和使用都跟上面我们的例子相似,有所不同的是 bool 参数,bool 参数在命令行可以不指定值也可以指定值,假如我们定义了一个 bool 参数 debug_switch,可以在命令行这样指定:
./gflags_test -debug_switch # 这样就是 true ./gflags_test -debug_switch=true # 这样也是 true ./gflags_test -debug_switch=1 # 这样也是 true ./gflags_test -debug_switch=false # 0 也是 false
所有我们定义的 gflags 变量都可以通过 FLAGS_ 前缀加参数名访问,gflags 变量也可以被自由修改:
if (FLAGS_consider_made_up_languages) FLAGS_languages += ",klingon"; if (FLAGS_languages.find("finnish") != string::npos) HandleFinnish();
进阶:
定义规范
如果你想要访问在另一个文件定义的 gflags 变量呢?使用 DECLARE_
,它的作用就相当于用 extern 声明变量。为了方便的管理变量,我们推荐在 .cc 或者 .cpp 文件中 DEFINE 变量,然后只在对应 .h 中或者单元测试中 DECLARE 变量。例如,在 foo.cc 定义了一个 gflags 变量 DEFINE_string(name, 'bob', '')
,假如你需要在其他文件中使用该变量,那么在 foo.h 中声明 DECLARE_string(name)
,然后在使用该变量的文件中 include "foo.h"
就可以。当然,这只是为了更好地管理文件关联,如果你不想遵循也是可以的。
参数检查
如果你定义的 gflags 参数很重要,希望检查其值是否符合预期,那么可以定义并注册参数的值的检查函数。如果采用 static 全局变量来确保检查函数会在 main 开始时被注册,可以保证注册会在 ParseCommandLineFlags 函数之前。如果默认值检查失败,那么 ParseCommandLineFlags 将会使程序退出。如果之后使用 SetCommandLineOption() 来改变参数的值,那么检查函数也会被调用,但是如果验证失败,只会返回 false,然后参数保持原来的值,程序不会结束。看下面的程序示例:
#include <stdint.h>// 定义了 int16_t 、 uint32_t 、 int64_t 等整型,在需要确定大小的整型时可以使用它们代替 short 、 unsigned long long 等,在 C 整型中,只使用 int 。适当情况下,推 荐使用标准类型如 size_t 和 ptrdiff_t #include <stdio.h> #include <iostream> #include <gflags/gflags.h> //定义对FLAGS_port的检查函数 static bool ValidatePort(const char* name, int32_t value) { if(value > 0 && value < 32768) return true; printf("Invalid value for --%s: %d\n",name, (int)value); return false; } /** * 设置命令行参数变量 * 默认的主机地址为 127.0.0.1,变量解释为 'the server host' * 默认的端口为 12306,变量解释为 'the server port' */ DEFINE_string(host, "127.0.0.1", "the server host"); DEFINE_int32(port, 12306, "the server port"); //使用全局static变量来注册函数,static变量会在main函数开始时就调用 static const bool port_dummy = gflags::RegisterFlagValidator(&FLAGS_port, &ValidatePort); int main(int argc, char** argv) { //解析命令行参数,一般都放在main函数中开始位置 gflags::ParseCommandLineFlags(&argc, &argv, true); std::cout << "The server host is: " << FLAGS_host << ", the server port is: " <<FLAGS_port << std::endl; //使用SetCommandLineOPtion函数对参数进行设置才会调用检查函数 gflags::SetCommandLineOption("port", "-2"); std::cout << "The server host is: " << FLAGS_host << ", the server port is: " <<FLAGS_port << std::endl; return 0; }
运行:
#命令行指定非法值,程序解析参数时直接退出 ./gflags_test -port -2 Invalid value for --port: -2 ERROR: failed validation of new value '-2' for flag 'port' # 这里参数默认值合法,但是 SetCommandLineOption 指定的值不合法,程序不退出,参数保持原来的值 ./gflags_test The server host is: 127.0.0.1, the server port is: 12306 Invalid value for --port: -2 The server host is: 127.0.0.1, the server port is: 12306
使用flagfile
如果我们定义了很多参数,那么每次启动时都在命令行指定对应的参数显然是不合理的。gflags 库已经很好的解决了这个问题。你可以把 flag 参数和对应的值写在文件中,然后运行时使用 -flagfile 来指定对应的 flag 文件就好。文件中的参数定义格式与通过命令行指定是一样的。
例如
我们可以定义这样一个文件,文件后缀名没有关系,为了方便管理可以使用 server.flags:
--host=10.123.14.11 --port=23333
然后执行
./gflags_test --flagfile server.flags The server host is: 10.123.14.11, the server port is: 23333
结合到cartographer_ros里面的
roslaunch cartographer_ros demo_revo_lds.launch bag_filename:=/home/gary/cartographer_ws/bagfiles/Revo_LDS/cartographer_paper_revo_lds.bag
在node_main.cc文件里面的
DEFINE_string(configuration_directory, "",
"First directory in which configuration files are searched, "
"second is always the Cartographer installation to allow "
"including files from there.");
DEFINE_string(configuration_basename, "",
"Basename, i.e. not containing any directory prefix, of the "
"configuration file.");
CHECK(!FLAGS_configuration_directory.empty())
<< "-configuration_directory is missing.";
CHECK(!FLAGS_configuration_basename.empty())
<< "-configuration_basename is missing.";
在launch 文件里面可以看到有如下
<node name="cartographer_node" pkg="cartographer_ros"
type="cartographer_node" args="
-configuration_directory $(find cartographer_ros)/configuration_files
-configuration_basename revo_lds.lua"
output="screen">
<remap from="scan" to="horizontal_laser_2d" />
</node>