MySQL 8.3.0
Source Code Documentation
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 ENUM_OPTION_INCLUDED
26#define ENUM_OPTION_INCLUDED
27
28#include <string>
29
31
32namespace Mysql {
33namespace Tools {
34namespace Base {
35namespace Options {
36
37/**
38 Enum value option.
39 */
40template <typename T_type, typename T_typelib>
41class Enum_option : public Abstract_enum_option<T_type, T_typelib> {
42 public:
43 /**
44 Constructs new enum option.
45 @param value Pointer to enum object to receive option value.
46 @param type Pointer to enum tylelib.
47 @param name Name of option. It is used in command line option name as
48 --name.
49 @param description Description of option to be printed in --help.
50 */
51 Enum_option(T_type *value, const T_typelib *type, std::string name,
52 std::string description)
53 : Abstract_enum_option<T_type, T_typelib>(value, type, GET_ENUM, name,
54 description, 1),
55 m_value(value) {}
56
57 void set_value(T_type value) { *m_value = value; }
58
59 private:
60 T_type *m_value;
61};
62
63} // namespace Options
64} // namespace Base
65} // namespace Tools
66} // namespace Mysql
67
68#endif
Abstract option to handle enum option values.
Definition: abstract_enum_option.h:41
Enum value option.
Definition: enum_option.h:41
T_type * m_value
Definition: enum_option.h:60
void set_value(T_type value)
Definition: enum_option.h:57
Enum_option(T_type *value, const T_typelib *type, std::string name, std::string description)
Constructs new enum option.
Definition: enum_option.h:51
#define GET_ENUM
Definition: my_getopt.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