class basic_command_line_parser

Declaration

template <class Char>
class basic_command_line_parser : private cmdline { /* full declaration omitted */ };

Description

Command line parser. The class allows one to specify all the information needed for parsing and to parse the command line. It is primarily needed to emulate named function parameters \ -- a regular function with 5 parameters will be hard to use and creating overloads with a smaller number of parameters will be confusing. For the most common case, the function parse_command_line is a better alternative. There are two typedefs \ -- command_line_parser and wcommand_line_parser, for charT == char and charT == wchar_t cases.

Declared at: libs/pika/program_options/include/pika/program_options/parsers.hpp:116

Inherits from: cmdline

Method Overview

  • public basic_command_line_parser<Char> & allow_unregistered()
  • public basic_command_line_parser<Char>(const std::vector<std::basic_string<Char>> & args)
  • public basic_command_line_parser<Char>(int argc, const Char *const * argv)
  • public basic_command_line_parser<Char> & extra_parser(pika::program_options::ext_parser)
  • public basic_command_line_parser<Char> & extra_style_parser(pika::program_options::detail::cmdline::style_parser s)
  • public basic_command_line_parser<Char> & options(const pika::program_options::options_description & desc)
  • public basic_command_line_parser<Char> & positional(const pika::program_options::positional_options_description & desc)
  • public basic_parsed_options<Char> run()
  • public basic_command_line_parser<Char> & style(int)

Methods

basic_command_line_parser<Char>&
allow_unregistered()

Description

Specifies that unregistered options are allowed and should be passed though. For each command like token that looks like an option but does not contain a recognized name, an instance of basic_option <charT > will be added to result, with 'unrecognized' field set to 'true'. It's possible to collect all unrecognized options with the 'collect_unrecognized' function.

Declared at: libs/pika/program_options/include/pika/program_options/parsers.hpp:153

basic_command_line_parser<Char>(
    const std::vector<std::basic_string<Char>>&
        args)

Description

Creates a command line parser for the specified arguments list. The 'args' parameter should not include program name.

Declared at: libs/pika/program_options/include/pika/program_options/parsers.hpp:122

Parameters

const std::vector<std::basic_string<Char>>& args

basic_command_line_parser<Char>(
    int argc,
    const Char* const* argv)

Description

Creates a command line parser for the specified arguments list. The parameters should be the same as passed to 'main'.

Declared at: libs/pika/program_options/include/pika/program_options/parsers.hpp:127

Parameters

int argc
const Char* const* argv

basic_command_line_parser<Char>& extra_parser(
    pika::program_options::ext_parser)

Description

Sets the extra parsers.

Declared at: libs/pika/program_options/include/pika/program_options/parsers.hpp:138

Parameters

pika::program_options::ext_parser 

basic_command_line_parser<Char>&
extra_style_parser(pika::program_options::detail::
                       cmdline::style_parser s)

Declared at: libs/pika/program_options/include/pika/program_options/parsers.hpp:157

Parameters

pika::program_options::detail::cmdline:: style_parser s

basic_command_line_parser<Char>& options(
    const pika::program_options::
        options_description& desc)

Description

Sets options descriptions to use.

Declared at: libs/pika/program_options/include/pika/program_options/parsers.hpp:130

Parameters

const pika::program_options::options_description& desc

basic_command_line_parser<Char>& positional(
    const pika::program_options::
        positional_options_description& desc)

Description

Sets positional options description to use.

Declared at: libs/pika/program_options/include/pika/program_options/parsers.hpp:132

Parameters

const pika::program_options:: positional_options_description& desc

basic_parsed_options<Char> run()

Description

Parses the options and returns the result of parsing. Throws on error.

Declared at: libs/pika/program_options/include/pika/program_options/parsers.hpp:143

basic_command_line_parser<Char>& style(int)

Description

Sets the command line style.

Declared at: libs/pika/program_options/include/pika/program_options/parsers.hpp:136

Parameters

int