VW::config::options_boost_po Struct Reference

#include <options_boost_po.h>

Inheritance diagram for VW::config::options_boost_po:

Public Member Functions
	options_boost_po (int argc, char **argv)
	options_boost_po (std::vector< std::string > args)
	options_boost_po (options_boost_po &)=delete
options_boost_po &	operator= (options_boost_po &)=delete
virtual void	add_and_parse (const option_group_definition &group) override
virtual bool	was_supplied (const std::string &key) override
virtual std::string	help () override
virtual void	check_unregistered () override
virtual std::vector< std::shared_ptr< base_option > >	get_all_options () override
virtual std::shared_ptr< base_option >	get_option (const std::string &key) override
virtual void	insert (const std::string &key, const std::string &value) override
virtual void	replace (const std::string &key, const std::string &value) override
bool	try_get_positional_option_token (const std::string &key, std::string &token, int position)
template<>
po::typed_value< std::vector< bool > > *	convert_to_boost_value (std::shared_ptr< typed_option< bool >> &opt)
Public Member Functions inherited from VW::config::options_i
template<typename T >
typed_option< T > &	get_typed_option (const std::string &key)
virtual	~options_i ()=default

Private Member Functions
template<typename T >
po::typed_value< std::vector< T > > *	get_base_boost_value (std::shared_ptr< typed_option< T >> &opt)
template<typename T >
po::typed_value< std::vector< T > > *	get_base_boost_value (std::shared_ptr< typed_option< std::vector< T >>> &opt)
template<typename T >
po::typed_value< std::vector< T > > *	convert_to_boost_value (std::shared_ptr< typed_option< T >> &opt)
template<typename T >
po::typed_value< std::vector< T > > *	convert_to_boost_value (std::shared_ptr< typed_option< std::vector< T >>> &opt)
template<typename T >
po::typed_value< std::vector< T > > *	add_notifier (std::shared_ptr< typed_option< T >> &opt, po::typed_value< std::vector< T >> *po_value)
template<typename T >
po::typed_value< std::vector< T > > *	add_notifier (std::shared_ptr< typed_option< std::vector< T >>> &opt, po::typed_value< std::vector< T >> *po_value)
template<typename T >
bool	add_if_t (std::shared_ptr< base_option > opt, po::options_description &options_description)
void	add_to_description (std::shared_ptr< base_option > opt, po::options_description &options_description)
template<typename TTypes >
void	add_to_description_impl (std::shared_ptr< base_option > opt, po::options_description &options_description)
template<typename T >
void	add_to_description (std::shared_ptr< typed_option< T >> opt, po::options_description &options_description)
template<>
void	add_to_description_impl (std::shared_ptr< base_option >, po::options_description &)
template<>
void	add_to_description_impl (std::shared_ptr< base_option > opt, po::options_description &options_description)

Private Attributes
std::map< std::string, std::shared_ptr< base_option > >	m_options
std::vector< std::string >	m_command_line
std::stringstream	m_help_stringstream
std::set< std::string >	m_supplied_options
std::set< std::string >	m_ignore_supplied
po::options_description	master_description
std::set< std::string >	m_defined_options

Detailed Description

Definition at line 40 of file options_boost_po.h.

Constructor & Destructor Documentation

options_boost_po() [1/3]

VW::config::options_boost_po::options_boost_po ( int  argc, char **  argv  )

inline

Definition at line 42 of file options_boost_po.h.

: options_boost_po(std::vector<std::string>(argv + 1, argv + argc)) {}

options_boost_po() [2/3]

VW::config::options_boost_po::options_boost_po ( std::vector< std::string >  args )

inline

Definition at line 44 of file options_boost_po.h.

: m_command_line(args) {}

options_boost_po() [3/3]

VW::config::options_boost_po::options_boost_po ( options_boost_po &  )

delete

Member Function Documentation

add_and_parse()

void options_boost_po::add_and_parse ( const option_group_definition &  group )

overridevirtual

Implements VW::config::options_i.

Definition at line 48 of file options_boost_po.cc.

References add_to_description(), is_number(), m_command_line, m_defined_options, m_help_stringstream, m_ignore_supplied, VW::config::option_group_definition::m_name, VW::config::option_group_definition::m_options, m_options, m_supplied_options, THROW, THROW_EX, and VW::vw_exception::what().

