How to get better error messages in Boost program options
In the code below, I used program options to read parameters from command-line or file. In addition, options can be set programatically at runtime through ConfigProxy::setConfig
po::options_description desc("Allowed options");
desc.add_options()
...
("compression", po::value<int>(), "set compression level");
po::variables_map vm;
class ConfigProxy
{
template< typename T>
void setConfig( const std::string key, const T value ){
... // check if the key exists in variable map "vm"
// key exists, set the value
runtimeConfig[key] = po::variable_value( boost::any(value), false);
}
po::variable_value& operator[] (const std::string key) const{
...
// if exists in runtimeConfig return the value in runtimeConfig
// of type program_options::variable_value
...
// else return value in variable map "vm"
}
std::map<std::string, boost::program_options::variable_value> runtimeConfig;
}
through ConfigProxy, the option value is retrieved
if( vm.count("compression") ){
int value = proxyConfig["compression"].as<int>();
...
}
However, if the "compression" option value provided by the user is in wrong type, for example
configProxy.setConfig("compression", "12" );
...
int value = configProxy["compression"].as<int>(); // was set as st开发者_Python百科ring
then exception is thrown
what(): boost::bad_any_cast: failed conversion using boost::any_cast
The exception clearly shows the type cast problem. But the message seems not so helpful to users for finding out which option is responsible for the error.
Is there a better way to inform users about this type of error, instead of throwing bad_any_cast exception?
----- Edit --------------------------
Thanks to Luc Danton and Tony, I have found how Program options shows the errors.
void validate(boost::any& v,
const std::vector< std::basic_string<charT> >& xs,
T*, long)
{
validators::check_first_occurrence(v);
std::basic_string<charT> s(validators::get_single_string(xs));
try {
v = any(lexical_cast<T>(s));
}
catch(const bad_lexical_cast&) {
boost::throw_exception(invalid_option_value(s));
}
}
I think, by implementing the logic, I can get rid of the bad_any_cast exception.
Have you tried it?
("compression", po::value<int>(), "set compression level");
Notice po::value<int>()
. You specify here that the associated value has type int
. When the user passes something that Boost.ProgramOptions can't convert to int
, the program fails with an error message:
error: in option 'compression': invalid option value
That's one of the roles of the library after all.
The reason you do have to do vm["compression"].as<int>()
is because the the type of compression
is specified in a function call (the triplet in parentheses), something in the runtime world. This can't influence the return type of vm["compression"]
, so it needs to be some dynamic type emulation. Hence the boost::any_cast_failed
exception when you query a type that you did not specify.
Can you not put this:
if( vm.count("compression") ){
int value = vm["compression"].as<int>();
...
}
in a try catch
block where you catch the bad_any_cast
exception thrown by boost is caught and then show a message to the user of your own, by either throwing (retrow) a new exception of a type you have created or by writing a message to the std::cout
, I guess much depending on your application.
so:
try {
if( vm.count("compression") ){
int value = vm["compression"].as<int>();
...
}
}
catch(const boost::bad_any_cast& ex)
{
//rethrow exception of your own to show to the user or print msg to std::cout
}
精彩评论