MySQL 8.2.0
Source Code Documentation
help_options.h
Go to the documentation of this file.
1/*
2 Copyright (c) 2014, 2023, Oracle and/or its affiliates.
3
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License, version 2.0,
6 as published by the Free Software Foundation.
7
8 This program is also distributed with certain software (including
9 but not limited to OpenSSL) that is licensed under separate terms,
10 as designated in a particular file or component or in included license
11 documentation. The authors of MySQL hereby grant you an additional
12 permission to link the program and your derivative works with the
13 separately licensed software that they have included with MySQL.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License, version 2.0, for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23*/
24
25#ifndef HELP_OPTIONS_INCLUDED
26#define HELP_OPTIONS_INCLUDED
27
29#include "my_compiler.h"
30
31namespace Mysql {
32namespace Tools {
33namespace Base {
34
35class Abtract_program;
36
37namespace Options {
38
39/**
40 Options provider providing --help option and handling usage printing.
41 */
43 public:
44 /**
45 Constructs new help options provider.
46 @param program Pointer to main program class, used to collect list of all
47 options available in program.
48 */
49 explicit Help_options(Base::Abstract_program *program);
50 /**
51 Creates all options that will be provided.
52 Implementation of Abstract_options_provider virtual method.
53 */
54 void create_options() override;
55 /**
56 Prints program usage message.
57 */
58 virtual void print_usage();
59
60 private:
61 void help_callback(char *argument [[maybe_unused]]);
62 void version_callback(char *argument [[maybe_unused]]);
63
64 void print_version_line();
65
67};
68
69} // namespace Options
70} // namespace Base
71} // namespace Tools
72} // namespace Mysql
73
74#endif
Base class for all MySQL client tools.
Definition: abstract_program.h:46
Common abstract class for options providers.
Definition: abstract_options_provider.h:54
Options provider providing –help option and handling usage printing.
Definition: help_options.h:42
void create_options() override
Creates all options that will be provided.
Definition: help_options.cc:46
Help_options(Base::Abstract_program *program)
Constructs new help options provider.
Definition: help_options.cc:44
void version_callback(char *argument)
Definition: help_options.cc:63
void help_callback(char *argument)
Definition: help_options.cc:58
void print_version_line()
A helper function.
Definition: help_options.cc:69
Abstract_program * m_program
Definition: help_options.h:66
virtual void print_usage()
Prints program usage message.
Definition: help_options.cc:71
Header for compiler-dependent features.
constexpr pos_type Options
Definition: http_request.h:260
Definition: abstract_connection_program.h:39