MySQL  8.0.27
Source Code Documentation
my_default.h
Go to the documentation of this file.
1 /* Copyright (c) 2012, 2021, Oracle and/or its affiliates.
2 
3  This program is free software; you can redistribute it and/or modify
4  it under the terms of the GNU General Public License, version 2.0,
5  as published by the Free Software Foundation.
6 
7  This program is also distributed with certain software (including
8  but not limited to OpenSSL) that is licensed under separate terms,
9  as designated in a particular file or component or in included license
10  documentation. The authors of MySQL hereby grant you an additional
11  permission to link the program and your derivative works with the
12  separately licensed software that they have included with MySQL.
13 
14  This program is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  GNU General Public License, version 2.0, for more details.
18 
19  You should have received a copy of the GNU General Public License
20  along with this program; if not, write to the Free Software
21  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
22 
23 #ifndef MY_DEFAULT_INCLUDED
24 #define MY_DEFAULT_INCLUDED
25 
26 /**
27  @file include/my_default.h
28 */
29 
30 #include <sys/types.h>
31 
32 #include "my_inttypes.h"
33 #include "my_macros.h"
34 
35 struct MEM_ROOT;
36 
37 extern const char *my_defaults_extra_file;
38 extern const char *my_defaults_group_suffix;
39 extern const char *my_defaults_file;
41 extern bool my_defaults_read_login_file;
42 extern bool no_defaults;
43 extern char datadir_buffer[];
44 
45 /* Define the type of function to be passed to process_default_option_files */
46 typedef int (*Process_option_func)(void *ctx, const char *group_name,
47  const char *option, const char *cnf_file);
48 void set_persist_args_separator(char **arg);
49 bool my_getopt_is_args_separator(const char *arg);
50 bool my_getopt_is_ro_persist_args_separator(const char *arg);
51 int get_defaults_options(int argc, char **argv, char **defaults,
52  char **extra_defaults, char **group_suffix,
53  char **login_path, bool found_no_defaults);
54 
55 // extern "C" since it is an (undocumented) part of the libmysql ABI.
56 extern "C" int my_load_defaults(const char *conf_file, const char **groups,
57  int *argc, char ***argv, MEM_ROOT *alloc,
58  const char ***);
59 int check_file_permissions(const char *file_name, bool is_login_file,
60  myf MyFlags = 0);
61 int load_defaults(const char *conf_file, const char **groups, int *argc,
62  char ***argv, MEM_ROOT *alloc);
63 int my_search_option_files(const char *conf_file, int *argc, char ***argv,
64  uint *args_used, Process_option_func func,
65  void *func_ctx, const char **default_directories,
66  bool is_login_file, bool found_no_defaults);
67 void my_print_default_files(const char *conf_file);
68 void print_defaults(const char *conf_file, const char **groups);
70 void update_variable_source(const char *opt_name, const char *config_file);
71 void set_variable_source(const char *opt_name, void *value);
72 
73 #endif // MY_DEFAULT_INCLUDED
char * argv[]
Definition: do_ctype.cc:45
get_options & argc
Definition: do_ctype.cc:51
static const char ** default_directories
Definition: my_default.cc:209
int load_defaults(const char *conf_file, const char **groups, int *argc, char ***argv, MEM_ROOT *alloc)
Definition: my_default.cc:629
bool no_defaults
Definition: my_default.cc:203
char datadir_buffer[]
Holds a reference to the directory where the persisted configuration file is located.
Definition: my_default.cc:126
void set_variable_source(const char *opt_name, void *value)
This function will set value for my_option::arg_source by doing a lookup into variables_hash based on...
Definition: my_default.cc:1539
int(* Process_option_func)(void *ctx, const char *group_name, const char *option, const char *cnf_file)
Definition: my_default.h:46
bool my_getopt_is_ro_persist_args_separator(const char *arg)
Definition: my_default.cc:176
bool my_getopt_use_args_separator
Definition: my_default.cc:186
bool my_defaults_read_login_file
A global to turn off or on reading the mylogin file.
Definition: my_default.cc:636
void set_persist_args_separator(char **arg)
Definition: my_default.cc:173
int my_search_option_files(const char *conf_file, int *argc, char ***argv, uint *args_used, Process_option_func func, void *func_ctx, const char **default_directories, bool is_login_file, bool found_no_defaults)
Definition: my_default.cc:341
int my_load_defaults(const char *conf_file, const char **groups, int *argc, char ***argv, MEM_ROOT *alloc, const char ***)
Definition: my_default.cc:675
const char * my_defaults_group_suffix
Definition: my_default.cc:192
const char * my_defaults_extra_file
Definition: my_default.cc:193
void update_variable_source(const char *opt_name, const char *config_file)
Track all options loaded from config files and command line options along with the path from where op...
Definition: my_default.cc:1455
void my_print_default_files(const char *conf_file)
Definition: my_default.cc:1280
int get_defaults_options(int argc, char **argv, char **defaults, char **extra_defaults, char **group_suffix, char **login_path, bool found_no_defaults)
Definition: my_default.cc:561
bool my_getopt_is_args_separator(const char *arg)
Definition: my_default.cc:187
const char * my_defaults_file
Definition: my_default.cc:191
int check_file_permissions(const char *file_name, bool is_login_file, myf MyFlags=0)
Check file permissions of the option file.
Definition: my_default.cc:1725
void init_variable_default_paths()
Initialize all the mappings between default config file paths/ command line options/persistent config...
Definition: my_default.cc:1363
void print_defaults(const char *conf_file, const char **groups)
Definition: my_default.cc:1328
Some integer typedefs for easier portability.
int myf
Definition: my_inttypes.h:93
Some common macros.
const string value("\"Value\"")
The MEM_ROOT is a simple arena, where allocations are carved out of larger blocks.
Definition: my_alloc.h:78
unsigned int uint
Definition: uca-dump.cc:29