c++ - 如何为 boost::program_options 的位置选项添加描述？

Question

我想用 boost_program_options 创建一个位置列表程序选项，不允许命名程序选项(如 --files)。

我有以下代码片段:

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

namespace po = boost::program_options;

int main(int argc, const char* argv[]) {
  po::options_description desc("Allowed options");
  desc.add_options()("help", "produce help message")
  ( "files", po::value<std::vector<std::string>>()->required(), "list of files");

  po::positional_options_description pos;
  pos.add("files", -1);

  po::variables_map vm;
  try {
    po::store(po::command_line_parser(argc, argv).options(desc).positional(pos).run(), vm);
    po::notify(vm);
  } catch(const po::error& e) {
    std::cerr << "Couldn't parse command line arguments properly:\n";
    std::cerr << e.what() << '\n' << '\n';
    std::cerr << desc << '\n';
    return 1;
  }

  if(vm.count("help") || !vm.count("files")) {
    std::cout << desc << "\n";
    return 1;
  }
}

问题是我可以读取文件列表作为位置参数列表，如下所示:

./a.out file1 file2 file3

但不幸的是也喜欢这个(我想禁用它)

./a.out --files file1 file2 file3

问题还在于产生的帮助:

./a.out
Couldn't parse command line arguments properly:
the option '--files' is required but missing

Allowed options:
  --help                produce help message
  --files arg           list of files

所以我想要的场景更像是(类似):

./a.out
Couldn't parse command line arguments properly:
[FILES ...] is required but missing

Allowed options:
  --help                produce help message
  --optionx             some random option used in future
  [FILE ...]            list of files

在我从 desc.add_option()(...) 中删除 files 选项后，它停止工作，所以我相信我需要它。

Answer 1

关于标题中提出的问题，“如何为 boost::program_options 的位置选项添加描述？”，有 no functionality图书馆为此提供。您需要自己处理该部分。

至于问题的正文......这是可能的，但以一种稍微迂回的方式。

位置选项将每个位置映射到一个名称，名称需要存在。从我在代码 ( cmdline.cpp ) 中得知的情况来看，不会为位置参数设置 unregistered 标志。 [ 1 ], [ 2 ]

所以，为了做你想做的，我们可以做以下事情:

• 在帮助中隐藏 --files 选项。您需要自己为位置选项显示适当的帮助，但这与以前没有什么不同。
• 在 variables_map 的已解析选项的解析和存储之间添加我们自己的验证。

从帮助中隐藏--files

在这里我们利用了我们可以创建复合 options_description 的事实使用 add(...)成员函数:

po::options_description desc_1;
// ...
po::options_description desc_2;
// ...
po::options_description desc_composite;
desc_composite.add(desc_1).add(desc_2);

因此，我们可以将 files 选项放入隐藏的 options_description 中，并创建一个仅用于解析阶段的组合。 (见下面的代码)

防止显式--files

我们需要在解析选项列表和将它们存储到 variables_map 之间拦截选项列表。

command_line_parser 的run() 方法返回basic_parsed_options 的一个实例，其成员 options 包含 basic_option 的 vector 秒。每个解析参数都有一个元素，任何位置选项都从 0 开始枚举，任何非位置选项的位置都是 -1。当我们将 --files 视为显式(非位置)参数时，我们可以使用它来执行我们自己的验证并引发错误。

示例源代码

See on Coliru

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

namespace po = boost::program_options;

int main(int argc, const char* argv[])
{
    std::vector<std::string> file_names;

    po::options_description desc("Allowed options");
    desc.add_options()
        ("help", "produce help message")
        ("test", "test option");

    std::string const FILES_KEY("files");

    // Hide the `files` options in a separate description
    po::options_description desc_hidden("Hidden options");
    desc_hidden.add_options()
        (FILES_KEY.c_str(), po::value(&file_names)->required(), "list of files");

    // This description is used for parsing and validation
    po::options_description cmdline_options;
    cmdline_options.add(desc).add(desc_hidden);

    // And this one to display help
    po::options_description visible_options;
    visible_options.add(desc);

    po::positional_options_description pos;
    pos.add(FILES_KEY.c_str(), -1);

    po::variables_map vm;
    try {
        // Only parse the options, so we can catch the explicit `--files`
        auto parsed = po::command_line_parser(argc, argv)
            .options(cmdline_options)
            .positional(pos)
            .run();

        // Make sure there were no non-positional `files` options
        for (auto const& opt : parsed.options) {
            if ((opt.position_key == -1) && (opt.string_key == FILES_KEY)) {
                throw po::unknown_option(FILES_KEY);
            }
        }

        po::store(parsed, vm);
        po::notify(vm);
    } catch(const po::error& e) {
        std::cerr << "Couldn't parse command line arguments properly:\n";
        std::cerr << e.what() << '\n' << '\n';
        std::cerr << visible_options << '\n';
        return 1;
    }

    if (vm.count("help") || !vm.count("files")) {
        std::cout << desc << "\n";
        return 1;
    }

    if (!file_names.empty()) {
        std::cout << "Files: \n";
        for (auto const& file_name : file_names) {
            std::cout << " * " << file_name << "\n";
        }
    }
}

测试输出

有效选项:

>example a b c --test d e
Files:
 * a
 * b
 * c
 * d
 * e

无效选项:

>example a b c --files d e
Couldn't parse command line arguments properly:
unrecognised option 'files'


Allowed options:
  --help                 produce help message
  --test                 test option