]>
Commit | Line | Data |
---|---|---|
e67a57fc BW |
1 | #ifndef CONFIG_H |
2 | #define CONFIG_H | |
3 | ||
ef3ca954 EN |
4 | #include "hashmap.h" |
5 | #include "string-list.h" | |
6 | ||
6c96630c HW |
7 | |
8 | /** | |
9 | * The config API gives callers a way to access Git configuration files | |
10 | * (and files which have the same syntax). | |
11 | * | |
12 | * General Usage | |
13 | * ------------- | |
14 | * | |
15 | * Config files are parsed linearly, and each variable found is passed to a | |
16 | * caller-provided callback function. The callback function is responsible | |
17 | * for any actions to be taken on the config option, and is free to ignore | |
18 | * some options. It is not uncommon for the configuration to be parsed | |
19 | * several times during the run of a Git program, with different callbacks | |
20 | * picking out different variables useful to themselves. | |
21 | */ | |
22 | ||
ef3ca954 EN |
23 | struct object_id; |
24 | ||
e67a57fc BW |
25 | /* git_config_parse_key() returns these negated: */ |
26 | #define CONFIG_INVALID_KEY 1 | |
27 | #define CONFIG_NO_SECTION_OR_NAME 2 | |
28 | /* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */ | |
29 | #define CONFIG_NO_LOCK -1 | |
30 | #define CONFIG_INVALID_FILE 3 | |
31 | #define CONFIG_NO_WRITE 4 | |
32 | #define CONFIG_NOTHING_SET 5 | |
33 | #define CONFIG_INVALID_PATTERN 6 | |
34 | #define CONFIG_GENERIC_ERROR 7 | |
35 | ||
36 | #define CONFIG_REGEX_NONE ((void *)1) | |
37 | ||
e37efa40 MR |
38 | enum config_scope { |
39 | CONFIG_SCOPE_UNKNOWN = 0, | |
40 | CONFIG_SCOPE_SYSTEM, | |
41 | CONFIG_SCOPE_GLOBAL, | |
42 | CONFIG_SCOPE_LOCAL, | |
43 | CONFIG_SCOPE_WORKTREE, | |
44 | CONFIG_SCOPE_COMMAND, | |
9a83d088 | 45 | CONFIG_SCOPE_SUBMODULE, |
e37efa40 MR |
46 | }; |
47 | const char *config_scope_name(enum config_scope scope); | |
48 | ||
e67a57fc BW |
49 | struct git_config_source { |
50 | unsigned int use_stdin:1; | |
51 | const char *file; | |
52 | const char *blob; | |
e37efa40 | 53 | enum config_scope scope; |
e67a57fc BW |
54 | }; |
55 | ||
56 | enum config_origin_type { | |
57 | CONFIG_ORIGIN_BLOB, | |
58 | CONFIG_ORIGIN_FILE, | |
59 | CONFIG_ORIGIN_STDIN, | |
60 | CONFIG_ORIGIN_SUBMODULE_BLOB, | |
61 | CONFIG_ORIGIN_CMDLINE | |
62 | }; | |
63 | ||
8032cc44 JS |
64 | enum config_event_t { |
65 | CONFIG_EVENT_SECTION, | |
66 | CONFIG_EVENT_ENTRY, | |
67 | CONFIG_EVENT_WHITESPACE, | |
68 | CONFIG_EVENT_COMMENT, | |
69 | CONFIG_EVENT_EOF, | |
70 | CONFIG_EVENT_ERROR | |
71 | }; | |
72 | ||
73 | /* | |
74 | * The parser event function (if not NULL) is called with the event type and | |
75 | * the begin/end offsets of the parsed elements. | |
76 | * | |
77 | * Note: for CONFIG_EVENT_ENTRY (i.e. config variables), the trailing newline | |
78 | * character is considered part of the element. | |
79 | */ | |
80 | typedef int (*config_parser_event_fn_t)(enum config_event_t type, | |
81 | size_t begin_offset, size_t end_offset, | |
82 | void *event_fn_data); | |
83 | ||
e67a57fc BW |
84 | struct config_options { |
85 | unsigned int respect_includes : 1; | |
800a7f99 JH |
86 | unsigned int ignore_repo : 1; |
87 | unsigned int ignore_worktree : 1; | |
88 | unsigned int ignore_cmdline : 1; | |
f672deec | 89 | unsigned int system_gently : 1; |
a577fb5f | 90 | const char *commondir; |
e67a57fc | 91 | const char *git_dir; |
8032cc44 JS |
92 | config_parser_event_fn_t event_fn; |
93 | void *event_fn_data; | |
66f97228 JK |
94 | enum config_error_action { |
95 | CONFIG_ERROR_UNSET = 0, /* use source-specific default */ | |
96 | CONFIG_ERROR_DIE, /* die() on error */ | |
97 | CONFIG_ERROR_ERROR, /* error() on error, return -1 */ | |
63583203 | 98 | CONFIG_ERROR_SILENT, /* return -1 */ |
66f97228 | 99 | } error_action; |
e67a57fc BW |
100 | }; |
101 | ||
6c96630c HW |
102 | /** |
103 | * A config callback function takes three parameters: | |
104 | * | |
105 | * - the name of the parsed variable. This is in canonical "flat" form: the | |
106 | * section, subsection, and variable segments will be separated by dots, | |
107 | * and the section and variable segments will be all lowercase. E.g., | |
108 | * `core.ignorecase`, `diff.SomeType.textconv`. | |
109 | * | |
110 | * - the value of the found variable, as a string. If the variable had no | |
111 | * value specified, the value will be NULL (typically this means it | |
112 | * should be interpreted as boolean true). | |
113 | * | |
114 | * - a void pointer passed in by the caller of the config API; this can | |
115 | * contain callback-specific data | |
116 | * | |
117 | * A config callback should return 0 for success, or -1 if the variable | |
118 | * could not be parsed properly. | |
119 | */ | |
e67a57fc | 120 | typedef int (*config_fn_t)(const char *, const char *, void *); |
6c96630c | 121 | |
55454427 | 122 | int git_default_config(const char *, const char *, void *); |
6c96630c HW |
123 | |
124 | /** | |
125 | * Read a specific file in git-config format. | |
126 | * This function takes the same callback and data parameters as `git_config`. | |
127 | */ | |
55454427 | 128 | int git_config_from_file(config_fn_t fn, const char *, void *); |
6c96630c | 129 | |
55454427 | 130 | int git_config_from_file_with_options(config_fn_t fn, const char *, |
ad6dad09 DL |
131 | void *, |
132 | const struct config_options *); | |
55454427 | 133 | int git_config_from_mem(config_fn_t fn, |
ad6dad09 DL |
134 | const enum config_origin_type, |
135 | const char *name, | |
136 | const char *buf, size_t len, | |
137 | void *data, const struct config_options *opts); | |
55454427 | 138 | int git_config_from_blob_oid(config_fn_t fn, const char *name, |
ad6dad09 | 139 | const struct object_id *oid, void *data); |
55454427 DL |
140 | void git_config_push_parameter(const char *text); |
141 | int git_config_from_parameters(config_fn_t fn, void *data); | |
142 | void read_early_config(config_fn_t cb, void *data); | |
4aeeef37 | 143 | void read_very_early_config(config_fn_t cb, void *data); |
6c96630c HW |
144 | |
145 | /** | |
146 | * Most programs will simply want to look up variables in all config files | |
147 | * that Git knows about, using the normal precedence rules. To do this, | |
148 | * call `git_config` with a callback function and void data pointer. | |
149 | * | |
150 | * `git_config` will read all config sources in order of increasing | |
151 | * priority. Thus a callback should typically overwrite previously-seen | |
152 | * entries with new ones (e.g., if both the user-wide `~/.gitconfig` and | |
153 | * repo-specific `.git/config` contain `color.ui`, the config machinery | |
154 | * will first feed the user-wide one to the callback, and then the | |
155 | * repo-specific one; by overwriting, the higher-priority repo-specific | |
156 | * value is left at the end). | |
157 | */ | |
55454427 | 158 | void git_config(config_fn_t fn, void *); |
6c96630c HW |
159 | |
160 | /** | |
161 | * Lets the caller examine config while adjusting some of the default | |
162 | * behavior of `git_config`. It should almost never be used by "regular" | |
163 | * Git code that is looking up configuration variables. | |
164 | * It is intended for advanced callers like `git-config`, which are | |
165 | * intentionally tweaking the normal config-lookup process. | |
166 | * It takes two extra parameters: | |
167 | * | |
168 | * - `config_source` | |
169 | * If this parameter is non-NULL, it specifies the source to parse for | |
170 | * configuration, rather than looking in the usual files. See `struct | |
171 | * git_config_source` in `config.h` for details. Regular `git_config` defaults | |
172 | * to `NULL`. | |
173 | * | |
174 | * - `opts` | |
175 | * Specify options to adjust the behavior of parsing config files. See `struct | |
176 | * config_options` in `config.h` for details. As an example: regular `git_config` | |
177 | * sets `opts.respect_includes` to `1` by default. | |
178 | */ | |
55454427 | 179 | int config_with_options(config_fn_t fn, void *, |
ad6dad09 DL |
180 | struct git_config_source *config_source, |
181 | const struct config_options *opts); | |
6c96630c HW |
182 | |
183 | /** | |
184 | * Value Parsing Helpers | |
185 | * --------------------- | |
186 | * | |
187 | * The following helper functions aid in parsing string values | |
188 | */ | |
189 | ||
55454427 DL |
190 | int git_parse_ssize_t(const char *, ssize_t *); |
191 | int git_parse_ulong(const char *, unsigned long *); | |
6c96630c HW |
192 | |
193 | /** | |
194 | * Same as `git_config_bool`, except that it returns -1 on error rather | |
195 | * than dying. | |
196 | */ | |
55454427 | 197 | int git_parse_maybe_bool(const char *); |
6c96630c HW |
198 | |
199 | /** | |
200 | * Parse the string to an integer, including unit factors. Dies on error; | |
201 | * otherwise, returns the parsed result. | |
202 | */ | |
55454427 | 203 | int git_config_int(const char *, const char *); |
6c96630c | 204 | |
55454427 | 205 | int64_t git_config_int64(const char *, const char *); |
6c96630c HW |
206 | |
207 | /** | |
208 | * Identical to `git_config_int`, but for unsigned longs. | |
209 | */ | |
55454427 | 210 | unsigned long git_config_ulong(const char *, const char *); |
6c96630c | 211 | |
55454427 | 212 | ssize_t git_config_ssize_t(const char *, const char *); |
6c96630c HW |
213 | |
214 | /** | |
215 | * Same as `git_config_bool`, except that integers are returned as-is, and | |
216 | * an `is_bool` flag is unset. | |
217 | */ | |
55454427 | 218 | int git_config_bool_or_int(const char *, const char *, int *); |
6c96630c HW |
219 | |
220 | /** | |
221 | * Parse a string into a boolean value, respecting keywords like "true" and | |
222 | * "false". Integer values are converted into true/false values (when they | |
223 | * are non-zero or zero, respectively). Other values cause a die(). If | |
224 | * parsing is successful, the return value is the result. | |
225 | */ | |
55454427 | 226 | int git_config_bool(const char *, const char *); |
6c96630c HW |
227 | |
228 | /** | |
229 | * Allocates and copies the value string into the `dest` parameter; if no | |
230 | * string is given, prints an error message and returns -1. | |
231 | */ | |
55454427 | 232 | int git_config_string(const char **, const char *, const char *); |
6c96630c HW |
233 | |
234 | /** | |
235 | * Similar to `git_config_string`, but expands `~` or `~user` into the | |
236 | * user's home directory when found at the beginning of the path. | |
237 | */ | |
55454427 | 238 | int git_config_pathname(const char **, const char *, const char *); |
6c96630c | 239 | |
55454427 DL |
240 | int git_config_expiry_date(timestamp_t *, const char *, const char *); |
241 | int git_config_color(char *, const char *, const char *); | |
242 | int git_config_set_in_file_gently(const char *, const char *, const char *); | |
6c96630c HW |
243 | |
244 | /** | |
245 | * write config values to a specific config file, takes a key/value pair as | |
246 | * parameter. | |
247 | */ | |
55454427 | 248 | void git_config_set_in_file(const char *, const char *, const char *); |
6c96630c | 249 | |
55454427 | 250 | int git_config_set_gently(const char *, const char *); |
6c96630c HW |
251 | |
252 | /** | |
253 | * write config values to `.git/config`, takes a key/value pair as parameter. | |
254 | */ | |
55454427 | 255 | void git_config_set(const char *, const char *); |
6c96630c | 256 | |
f011a965 | 257 | int git_config_parse_key(const char *, char **, size_t *); |
55454427 | 258 | int git_config_key_is_valid(const char *key); |
504ee129 DS |
259 | |
260 | /* | |
261 | * The following macros specify flag bits that alter the behavior | |
262 | * of the git_config_set_multivar*() methods. | |
263 | */ | |
264 | ||
265 | /* | |
266 | * When CONFIG_FLAGS_MULTI_REPLACE is specified, all matching key/values | |
267 | * are removed before a single new pair is written. If the flag is not | |
268 | * present, then set operations replace only the first match. | |
269 | */ | |
270 | #define CONFIG_FLAGS_MULTI_REPLACE (1 << 0) | |
271 | ||
c90702a1 DS |
272 | /* |
273 | * When CONFIG_FLAGS_FIXED_VALUE is specified, match key/value pairs | |
274 | * by string comparison (not regex match) to the provided value_pattern | |
275 | * parameter. | |
276 | */ | |
277 | #define CONFIG_FLAGS_FIXED_VALUE (1 << 1) | |
278 | ||
504ee129 DS |
279 | int git_config_set_multivar_gently(const char *, const char *, const char *, unsigned); |
280 | void git_config_set_multivar(const char *, const char *, const char *, unsigned); | |
281 | int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, unsigned); | |
6c96630c HW |
282 | |
283 | /** | |
284 | * takes four parameters: | |
285 | * | |
286 | * - the name of the file, as a string, to which key/value pairs will be written. | |
287 | * | |
288 | * - the name of key, as a string. This is in canonical "flat" form: the section, | |
289 | * subsection, and variable segments will be separated by dots, and the section | |
290 | * and variable segments will be all lowercase. | |
291 | * E.g., `core.ignorecase`, `diff.SomeType.textconv`. | |
292 | * | |
293 | * - the value of the variable, as a string. If value is equal to NULL, it will | |
294 | * remove the matching key from the config file. | |
295 | * | |
296 | * - the value regex, as a string. It will disregard key/value pairs where value | |
297 | * does not match. | |
298 | * | |
504ee129 | 299 | * - a flags value with bits corresponding to the CONFIG_FLAG_* macros. |
6c96630c HW |
300 | * |
301 | * It returns 0 on success. | |
302 | */ | |
504ee129 DS |
303 | void git_config_set_multivar_in_file(const char *config_filename, |
304 | const char *key, | |
305 | const char *value, | |
247e2f82 | 306 | const char *value_pattern, |
504ee129 | 307 | unsigned flags); |
6c96630c HW |
308 | |
309 | /** | |
310 | * rename or remove sections in the config file | |
311 | * parameters `old_name` and `new_name` | |
312 | * If NULL is passed through `new_name` parameter, | |
313 | * the section will be removed from the config file. | |
314 | */ | |
55454427 | 315 | int git_config_rename_section(const char *, const char *); |
6c96630c | 316 | |
55454427 DL |
317 | int git_config_rename_section_in_file(const char *, const char *, const char *); |
318 | int git_config_copy_section(const char *, const char *); | |
319 | int git_config_copy_section_in_file(const char *, const char *, const char *); | |
320 | const char *git_etc_gitconfig(void); | |
321 | int git_env_bool(const char *, int); | |
322 | unsigned long git_env_ulong(const char *, unsigned long); | |
323 | int git_config_system(void); | |
324 | int config_error_nonbool(const char *); | |
e67a57fc BW |
325 | #if defined(__GNUC__) |
326 | #define config_error_nonbool(s) (config_error_nonbool(s), const_error()) | |
327 | #endif | |
328 | ||
55454427 | 329 | int git_config_parse_parameter(const char *, config_fn_t fn, void *data); |
e67a57fc | 330 | |
55454427 DL |
331 | enum config_scope current_config_scope(void); |
332 | const char *current_config_origin_type(void); | |
333 | const char *current_config_name(void); | |
f2a2327a | 334 | int current_config_line(void); |
e67a57fc | 335 | |
6c96630c HW |
336 | /** |
337 | * Include Directives | |
338 | * ------------------ | |
339 | * | |
340 | * By default, the config parser does not respect include directives. | |
341 | * However, a caller can use the special `git_config_include` wrapper | |
342 | * callback to support them. To do so, you simply wrap your "real" callback | |
343 | * function and data pointer in a `struct config_include_data`, and pass | |
344 | * the wrapper to the regular config-reading functions. For example: | |
345 | * | |
346 | * ------------------------------------------- | |
347 | * int read_file_with_include(const char *file, config_fn_t fn, void *data) | |
348 | * { | |
349 | * struct config_include_data inc = CONFIG_INCLUDE_INIT; | |
350 | * inc.fn = fn; | |
351 | * inc.data = data; | |
352 | * return git_config_from_file(git_config_include, file, &inc); | |
353 | * } | |
354 | * ------------------------------------------- | |
355 | * | |
356 | * `git_config` respects includes automatically. The lower-level | |
357 | * `git_config_from_file` does not. | |
358 | * | |
359 | */ | |
e67a57fc BW |
360 | struct config_include_data { |
361 | int depth; | |
362 | config_fn_t fn; | |
363 | void *data; | |
364 | const struct config_options *opts; | |
365 | }; | |
366 | #define CONFIG_INCLUDE_INIT { 0 } | |
55454427 | 367 | int git_config_include(const char *name, const char *value, void *data); |
e67a57fc BW |
368 | |
369 | /* | |
370 | * Match and parse a config key of the form: | |
371 | * | |
372 | * section.(subsection.)?key | |
373 | * | |
374 | * (i.e., what gets handed to a config_fn_t). The caller provides the section; | |
375 | * we return -1 if it does not match, 0 otherwise. The subsection and key | |
376 | * out-parameters are filled by the function (and *subsection is NULL if it is | |
377 | * missing). | |
378 | * | |
379 | * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if | |
380 | * there is no subsection at all. | |
381 | */ | |
55454427 | 382 | int parse_config_key(const char *var, |
ad6dad09 | 383 | const char *section, |
f5914f4b | 384 | const char **subsection, size_t *subsection_len, |
ad6dad09 | 385 | const char **key); |
e67a57fc | 386 | |
6c96630c HW |
387 | /** |
388 | * Custom Configsets | |
389 | * ----------------- | |
390 | * | |
391 | * A `config_set` can be used to construct an in-memory cache for | |
392 | * config-like files that the caller specifies (i.e., files like `.gitmodules`, | |
393 | * `~/.gitconfig` etc.). For example, | |
394 | * | |
395 | * ---------------------------------------- | |
396 | * struct config_set gm_config; | |
397 | * git_configset_init(&gm_config); | |
398 | * int b; | |
399 | * //we add config files to the config_set | |
400 | * git_configset_add_file(&gm_config, ".gitmodules"); | |
401 | * git_configset_add_file(&gm_config, ".gitmodules_alt"); | |
402 | * | |
403 | * if (!git_configset_get_bool(gm_config, "submodule.frotz.ignore", &b)) { | |
404 | * //hack hack hack | |
405 | * } | |
406 | * | |
407 | * when we are done with the configset: | |
408 | * git_configset_clear(&gm_config); | |
409 | * ---------------------------------------- | |
410 | * | |
411 | * Configset API provides functions for the above mentioned work flow | |
412 | */ | |
413 | ||
e67a57fc BW |
414 | struct config_set_element { |
415 | struct hashmap_entry ent; | |
416 | char *key; | |
417 | struct string_list value_list; | |
418 | }; | |
419 | ||
420 | struct configset_list_item { | |
421 | struct config_set_element *e; | |
422 | int value_index; | |
423 | }; | |
424 | ||
425 | /* | |
426 | * the contents of the list are ordered according to their | |
427 | * position in the config files and order of parsing the files. | |
428 | * (i.e. key-value pair at the last position of .git/config will | |
429 | * be at the last item of the list) | |
430 | */ | |
431 | struct configset_list { | |
432 | struct configset_list_item *items; | |
433 | unsigned int nr, alloc; | |
434 | }; | |
435 | ||
436 | struct config_set { | |
437 | struct hashmap config_hash; | |
438 | int hash_initialized; | |
439 | struct configset_list list; | |
440 | }; | |
441 | ||
6c96630c HW |
442 | /** |
443 | * Initializes the config_set `cs`. | |
444 | */ | |
55454427 | 445 | void git_configset_init(struct config_set *cs); |
6c96630c HW |
446 | |
447 | /** | |
448 | * Parses the file and adds the variable-value pairs to the `config_set`, | |
449 | * dies if there is an error in parsing the file. Returns 0 on success, or | |
450 | * -1 if the file does not exist or is inaccessible. The user has to decide | |
451 | * if he wants to free the incomplete configset or continue using it when | |
452 | * the function returns -1. | |
453 | */ | |
55454427 | 454 | int git_configset_add_file(struct config_set *cs, const char *filename); |
6c96630c HW |
455 | |
456 | /** | |
457 | * Finds and returns the value list, sorted in order of increasing priority | |
458 | * for the configuration variable `key` and config set `cs`. When the | |
459 | * configuration variable `key` is not found, returns NULL. The caller | |
460 | * should not free or modify the returned pointer, as it is owned by the cache. | |
461 | */ | |
55454427 | 462 | const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key); |
6c96630c HW |
463 | |
464 | /** | |
465 | * Clears `config_set` structure, removes all saved variable-value pairs. | |
466 | */ | |
55454427 | 467 | void git_configset_clear(struct config_set *cs); |
8ad169c4 HWN |
468 | |
469 | /* | |
470 | * These functions return 1 if not found, and 0 if found, leaving the found | |
471 | * value in the 'dest' pointer. | |
472 | */ | |
6c96630c HW |
473 | |
474 | /* | |
475 | * Finds the highest-priority value for the configuration variable `key` | |
476 | * and config set `cs`, stores the pointer to it in `value` and returns 0. | |
477 | * When the configuration variable `key` is not found, returns 1 without | |
478 | * touching `value`. The caller should not free or modify `value`, as it | |
479 | * is owned by the cache. | |
480 | */ | |
55454427 | 481 | int git_configset_get_value(struct config_set *cs, const char *key, const char **dest); |
6c96630c | 482 | |
55454427 | 483 | int git_configset_get_string(struct config_set *cs, const char *key, char **dest); |
f1de981e | 484 | int git_configset_get_string_tmp(struct config_set *cs, const char *key, const char **dest); |
55454427 DL |
485 | int git_configset_get_int(struct config_set *cs, const char *key, int *dest); |
486 | int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest); | |
487 | int git_configset_get_bool(struct config_set *cs, const char *key, int *dest); | |
488 | int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest); | |
489 | int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest); | |
490 | int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest); | |
e67a57fc | 491 | |
3b256228 BW |
492 | /* Functions for reading a repository's config */ |
493 | struct repository; | |
55454427 DL |
494 | void repo_config(struct repository *repo, config_fn_t fn, void *data); |
495 | int repo_config_get_value(struct repository *repo, | |
ad6dad09 | 496 | const char *key, const char **value); |
55454427 | 497 | const struct string_list *repo_config_get_value_multi(struct repository *repo, |
ad6dad09 | 498 | const char *key); |
55454427 | 499 | int repo_config_get_string(struct repository *repo, |
ad6dad09 | 500 | const char *key, char **dest); |
f1de981e JK |
501 | int repo_config_get_string_tmp(struct repository *repo, |
502 | const char *key, const char **dest); | |
55454427 | 503 | int repo_config_get_int(struct repository *repo, |
ad6dad09 | 504 | const char *key, int *dest); |
55454427 | 505 | int repo_config_get_ulong(struct repository *repo, |
ad6dad09 | 506 | const char *key, unsigned long *dest); |
55454427 | 507 | int repo_config_get_bool(struct repository *repo, |
ad6dad09 | 508 | const char *key, int *dest); |
55454427 | 509 | int repo_config_get_bool_or_int(struct repository *repo, |
ad6dad09 | 510 | const char *key, int *is_bool, int *dest); |
55454427 | 511 | int repo_config_get_maybe_bool(struct repository *repo, |
3b256228 | 512 | const char *key, int *dest); |
55454427 | 513 | int repo_config_get_pathname(struct repository *repo, |
ad6dad09 | 514 | const char *key, const char **dest); |
3b256228 | 515 | |
6c96630c HW |
516 | /** |
517 | * Querying For Specific Variables | |
518 | * ------------------------------- | |
519 | * | |
520 | * For programs wanting to query for specific variables in a non-callback | |
521 | * manner, the config API provides two functions `git_config_get_value` | |
522 | * and `git_config_get_value_multi`. They both read values from an internal | |
523 | * cache generated previously from reading the config files. | |
524 | */ | |
525 | ||
526 | /** | |
527 | * Finds the highest-priority value for the configuration variable `key`, | |
528 | * stores the pointer to it in `value` and returns 0. When the | |
529 | * configuration variable `key` is not found, returns 1 without touching | |
530 | * `value`. The caller should not free or modify `value`, as it is owned | |
531 | * by the cache. | |
532 | */ | |
55454427 | 533 | int git_config_get_value(const char *key, const char **value); |
6c96630c HW |
534 | |
535 | /** | |
536 | * Finds and returns the value list, sorted in order of increasing priority | |
537 | * for the configuration variable `key`. When the configuration variable | |
538 | * `key` is not found, returns NULL. The caller should not free or modify | |
539 | * the returned pointer, as it is owned by the cache. | |
540 | */ | |
55454427 | 541 | const struct string_list *git_config_get_value_multi(const char *key); |
6c96630c HW |
542 | |
543 | /** | |
544 | * Resets and invalidates the config cache. | |
545 | */ | |
55454427 | 546 | void git_config_clear(void); |
6c96630c HW |
547 | |
548 | /** | |
549 | * Allocates and copies the retrieved string into the `dest` parameter for | |
550 | * the configuration variable `key`; if NULL string is given, prints an | |
551 | * error message and returns -1. When the configuration variable `key` is | |
552 | * not found, returns 1 without touching `dest`. | |
553 | */ | |
55454427 | 554 | int git_config_get_string(const char *key, char **dest); |
6c96630c | 555 | |
f1de981e | 556 | /** |
9a53219f | 557 | * Similar to `git_config_get_string`, but does not allocate any new |
f1de981e JK |
558 | * memory; on success `dest` will point to memory owned by the config |
559 | * machinery, which could be invalidated if it is discarded and reloaded. | |
560 | */ | |
561 | int git_config_get_string_tmp(const char *key, const char **dest); | |
562 | ||
6c96630c HW |
563 | /** |
564 | * Finds and parses the value to an integer for the configuration variable | |
565 | * `key`. Dies on error; otherwise, stores the value of the parsed integer in | |
566 | * `dest` and returns 0. When the configuration variable `key` is not found, | |
567 | * returns 1 without touching `dest`. | |
568 | */ | |
55454427 | 569 | int git_config_get_int(const char *key, int *dest); |
6c96630c HW |
570 | |
571 | /** | |
572 | * Similar to `git_config_get_int` but for unsigned longs. | |
573 | */ | |
55454427 | 574 | int git_config_get_ulong(const char *key, unsigned long *dest); |
6c96630c HW |
575 | |
576 | /** | |
577 | * Finds and parses the value into a boolean value, for the configuration | |
578 | * variable `key` respecting keywords like "true" and "false". Integer | |
579 | * values are converted into true/false values (when they are non-zero or | |
580 | * zero, respectively). Other values cause a die(). If parsing is successful, | |
581 | * stores the value of the parsed result in `dest` and returns 0. When the | |
582 | * configuration variable `key` is not found, returns 1 without touching | |
583 | * `dest`. | |
584 | */ | |
55454427 | 585 | int git_config_get_bool(const char *key, int *dest); |
6c96630c HW |
586 | |
587 | /** | |
588 | * Similar to `git_config_get_bool`, except that integers are copied as-is, | |
589 | * and `is_bool` flag is unset. | |
590 | */ | |
55454427 | 591 | int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest); |
6c96630c HW |
592 | |
593 | /** | |
594 | * Similar to `git_config_get_bool`, except that it returns -1 on error | |
595 | * rather than dying. | |
596 | */ | |
55454427 | 597 | int git_config_get_maybe_bool(const char *key, int *dest); |
6c96630c HW |
598 | |
599 | /** | |
600 | * Similar to `git_config_get_string`, but expands `~` or `~user` into | |
601 | * the user's home directory when found at the beginning of the path. | |
602 | */ | |
55454427 | 603 | int git_config_get_pathname(const char *key, const char **dest); |
6c96630c | 604 | |
55454427 DL |
605 | int git_config_get_index_threads(int *dest); |
606 | int git_config_get_untracked_cache(void); | |
607 | int git_config_get_split_index(void); | |
608 | int git_config_get_max_percent_split_change(void); | |
609 | int git_config_get_fsmonitor(void); | |
e67a57fc BW |
610 | |
611 | /* This dies if the configured or default date is in the future */ | |
55454427 | 612 | int git_config_get_expiry(const char *key, const char **output); |
e67a57fc | 613 | |
6e96cb52 | 614 | /* parse either "this many days" integer, or "5.days.ago" approxidate */ |
55454427 | 615 | int git_config_get_expiry_in_days(const char *key, timestamp_t *, timestamp_t now); |
6e96cb52 | 616 | |
e67a57fc BW |
617 | struct key_value_info { |
618 | const char *filename; | |
619 | int linenr; | |
620 | enum config_origin_type origin_type; | |
621 | enum config_scope scope; | |
622 | }; | |
623 | ||
6c96630c HW |
624 | /** |
625 | * First prints the error message specified by the caller in `err` and then | |
626 | * dies printing the line number and the file name of the highest priority | |
627 | * value for the configuration variable `key`. | |
628 | */ | |
b199d714 | 629 | NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3))); |
6c96630c HW |
630 | |
631 | /** | |
632 | * Helper function which formats the die error message according to the | |
633 | * parameters entered. Used by `git_die_config()`. It can be used by callers | |
634 | * handling `git_config_get_value_multi()` to print the correct error message | |
635 | * for the desired value. | |
636 | */ | |
55454427 | 637 | NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr); |
e67a57fc | 638 | |
a73b3680 NTND |
639 | #define LOOKUP_CONFIG(mapping, var) \ |
640 | lookup_config(mapping, ARRAY_SIZE(mapping), var) | |
641 | int lookup_config(const char **mapping, int nr_mapping, const char *var); | |
642 | ||
e67a57fc | 643 | #endif /* CONFIG_H */ |