cxxopts::Options Class Reference

#include <cxxopts.h>

Public Member Functions
void	add_option (const std::string &group, const std::string &s, const std::string &l, std::string desc, std::shared_ptr< const Value > value, std::string arg_help)
OptionAdder	add_options (std::string group="")
Options &	allow_unrecognised_options ()
Options &	custom_help (std::string help_text)
const HelpGroupDetails &	group_help (const std::string &group) const
const std::vector< std::string >	groups () const
std::string	help (const std::vector< std::string > &groups={}) const
	Options (std::string program, std::string help_string="")
ParseResult	parse (int &argc, char **&argv)
void	parse_positional (std::string option)
void	parse_positional (std::vector< std::string > options)
void	parse_positional (std::initializer_list< std::string > options)
template<typename Iterator >
void	parse_positional (Iterator begin, Iterator end)
Options &	positional_help (std::string help_text)
Options &	show_positional_help ()

Private Types
typedef std::unordered_map< std::string, std::shared_ptr< OptionDetails > >	OptionMap

Private Member Functions
void	add_one_option (const std::string &option, std::shared_ptr< OptionDetails > details)
void	generate_all_groups_help (String &result) const
void	generate_group_help (String &result, const std::vector< std::string > &groups) const
String	help_one_group (const std::string &group) const

Private Attributes
bool	m_allow_unrecognised
std::string	m_custom_help
std::map< std::string, HelpGroupDetails >	m_help
String	m_help_string
std::vector< std::string >::iterator	m_next_positional
std::shared_ptr< OptionMap >	m_options
std::vector< std::string >	m_positional
std::string	m_positional_help
std::unordered_set< std::string >	m_positional_set
std::string	m_program
bool	m_show_positional

Detailed Description

Definition at line 753 of file cxxopts.h.

Member Typedef Documentation

OptionMap

typedef std::unordered_map<std::string, std::shared_ptr<OptionDetails> > cxxopts::Options::OptionMap

private

Definition at line 754 of file cxxopts.h.

Constructor & Destructor Documentation

Options()

cxxopts::Options::Options ( std::string  program, std::string  help_string = ""  )

inline

Definition at line 757 of file cxxopts.h.

        : m_program(std::move(program)),
          m_help_string(toLocalString(std::move(help_string))),
          m_custom_help("[OPTION...]"),
          m_positional_help("positional parameters"),
          m_show_positional(false),
          m_allow_unrecognised(false),
          m_options(std::make_shared<OptionMap>()),
          m_next_positional(m_positional.end()) {}

Member Function Documentation

add_one_option()

void cxxopts::Options::add_one_option ( const std::string &  option, std::shared_ptr< OptionDetails >  details  )

inlineprivate

Definition at line 1238 of file cxxopts.h.

References recoMuon::in, m_options, and fileinputsource_cfi::option.

Referenced by add_option().

                                                                                                   {
    auto in = m_options->emplace(option, details);

    if (!in.second) {
      throw Option_exists_error(option);
    }
  }

add_option()

void cxxopts::Options::add_option ( const std::string &  group, const std::string &  s, const std::string &  l, std::string  desc, std::shared_ptr< const Value >  value, std::string  arg_help  )

inline

Definition at line 1206 of file cxxopts.h.

References add_one_option(), submitPVResolutionJobs::desc, watchdog::group, MainPageGenerator::l, m_help, eostools::move(), fileinputsource_cfi::option, alignCSCRings::s, cxxopts::toLocalString(), and cxxopts::value().

Referenced by contentValuesCheck.OptionParser::__init__(), contentValuesToDBS.OptionParser::__init__(), contentValuesToRR.OptionParser::__init__(), bookConverter.OptionParser::__init__(), contentValuesFiles.OptionParser::__init__(), and cxxopts::OptionAdder::operator()().

                                                      {
    auto stringDesc = toLocalString(std::move(desc));
    auto option = std::make_shared<OptionDetails>(s, l, stringDesc, value);

    if (s.size() > 0) {
      add_one_option(s, option);
    }

    if (l.size() > 0) {
      add_one_option(l, option);
    }

    //add the help details
    auto& options = m_help[group];

    options.options.emplace_back(HelpOptionDetails{s,
                                                   l,
                                                   stringDesc,
                                                   value->has_default(),
                                                   value->get_default_value(),
                                                   value->has_implicit(),
                                                   value->get_implicit_value(),
                                                   std::move(arg_help),
                                                   value->is_container(),
                                                   value->is_boolean()});
  }

add_options()

OptionAdder cxxopts::Options::add_options ( std::string  group = "" )

inline

Definition at line 956 of file cxxopts.h.

References watchdog::group, and eostools::move().

