Обязательные и необязательные аргументы с использованием параметров программы Boost Library
Я использую библиотеку параметров программы Boost для анализа аргументов командной строки.
У меня следующие требования:
- После предоставления "помощи" все остальные опции являются необязательными;
- Когда "помощь" не предоставляется, требуются все остальные параметры.
Как я могу справиться с этим? Вот мой код, обрабатывающий это, и я нашел его очень избыточным, и я думаю, что должно быть легко сделать, правильно?
#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
}
Ответы
Ответ 1
Я сам столкнулся с этой проблемой. Ключом к решению является то, что функция 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- >().
Ответ 2
Вот полная программа в соответствии с 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: .
*/
Ответ 3
Вы можете указать, что опция требуется достаточно легко [1], например:
..., value<string>()->required(), ...
но насколько я знаю, нет способа представить отношения между различными опциями в библиотеке program_options.
Одна из возможностей состоит в том, чтобы разыгрывать командную строку несколько раз с разными наборами параметров, а затем, если вы уже проверили "помощь", вы можете снова проанализировать три других параметра, которые все установлены по мере необходимости. Я не уверен, что считаю, что улучшение по сравнению с тем, что у вас есть.
Ответ 4
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;
}
}
