Arguments obligatoires et facultatifs à l'aide des options du programme Boost Library
J'utilise Boost Program Options Library pour analyser les arguments de la ligne de commande.
J'ai les exigences suivantes:
- Une fois que "l'aide" est fournie, toutes les autres options sont facultatives;
- Une fois que "l'aide" n'est pas fournie, toutes les autres options sont requises.
Comment puis-je y faire face? Voici mon code qui gère cela, et j'ai trouvé que c'était très redondant, et je pense qu'il doit y avoir un moyen facile à faire, non?
#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
}
J'ai rencontré ce problème moi-même. La clé d'une solution est que la fonction po::store Remplit le variables_map Tandis que po::notify Soulève toutes les erreurs rencontrées, donc vm peut être utilisé avant toute notification. envoyé.
Ainsi, selon Tim , définissez chaque option sur requis, comme vous le souhaitez, mais exécutez po::notify(vm) après avoir traité l'option d'aide. De cette façon, il se fermera sans aucune exception levée. Maintenant, avec les options définies sur required, une option manquante provoquera une exception required_option et en utilisant sa méthode get_option_name Vous pouvez réduire votre code d'erreur à un bloc catch relativement simple.
De plus, vos variables d'options sont définies directement via le mécanisme po::value< -type- >( &var_name ), vous n'avez donc pas besoin d'y accéder via vm["opt_name"].as< -type- >().
Voici le programme complet selon rcollyer et Tim, à qui les crédits vont:
#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: .
*/
Vous pouvez spécifier qu'une option est requise assez facilement [ 1 ], par exemple:
..., value<string>()->required(), ...
mais pour autant que je sache, il n'y a aucun moyen de représenter les relations entre les différentes options de la bibliothèque program_options.
Une possibilité consiste à analyser la ligne de commande plusieurs fois avec différents jeux d'options, puis si vous avez déjà vérifié "aide", vous pouvez à nouveau analyser avec les trois autres options toutes définies comme requis. Je ne suis pas sûr que je considérerais cela comme une amélioration par rapport à ce que vous avez, cependant.
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;
}
}