Обязательные и необязательные аргументы с использованием параметров программы библиотеки 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 
— Питер Ли
источник

Ответы:

103

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

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

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

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

— rcollyer
источник
Спасибо за ваш ответ. Думаю, все работает как положено. Я также разместил полную программу ниже для людей, которым нужен хороший пример.
— Питер Ли
5
Отличное решение! Официальная документация должна пояснять это на примере.
— russoue
@rcollyer, не могли бы вы предоставить полный рабочий пример?
— Йонас Штайн
@JonasStein Я мог бы, но у Питера все в порядке. Сообщите мне, если этого недостаточно.
— 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: .
*/
— Питер Ли
источник
3
Вы должны уловить, boost::program_options::required_optionчтобы вы могли справиться с отсутствием требуемой опции напрямую, вместо того, чтобы ее ловить std::exception.
— rcollyer 01
Порт должен быть беззнакового типа.
— g33kz0r 01
2
Вы должны поймать boost :: program_options :: error только здесь.
— CreativeMind
13

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

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

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

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

— Тим Сильвестр
источник
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;
        }
    }
— Эдгард Лима
источник
Это, безусловно, интересная альтернатива. Но он заставляет вас повторять код обработки справки, и, хотя он небольшой, я бы старался избегать его.
— rcollyer 02
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.