my_getopt.h

/*
 Copyright (c) 2002, 2025, Oracle and/or its affiliates.

 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License, version 2.0,
 as published by the Free Software Foundation.

 This program is designed to work with certain software (including
 but not limited to OpenSSL) that is licensed under separate terms,
 as designated in a particular file or component or in included license
 documentation. The authors of MySQL hereby grant you an additional
 permission to link the program and your derivative works with the
 separately licensed software that they have either included with
 the program or referenced in the documentation.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 GNU General Public License, version 2.0, for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */

#ifndef _my_getopt_h
#define_my_getopt_h

/**
 @file include/my_getopt.h
*/

#include<sys/types.h>

#include<cstdio>
#include<string_view>

#include<mysql/components/services/system_variable_source_type.h>/* enum_variable_source */
#include"my_config.h"
#include"my_inttypes.h"
#include"my_io.h"
#include"my_macros.h"
#include"my_sys.h"/* loglevel */

#defineGET_NO_ARG1
#defineGET_BOOL2
#defineGET_INT3
#defineGET_UINT4
#defineGET_LONG5
#defineGET_ULONG6
#defineGET_LL7
#defineGET_ULL8
#defineGET_STR9
#defineGET_STR_ALLOC10
#defineGET_DISABLED11
#defineGET_ENUM12
#defineGET_SET13
#defineGET_DOUBLE14
#defineGET_FLAGSET15
#defineGET_PASSWORD16

#if SIZEOF_INT == 4
#defineGET_INT32 GET_INT
#defineGET_UINT32 GET_UINT
#elif SIZEOF_LONG == 4
#defineGET_INT32 GET_LONG
#defineGET_UINT32 GET_ULONG
#else
#error Neither int or long is of 4 bytes width
#endif

#defineGET_ASK_ADDR128
#defineGET_TYPE_MASK127

/**
 Enumeration of the my_option::arg_type attributes.
 It should be noted that for historical reasons variables with the combination
 arg_type=NO_ARG, my_option::var_type=GET_BOOL still accepts
 arguments. This is someone counter intuitive and care should be taken
 if the code is refactored.
*/
enum get_opt_arg_type { NO_ARG, OPT_ARG, REQUIRED_ARG };

structget_opt_arg_source {
/**
 config file path OR compiled default values
*/
char m_path_name[FN_REFLEN];
enum enum_variable_source m_source;
};

structTYPELIB;

structmy_option {
constchar *name; /**< Name of the option. name=NULL
 marks the end of the my_option[]
 array.
*/
int id; /**< For 0<id<=255 it's means one
 character for a short option
 (like -A), if >255 no short option
 is created, but a long option still
 can be identified uniquely in the
 my_get_one_option() callback.
 If an opton needs neither special
 treatment in the my_get_one_option()
 nor one-letter short equivalent
 use id=0.
 id=-1 is a special case and is used
 to generate deprecation warnings for
 plugin options. It should not be
 used for anything else.
*/
constchar *comment; /**< option comment, for autom. --help.
 if it's NULL the option is not
 visible in --help.
*/
void *value; /**< A pointer to the variable value */
void *u_max_value; /**< The user def. max variable value */
 TYPELIB *typelib; /**< Pointer to possible values */
 ulong var_type; /**< GET_BOOL, GET_ULL, etc */
enum get_opt_arg_type arg_type; /**< e.g. REQUIRED_ARG or OPT_ARG */
 longlong def_value; /**< Default value */
 longlong min_value; /**< Min allowed value (for numbers) */
 ulonglong max_value; /**< Max allowed value (for numbers) */
structget_opt_arg_source *arg_source; /**< Represents source/path from where
 this variable is set. */
long block_size; /**< Value should be a mult. of this (for numbers) */
void *app_type; /**< To be used by an application */
};

typedefbool (*my_get_one_option)(int, conststructmy_option *, char *);
/**
 Used to retrieve a reference to the object (variable) that holds the value
 for the given option. For example, if var_type is GET_UINT, the function
 must return a pointer to a variable of type uint. A argument is stored in
 the location pointed to by the returned pointer.
*/
typedefvoid *(*my_getopt_value)(constchar *, size_t, conststructmy_option *,
int *);

externchar *disabled_my_option;
externbool my_getopt_print_errors;
externbool my_getopt_skip_unknown;
externbool log_replica_updates_supplied;
externbool replica_preserve_commit_order_supplied;
extern my_error_reporter my_getopt_error_reporter;

extern"C"inthandle_options(int *argc, char ***argv,
conststructmy_option *longopts,
 my_get_one_option);
externintmy_handle_options(int *argc, char ***argv,
conststructmy_option *longopts,
 my_get_one_option, constchar **command_list,
bool ignore_unknown_option);
externintmy_handle_options2(int *argc, char ***argv,
conststructmy_option *longopts,
 my_get_one_option, constchar **command_list,
bool ignore_unknown_option, bool boolean_as_int);
externvoidprint_cmdline_password_warning();
externvoidmy_cleanup_options(conststructmy_option *options);
externvoidmy_print_help(conststructmy_option *options);
externvoidmy_print_variables(conststructmy_option *options);
externvoidmy_print_variables_ex(conststructmy_option *options, FILE *file);
externvoidmy_getopt_register_get_addr(my_getopt_value);

ulonglong getopt_ull_limit_value(ulonglong num, conststructmy_option *optp,
bool *fix);
longlong getopt_ll_limit_value(longlong, conststructmy_option *, bool *fix);
doublegetopt_double_limit_value(double num, conststructmy_option *optp,
bool *fix);
ulonglong max_of_int_range(int var_type);

ulonglong getopt_double2ulonglong(double);
doublegetopt_ulonglong2double(ulonglong);
intfindopt(constchar *, uint, conststructmy_option **);

boolis_key_cache_variable_suffix(std::string_view suffix);

boolget_bool_argument(constchar *argument, bool *error);
// Declared here, so we can unit test it.
template <typename LLorULL>
LLorULL eval_num_suffix(constchar *argument, int *error,
constchar *option_name);

#endif/* _my_getopt_h */