{
  po::options_description new_options(group.m_name);

  for (auto opt_ptr : group.m_options)
  {
    add_to_description(opt_ptr, new_options);
    m_defined_options.insert(opt_ptr->m_name);
    m_defined_options.insert(opt_ptr->m_short_name);
    m_defined_options.insert("-" + opt_ptr->m_short_name);

    // The last definition is kept. There was a bug where using .insert at a later pointer changed the command line but
    // the previously defined option's default value was serialized into the model. This resolves that state info.
    m_options[opt_ptr->m_name] = opt_ptr;
  }

  // Add the help for the given options.
  new_options.print(m_help_stringstream);

  try
  {
    po::variables_map vm;
    auto parsed_options = po::command_line_parser(m_command_line)
                              .options(new_options)
                              .style(po::command_line_style::default_style ^ po::command_line_style::allow_guessing)
                              .allow_unregistered()
                              .run();

    for (auto const& option : parsed_options.options)
    {
      // If the supplied option is interpreted as a number, then ignore it. There are no options like this and it is
      // just a false positive.
      if (is_number(option.string_key))
      {
        m_ignore_supplied.insert(option.string_key);
      }

      m_supplied_options.insert(option.string_key);

      // If a std::string is later determined to be a value the erase it. This happens for negative numbers "-2"
      for (auto& val : option.value)
      {
        m_ignore_supplied.insert(val);
      }

      // Parsed options can contain short options in the form -k, we can only check these as the group definitions come
      // in.
      if (option.string_key.length() > 0 && option.string_key[0] == '-')
      {
        auto short_name = option.string_key.substr(1);
        for (const auto& opt_ptr : group.m_options)
        {
          if (opt_ptr->m_short_name == short_name)
          {
            m_supplied_options.insert(short_name);
          }
        }
      }
    }

    po::store(parsed_options, vm);
    po::notify(vm);
  }
  catch (boost::exception_detail::clone_impl<
      boost::exception_detail::error_info_injector<boost::program_options::invalid_option_value>>& ex)
  {
    THROW_EX(VW::vw_argument_invalid_value_exception, ex.what());
  }
  catch (boost::exception_detail::clone_impl<boost::exception_detail::error_info_injector<boost::bad_lexical_cast>>& ex)
  {
    THROW_EX(VW::vw_argument_invalid_value_exception, ex.what());
  }
  catch (boost::exception_detail::clone_impl<
      boost::exception_detail::error_info_injector<boost::program_options::ambiguous_option>>& ex)
  {
    THROW(ex.what());
  }
  catch (boost::program_options::ambiguous_option& ex)
  {
    THROW(ex.what());
  }
}

add_if_t()

template<typename T >

bool VW::config::options_boost_po::add_if_t ( std::shared_ptr< base_option >  opt, po::options_description &  options_description  )

private

Definition at line 247 of file options_boost_po.h.

{
  if (opt->m_type_hash == typeid(T).hash_code())
  {
    auto typed = std::dynamic_pointer_cast<typed_option<T>>(opt);
    add_to_description(typed, options_description);
    return true;
  }

  return false;
}

add_notifier() [1/2]

template<typename T >

po::typed_value< std::vector< T > > * VW::config::options_boost_po::add_notifier ( std::shared_ptr< typed_option< T >> &  opt, po::typed_value< std::vector< T >> *  po_value  )

private

Definition at line 214 of file options_boost_po.h.

References THROW_EX.

Referenced by convert_to_boost_value().

{
  return po_value->notifier([opt](std::vector<T> final_arguments) {
    T first = final_arguments[0];
    for (auto const& item : final_arguments)
    {
      if (item != first)
      {
        std::stringstream ss;
        ss << "Disagreeing option values for '" << opt->m_name << "': '" << first << "' vs '" << item << "'";
        THROW_EX(VW::vw_argument_disagreement_exception, ss.str());
      }
    }

    // Set the value for the listening location.
    opt->m_location = first;
    opt->value(first);
  });
}

add_notifier() [2/2]

template<typename T >

po::typed_value< std::vector< T > > * VW::config::options_boost_po::add_notifier ( std::shared_ptr< typed_option< std::vector< T >>> &  opt, po::typed_value< std::vector< T >> *  po_value  )

private

Definition at line 236 of file options_boost_po.h.

{
  return po_value->notifier([opt](std::vector<T> final_arguments) {
    // Set the value for the listening location.
    opt->m_location = final_arguments;
    opt->value(final_arguments);
  });
}

add_to_description() [1/2]

void options_boost_po::add_to_description ( std::shared_ptr< base_option >  opt, po::options_description &  options_description  )

private

Definition at line 42 of file options_boost_po.cc.

Referenced by add_and_parse().

{
  add_to_description_impl<supported_options_types>(std::move(opt), options_description);
}

add_to_description() [2/2]

template<typename T >

void VW::config::options_boost_po::add_to_description ( std::shared_ptr< typed_option< T >>  opt, po::options_description &  options_description  )

private

Definition at line 264 of file options_boost_po.h.

