Boost C++ Libraries of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of boost. Click here for the latest Boost documentation.

Class template basic_command_line_parser

boost::program_options::basic_command_line_parser —


template<typename charT> 
class basic_command_line_parser
  :  : private boost::program_options::common_command_line_parser
// construct/copy/destruct
basic_command_line_parser(const std::vector< std::basic_string< charT > > &);
basic_command_line_parser(int, charT *);

// public member functions
basic_command_line_parser & options(const options_description &) ;
basic_command_line_parser & 
positional(const positional_options_description &) ;
basic_command_line_parser & style(int) ;
basic_command_line_parser & extra_parser(ext_parser) ;
basic_parsed_options< charT > run() const;


Command line parser.

The class allows one to specify all the information needed for parsing and to parser the 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 nuber of parameters will be confusing.

For the most common case, the function parse_command_line is a better alternative.

basic_command_line_parser construct/copy/destruct

  1. basic_command_line_parser(const std::vector< std::basic_string< charT > > & args);

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

  2. basic_command_line_parser(int argc, charT * argv);

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

basic_command_line_parser public member functions

  1. basic_command_line_parser & options(const options_description & desc) ;

    Sets options descriptions to use.

  2. basic_command_line_parser & 
    positional(const positional_options_description & desc) ;

    Sets positional options description to use.

  3. basic_command_line_parser & style(int ) ;

    Sets the command line style.

  4. basic_command_line_parser & extra_parser(ext_parser ) ;

    Sets the extra parsers.

  5. basic_parsed_options< charT > run() const;

    Parses the command line and returns parsed options in internal encoding.

Copyright 2002-2004 Vladimir Prus