Search code examples
c++booststlboost-program-optionsstd-pair

Boost program options pair value


I'm observing a curious behavior of the boost::program_options::value function with STL classes. I often need to provide arguments to programs in pairs, e.g. file names with short labels, but the boost::program_options::value function seems not to work with std::pair, while it does work with any class I define myself. Consider the following code:

#include <string>
#include <utility>

#include <boost/program_options.hpp>

using namespace std;
namespace po = boost::program_options;

class sspair: public pair<string,string> { };

typedef pair<string,string> mypair;
// typedef sspair mypair;

istream& operator>>(istream& in, mypair& ss) {
  string s;
  in >> s;
  const size_t sep = s.find(':');
  if (sep==string::npos) {
    ss.first = string();
    ss.second = s;
  } else {
    ss.first  = s.substr(0,sep);
    ss.second = s.substr(sep+1);
  }
  return in;
}

int main(int argc, char **argv)
{
  mypair a;

  try {
    po::options_description all_opt("Options");
    all_opt.add_options()
      ("arg,a", po::value<mypair>(&a),"colon separated pair")
    ;

    po::variables_map vm;
    po::store(po::parse_command_line(argc, argv, all_opt), vm);
    po::notify(vm);
  } catch(exception& e) {
    cerr << e.what() << endl;
    exit(1);
  }

  cout << "a = (" << a.first << ", " << a.second << ")" << endl;

  return 0;
}

With typedef sspair mypair I get the expected behavior.

$ ./test 
a = (, )
$ ./test -a b:c
a = (b, c)
$ ./test -a bc
a = (, bc)

but with typedef pair<string,string> mypair I get the following compilation errors:

In file included from /usr/include/boost/any.hpp:27:0,
                 from /usr/include/boost/program_options/value_semantic.hpp:12,
                 from /usr/include/boost/program_options/options_description.hpp:13,
                 from /usr/include/boost/program_options.hpp:15,
                 from test.cc:4:
/usr/include/boost/lexical_cast.hpp: In instantiation of ‘struct boost::detail::deduce_target_char_impl<boost::detail::deduce_character_type_later<std::pair<std::basic_string<char>, std::basic_string<char> > > >’:
/usr/include/boost/lexical_cast.hpp:415:89:   required from ‘struct boost::detail::deduce_target_char<std::pair<std::basic_string<char>, std::basic_string<char> > >’
/usr/include/boost/lexical_cast.hpp:674:92:   required from ‘struct boost::detail::lexical_cast_stream_traits<std::basic_string<char>, std::pair<std::basic_string<char>, std::basic_string<char> > >’
/usr/include/boost/lexical_cast.hpp:2363:19:   required from ‘static Target boost::detail::lexical_cast_do_cast<Target, Source>::lexical_cast_impl(const Source&) [with Target = std::pair<std::basic_string<char>, std::basic_string<char> >; Source = std::basic_string<char>]’
/usr/include/boost/lexical_cast.hpp:2543:50:   required from ‘Target boost::lexical_cast(const Source&) [with Target = std::pair<std::basic_string<char>, std::basic_string<char> >; Source = std::basic_string<char>]’
/usr/include/boost/program_options/detail/value_semantic.hpp:89:38:   required from ‘void boost::program_options::validate(boost::any&, const std::vector<std::basic_string<charT> >&, T*, long int) [with T = std::pair<std::basic_string<char>, std::basic_string<char> >; charT = char]’
/usr/include/boost/program_options/detail/value_semantic.hpp:170:55:   required from ‘void boost::program_options::typed_value<T, charT>::xparse(boost::any&, const std::vector<std::basic_string<charT> >&) const [with T = std::pair<std::basic_string<char>, std::basic_string<char> >; charT = char]’
test.cc:49:1:   required from here
/usr/include/boost/lexical_cast.hpp:388:13: error: invalid application of ‘sizeof’ to incomplete type ‘boost::STATIC_ASSERTION_FAILURE<false>’
             BOOST_STATIC_ASSERT_MSG((result_t::value || boost::has_right_shift<std::basic_istream<wchar_t>, T >::value), 
             ^
make: *** [test] Error 1

I found that similar behavior occurs if I try to use other stl containers, like std::array or std::tuple.

Does anybody know what the problem is?

EDIT:

Ok, I just found out what was causing this issue, after I read this post. Apparently, the stream operator is only looked up in the namespace in which the class, which is the template argument of the po::value function, was defined. So, with the edit

namespace std {
  istream& operator>>(istream& in, mypair& ss) { ... }
}

the pair<string,string> class works directly.

Now, is there any drawback to defining the operator in the std namespace? I've hear that that's not standard complient per se.


Solution

  • Sorry, only have time for a quick answer.

    If you want to use std::pair<std::string, std:string> as your pair, you will need to write an operator>>(...) for it, and this operator will also need to be in namespace std, so that ADL works.