{
  std::string boost_option_name = opt->m_name;
  if (opt->m_short_name != "")
  {
    boost_option_name += ",";
    boost_option_name += opt->m_short_name;
  }
  options_description.add_options()(boost_option_name.c_str(), convert_to_boost_value(opt), opt->m_help.c_str());

  if (m_defined_options.count(opt->m_name) == 0)
  {
    // TODO may need to add noop notifier here.
    master_description.add_options()(boost_option_name.c_str(), convert_to_boost_value(opt), "");
  }
}

add_to_description_impl() [1/3]

template<typename TTypes >

void VW::config::options_boost_po::add_to_description_impl ( std::shared_ptr< base_option >  opt, po::options_description &  options_description  )

inlineprivate

Definition at line 139 of file options_boost_po.h.

  {
    if (add_if_t<typename TTypes::head>(opt, options_description))
    {
      return;
    }
    add_to_description_impl<typename TTypes::tail>(opt, options_description);
  }

add_to_description_impl() [2/3]

template<>

void VW::config::options_boost_po::add_to_description_impl ( std::shared_ptr< base_option >  , po::options_description &    )

private

Definition at line 180 of file options_boost_po.cc.

References THROW.

{
  THROW("That is an unsupported option type.");
}

add_to_description_impl() [3/3]

template<>

void VW::config::options_boost_po::add_to_description_impl ( std::shared_ptr< base_option >  opt, po::options_description &  options_description  )

private

check_unregistered()

void options_boost_po::check_unregistered ( )

overridevirtual

Implements VW::config::options_i.

Definition at line 168 of file options_boost_po.cc.

References m_defined_options, m_ignore_supplied, m_supplied_options, and THROW_EX.

{
  for (auto const& supplied : m_supplied_options)
  {
    if (m_defined_options.count(supplied) == 0 && m_ignore_supplied.count(supplied) == 0)
    {
      THROW_EX(VW::vw_unrecognised_option_exception, "unrecognised option '--" << supplied << "'");
    }
  }
}

convert_to_boost_value() [1/3]

po::typed_value< std::vector< bool > > * VW::config::options_boost_po::convert_to_boost_value

(

std::shared_ptr< typed_option< bool >> &

opt

)

Definition at line 26 of file options_boost_po.cc.

References add_notifier(), get_base_boost_value(), and THROW.

{
  auto value = get_base_boost_value(opt);

  if (opt->default_value_supplied())
  {
    THROW("Using a bool option type acts as a switch, no explicit default value is allowed.")
  }

  value->default_value({false});
  value->zero_tokens();
  value->implicit_value({true});

  return add_notifier(opt, value);
}

convert_to_boost_value() [2/3]

template<typename T >

po::typed_value< std::vector< T > > * VW::config::options_boost_po::convert_to_boost_value ( std::shared_ptr< typed_option< T >> &  opt )

private

Definition at line 198 of file options_boost_po.h.

{
  return get_base_boost_value(opt);
}

convert_to_boost_value() [3/3]

template<typename T >

po::typed_value< std::vector< T > > * VW::config::options_boost_po::convert_to_boost_value ( std::shared_ptr< typed_option< std::vector< T >>> &  opt )

private

Definition at line 204 of file options_boost_po.h.

{
  return get_base_boost_value(opt)->multitoken();
}

get_all_options()

std::vector< std::shared_ptr< base_option > > options_boost_po::get_all_options ( )

overridevirtual

Implements VW::config::options_i.

Definition at line 146 of file options_boost_po.cc.

References m_options.

{
  std::vector<std::shared_ptr<base_option>> output_values;

  std::transform(m_options.begin(), m_options.end(), std::back_inserter(output_values),
      [](std::pair<const std::string, std::shared_ptr<base_option>>& kv) { return kv.second; });

  return output_values;
}

get_base_boost_value() [1/2]

template<typename T >

po::typed_value< std::vector< T > > * VW::config::options_boost_po::get_base_boost_value ( std::shared_ptr< typed_option< T >> &  opt )

private

Definition at line 171 of file options_boost_po.h.

Referenced by convert_to_boost_value().

{
  auto value = po::value<std::vector<T>>();

  if (opt->default_value_supplied())
  {
    value->default_value({opt->default_value()});
  }

  return add_notifier(opt, value)->composing();
}

get_base_boost_value() [2/2]

template<typename T >

po::typed_value< std::vector< T > > * VW::config::options_boost_po::get_base_boost_value ( std::shared_ptr< typed_option< std::vector< T >>> &  opt )

private

Definition at line 184 of file options_boost_po.h.

{
  auto value = po::value<std::vector<T>>();

  if (opt->default_value_supplied())
  {
    value->default_value(opt->default_value());
  }

  return add_notifier(opt, value)->composing();
}

get_option()

std::shared_ptr< base_option > VW::config::options_boost_po::get_option ( const std::string &  key )

