Fifth batch for 2.19 cycle
[git/git.git] / config.h
CommitLineData
e67a57fc
BW
1#ifndef CONFIG_H
2#define CONFIG_H
3
4/* git_config_parse_key() returns these negated: */
5#define CONFIG_INVALID_KEY 1
6#define CONFIG_NO_SECTION_OR_NAME 2
7/* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
8#define CONFIG_NO_LOCK -1
9#define CONFIG_INVALID_FILE 3
10#define CONFIG_NO_WRITE 4
11#define CONFIG_NOTHING_SET 5
12#define CONFIG_INVALID_PATTERN 6
13#define CONFIG_GENERIC_ERROR 7
14
15#define CONFIG_REGEX_NONE ((void *)1)
16
17struct git_config_source {
18 unsigned int use_stdin:1;
19 const char *file;
20 const char *blob;
21};
22
23enum config_origin_type {
24 CONFIG_ORIGIN_BLOB,
25 CONFIG_ORIGIN_FILE,
26 CONFIG_ORIGIN_STDIN,
27 CONFIG_ORIGIN_SUBMODULE_BLOB,
28 CONFIG_ORIGIN_CMDLINE
29};
30
8032cc44
JS
31enum config_event_t {
32 CONFIG_EVENT_SECTION,
33 CONFIG_EVENT_ENTRY,
34 CONFIG_EVENT_WHITESPACE,
35 CONFIG_EVENT_COMMENT,
36 CONFIG_EVENT_EOF,
37 CONFIG_EVENT_ERROR
38};
39
40/*
41 * The parser event function (if not NULL) is called with the event type and
42 * the begin/end offsets of the parsed elements.
43 *
44 * Note: for CONFIG_EVENT_ENTRY (i.e. config variables), the trailing newline
45 * character is considered part of the element.
46 */
47typedef int (*config_parser_event_fn_t)(enum config_event_t type,
48 size_t begin_offset, size_t end_offset,
49 void *event_fn_data);
50
e67a57fc
BW
51struct config_options {
52 unsigned int respect_includes : 1;
a577fb5f 53 const char *commondir;
e67a57fc 54 const char *git_dir;
8032cc44
JS
55 config_parser_event_fn_t event_fn;
56 void *event_fn_data;
66f97228
JK
57 enum config_error_action {
58 CONFIG_ERROR_UNSET = 0, /* use source-specific default */
59 CONFIG_ERROR_DIE, /* die() on error */
60 CONFIG_ERROR_ERROR, /* error() on error, return -1 */
63583203 61 CONFIG_ERROR_SILENT, /* return -1 */
66f97228 62 } error_action;
e67a57fc
BW
63};
64
65typedef int (*config_fn_t)(const char *, const char *, void *);
66extern int git_default_config(const char *, const char *, void *);
67extern int git_config_from_file(config_fn_t fn, const char *, void *);
8032cc44
JS
68extern int git_config_from_file_with_options(config_fn_t fn, const char *,
69 void *,
70 const struct config_options *);
4574f1aa
JK
71extern int git_config_from_mem(config_fn_t fn,
72 const enum config_origin_type,
73 const char *name,
74 const char *buf, size_t len,
75 void *data, const struct config_options *opts);
cd73de47 76extern int git_config_from_blob_oid(config_fn_t fn, const char *name,
77 const struct object_id *oid, void *data);
e67a57fc
BW
78extern void git_config_push_parameter(const char *text);
79extern int git_config_from_parameters(config_fn_t fn, void *data);
80extern void read_early_config(config_fn_t cb, void *data);
81extern void git_config(config_fn_t fn, void *);
dc8441fd
BW
82extern int config_with_options(config_fn_t fn, void *,
83 struct git_config_source *config_source,
84 const struct config_options *opts);
e67a57fc
BW
85extern int git_parse_ulong(const char *, unsigned long *);
86extern int git_parse_maybe_bool(const char *);
87extern int git_config_int(const char *, const char *);
88extern int64_t git_config_int64(const char *, const char *);
89extern unsigned long git_config_ulong(const char *, const char *);
90extern ssize_t git_config_ssize_t(const char *, const char *);
91extern int git_config_bool_or_int(const char *, const char *, int *);
92extern int git_config_bool(const char *, const char *);
e67a57fc
BW
93extern int git_config_string(const char **, const char *, const char *);
94extern int git_config_pathname(const char **, const char *, const char *);
5f967424 95extern int git_config_expiry_date(timestamp_t *, const char *, const char *);
6d2f9acc 96extern int git_config_color(char *, const char *, const char *);
e67a57fc
BW
97extern int git_config_set_in_file_gently(const char *, const char *, const char *);
98extern void git_config_set_in_file(const char *, const char *, const char *);
99extern int git_config_set_gently(const char *, const char *);
100extern void git_config_set(const char *, const char *);
101extern int git_config_parse_key(const char *, char **, int *);
102extern int git_config_key_is_valid(const char *key);
103extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
104extern void git_config_set_multivar(const char *, const char *, const char *, int);
105extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
106extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
107extern int git_config_rename_section(const char *, const char *);
108extern int git_config_rename_section_in_file(const char *, const char *, const char *);
3b48045c
JH
109extern int git_config_copy_section(const char *, const char *);
110extern int git_config_copy_section_in_file(const char *, const char *, const char *);
e67a57fc
BW
111extern const char *git_etc_gitconfig(void);
112extern int git_env_bool(const char *, int);
113extern unsigned long git_env_ulong(const char *, unsigned long);
114extern int git_config_system(void);
115extern int config_error_nonbool(const char *);
116#if defined(__GNUC__)
117#define config_error_nonbool(s) (config_error_nonbool(s), const_error())
118#endif
119
120extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
121
122enum config_scope {
123 CONFIG_SCOPE_UNKNOWN = 0,
124 CONFIG_SCOPE_SYSTEM,
125 CONFIG_SCOPE_GLOBAL,
126 CONFIG_SCOPE_REPO,
127 CONFIG_SCOPE_CMDLINE,
128};
129
130extern enum config_scope current_config_scope(void);
131extern const char *current_config_origin_type(void);
132extern const char *current_config_name(void);
133
134struct config_include_data {
135 int depth;
136 config_fn_t fn;
137 void *data;
138 const struct config_options *opts;
139};
140#define CONFIG_INCLUDE_INIT { 0 }
141extern int git_config_include(const char *name, const char *value, void *data);
142
143/*
144 * Match and parse a config key of the form:
145 *
146 * section.(subsection.)?key
147 *
148 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
149 * we return -1 if it does not match, 0 otherwise. The subsection and key
150 * out-parameters are filled by the function (and *subsection is NULL if it is
151 * missing).
152 *
153 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if
154 * there is no subsection at all.
155 */
156extern int parse_config_key(const char *var,
157 const char *section,
158 const char **subsection, int *subsection_len,
159 const char **key);
160
161struct config_set_element {
162 struct hashmap_entry ent;
163 char *key;
164 struct string_list value_list;
165};
166
167struct configset_list_item {
168 struct config_set_element *e;
169 int value_index;
170};
171
172/*
173 * the contents of the list are ordered according to their
174 * position in the config files and order of parsing the files.
175 * (i.e. key-value pair at the last position of .git/config will
176 * be at the last item of the list)
177 */
178struct configset_list {
179 struct configset_list_item *items;
180 unsigned int nr, alloc;
181};
182
183struct config_set {
184 struct hashmap config_hash;
185 int hash_initialized;
186 struct configset_list list;
187};
188
189extern void git_configset_init(struct config_set *cs);
190extern int git_configset_add_file(struct config_set *cs, const char *filename);
191extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
192extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
193extern void git_configset_clear(struct config_set *cs);
194extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
195extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
196extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
197extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
198extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
199extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
200extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
201extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
202
3b256228
BW
203/* Functions for reading a repository's config */
204struct repository;
205extern void repo_config(struct repository *repo, config_fn_t fn, void *data);
206extern int repo_config_get_value(struct repository *repo,
207 const char *key, const char **value);
208extern const struct string_list *repo_config_get_value_multi(struct repository *repo,
209 const char *key);
210extern int repo_config_get_string_const(struct repository *repo,
211 const char *key, const char **dest);
212extern int repo_config_get_string(struct repository *repo,
213 const char *key, char **dest);
214extern int repo_config_get_int(struct repository *repo,
215 const char *key, int *dest);
216extern int repo_config_get_ulong(struct repository *repo,
217 const char *key, unsigned long *dest);
218extern int repo_config_get_bool(struct repository *repo,
219 const char *key, int *dest);
220extern int repo_config_get_bool_or_int(struct repository *repo,
221 const char *key, int *is_bool, int *dest);
222extern int repo_config_get_maybe_bool(struct repository *repo,
223 const char *key, int *dest);
224extern int repo_config_get_pathname(struct repository *repo,
225 const char *key, const char **dest);
226
e67a57fc
BW
227extern int git_config_get_value(const char *key, const char **value);
228extern const struct string_list *git_config_get_value_multi(const char *key);
229extern void git_config_clear(void);
e67a57fc
BW
230extern int git_config_get_string_const(const char *key, const char **dest);
231extern int git_config_get_string(const char *key, char **dest);
232extern int git_config_get_int(const char *key, int *dest);
233extern int git_config_get_ulong(const char *key, unsigned long *dest);
234extern int git_config_get_bool(const char *key, int *dest);
235extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
236extern int git_config_get_maybe_bool(const char *key, int *dest);
237extern int git_config_get_pathname(const char *key, const char **dest);
238extern int git_config_get_untracked_cache(void);
239extern int git_config_get_split_index(void);
240extern int git_config_get_max_percent_split_change(void);
883e248b 241extern int git_config_get_fsmonitor(void);
e67a57fc
BW
242
243/* This dies if the configured or default date is in the future */
244extern int git_config_get_expiry(const char *key, const char **output);
245
6e96cb52
JH
246/* parse either "this many days" integer, or "5.days.ago" approxidate */
247extern int git_config_get_expiry_in_days(const char *key, timestamp_t *, timestamp_t now);
248
e67a57fc
BW
249struct key_value_info {
250 const char *filename;
251 int linenr;
252 enum config_origin_type origin_type;
253 enum config_scope scope;
254};
255
256extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
257extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
258
a73b3680
NTND
259#define LOOKUP_CONFIG(mapping, var) \
260 lookup_config(mapping, ARRAY_SIZE(mapping), var)
261int lookup_config(const char **mapping, int nr_mapping, const char *var);
262
e67a57fc 263#endif /* CONFIG_H */