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

时间:2011-03-22 17:37:57

标签: c++ boost boost-program-options required optional

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

我有以下要求:

  1. 提供“帮助”后,所有其他选项都是可选的;
  2. 如果未提供“帮助”,则需要所有其他选项。
  3. 我该如何处理?这是我处理这个问题的代码,我发现它非常多余,而且我认为必须有一个容易做的,对吧?

    #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
    }
    

4 个答案:

答案 0 :(得分:91)

我自己也遇到过这个问题。解决方案的关键是函数po::store填充variables_map,而po::notify会引发遇到的任何错误,因此可以在发送任何通知之前使用vm

因此,根据Tim,根据需要将每个选项设置为必需,但在处理完帮助选项后运行po::notify(vm)。这样它就会退出而不会抛出任何异常。现在,将选项设置为required,缺少选项将导致抛出required_option异常并使用其get_option_name方法将错误代码减少到相对简单的catch块。

作为补充说明,您的选项变量是通过po::value< -type- >( &var_name )机制直接设置的,因此您无需通过vm["opt_name"].as< -type- >()访问它们。

答案 1 :(得分:35)

按照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:\Documents and Settings\plee\My Documents\Visual Studio 2010\Projects\VCLearning\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:\Documents and Settings\plee\My Documents\Visual Studio 2010\Projects\VCLearning\Debug>boost.exe
Error: missing required option config

C:\Documents and Settings\plee\My Documents\Visual Studio 2010\Projects\VCLearning\Debug>boost.exe --host localhost
Error: missing required option config

C:\Documents and Settings\plee\My Documents\Visual Studio 2010\Projects\VCLearning\Debug>boost.exe --config .
Error: missing required option host

C:\Documents and Settings\plee\My Documents\Visual Studio 2010\Projects\VCLearning\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:\Documents and Settings\plee\My Documents\Visual Studio 2010\Projects\VCLearning\Debug>boost.exe --host 127.0.0.1 --port 31528 --config .
host:   127.0.0.1
port:   31528
config: .

C:\Documents and Settings\plee\My Documents\Visual Studio 2010\Projects\VCLearning\Debug>boost.exe -h 127.0.0.1 -p 31528 -c .
host:   127.0.0.1
port:   31528
config: .
*/

答案 2 :(得分:12)

您可以轻松指定一个选项[1],例如:

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

但据我所知,没有办法表示program_options库的不同选项之间的关系。

一种可能性是使用不同的选项集多次解析命令行,然后如果您已经检查过“帮助”,则可以再次使用所有根据需要设置的其他选项进行解析。不过,我不确定我会认为这比你的改进还要好。

答案 3 :(得分: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;
        }
    }