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

【问题标题】：How to create option aliases with boost::program_options?如何使用 boost::program_options 创建选项别名？
【发布时间】：2017-02-06 10:23:02
【问题描述】：

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

感谢您的帮助！

【问题讨论】：

我想我想你必须在商店/通知后进行手动检查。
嗯，不方便。我希望像 python 的 argparse 中的 target 选项一样简单...谢谢。

标签： c++ c++11 boost boost-program-options

【解决方案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）可以为空 - 只有选项名称已被解析。如果返回的对有效，则使用名称或名称/值对，而不是通过普通机器解析原始令牌。

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

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（如果没有= 符号则没有值），如果在提供的别名映射中找到名称，则返回@ 987654336@.

然后，我们使用 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...）

您可以将此解析器插入命令行解析器：

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 将被解析为选项 name，其值为 --mark.twain（如预期）而 --name --mark.twain将被解析为选项name，值为samuel.clemens。

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

希望对你有帮助。

【讨论】：

【解决方案2】：

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

希望我正确理解了您的问题。

【讨论】：

感谢您的建议。然而 variables_map 在代码中的许多地方都被抛出，所以你的解决方案对我来说并不是真的有用。但是，如果我重构代码，我可能会使用它。

【解决方案3】：

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

【讨论】：