Class template basic_command_line_parser . Boost , The Boost C++ Libraries BoostBook Documentation Subset , Reference

Class template basic_command_line_parser

boost::program_options::basic_command_line_parser

Synopsis

// In header: <boost/program_options/parsers.hpp>
template<typename charT> 
class basic_command_line_parser : private cmdline {
public:
  // construct/copy/destruct
  basic_command_line_parser(const std::vector< std::basic_string< charT > > &);
  basic_command_line_parser(int, const charT *const);
  // 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();
  basic_command_line_parser & allow_unregistered();
  basic_command_line_parser & extra_style_parser(style_parser);
};

Description

Парсер командной строки.

Класс позволяет указать всю информацию, необходимую для разбора и разбора командной строки. Прежде всего, необходимо эмулировать именованные параметры функции - обычная функция с 5 параметрами будет трудно использовать, а создание перегрузок с меньшим количеством параметров будет запутанным.

Для наиболее распространенного случая функция parse_command_line является лучшей альтернативой.

Существует два типа: command_line_parser и wcommand_line_parser, для charT == char и charT == wchar_t cases.

`basic_command_line_parser` public construct/copy/destruct

<
```
basic_command_line_parser(conststd::vector<std::basic_string<charT>>&args);
```
>
Создает парсер командной строки для указанного списка аргументов. Параметр «args» не должен содержать название программы.
<
```
basic_command_line_parser(intargc,constcharT*constargv);
```
>
Создает парсер командной строки для указанного списка аргументов. Параметры должны быть такими же, как переданы на «основной».

`basic_command_line_parser` public member functions

<
```
basic_command_line_parser&options(constoptions_description&desc);
```
>
Устанавливает варианты описания для использования.
<
```
basic_command_line_parser&
positional(constpositional_options_description&desc);
```
>
Устанавливает описание позиционных опций для использования.
<
```
basic_command_line_parser&style(int);
```
>
Установите стиль командной строки.
<
```
basic_command_line_parser&extra_parser(ext_parser);
```
>
Устанавливает дополнительные парсеры.
<
```
basic_parsed_options<charT>run();
```
>
Парсирует варианты и возвращает результат парсинга. Бросает на ошибку.
<
```
basic_command_line_parser&allow_unregistered();
```
>
Указывает, что незарегистрированные варианты разрешены и должны быть приняты. Для каждой команды, похожей на токен, который выглядит как опция, но не содержит признанного имени, в результате будет добавлен экземпляр basic_optionс «непризнанным» полем, установленным на «истинное». Можно собрать все непризнанные варианты с помощью «collect_unrecognized» funciton.

basic_command_line_parser&extra_style_parser(style_parsers);

Статья Class template basic_command_line_parser раздела The Boost C++ Libraries BoostBook Documentation Subset Reference может быть полезна для разработчиков на c++ и boost.

Class template basic_command_line_parser

Boost , The Boost C++ Libraries BoostBook Documentation Subset , Reference

Boost C++ Libraries

Class template basic_command_line_parser

Synopsis

Description

basic_command_line_parser public construct/copy/destruct

basic_command_line_parser public member functions

`basic_command_line_parser` public construct/copy/destruct

`basic_command_line_parser` public member functions