MySQL 8.2.0
Source Code Documentation
abstract_enum_option.h
Go to the documentation of this file.
1/*
2 Copyright (c) 2016, 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 ABSTRACT_ENUM_OPTION_INCLUDED
26#define ABSTRACT_ENUM_OPTION_INCLUDED
27
28#include <string>
29
31
32namespace Mysql {
33namespace Tools {
34namespace Base {
35namespace Options {
36
37/**
38 Abstract option to handle enum option values.
39 */
40template <typename T_type, typename T_typelib>
41class Abstract_enum_option : public Abstract_option<T_type> {
42 protected:
43 /**
44 Constructs new enum option.
45 @param value Pointer to object to receive option value.
46 @param type Pointer to enum tylelib.
47 @param var_type my_getopt internal option type.
48 @param name Name of option. It is used in command line option name as
49 --name.
50 @param description Description of option to be printed in --help.
51 @param default_value default value to be supplied to internal option
52 data structure.
53 */
54 Abstract_enum_option(T_type *value, const T_typelib *type, ulong var_type,
55 std::string name, std::string description,
56 longlong default_value);
57};
58
59template <typename T_type, typename T_typelib>
61 T_type *value, const T_typelib *type, ulong var_type, std::string name,
62 std::string description, longlong default_value)
63 : Abstract_option<T_type>(value, var_type, name, description,
64 default_value) {
65 this->m_option_structure.typelib = const_cast<T_typelib *>(type);
66}
67
68} // namespace Options
69} // namespace Base
70} // namespace Tools
71} // namespace Mysql
72
73#endif
Abstract option to handle enum option values.
Definition: abstract_enum_option.h:41
Abstract_enum_option(T_type *value, const T_typelib *type, ulong var_type, std::string name, std::string description, longlong default_value)
Constructs new enum option.
Definition: abstract_enum_option.h:60
Abstract base with common option functionalities.
Definition: abstract_option.h:49
my_option m_option_structure
Definition: abstract_option.h:95
long long int longlong
Definition: my_inttypes.h:54
constexpr pos_type Options
Definition: http_request.h:260
Definition: abstract_connection_program.h:39
required string type
Definition: replication_group_member_actions.proto:33
case opt name
Definition: sslopt-case.h:32
TYPELIB * typelib
Pointer to possible values.
Definition: my_getopt.h:118