boost::parogram_options
Boost库中的 program_options用于实现命令行参数配置
program_options的组成成分
- 项描述器
- 分析器
- 存储器
|构造option_description对象和variables_map对象
|add_options()->向option_description对象添加选项
|parse_command_line()->将命令行输入的参数解析出来
|store()->将解析出的选项存储至variables_map中
|notify()->通知variables_map去更新所有的外部变量
|count()->检测某个选项是否被输入
|operator[]->取出选项的值
选项描述器
作用：定义选项及选项的值。
我们经常见到的命令行，比如 ./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); // 添加选项描述器
分析器
作用：解析命令行。
command_line_parser(argc, argv).options(cmd_options).run()
存储器
作用：把分析器分析的结果保存成程序中的变量。
variables_map vm; // 定义存储器
store( 分析器 , vm); // 存储分析结果
notify(vm); // 更新存储器 vm
vm["file"].as<std::string>() // 得到选项--file的选项值
Eg1:
//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;
}
g++ -I/usr/local/include/boost/include -L/usr/local/include/boost/lib -lboost_program_options -Wl,-rpath=/usr/local/include/boost/lib program_option.cpp
运行结果：
example --help
example options:
--help Help message
--file arg to find a file
example --file=abc.txt
find abc.txt
eg2 转自 blog
///////////////////////////////////////////
//计算橘子和苹果的总数量，可以指定多个生产地 //
//编译选项加上 -lboost_program_options //
///////////////////////////////////////////
#include <iostream>
#include <vector>
#include <string>
#include <boost/program_options.hpp>
namespace bpo = boost::program_options;
int main(int argc, char const *argv[])
{
//外部变量，用于保存获取的参数值
int apple_num = 0, orange_num = 0;
std::vector<std::string> addr;
bpo::options_description opt("all options");
opt.add_options()
//指定该参数的默认值
// "apple,a" : 指定选项的全写形式为 --apple, 简写形式为 -a
//value<type>(ptr) : ptr为该选项对应的外部变量的地址, 当该选项被解析后,
//可通过下面的notify()函数将选项的值赋给该外部变量,该变量的值会自动更新
//defaut_value(num) : num为该选项的默认值, 若命令行中未输入该选项, 则该选项的值取为num
("apple,a", bpo::value<int>(&apple_num)->default_value(10), "苹果的数量")
("orange,o", bpo::value<int>(&orange_num)->default_value(20), "橘子的数量")
//该参数的实际类型为vector,所以命令行中输入的值可以是多个,
//multitoken()的作用就是告诉编译器,该选项可接受多个值
("address", bpo::value<std::vector<std::string> >()->multitoken(), "生产地")
("help", "计算苹果和橘子的总数量");
bpo::variables_map vm;
try{
bpo::store(parse_command_line(argc, argv, opt), vm);
}
catch(...){
std::cout << "输入的参数中存在未定义的选项！\n";
return 0;
}
//参数解析完成后，通知variables_map去更新所有的外部变量
//这句话执行后, 会使得apple_num和orange_num的值自动更新为选项指定的值
bpo::notify(vm);
if(vm.count("help") ){
std::cout << opt << std::endl;
return 0;
}
if(vm.count("address") ){
std::cout << "生产地为：";
//遍历选项值
for(auto& str : vm["address"].as<std::vector<std::string> >() )
std::cout << str << " ";
std::cout << std::endl;
}
std::cout << "苹果的数量:" << apple_num << std::endl;
std::cout << "橘子的数量:" << orange_num << std::endl;
std::cout << "总数量数量:" << orange_num + apple_num << std::endl;
return 0;
}