{ return OptionAdder(*this, std::move(group)); }

allow_unrecognised_options()

Options& cxxopts::Options::allow_unrecognised_options ( )

inline

Definition at line 782 of file cxxopts.h.

References m_allow_unrecognised.

                                          {
      m_allow_unrecognised = true;
      return *this;
    }

custom_help()

Options& cxxopts::Options::custom_help ( std::string  help_text )

inline

Definition at line 772 of file cxxopts.h.

References m_custom_help, and eostools::move().

                                              {
      m_custom_help = std::move(help_text);
      return *this;
    }

generate_all_groups_help()

void cxxopts::Options::generate_all_groups_help ( String &  result ) const

inlineprivate

Definition at line 1316 of file cxxopts.h.

References generate_group_help(), watchdog::group, m_help, and mps_fire::result.

Referenced by help().

                                                                    {
    std::vector<std::string> all_groups;
    all_groups.reserve(m_help.size());

    for (auto& group : m_help) {
      all_groups.push_back(group.first);
    }

    generate_group_help(result, all_groups);
  }

generate_group_help()

void cxxopts::Options::generate_group_help ( String &  result, const std::vector< std::string > &  groups  ) const

inlineprivate

Definition at line 1303 of file cxxopts.h.

References cxxopts::empty(), help_one_group(), mps_fire::i, and mps_fire::result.

Referenced by generate_all_groups_help(), and help().

                                                                                                         {
    for (size_t i = 0; i != print_groups.size(); ++i) {
      const String& group_help_text = help_one_group(print_groups[i]);
      if (empty(group_help_text)) {
        continue;
      }
      result += group_help_text;
      if (i < print_groups.size() - 1) {
        result += '\n';
      }
    }
  }

group_help()

const HelpGroupDetails & cxxopts::Options::group_help ( const std::string &  group ) const

inline

Definition at line 1356 of file cxxopts.h.

References watchdog::group, and m_help.

{ return m_help.at(group); }

groups()

const std::vector< std::string > cxxopts::Options::groups ( ) const

inline

Definition at line 1345 of file cxxopts.h.

References g, m_help, and HcalDetIdTransform::transform().

                                                          {
    std::vector<std::string> g;

    std::transform(m_help.begin(),
                   m_help.end(),
                   std::back_inserter(g),
                   [](const std::map<std::string, HelpGroupDetails>::value_type& pair) { return pair.first; });

    return g;
  }

help()

std::string cxxopts::Options::help ( const std::vector< std::string > &  groups = {} ) const

inline

Definition at line 1327 of file cxxopts.h.

References generate_all_groups_help(), generate_group_help(), m_custom_help, m_help_string, m_positional, m_positional_help, m_program, mps_fire::result, cxxopts::toLocalString(), and cxxopts::toUTF8String().

                                                                              {
    String result = m_help_string + "\nUsage:\n  " + toLocalString(m_program) + " " + toLocalString(m_custom_help);

    if (m_positional.size() > 0 && m_positional_help.size() > 0) {
      result += " " + toLocalString(m_positional_help);
    }

    result += "\n\n";

    if (help_groups.size() == 0) {
      generate_all_groups_help(result);
    } else {
      generate_group_help(result, help_groups);
    }

    return toUTF8String(result);
  }

help_one_group()

String cxxopts::Options::help_one_group ( const std::string &  group ) const

inlineprivate

Definition at line 1246 of file cxxopts.h.

References ztail::d, dqm-mbProfile::format, g, watchdog::group, m_help, m_positional_set, m_show_positional, WZElectronSkims53X_cff::max, SiStripPI::min, EcalTangentSkim_cfg::o, mps_fire::result, alignCSCRings::s, AlCaHLTBitMon_QueryRunRegistry::string, cxxopts::stringLength(), and cxxopts::toLocalString().

Referenced by generate_group_help().

                                                                {
    typedef std::vector<std::pair<String, String>> OptionHelp;

    auto group = m_help.find(g);
    if (group == m_help.end()) {
      return "";
    }

    OptionHelp format;

    size_t longest = 0;

    String result;

    if (!g.empty()) {
      result += toLocalString(" " + g + " options:\n");
    }

    for (const auto& o : group->second.options) {
      if (o.is_container && m_positional_set.find(o.l) != m_positional_set.end() && !m_show_positional) {
        continue;
      }

      auto s = format_option(o);
      longest = (std::max)(longest, stringLength(s));
      format.push_back(std::make_pair(s, String()));
    }

    longest = (std::min)(longest, static_cast<size_t>(OPTION_LONGEST));

    //widest allowed description
    auto allowed = size_t{76} - longest - OPTION_DESC_GAP;

    auto fiter = format.begin();
    for (const auto& o : group->second.options) {
      if (o.is_container && m_positional_set.find(o.l) != m_positional_set.end() && !m_show_positional) {
        continue;
      }

      auto d = format_description(o, longest + OPTION_DESC_GAP, allowed);

      result += fiter->first;
      if (stringLength(fiter->first) > longest) {
        result += '\n';
        result += toLocalString(std::string(longest + OPTION_DESC_GAP, ' '));
      } else {
        result += toLocalString(std::string(longest + OPTION_DESC_GAP - stringLength(fiter->first), ' '));
      }
      result += d;
      result += '\n';

      ++fiter;
    }

    return result;
  }

