MySQL 8.2.0
Source Code Documentation
abstract_value_option.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 ABSTRACT_VALUE_OPTION_INCLUDED
26#define ABSTRACT_VALUE_OPTION_INCLUDED
27
28#include <string>
29
31#include "my_getopt.h"
32
33namespace Mysql {
34namespace Tools {
35namespace Base {
36namespace Options {
37
38/**
39 Abstract option to handle options accepting value argument.
40 */
41template <typename T_type>
42class Abstract_value_option : public Abstract_option<T_type> {
43 public:
44 /**
45 Sets arg_type to OPT_ARG - doesn't require argument to be specified when
46 using this option.
47 */
48 T_type *value_optional();
49
50 protected:
51 /**
52 Constructs new option with value argument.
53 @param value Pointer to object to receive option value.
54 @param var_type my_getopt internal option type.
55 @param name Name of option. It is used in command line option name as
56 --name.
57 @param description Description of option to be printed in --help.
58 @param default_value default value to be supplied to internal option
59 data structure.
60 */
61 Abstract_value_option(void *value, ulong var_type, std::string name,
62 std::string description, uint64 default_value);
63};
64
65template <typename T_type>
67 ulong var_type,
68 std::string name,
69 std::string description,
70 uint64 default_value)
71 : Abstract_option<T_type>(value, var_type, name, description,
72 default_value) {}
73
74template <typename T_type>
76 this->m_option_structure.arg_type = OPT_ARG;
77 return (T_type *)this;
78}
79
80} // namespace Options
81} // namespace Base
82} // namespace Tools
83} // namespace Mysql
84#endif
Abstract base with common option functionalities.
Definition: abstract_option.h:49
Abstract option to handle options accepting value argument.
Definition: abstract_value_option.h:42
Abstract_value_option(void *value, ulong var_type, std::string name, std::string description, uint64 default_value)
Constructs new option with value argument.
Definition: abstract_value_option.h:66
T_type * value_optional()
Sets arg_type to OPT_ARG - doesn't require argument to be specified when using this option.
Definition: abstract_value_option.h:75
@ OPT_ARG
Definition: my_getopt.h:80
uint64_t uint64
Definition: my_inttypes.h:68
constexpr pos_type Options
Definition: http_request.h:260
Definition: abstract_connection_program.h:39
case opt name
Definition: sslopt-case.h:32