使用Boost库程序选项的必需参数和可选参数

83

我正在使用Boost程序选项库来解析命令行参数。

我有以下要求：

  1. 一旦提供了“帮助”，所有其他选项都是可选的。
  2. 一旦不提供“帮助”，则所有其他选项都是必需的。

我该如何处理？这是我处理此问题的代码，我发现它非常多余，我认为必须很容易做到，对吗？

#include <boost/program_options.hpp>
#include <iostream>
#include <sstream>
namespace po = boost::program_options;

bool process_command_line(int argc, char** argv,
                          std::string& host,
                          std::string& port,
                          std::string& configDir)
{
    int iport;

    try
    {
        po::options_description desc("Program Usage", 1024, 512);
        desc.add_options()
          ("help",     "produce help message")
          ("host,h",   po::value<std::string>(&host),      "set the host server")
          ("port,p",   po::value<int>(&iport),             "set the server port")
          ("config,c", po::value<std::string>(&configDir), "set the config path")
        ;

        po::variables_map vm;
        po::store(po::parse_command_line(argc, argv, desc), vm);
        po::notify(vm);

        if (vm.count("help"))
        {
            std::cout << desc << "\n";
            return false;
        }

        // There must be an easy way to handle the relationship between the
        // option "help" and "host"-"port"-"config"
        if (vm.count("host"))
        {
            std::cout << "host:   " << vm["host"].as<std::string>() << "\n";
        }
        else
        {
            std::cout << "\"host\" is required!" << "\n";
            return false;
        }

        if (vm.count("port"))
        {
            std::cout << "port:   " << vm["port"].as<int>() << "\n";
        }
        else
        {
            std::cout << "\"port\" is required!" << "\n";
            return false;
        }

        if (vm.count("config"))
        {
            std::cout << "config: " << vm["config"].as<std::string>() << "\n";
        }
        else
        {
            std::cout << "\"config\" is required!" << "\n";
            return false;
        }
    }
    catch(std::exception& e)
    {
        std::cerr << "Error: " << e.what() << "\n";
        return false;
    }
    catch(...)
    {
        std::cerr << "Unknown error!" << "\n";
        return false;
    }

    std::stringstream ss;
    ss << iport;
    port = ss.str();

    return true;
}

int main(int argc, char** argv)
{
  std::string host;
  std::string port;
  std::string configDir;

  bool result = process_command_line(argc, argv, host, port, configDir);
  if (!result)
      return 1;

  // Do the main routine here
}
c++  boost  boost-program-options  required  optional 
— 彼得·李
source

Answers:

103

我本人已经遇到了这个问题。解决方案的关键是该函数po::store填充variables_mapwhilepo::notify会引发遇到的任何错误，因此vm可以在发送任何通知之前使用它。

因此，按照Tim的要求，将每个选项均按需设置为必选，但po::notify(vm) 要在处理了帮助选项后才能运行。这样，它将退出而不会引发任何异常。现在，将选项设置为必需，缺少的选项将导致引发required_option异常，并且使用其get_option_name方法可以将错误代码减少为相对简单的catch块。

另外要注意的是，您的选项变量是通过该po::value< -type- >( &var_name )机制直接设置的，因此您不必通过进行访问vm["opt_name"].as< -type- >()。

Peters答案中提供了一个代码示例

— olly
source
感谢您的回复。我认为它工作正常。我还在下面为需要良好榜样的人们发布了完整的程序。
— 彼得·李
5
优秀的解决方案！官方文档应通过示例使其清楚。
— russoue 2014年
@rcollyer您能提供一个完整的工作示例吗？
— 乔纳斯·斯坦
@JonasStein我可以，但是Peter的情况还不错。让我知道是否足够。
— rcollyer
1
@rcollyer sx网站无法直观地将两个答案联系起来，因此我错过了。我加了一条纸条。如果您不满意，请还原。
— 乔纳斯·斯坦
46

根据rcollyer和Tim的介绍，这是完整的程序，功劳归于：

#include <boost/program_options.hpp>
#include <iostream>
#include <sstream>
namespace po = boost::program_options;

bool process_command_line(int argc, char** argv,
                          std::string& host,
                          std::string& port,
                          std::string& configDir)
{
    int iport;

    try
    {
        po::options_description desc("Program Usage", 1024, 512);
        desc.add_options()
          ("help",     "produce help message")
          ("host,h",   po::value<std::string>(&host)->required(),      "set the host server")
          ("port,p",   po::value<int>(&iport)->required(),             "set the server port")
          ("config,c", po::value<std::string>(&configDir)->required(), "set the config path")
        ;

        po::variables_map vm;
        po::store(po::parse_command_line(argc, argv, desc), vm);

        if (vm.count("help"))
        {
            std::cout << desc << "\n";
            return false;
        }

        // There must be an easy way to handle the relationship between the
        // option "help" and "host"-"port"-"config"
        // Yes, the magic is putting the po::notify after "help" option check
        po::notify(vm);
    }
    catch(std::exception& e)
    {
        std::cerr << "Error: " << e.what() << "\n";
        return false;
    }
    catch(...)
    {
        std::cerr << "Unknown error!" << "\n";
        return false;
    }

    std::stringstream ss;
    ss << iport;
    port = ss.str();

    return true;
}

