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