Обов’язкові та необов’язкові аргументи за допомогою параметрів програми Boost Library


83

Я використовую бібліотеку параметрів Boost Program для аналізу аргументів командного рядка.

У мене є такі вимоги:

  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
}

Відповіді:


103

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

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

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

Приклад коду наведено у відповіді Петерса


Спасибі за Вашу відповідь. Думаю, це працює, як очікувалося. Я також опублікував повну програму нижче для людей, яким потрібен хороший приклад.
Пітер Лі

5
Відмінне рішення! Офіційна документація повинна це чітко наводити на прикладі.
russoue

@rcollyer не могли б ви навести повний робочий приклад, будь ласка?
Йонас Штейн

@JonasStein Я міг би, але, як видається, у Пітера все в порядку. Повідомте мене, якщо цього недостатньо.
rcollyer

1
@rcollyer Веб-сайт sx візуально не пов’язує дві відповіді, тому я пропустив це. Я додав примітку. Будь ласка, поверніться, якщо вам це неприємно.
Jonas Stein

46

Ось повна програма на 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:\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

Порт повинен мати тип без підпису.
g33kz0r

2
Ви повинні зловити boost :: program_options :: помилка лише в цьому.
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
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.