如何使用 boost::program_options 创建选项别名?

2024-01-19

我希望能够创建选项别名boost::program_options将它们的参数存储在相同的键/标签下。

我的软件的架构根据值使用不同的专用选项解析器argv[1]。然而,有些选项是共享的,比如我的选项--inputs.

inputOptions.add_options()
        ("--inputs",
         po::value< std::vector<std::string> >()->value_name("paths"),
         "List of files to edit.\n");

为了与旧版本的程序兼容,我想向子解析器之一添加兼容性选项--input将其参数存储在“--inputs”下。理想情况下,该选项最多应采用一个参数,而不是任意多个。但是,如果您提供一个解决方案,使--input相同--inputs,我想这也很好,因为在这种情况下,位置选项无论如何都会发送到“--inputs”。

感谢您的任何帮助 !


您可以使用extra_parser(see 非常规语法 https://www.boost.org/doc/libs/1_73_0/doc/html/program_options/howto.html#id-1.3.31.6.3在文档中),即解析器可用于在进一步处理输入之前操纵输入中的标记。它可以用于诸如翻译之类的事情--run into --command=run etc.

额外的解析器是一个具有以下签名的函子:

std::pair<std::string, std::string>(const std::string &s)

它应该返回选项名称pair::first和(可选)选项值pair::second. Empty pair::first意味着额外的解析器还没有解析任何东西。值(即pair::second) 可以为空 - 仅解析选项名称。如果返回的对有效,则使用名称或名称/值对,而不是通过正常机器解析原始标记。

首先,我们编写别名函数:

using OptionAliases = std::map<std::string, std::string>;

std::pair<std::string, std::string>
renameOptions(const std::string &token, const OptionAliases &aliases)
{
    auto rtoken(boost::make_iterator_range(token));

    // consume "--" prefix
    if (!boost::algorithm::starts_with(rtoken, "--")) { return { "", "" }; }
    rtoken.advance_begin(2);

    // find equal sign (returns iterator range)
    const auto eq(boost::algorithm::find_first(rtoken, "="));

    // extract option (between "--prefix" and "="/end()) and map it to output
    const auto faliases(aliases.find(std::string(rtoken.begin(), eq.begin())));
    if (faliases == aliases.end()) { return { "", "" }; }

    // return remapped option and (optionally) value after "="
    return std::make_pair(faliases->second
                          , std::string(eq.end(), rtoken.end()));
}

它只是将输入令牌分成--, name, =, value(如果没有则没有价值=符号),如果在提供的别名映射中找到该名称,则返回(remapped-name, value).

然后,我们使用 lambda 创建解析器本身:

boost::program_options::ext_parser optionAlias(OptionAliases &&aliases)
{
    return [aliases{std::move(aliases)}](const std::string &token)
    {
        return renameOptions(token, aliases);
    };
}

(至少需要 C++14,对于 C++11 更改为return [aliases](con...)

您可以将此解析器插入到 cmdline 解析器中:

parser.extra_parser(optionAlias({{"mark.twain", "samuel.clemens"}
                                  , {"lewis.caroll", "charles.dodgson"}}));

现在,在上面的例子中,两者--mark.twain and --samuel.clemens将指向vars["samuel.clemens"]以及两者--lewis.caroll and --charles.dodgson将指向vars["charles.dodgson"].

Caveats:

  • 仅适用于命令行解析器。
  • Expects allow_long风格(长选项与--字首)。可以在代码中更改。
  • Expects long_allow_adjacent样式(一个标记中允许使用的值=)。也可以在代码中更改。
  • 如果有任何非选项标记解析为--alias然后它也会被翻译,因为没有上下文。没有办法规避。

    示例:如果有一个带有名称的选项name期望价值和long_allow_next使用样式,然后--name=--mark.twain将被解析为选项name有价值--mark.twain(如预期)同时--name --mark.twain将被解析为选项name有价值samuel.clemens.

    除此之外,它按预期工作。

希望能帮助到你。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

如何使用 boost::program_options 创建选项别名? 的相关文章

随机推荐