web-dev-qa-db-ja.com

Boostライブラリプログラムオプションを使用した必須およびオプションの引数

Boost Program Options Libraryを使用して、コマンドライン引数を解析しています。

次の要件があります。

  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++boostboost-program-optionsrequiredoptional
73
Peter Lee

私は自分でこの問題に遭遇しました。ソリューションの鍵は、関数_po::store_が_variables_map_を生成し、_po::notify_が発生したエラーを発生させるため、通知を送信する前にvmを使用できることです。

したがって、 Tim に従って、各オプションを必要に応じて必須に設定しますが、ヘルプオプションを処理した後でpo::notify(vm)を実行します。これにより、例外がスローされることなく終了します。オプションが必須に設定されているため、オプションが欠落していると _required_option_ 例外がスローされ、_get_option_name_メソッドを使用してエラーコードを比較的単純なものに減らすことができますcatchブロック。

追加の注意事項として、オプション変数はpo::value< -type- >( &var_name )メカニズムを介して直接設定されるため、vm["opt_name"].as< -type- >()を介してそれらにアクセスする必要はありません。

93
rcollyer

ここにクレジットが行くrcollyerとティムによる完全なプログラムがあります：

#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: .
*/
35
Peter Lee

オプションが十分に簡単に必要であることを指定できます[ 1 ]、例えば：

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

しかし、私の知る限り、異なるオプション間の関係をprogram_optionsライブラリに表す方法はありません。

可能性の1つは、異なるオプションセットを使用してコマンドラインを複数回解析することです。その後、「ヘルプ」をすでにチェックしている場合、必要に応じて設定された他の3つのオプションで再度解析できます。しかし、あなたが持っているものよりも改善されていると思うかどうかはわかりません。

12
Tim Sylvester
    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;
        }
    }
1
Edgard Lima