int main(int argc, char** argv)
{
  std::string host;
  std::string port;
  std::string configDir;

  bool result = process_command_line(argc, argv, host, port, configDir);
  if (!result)
      return 1;

  // else
  std::cout << "host:\t"   << host      << "\n";
  std::cout << "port:\t"   << port      << "\n";
  std::cout << "config:\t" << configDir << "\n";

  // Do the main routine here
}

/* Sample output:

C:\Debug>boost.exe --help
Program Usage:
  --help                produce help message
  -h [ --host ] arg     set the host server
  -p [ --port ] arg     set the server port
  -c [ --config ] arg   set the config path


C:\Debug>boost.exe
Error: missing required option config

C:\Debug>boost.exe --host localhost
Error: missing required option config

C:\Debug>boost.exe --config .
Error: missing required option host

C:\Debug>boost.exe --config . --help
Program Usage:
  --help                produce help message
  -h [ --host ] arg     set the host server
  -p [ --port ] arg     set the server port
  -c [ --config ] arg   set the config path


C:\Debug>boost.exe --host 127.0.0.1 --port 31528 --config .
host:   127.0.0.1
port:   31528
config: .

C:\Debug>boost.exe -h 127.0.0.1 -p 31528 -c .
host:   127.0.0.1
port:   31528
config: .
*/
— 彼得·李
source
3
您应该抓住，boost::program_options::required_option以便您可以直接处理缺少必需选项的问题，而不必被抓住std::exception。
— rcollyer 2011年
端口应为无符号类型。
— g33kz0r 2011年
2
您应该只捕获boost :: program_options :: error。
— CreativeMind
13

您可以指定足够容易地需要一个选项[ 1 ]，例如：

..., value<string>()->required(), ...

但据我所知，无法代表program_options库的不同选项之间的关系。

一种可能性是使用不同的选项集多次分析命令行，然后，如果您已经检查了“帮助”，则可以使用所有其他三个按需设置的选项再次进行解析。不过，我不确定是否会考虑对您的现有功能进行改进。

— 蒂姆·西尔维斯特
source
2
是的，对，我可以放进去->required()，但是用户无法获得帮助信息--help（不提供所有其他必需的选项），因为需要其他选项。
— 彼得·李
@Peter您只会在第一次时寻求帮助，其他选项甚至不在列表中。然后，如果他们没有传递帮助选项，则只有这样，您才可以再次运行解析，这次传递其他三个选项（设置为必填而不是没有帮助）。这种方法可能需要第三组选项，将所有选项组合在一起才能用于打印使用情况信息。我很确定它会起作用，但是rcollyer的方法更干净。
— 蒂姆·西尔维斯特
1 
    std::string conn_mngr_id;
    std::string conn_mngr_channel;
    int32_t priority;
    int32_t timeout;

    boost::program_options::options_description p_opts_desc("Program options");
    boost::program_options::variables_map p_opts_vm;

    try {

        p_opts_desc.add_options()
            ("help,h", "produce help message")
            ("id,i", boost::program_options::value<std::string>(&conn_mngr_id)->required(), "Id used to connect to ConnectionManager")
            ("channel,c", boost::program_options::value<std::string>(&conn_mngr_channel)->required(), "Channel to attach with ConnectionManager")
            ("priority,p", boost::program_options::value<int>(&priority)->default_value(1), "Channel to attach with ConnectionManager")
            ("timeout,t", boost::program_options::value<int>(&timeout)->default_value(15000), "Channel to attach with ConnectionManager")
        ;

        boost::program_options::store(boost::program_options::parse_command_line(argc, argv, p_opts_desc), p_opts_vm);

        boost::program_options::notify(p_opts_vm);

        if (p_opts_vm.count("help")) {
            std::cout << p_opts_desc << std::endl;
            return 1;
        }

    } catch (const boost::program_options::required_option & e) {
        if (p_opts_vm.count("help")) {
            std::cout << p_opts_desc << std::endl;
            return 1;
        } else {
            throw e;
        }
    }
— 埃德加德·利马
source
当然，这是一个有趣的选择。但是，它迫使您重复帮助处理代码，尽管很小，但我还是倾向于避免使用它。
— rcollyer
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.