MySQL 8.0.39
Source Code Documentation
enum_option.h
Go to the documentation of this file.
1/*
2 Copyright (c) 2016, 2024, 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 designed to work 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 either included with
14 the program or referenced in the documentation.
15
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License, version 2.0, for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24*/
25
26#ifndef ENUM_OPTION_INCLUDED
27#define ENUM_OPTION_INCLUDED
28
29#include <string>
30
32
33namespace Mysql {
34namespace Tools {
35namespace Base {
36namespace Options {
37
38/**
39 Enum value option.
40 */
41template <typename T_type, typename T_typelib>
42class Enum_option : public Abstract_enum_option<T_type, T_typelib> {
43 public:
44 /**
45 Constructs new enum option.
46 @param value Pointer to enum object to receive option value.
47 @param type Pointer to enum tylelib.
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 */
52 Enum_option(T_type *value, const T_typelib *type, std::string name,
53 std::string description)
54 : Abstract_enum_option<T_type, T_typelib>(value, type, GET_ENUM, name,
55 description, 1),
56 m_value(value) {}
57
58 void set_value(T_type value) { *m_value = value; }
59
60 private:
61 T_type *m_value;
62};
63
64} // namespace Options
65} // namespace Base
66} // namespace Tools
67} // namespace Mysql
68
69#endif
Abstract option to handle enum option values.
Definition: abstract_enum_option.h:42
Enum value option.
Definition: enum_option.h:42
T_type * m_value
Definition: enum_option.h:61
void set_value(T_type value)
Definition: enum_option.h:58
Enum_option(T_type *value, const T_typelib *type, std::string name, std::string description)
Constructs new enum option.
Definition: enum_option.h:52
#define GET_ENUM
Definition: my_getopt.h:55
constexpr pos_type Options
Definition: http_request.h:261
Definition: abstract_connection_program.h:38
required string type
Definition: replication_group_member_actions.proto:34
case opt name
Definition: sslopt-case.h:33