MySQL 8.3.0
Source Code Documentation
bool_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 BOOL_OPTION_INCLUDED
26#define BOOL_OPTION_INCLUDED
27
28#include <string>
29
31#include "my_getopt.h"
32
33namespace Mysql {
34namespace Tools {
35namespace Base {
36namespace Options {
37
38/**
39 Boolean option with value specified as argument.
40 */
41class Bool_option : public Abstract_option<Bool_option> {
42 public:
43 /**
44 Constructs new boolean option with value received from argument.
45 @param value Pointer to double object to receive option value.
46 @param name Name of option. It is used in command line option name as
47 --name.
48 @param description Description of option to be printed in --help.
49 */
50 Bool_option(bool *value, std::string name, std::string description);
51
52 /**
53 Sets value for this option. If it is specified before handling commandline
54 options then supplied value is used as default value of this option.
55 */
56 Bool_option *set_value(bool value);
57};
58
59} // namespace Options
60} // namespace Base
61} // namespace Tools
62} // namespace Mysql
63
64#endif
Abstract base with common option functionalities.
Definition: abstract_option.h:49
Boolean option with value specified as argument.
Definition: bool_option.h:41
Bool_option(bool *value, std::string name, std::string description)
Constructs new boolean option with value received from argument.
Definition: bool_option.cc:30
Bool_option * set_value(bool value)
Sets value for this option.
Definition: bool_option.cc:36
constexpr pos_type Options
Definition: http_request.h:260
Definition: abstract_connection_program.h:39
case opt name
Definition: sslopt-case.h:32