parse()

ParseResult cxxopts::Options::parse ( int &  argc, char **&  argv  )

inline

Definition at line 1073 of file cxxopts.h.

References dir2webdir::argc, GCPpyPlots::argv, m_allow_unrecognised, m_options, m_positional, and mps_fire::result.

                                                           {
    ParseResult result(m_options, m_positional, m_allow_unrecognised, argc, argv);
    return result;
  }

parse_positional() [1/4]

void cxxopts::Options::parse_positional ( std::string  option )

inline

Definition at line 1058 of file cxxopts.h.

References eostools::move(), and fileinputsource_cfi::option.

Referenced by parse_positional().

                                                        {
    parse_positional(std::vector<std::string>{std::move(option)});
  }

parse_positional() [2/4]

void cxxopts::Options::parse_positional ( std::vector< std::string >  options )

inline

Definition at line 1062 of file cxxopts.h.

References m_next_positional, m_positional, m_positional_set, and eostools::move().

                                                                    {
    m_positional = std::move(options);
    m_next_positional = m_positional.begin();

    m_positional_set.insert(m_positional.begin(), m_positional.end());
  }

parse_positional() [3/4]

void cxxopts::Options::parse_positional ( std::initializer_list< std::string >  options )

inline

Definition at line 1069 of file cxxopts.h.

References eostools::move(), and parse_positional().

                                                                              {
    parse_positional(std::vector<std::string>(std::move(options)));
  }

parse_positional() [4/4]

template<typename Iterator >

void cxxopts::Options::parse_positional ( Iterator  begin, Iterator  end  )

inline

Definition at line 806 of file cxxopts.h.

References parse_positional().

                                                        {
      parse_positional(std::vector<std::string>{begin, end});
    }

positional_help()

Options& cxxopts::Options::positional_help ( std::string  help_text )

inline

Definition at line 767 of file cxxopts.h.

References m_positional_help, and eostools::move().

                                                  {
      m_positional_help = std::move(help_text);
      return *this;
    }

show_positional_help()

Options& cxxopts::Options::show_positional_help ( )

inline

Definition at line 777 of file cxxopts.h.

References m_show_positional.

                                    {
      m_show_positional = true;
      return *this;
    }

Member Data Documentation

m_allow_unrecognised

bool cxxopts::Options::m_allow_unrecognised

private

Definition at line 830 of file cxxopts.h.

Referenced by allow_unrecognised_options(), and parse().

m_custom_help

std::string cxxopts::Options::m_custom_help

private

Definition at line 827 of file cxxopts.h.

Referenced by custom_help(), and help().

m_help

std::map<std::string, HelpGroupDetails> cxxopts::Options::m_help

private

Definition at line 838 of file cxxopts.h.

Referenced by add_option(), generate_all_groups_help(), group_help(), groups(), and help_one_group().

m_help_string

String cxxopts::Options::m_help_string

private

Definition at line 826 of file cxxopts.h.

Referenced by help().

m_next_positional

std::vector<std::string>::iterator cxxopts::Options::m_next_positional

private

Definition at line 834 of file cxxopts.h.

Referenced by parse_positional().

m_options

std::shared_ptr<OptionMap> cxxopts::Options::m_options

private

Definition at line 832 of file cxxopts.h.

Referenced by add_one_option(), and parse().

m_positional

std::vector<std::string> cxxopts::Options::m_positional

private

Definition at line 833 of file cxxopts.h.

Referenced by help(), parse(), and parse_positional().

m_positional_help

std::string cxxopts::Options::m_positional_help

private

Definition at line 828 of file cxxopts.h.

Referenced by help(), and positional_help().

m_positional_set

std::unordered_set<std::string> cxxopts::Options::m_positional_set

private

Definition at line 835 of file cxxopts.h.

Referenced by help_one_group(), and parse_positional().

m_program

std::string cxxopts::Options::m_program

private

Definition at line 825 of file cxxopts.h.

Referenced by help().

m_show_positional

bool cxxopts::Options::m_show_positional

private

Definition at line 829 of file cxxopts.h.

Referenced by help_one_group(), and show_positional_help().