Boost C++ Libraries: Ticket #2982: Required Arguments

attachment set

s.ochsenknecht@… — Thu, 22 Oct 2009 17:29:09 GMT

attachment → patch_ticket2982.diff

s.ochsenknecht@… — Thu, 22 Oct 2009 17:38:39 GMT

I find it useful, so I added a patch which implements the required() flag as described. It throws an exception from parsing if a required option isn't present.

This is my test case:

#include <boost/program_options.hpp>
#include <string>
#include <iostream>
using namespace boost::program_options;
using namespace std;
int main(int argc, char *argv[])
{
  options_description		opts;
  opts.add_options()
    ("cfgfile,c", value<std::string>()->required(), "the configfile")
    ("fritz,f", value<std::string>()->default_value("/other/file"), "the output file")
   ;
   variables_map vm;
   try {
       store(parse_command_line(argc, argv, opts), vm);
       notify(vm);
   }
   catch (required_option& e) {   // new exception type
       cout << "required option: " << e.what() << endl;
       return -1;
   }
   catch (...) {
       cout << "other exception: " << endl;
       return -1;
   }
}

Does it make sense? Is it useful?

I'm not a Boost maintainer, so I won't change the state of this ticket :-).

Thanks

cc set

Fri, 23 Oct 2009 06:51:30 GMT

cc s.ochsenknecht@… added

Vladimir Prus — Sun, 01 Nov 2009 10:58:00 GMT

Sascha, I am not sure if the location of the check is right. I'd suspect that user wants the option to be always specified, but does not necessary care where it comes from. Maybe, a check inside 'notify' would be better?

s.ochsenknecht@… — Sun, 01 Nov 2009 13:21:48 GMT

I was also not very sure if this is right place. Since I'm still not very familiar with the internals of this library. I just cam to that place by tracing with the debugger ...

I'm going to check your proposal with 'notify' within the next days. Keep you informed. Thanks for reviewing.

s.ochsenknecht@… — Wed, 04 Nov 2009 10:10:56 GMT

I just checked if it is possible to place the check in notify(), but there is one problem. The notify function just gets the variables_map parameter and not the options_description's which have the information about required options.

I have following solutions in mind:

1) in store() we store any required options with an empty value (if not occur) in the variables_map. In notify we then check for empty() and throw exception if empty() and required(). Any side effects? My preferred solution.

2) we pass options_description's to notify() to be able to perform the cross check, but this breaks the interface (or we overload notify, but then its up to the user to choose the correct notify() ... :-(

3) we store a reference/pointer to options_description's in variables_map. :-(

...

Please comment. Thanks

attachment set

s.ochsenknecht@… — Wed, 04 Nov 2009 12:01:26 GMT

attachment → patch_ticket2982_2.diff

patch

attachment set

s.ochsenknecht@… — Wed, 04 Nov 2009 12:02:24 GMT

attachment → required.cpp

testcase

s.ochsenknecht@… — Wed, 04 Nov 2009 12:08:04 GMT

I implemented option (1), see patch_ticket2982_2.diff and the attached testcase required.cpp.

store() now adds empty variable_value's to the variable_map. I also override the count() method of the underlying std::map in that way that the empty variable_values are not counted.

Hm, this can have some side effects when operator[] is used: const variable_value& operator[](const std::string& name) const

But I think the user has to check for !empty() anyhow ..!?

Please comment.

Vladimir Prus — Mon, 09 Nov 2009 16:15:56 GMT

Sascha,

thanks for the patch. I am out of time for today, but will review it as soon as possible.

Thanks, Volodya

Tue, 17 Nov 2009 12:51:06 GMT

Replying to vladimir_prus:

Sascha,

thanks for the patch. I am out of time for today, but will review it as soon as possible.

Probably storing the required options together with the parsed options in the same map isn't a good idea. Maybe a new member variable (in variables_map) containing the required options would be better. I'll modify the patch again within the next days.

Thanks, Sascha

owner, status, milestone changed

Sascha Ochsenknecht — Thu, 26 Nov 2009 11:05:23 GMT

owner changed from Vladimir Prus to Sascha Ochsenknecht
status new → assigned
milestone Boost 1.39.0 → Boost 1.42.0

status changed; resolution set

Sascha Ochsenknecht — Thu, 10 Dec 2009 08:46:47 GMT

status assigned → closed
resolution → fixed

(In [58263]) Enhancement to flag options as required, Fixes #2982

anonymous — Thu, 10 Dec 2009 08:52:00 GMT

I modified the attached patch in that way that required options are stored as an additional member in variables_map. The check if all required options occur is done in notify().

Cheers, Sascha

ihorfg@… — Wed, 07 Sep 2016 15:24:17 GMT

How to use the required flag for arguments that could be set from both argument list and configuration file? Parsing command line in such a case throws an exception while the missing required arguments can exist in configuration file.