MySQL 8.2.0
Source Code Documentation
abstract_number_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_NUMBER_OPTION_INCLUDED
26#define ABSTRACT_NUMBER_OPTION_INCLUDED
27
28#include <string>
29
31
32namespace Mysql {
33namespace Tools {
34namespace Base {
35namespace Options {
36
37/**
38 Abstract option to handle numeric option values.
39 */
40template <typename T_type, typename T_value>
42 public:
43 /**
44 Sets minimum value boundary for option value. Smaller values passed as
45 option value will be changed to this minimum value.
46 */
47 virtual T_type *set_minimum_value(T_value minimum) = 0;
48 /**
49 Sets maximum value boundary for option value. Greater values passed as
50 option value will be changed to this maximum value.
51 */
52 virtual T_type *set_maximum_value(T_value maximum) = 0;
53
54 protected:
55 /**
56 Constructs new number option.
57 @param value Pointer to object to receive option value.
58 @param var_type my_getopt internal option type.
59 @param name Name of option. It is used in command line option name as
60 --name.
61 @param description Description of option to be printed in --help.
62 @param default_value default value to be supplied to internal option
63 data structure.
64 */
65 Abstract_number_option(T_value *value, ulong var_type, std::string name,
66 std::string description, uint64 default_value);
67};
68
69template <typename T_type, typename T_value>
71 T_value *value, ulong var_type, std::string name, std::string description,
72 uint64 default_value)
73 : Abstract_value_option<T_type>(value, var_type, name, description,
74 default_value) {}
75
76} // namespace Options
77} // namespace Base
78} // namespace Tools
79} // namespace Mysql
80
81#endif
Abstract option to handle numeric option values.
Definition: abstract_number_option.h:41
virtual T_type * set_minimum_value(T_value minimum)=0
Sets minimum value boundary for option value.
virtual T_type * set_maximum_value(T_value maximum)=0
Sets maximum value boundary for option value.
Abstract_number_option(T_value *value, ulong var_type, std::string name, std::string description, uint64 default_value)
Constructs new number option.
Definition: abstract_number_option.h:70
Abstract option to handle options accepting value argument.
Definition: abstract_value_option.h:42
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