MySQL 8.3.0
Source Code Documentation
Mysql::Tools::Base::Options::Help_options Class Reference

Options provider providing –help option and handling usage printing. More...

#include <help_options.h>

Inheritance diagram for Mysql::Tools::Base::Options::Help_options:
[legend]

Public Member Functions

 Help_options (Base::Abstract_program *program)
 Constructs new help options provider. More...
 
void create_options () override
 Creates all options that will be provided. More...
 
virtual void print_usage ()
 Prints program usage message. More...
 
- Public Member Functions inherited from Mysql::Tools::Base::Options::Abstract_options_provider
Simple_optioncreate_new_option (std::string name, std::string description)
 Creates and attach new simple option. More...
 
Disabled_optioncreate_new_disabled_option (std::string name, std::string description)
 Creates and attach new disabled option. More...
 
Char_array_optioncreate_new_option (char **value, std::string name, std::string description)
 Creates and attach new string option stored in char* type object. More...
 
Password_optioncreate_new_password_option (std::optional< std::string > *value, std::string name, std::string description)
 Creates and attach new password option. More...
 
String_optioncreate_new_option (std::optional< std::string > *value, std::string name, std::string description)
 Creates and attach new string option. More...
 
Number_option< int32 > * create_new_option (int32 *value, std::string name, std::string description)
 Creates and attach new 32-bit signed number option. More...
 
Number_option< uint32 > * create_new_option (uint32 *value, std::string name, std::string description)
 Creates and attach new 32-bit unsigned number option. More...
 
Number_option< int64 > * create_new_option (int64 *value, std::string name, std::string description)
 Creates and attach new 64-bit signed number option. More...
 
Number_option< uint64 > * create_new_option (uint64 *value, std::string name, std::string description)
 Creates and attach new 64-bit unsigned number option. More...
 
Number_option< double > * create_new_option (double *value, std::string name, std::string description)
 Creates and attach new floating-point number option. More...
 
Bool_optioncreate_new_option (bool *value, std::string name, std::string description)
 Creates and attach new boolean option with value received from argument. More...
 
template<typename T_type , typename T_typelib >
Enum_option< T_type, T_typelib > * create_new_enum_option (T_type *value, const T_typelib *type, std::string name, std::string description)
 
std::vector< my_optiongenerate_options () override
 Creates list of options provided by this provider. More...
 
void options_parsed () override
 Callback to be called when command-line options parsing have finished. More...
 
- Public Member Functions inherited from Mysql::Tools::Base::Options::I_option_changed_listener
virtual ~I_option_changed_listener ()=default
 

Private Member Functions

void help_callback (char *argument)
 
void version_callback (char *argument)
 
void print_version_line ()
 A helper function. More...
 

Private Attributes

Abstract_programm_program
 

Additional Inherited Members

- Protected Member Functions inherited from Mysql::Tools::Base::Options::Abstract_options_provider
 Abstract_options_provider ()
 
 ~Abstract_options_provider () override
 
void set_option_changed_listener (I_option_changed_listener *listener) override
 Sets optional option changes listener to which all changes in all options contained in this provider should be reported. More...
 

Detailed Description

Options provider providing –help option and handling usage printing.

Constructor & Destructor Documentation

◆ Help_options()

Help_options::Help_options ( Base::Abstract_program program)
explicit

Constructs new help options provider.

Parameters
programPointer to main program class, used to collect list of all options available in program.

Member Function Documentation

◆ create_options()

void Help_options::create_options ( )
overridevirtual

Creates all options that will be provided.

Implementation of Abstract_options_provider virtual method.

Implements Mysql::Tools::Base::Options::Abstract_options_provider.

◆ help_callback()

void Help_options::help_callback ( char *  argument)
private

◆ print_usage()

void Mysql::Tools::Base::Options::Help_options::print_usage ( )
virtual

Prints program usage message.

◆ print_version_line()

void Help_options::print_version_line ( )
private

A helper function.

Prints the program version line.

◆ version_callback()

void Help_options::version_callback ( char *  argument)
private

Member Data Documentation

◆ m_program

Abstract_program* Mysql::Tools::Base::Options::Help_options::m_program
private

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