overridevirtual

Implements VW::config::options_i.

Definition at line 156 of file options_boost_po.cc.

References m_options.

{
  auto it = m_options.find(key);
  if (it != m_options.end())
  {
    return it->second;
  }

  throw std::out_of_range(key + " was not found.");
}

help()

std::string options_boost_po::help ( )

overridevirtual

Implements VW::config::options_i.

Definition at line 144 of file options_boost_po.cc.

References m_help_stringstream.

{ return m_help_stringstream.str(); }

insert()

virtual void VW::config::options_boost_po::insert ( const std::string &  key, const std::string &  value  )

inlineoverridevirtual

Implements VW::config::options_i.

Definition at line 56 of file options_boost_po.h.

  {
    m_command_line.push_back("--" + key);
    if (value != "")
    {
      m_command_line.push_back(value);
    }
  }

operator=()

options_boost_po& VW::config::options_boost_po::operator= ( options_boost_po &  )

delete

replace()

virtual void VW::config::options_boost_po::replace ( const std::string &  key, const std::string &  value  )

inlineoverridevirtual

Implements VW::config::options_i.

Definition at line 66 of file options_boost_po.h.

References recall_tree_ns::find(), and THROW.

  {
    auto full_key = "--" + key;
    auto it = std::find(m_command_line.begin(), m_command_line.end(), full_key);

    // Not found, insert instead.
    if (it == m_command_line.end())
    {
      insert(key, value);
      return;
    }

    // Check if it is the final option or the next option is not a value.
    if (it + 1 == m_command_line.end() || (*(it + 1)).find("--") != std::string::npos)
    {
      THROW(key + " option does not have a value.");
    }

    // Actually replace the value.
    *(it + 1) = value;
  }

try_get_positional_option_token()

bool VW::config::options_boost_po::try_get_positional_option_token ( const std::string &  key, std::string &  token, int  position  )

inline

Definition at line 89 of file options_boost_po.h.

  {
    po::positional_options_description p;
    p.add(key.c_str(), position);
    po::parsed_options pos = po::command_line_parser(m_command_line)
                                 .style(po::command_line_style::default_style ^ po::command_line_style::allow_guessing)
                                 .options(master_description)
                                 .allow_unregistered()
                                 .positional(p)
                                 .run();

    auto it = std::find_if(pos.options.begin(), pos.options.end(),
        [&key](boost::program_options::option& option) { return option.string_key == key; });

    if (it != pos.options.end() && (*it).value.size() > 0)
    {
      token = (*it).value.at(0);
      return true;
    }

    return false;
  }

was_supplied()

bool options_boost_po::was_supplied ( const std::string &  key )

overridevirtual

Implements VW::config::options_i.

Definition at line 131 of file options_boost_po.cc.

References recall_tree_ns::find(), m_command_line, and m_supplied_options.

{
  // Best check, only valid after options parsed.
  if (m_supplied_options.count(key) > 0)
  {
    return true;
  }

  // Basic check, std::string match against command line.
  auto it = std::find(m_command_line.begin(), m_command_line.end(), std::string("--" + key));
  return it != m_command_line.end();
}

Member Data Documentation

m_command_line

std::vector<std::string> VW::config::options_boost_po::m_command_line

private

Definition at line 154 of file options_boost_po.h.

Referenced by add_and_parse(), and was_supplied().

m_defined_options

std::set<std::string> VW::config::options_boost_po::m_defined_options

private

Definition at line 167 of file options_boost_po.h.

Referenced by add_and_parse(), and check_unregistered().

m_help_stringstream

std::stringstream VW::config::options_boost_po::m_help_stringstream

private

Definition at line 156 of file options_boost_po.h.

Referenced by add_and_parse(), and help().

m_ignore_supplied

std::set<std::string> VW::config::options_boost_po::m_ignore_supplied

private

Definition at line 162 of file options_boost_po.h.

Referenced by add_and_parse(), and check_unregistered().

m_options

std::map<std::string, std::shared_ptr<base_option> > VW::config::options_boost_po::m_options

private

Definition at line 152 of file options_boost_po.h.

Referenced by add_and_parse(), get_all_options(), and get_option().

m_supplied_options

std::set<std::string> VW::config::options_boost_po::m_supplied_options

private

Definition at line 159 of file options_boost_po.h.

Referenced by add_and_parse(), check_unregistered(), and was_supplied().

master_description

po::options_description VW::config::options_boost_po::master_description

private

Definition at line 164 of file options_boost_po.h.

---

The documentation for this struct was generated from the following files:

• /mnt/c/w/linux/vowpal_wabbit/vowpalwabbit/options_boost_po.h
• /mnt/c/w/linux/vowpal_wabbit/vowpalwabbit/options_boost_po.cc