引言
命令行参数配置是一个很重要的功能,因为它能帮助用户更加方便的与程序参数进行交互,而且易于编写脚本文件来控制程序。我想大家都不愿意修改几个参数,还得打开Visual Studio或者源代码去修改参数然后再重新编译这么麻烦吧 :(
Boost库中的 program_options
可以很方便的形成命令行参数配置,下面是一个30分钟,快速掌握 program_options 的教程。
program_options的组成成分
program_options库由三个部分构成:1.选项描述器;2.分析器;3. 存储器。
Part 1 选项描述器
作用:定义选项及选项的值。
我们经常见到的命令行,比如 ./demo --help
中--help
就是一个选项,它的值是空的。对这个选项进行描述的部分就叫选项描述器。
常用语句:
options_description T; // 定义选项描述器
T.add_option()("help,h", "Help message"); // 添加选项
T.add_option()("file,f", value<string>(), "to find a file"); // 添加选项
T.add(T1).add(T2); // 添加选项描述器
Part 2 分析器
作用:解析命令行。
常用语句:
command_line_parser(argc, argv).options(cmd_options).run()
Part 3 存储器
作用:把分析器分析的结果保存成程序中的变量。
常用语句:
variables_map vm; // 定义存储器
store( 分析器 , vm); // 存储分析结果
notify(vm); // 更新存储器 vm
vm["file"].as<std::string>() // 得到选项--file的选项值
举个例子:
//example.cpp
#include <iostream>
#include "boost\program_options.hpp"
using namespace boost::program_options;
int main(int argc, char** argv)
{
options_description opts; // <--- 选项描述器
opts.add_options()("help", "Help message"); // <--- 添加选项
options_description fileopts; // <--- 选项描述器
fileopts.add_options()("file", value<std::string>(), "to find a file"); // <--- 添加选项
options_description cmd_options; // <--- 选项描述器
cmd_options.add(opts).add(fileopts); // <--- 添加选项描述器
variables_map vm; // <--- 定义存储器
store(command_line_parser(argc, argv).options(cmd_options).run(), vm);
// <--- (1) store: 存储分析结果 (2) command_line_parser: 分析器
notify(vm); // <--- 更新存储器 vm
if (vm.count("help")) { // 如果在存储器中找到选项 help,则输出所有选项列表
std::cerr << cmd_options << std::endl;
return 1;
}
if (vm.count("file")) { // 如果在存储器中找到选项 file,则输出 file 的文件名
std::cout << "find " << vm["file"].as<std::string>() << std::endl;
}
return 0;
}
比如用 Visual Studio IDE 来运行
- 新建一个项目 New > Project
- 选择win32控制台 Visual C++ > Win32
- 建立一个名为 “example” 的项目
- 在项目属性 Properties 中添加包含目录 Configuration Properties > C/C++ > General > Additional Include Directories,例如 D:\Program Files\boost\boost_1_62_0
- 更改配置 将 Configuration Properties > C/C++ > Precompiled Headers 从 Use Precompiled Header (/Yu) 改为 Not Using Precompiled Headers。
- 添加库目录 Configuration Properties > Linker > Additional Library Directories,例如 D:\Program Files\boost\boost_1_62_0\stage\lib
- 将写好的
example.cpp
添加到项目的源文件中 - 最后 build example,再 bulid solution
- 打开 DOS 命令行,修改当前目录为
example.exe
所在的 Debug 文件夹
运行结果:
example --help
example options:
--help Help message
--file arg to find a file
example --file=abc.txt
find abc.txt
亲自跑一遍这个程序,您就学会了 :)
参考文献:
[1] 罗剑锋 《Boost 程序库完全开发指南(第3版)》 2015. P428-445