使用 boost::program_options 时，如何设置参数的名称？

Question

使用boost::program_options时，如何设置boost::program_options::value<>()的参数名称？

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

int main()
{
  boost::program_options::options_description desc;

  desc.add_options()
    ("width", boost::program_options::value<int>(),
     "Give width");

  std::cout << desc << std::endl;

  return 0;
}

以上代码给出：

  --width arg           Give width

我想要的是将 arg 名称替换为更具描述性的名称，例如 NUM：

  --width NUM           Give width

Answer 1

在 Boost 的最新版本中（仅针对 >= 1.61 进行了测试），这是完全支持的。下面对教程中的第一个示例稍作修改，其中打印“LEVEL”而不是“arg”：

po::options_description desc("Allowed options");
desc.add_options()
    ("help", "produce help message")
    ("compression", po::value<int>()->value_name("LEVEL"), "set compression level")
;

Live Example

Answer 2

program_options::value_semantic 类没有参数化参数名称，所以我认为您必须定义自己的类。像这样的：

struct my_arg_type
    : public boost::program_options::typed_value<int>
{
    my_arg_type(std::string const& name)
        : boost::program_options::typed_value<int>(&my_value)
        , my_name(name)
        , my_value(0)
    {
    }
    std::string name() const { return my_name; }
    std::string my_name;
    int my_value;
};

boost::program_options::options_description desc;

my_arg_type arg("foo");
desc.add_options()
    ("width", &arg, "give width");

这应该是这样的：

--witdh foo    give width

Answer 3

在当前版本的 boost (1.53) 中，您不再需要像 Tim Sylvester 建议的那样创建自己的类。可以使用：boost::program_options::typed_value。可以在哪个 value_name 上配置。

#include <iostream>
#include <boost/program_options.hpp>
using boost::program_options::typed_value;
using boost::program_options::options_description;

int main(int argc, char **argv) {
    options_description desc("Usage");

    int someValue;
    auto someOption = new typed_value<decltype(someValue)>(&someValue);
    someOption->value_name("NUM");
    desc.add_options()
        ("some-option,s", someOption, "The option\n");

    std::cout << desc << std::endl;
    return 0;
}

将显示配置的参数名称：

Usage:
-s [ --some-option ] NUM The option

Answer 4

可以通过全局变量将arg 替换为不同的东西 boost::program_options::arg:

boost::program_options::arg = "NUM";

但由于这是一个全局变量，当多个选项可能需要不同的参数时，它对解决问题没有多大帮助。

Answer 5

daminetreg's answer 有效，但在用于大量选项条目时可能会有点冗长。我刚刚为value<T>( T* v ) 模板编写了一个重载，以构造我的value_sematics 和一个额外的value_name：使用

template<class T>
typed_value<T>*
value(T* v, const char * value_typename)
{
    typed_value<T>* r = new typed_value<T>(v);
    r->value_name( value_typename );

    return r;        
}

您可以像这样创建和添加新的 program_option：

int width;
desc.add_options()
    ("width", boost::program_options::value<int>( &width, "NUM"),
     "Give width");

（注意：这并没有解决所有其他构造模板，尤其是 OP 想要使用的默认 value() 构造函数）

Answer 6

Codebender 提供的方法是您唯一可以使用的方法。这实际上是有意的——使用“NUM”作为参数名称似乎是不值得做的微优化。对选项的良好描述还应该说明预期的参数类型。