Обязательные и необязательные аргументы с использованием опций программы Boost Library

Я использую библиотеку параметров программы 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
}

person Peter Lee    schedule 22.03.2011    source источник


Ответы (4)


Я сам столкнулся с этой проблемой. Ключом к решению является то, что функция po::store заполняет variables_map, а po::notify вызывает любые обнаруженные ошибки, поэтому vm можно использовать до отправки каких-либо уведомлений.

Итак, согласно Тиму, установите для каждой опции значение required, но запустите po::notify(vm) после того, как разберетесь с опцией справки. Таким образом, он выйдет без каких-либо исключений. Теперь, когда параметры установлены как обязательные, отсутствующий параметр вызовет required_option, и с помощью его метода get_option_name вы можете уменьшить код ошибки до относительно простого блока catch.

В качестве дополнительного примечания, ваши переменные опций устанавливаются непосредственно через механизм po::value< -type- >( &var_name ), поэтому вам не нужно обращаться к ним через vm["opt_name"].as< -type- >().

Пример кода приведен в ответе Питера.

person rcollyer    schedule 01.04.2011
comment
Спасибо за ответ. Я думаю, что это работает так, как ожидалось. Я также разместил полную программу ниже для людей, которым нужен хороший пример. - person Peter Lee; 02.04.2011
comment
Отличное решение! Официальная документация должна прояснить это на примере. - person russoue; 02.05.2014
comment
@rcollyer, не могли бы вы привести полный рабочий пример, пожалуйста? - person Jonas Stein; 07.12.2019
comment
@JonasStein Я мог бы, но у Peter все в порядке. Дайте мне знать, если этого недостаточно. - person rcollyer; 08.12.2019
comment
@rcollyer Веб-сайт sx визуально не связывает два ответа, поэтому я пропустил это. Я добавил примечание. Пожалуйста, верните, если вас это не устраивает. - person Jonas Stein; 08.12.2019

Вот полная программа, написанная Ркольером и Тимом, авторство которых принадлежит:

#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: .
*/
person Peter Lee    schedule 01.04.2011
comment
Вы должны поймать boost::program_options::required_option, чтобы вы могли напрямую обрабатывать отсутствие требуемой опции, а не std::exception. - person rcollyer; 02.04.2011
comment
Порт должен быть типа unsigned. - person ; 01.06.2011
comment
Вы должны поймать boost::program_options::error только в этом случае. - person CreativeMind; 01.08.2014

Вы можете достаточно легко указать, что опция требуется [1], например:

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

но, насколько я знаю, нет способа представить отношения между различными опциями в библиотеке program_options.

Одна из возможностей состоит в том, чтобы проанализировать командную строку несколько раз с разными наборами параметров, а затем, если вы уже отметили «помощь», вы можете снова выполнить анализ с тремя другими параметрами, установленными по мере необходимости. Я не уверен, что считаю это улучшением по сравнению с тем, что у вас есть.

person Tim Sylvester    schedule 01.04.2011
comment
да, вы правы, я мог бы указать ->required(), но тогда пользователь не может получить справочную информацию с помощью --help (без предоставления всех других необходимых параметров), потому что требуются другие параметры. - person Peter Lee; 01.04.2011
comment
@Peter В первый раз вы бы искали только помощь, других вариантов даже не было бы в списке. Затем, если они не передают параметр справки, только тогда вы снова запускаете синтаксический анализ, на этот раз передавая другие три параметра, установленные как обязательные, и не помощь. Этот подход, вероятно, потребует третьего набора опций, в котором все они объединены, для использования для печати информации об использовании. Я почти уверен, что это сработает, но подход rcollyer чище. - person Tim Sylvester; 02.04.2011

person    schedule
comment
Это, безусловно, интересная альтернатива. Но это заставляет вас повторять код обработки справки, и, хотя он небольшой, я бы старался его избегать. - person rcollyer; 02.03.2017