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

Question

我希望能够使用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”。

感谢您的任何帮助 ！

Answer 1

您可以使用extra_parser （请参阅文档中的非常规语法），即可用于在进一步处理输入之前操作标记的解析器。 它可用于将--run翻译成--command=run等。

Extra parser 是一个具有以下签名的函子：

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)则返回(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和--samuel.clemens都将指向vars["samuel.clemens"]并且--lewis.caroll和--charles.dodgson都将指向vars["charles.dodgson"] 。

注意事项：

• 仅适用于命令行解析器。
• 需要allow_long样式（带有--前缀的长选项）。 可以在代码中更改。
• 需要long_allow_adjacent样式（使用=在一个令牌中允许的值）。 也可以在代码中更改。

• 如果有任何解析为--alias非选项标记，那么它也会被翻译，因为没有上下文。 没有办法规避。

  示例：如果有一个名称为name的选项需要 value 并且使用了long_allow_next样式，则--name=--mark.twain将被解析为带有 value --mark.twain (如预期) 的选项name ，而--name --mark.twain将被解析为值为samuel.clemens选项name 。

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

希望能帮助到你。

Answer 2

您是否尝试过使用po::value<...>(&variable) ？ 选项的值在解析后直接保存到变量中。 然后，您可以添加两个选项--input和--inputs指向同一变量。 此外，您可能必须检查是否仅使用了两个选项之一，否则，将显示错误消息。

我希望我已经正确理解了你的问题。

Answer 3

默认情况下 boost::program_options 允许长选项的前缀匹配该选项。 所以，你所编写的代码都已经接受--input为的别名--inputs 。