c++ - 如何使用 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(请参阅文档中的 Non-conventional syntax)，即可用于在输入的标记被进一步处理之前对其进行操作的解析器。它可以用于将 --run 翻译成 --command=run 等

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

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

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

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

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()));
}

它只是简单地将输入 token 拆分为--、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 的选项需要值并且使用了 long_allow_next 样式，则 --name=--mark.twain 将被解析为具有值 --mark.twain 的选项 name(如预期的那样)，而 --name --mark.twain 将被解析为选项 name，值为 samuel.clemens。

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

希望对您有所帮助。