Loading

Boost命令行解释器的简单使用:Boost.Program_options

简介

如果使用比较多的命令行程序的话,对于命令行参数的输入肯定不会陌生,大部分的程序都是通过类似下面的形式进行输入的,比如熟悉的ls

ls --all -l --color=auto

这里面包含了三种不同的命令行输入--all-l--color=auto。如果使用一般的解决方法的话,是使用getopt.h文件中的getopt函数。其具体的教程可以看Linux下getopt()函数的简单使用,其使用方法比较麻烦。而且只支持一个字符的选项,如果要像--color=auto一样支持长选项,必须再使用getopt_long函数,而且由于其是对C进行支持的,所以在C++中使用起来也比较麻烦。

而Boost提供的Program_options库可以很好的解决这一问题。Program_options提供了一个成熟的C++库来解析命令行参数,几行简单清晰的代码就可以描绘出一个完整的命令行解析器。

而其的使用方法也是非常的简单,大致可以分为三个部分,构建解析器对象,解析命令行参数,使用结果。

使用的时候需要链接boost_program_options库

没有参数的选项

一个非常简单的例子,只定义了一个选项help,运行时会直接先打印获取到的var_mapname,然后检查是否存在help选项,如果存在则打印命令行帮助,如果不存在,就直接推出。

#include <boost/program_options.hpp>
#include <iostream>
#include <string>
#include <vector>

int main(int argc, char *argv[]) {
    boost::program_options::options_description desc("测试程序");

    desc.add_options()("help,h", "打印帮助文档");

    boost::program_options::variables_map var_map;
    boost::program_options::store(boost::program_options::parse_command_line(argc, argv, desc), var_map);
    boost::program_options::notify(var_map);

    for (auto iter : var_map) {
        std::cout << iter.first << std::endl;
    }


    if (var_map.count("help") > 0) std::cout << desc << std::endl;
    return 0;
}

编译以后运行./main_simple -h或者./main_simple --help可以得到:

help
测试程序:
  -h [ --help ]         打印帮助文档

首先是定义了一个boost::program_options::options_description对象,它可以选项列表的描述。它的构造函数可以传入一个字符串,作为打印时候的抬头。

然后是向选项列表里面添加选项,最简单的方法就是使用desc对象里面的add_options方法,它可以返回一个函数对象,借此向选项列表描述添加选项。

目前在这里的选项列表只有简单的两个参数,第一个是表明选项的name,你可以通过用分号将长选项和缩写分割开来,而最终的结果还是以长选项作为name的;第二个是对选项的描述。

然后定义了一个boost::program_options::variables_map对象,它是一个map,key元素为选项的name,value元素为Boost::any对象。

然后开始对命令行输入进行解析,首先使用boost::program_options::parse_command_line进行解析,然后使用boost::program_options::store将结果保存在var_map变量里面。

boost::program_options::notify将在后面提到。

接下来,就是对map的操作了。而如果想输出说明的话,也可以很直接的直接对desc进行cout

带参数的选项

上面我们介绍了不带参数的简单使用,但是在很多的时候,我们需要通过命令行输入一些参数。就如同最上面例子中的--color=auto一样。Boost提供了非常简单的方法来实现这一操作。

#include <vector>
#include <string>
#include <iostream>

#include <boost/program_options.hpp>

int main(int argc, char *argv[]) {
    boost::program_options::options_description desc("测试程序");

    desc.add_options()("help,h", "打印帮助文档");
    desc.add_options()("input,i", boost::program_options::value<std::string>()->default_value("Test")->value_name("string"), "输入");

    boost::program_options::variables_map var_map;
    boost::program_options::store(boost::program_options::parse_command_line(argc, argv, desc), var_map);
    boost::program_options::notify(var_map);


    if (var_map.count("help") > 0) std::cout << desc << std::endl;
    if (var_map.count("input") > 0) std::cout << var_map["input"].as<std::string>() << std::endl;
    return 0;
}

在这个程序中,增加了一行

desc.add_options()("input,i", boost::program_options::value<std::string>()->default_value("Test")->value_name("string"), "输入");

和之前的help选项类似,在这里我们增加了一个input选项,在这个添加过程中,我们向函数对象添加了3个参数,第一个和第三个参数和之前表述的一样。而第二个参数可以看作是对输入的描述。

首先我们通过boost::program_options::value构造了一个对象,在构造的过程中,需要向模板传入一个类型参数,表表明输入值的类型。然后其会构造出一个boost::program_options::type_value类型,可以通过一些方法对其进行设置。

在这一示例中,用户可以在input后面输入一个字符串,同时如果没有输入的话,会主动出现一个默认值Test,这个默认值会在没有输入的时候作为input项的默认值。

然后可以通过对var_map进行简单的操作,来获取输入的值。

输入数组

如果一个选项我们需要多次输入需要如何处理呢?比如exec.bin -i test -i test1

这一个的处理比较简单,和上面的程序相比,我们只需要将input选项的值修改为std::vector就可以了,即:

C++ desc.add_options()("input,i", boost::program_options::value<std::vector<std::string>>()->value_name("string"), "输入");

相应的,我们的输出改为

auto input_s = var_map["input"].as<std::vector<std::string>>();
for (auto inputm : input_s) {
    std::cout << inputm << std::endl;
}

如果想不用重复键入-i,而是直接在同一个输入用空格隔开不同的值,如exec.bin -i test test1,那么可以考虑为属性增加multitoken

desc.add_options()("input,i", boost::program_options::value<std::vector<std::string>>()->multitoken(), "输入");

其他杂项

很明显,Boost.Program_options的操作肯定还不止这一些,但是以上的简单操作,基本上可以覆盖大部分的使用场景了。然后还有一些使用的小细节。

报错

如果输入的选项中存在描述中没有的选项的话,就会在解析的时候产生一个异常,可以通过捕捉这一个异常,给程序一个更加合理的表现。

隐藏项

如果想给程序增加一个“后门”,只有你知道的选项,应该如何操作呢?

其实很简单,建立两个options_description就好了,一个用来显示,一个用来解析。这样就不会在显示的时候,显示需要隐藏的项了。

posted @ 2020-11-20 17:11  ink19  阅读(1438)  评论(0编辑  收藏  举报