Merge branch 'main' of github.com:git/git
[alt-git.git] / config.h
blobca994d771475a961da458454beabbb66bf63b949
1 #ifndef CONFIG_H
2 #define CONFIG_H
4 #include "hashmap.h"
5 #include "string-list.h"
8 /**
9 * The config API gives callers a way to access Git configuration files
10 * (and files which have the same syntax).
12 * General Usage
13 * -------------
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.
23 struct object_id;
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
36 #define CONFIG_REGEX_NONE ((void *)1)
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,
47 const char *config_scope_name(enum config_scope scope);
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;
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
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
76 * The parser event function (if not NULL) is called with the event type and
77 * the begin/end offsets of the parsed elements.
79 * Note: for CONFIG_EVENT_ENTRY (i.e. config variables), the trailing newline
80 * character is considered part of the element.
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);
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;
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.
99 unsigned int unconditional_remote_url : 1;
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;
114 * A config callback function takes three parameters:
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`.
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).
125 * - a void pointer passed in by the caller of the config API; this can
126 * contain callback-specific data
128 * A config callback should return 0 for success, or -1 if the variable
129 * could not be parsed properly.
131 typedef int (*config_fn_t)(const char *, const char *, void *);
133 int git_default_config(const char *, const char *, void *);
136 * Read a specific file in git-config format.
137 * This function takes the same callback and data parameters as `git_config`.
139 * Unlike git_config(), this function does not respect includes.
141 int git_config_from_file(config_fn_t fn, const char *, void *);
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);
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.
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).
173 * Unlike git_config_from_file(), this function respects includes.
175 void git_config(config_fn_t fn, void *);
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:
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`.
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.
196 int config_with_options(config_fn_t fn, void *,
197 struct git_config_source *config_source,
198 const struct config_options *opts);
201 * Value Parsing Helpers
202 * ---------------------
204 * The following helper functions aid in parsing string values
207 int git_parse_ssize_t(const char *, ssize_t *);
208 int git_parse_ulong(const char *, unsigned long *);
211 * Same as `git_config_bool`, except that it returns -1 on error rather
212 * than dying.
214 int git_parse_maybe_bool(const char *);
217 * Parse the string to an integer, including unit factors. Dies on error;
218 * otherwise, returns the parsed result.
220 int git_config_int(const char *, const char *);
222 int64_t git_config_int64(const char *, const char *);
225 * Identical to `git_config_int`, but for unsigned longs.
227 unsigned long git_config_ulong(const char *, const char *);
229 ssize_t git_config_ssize_t(const char *, const char *);
232 * Same as `git_config_bool`, except that integers are returned as-is, and
233 * an `is_bool` flag is unset.
235 int git_config_bool_or_int(const char *, const char *, int *);
238 * Parse a string into a boolean value, respecting keywords like "true" and
239 * "false". Integer values are converted into true/false values (when they
240 * are non-zero or zero, respectively). Other values cause a die(). If
241 * parsing is successful, the return value is the result.
243 int git_config_bool(const char *, const char *);
246 * Allocates and copies the value string into the `dest` parameter; if no
247 * string is given, prints an error message and returns -1.
249 int git_config_string(const char **, const char *, const char *);
252 * Similar to `git_config_string`, but expands `~` or `~user` into the
253 * user's home directory when found at the beginning of the path.
255 int git_config_pathname(const char **, const char *, const char *);
257 int git_config_expiry_date(timestamp_t *, const char *, const char *);
258 int git_config_color(char *, const char *, const char *);
259 int git_config_set_in_file_gently(const char *, const char *, const char *);
262 * write config values to a specific config file, takes a key/value pair as
263 * parameter.
265 void git_config_set_in_file(const char *, const char *, const char *);
267 int git_config_set_gently(const char *, const char *);
270 * Write a config value that should apply to the current worktree. If
271 * extensions.worktreeConfig is enabled, then the write will happen in the
272 * current worktree's config. Otherwise, write to the common config file.
274 int repo_config_set_worktree_gently(struct repository *, const char *, const char *);
277 * write config values to `.git/config`, takes a key/value pair as parameter.
279 void git_config_set(const char *, const char *);
281 int git_config_parse_key(const char *, char **, size_t *);
284 * The following macros specify flag bits that alter the behavior
285 * of the git_config_set_multivar*() methods.
289 * When CONFIG_FLAGS_MULTI_REPLACE is specified, all matching key/values
290 * are removed before a single new pair is written. If the flag is not
291 * present, then set operations replace only the first match.
293 #define CONFIG_FLAGS_MULTI_REPLACE (1 << 0)
296 * When CONFIG_FLAGS_FIXED_VALUE is specified, match key/value pairs
297 * by string comparison (not regex match) to the provided value_pattern
298 * parameter.
300 #define CONFIG_FLAGS_FIXED_VALUE (1 << 1)
302 int git_config_set_multivar_gently(const char *, const char *, const char *, unsigned);
303 void git_config_set_multivar(const char *, const char *, const char *, unsigned);
304 int repo_config_set_multivar_gently(struct repository *, const char *, const char *, const char *, unsigned);
305 int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, unsigned);
308 * takes four parameters:
310 * - the name of the file, as a string, to which key/value pairs will be written.
312 * - the name of key, as a string. This is in canonical "flat" form: the section,
313 * subsection, and variable segments will be separated by dots, and the section
314 * and variable segments will be all lowercase.
315 * E.g., `core.ignorecase`, `diff.SomeType.textconv`.
317 * - the value of the variable, as a string. If value is equal to NULL, it will
318 * remove the matching key from the config file.
320 * - the value regex, as a string. It will disregard key/value pairs where value
321 * does not match.
323 * - a flags value with bits corresponding to the CONFIG_FLAG_* macros.
325 * It returns 0 on success.
327 void git_config_set_multivar_in_file(const char *config_filename,
328 const char *key,
329 const char *value,
330 const char *value_pattern,
331 unsigned flags);
334 * rename or remove sections in the config file
335 * parameters `old_name` and `new_name`
336 * If NULL is passed through `new_name` parameter,
337 * the section will be removed from the config file.
339 int git_config_rename_section(const char *, const char *);
341 int git_config_rename_section_in_file(const char *, const char *, const char *);
342 int git_config_copy_section(const char *, const char *);
343 int git_config_copy_section_in_file(const char *, const char *, const char *);
344 int git_env_bool(const char *, int);
345 unsigned long git_env_ulong(const char *, unsigned long);
346 int git_config_system(void);
347 int config_error_nonbool(const char *);
348 #if defined(__GNUC__)
349 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
350 #endif
352 char *git_system_config(void);
353 void git_global_config(char **user, char **xdg);
355 int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
357 enum config_scope current_config_scope(void);
358 const char *current_config_origin_type(void);
359 const char *current_config_name(void);
360 int current_config_line(void);
363 * Match and parse a config key of the form:
365 * section.(subsection.)?key
367 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
368 * we return -1 if it does not match, 0 otherwise. The subsection and key
369 * out-parameters are filled by the function (and *subsection is NULL if it is
370 * missing).
372 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if
373 * there is no subsection at all.
375 int parse_config_key(const char *var,
376 const char *section,
377 const char **subsection, size_t *subsection_len,
378 const char **key);
381 * Custom Configsets
382 * -----------------
384 * A `config_set` can be used to construct an in-memory cache for
385 * config-like files that the caller specifies (i.e., files like `.gitmodules`,
386 * `~/.gitconfig` etc.). For example,
388 * ----------------------------------------
389 * struct config_set gm_config;
390 * git_configset_init(&gm_config);
391 * int b;
392 * //we add config files to the config_set
393 * git_configset_add_file(&gm_config, ".gitmodules");
394 * git_configset_add_file(&gm_config, ".gitmodules_alt");
396 * if (!git_configset_get_bool(gm_config, "submodule.frotz.ignore", &b)) {
397 * //hack hack hack
400 * when we are done with the configset:
401 * git_configset_clear(&gm_config);
402 * ----------------------------------------
404 * Configset API provides functions for the above mentioned work flow
407 struct config_set_element {
408 struct hashmap_entry ent;
409 char *key;
410 struct string_list value_list;
413 struct configset_list_item {
414 struct config_set_element *e;
415 int value_index;
419 * the contents of the list are ordered according to their
420 * position in the config files and order of parsing the files.
421 * (i.e. key-value pair at the last position of .git/config will
422 * be at the last item of the list)
424 struct configset_list {
425 struct configset_list_item *items;
426 unsigned int nr, alloc;
429 struct config_set {
430 struct hashmap config_hash;
431 int hash_initialized;
432 struct configset_list list;
436 * Initializes the config_set `cs`.
438 void git_configset_init(struct config_set *cs);
441 * Parses the file and adds the variable-value pairs to the `config_set`,
442 * dies if there is an error in parsing the file. Returns 0 on success, or
443 * -1 if the file does not exist or is inaccessible. The caller decides
444 * whether to free the incomplete configset or continue using it when
445 * the function returns -1.
447 int git_configset_add_file(struct config_set *cs, const char *filename);
450 * Parses command line options and environment variables, and adds the
451 * variable-value pairs to the `config_set`. Returns 0 on success, or -1
452 * if there is an error in parsing. The caller decides whether to free
453 * the incomplete configset or continue using it when the function
454 * returns -1.
456 int git_configset_add_parameters(struct config_set *cs);
459 * Finds and returns the value list, sorted in order of increasing priority
460 * for the configuration variable `key` and config set `cs`. When the
461 * configuration variable `key` is not found, returns NULL. The caller
462 * should not free or modify the returned pointer, as it is owned by the cache.
464 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
467 * Clears `config_set` structure, removes all saved variable-value pairs.
469 void git_configset_clear(struct config_set *cs);
472 * These functions return 1 if not found, and 0 if found, leaving the found
473 * value in the 'dest' pointer.
477 * Finds the highest-priority value for the configuration variable `key`
478 * and config set `cs`, stores the pointer to it in `value` and returns 0.
479 * When the configuration variable `key` is not found, returns 1 without
480 * touching `value`. The caller should not free or modify `value`, as it
481 * is owned by the cache.
483 int git_configset_get_value(struct config_set *cs, const char *key, const char **dest);
485 int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
486 int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
487 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
488 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
489 int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
490 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
491 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
493 /* Functions for reading a repository's config */
494 struct repository;
495 void repo_config(struct repository *repo, config_fn_t fn, void *data);
496 int repo_config_get_value(struct repository *repo,
497 const char *key, const char **value);
498 const struct string_list *repo_config_get_value_multi(struct repository *repo,
499 const char *key);
500 int repo_config_get_string(struct repository *repo,
501 const char *key, char **dest);
502 int repo_config_get_string_tmp(struct repository *repo,
503 const char *key, const char **dest);
504 int repo_config_get_int(struct repository *repo,
505 const char *key, int *dest);
506 int repo_config_get_ulong(struct repository *repo,
507 const char *key, unsigned long *dest);
508 int repo_config_get_bool(struct repository *repo,
509 const char *key, int *dest);
510 int repo_config_get_bool_or_int(struct repository *repo,
511 const char *key, int *is_bool, int *dest);
512 int repo_config_get_maybe_bool(struct repository *repo,
513 const char *key, int *dest);
514 int repo_config_get_pathname(struct repository *repo,
515 const char *key, const char **dest);
518 * Functions for reading protected config. By definition, protected
519 * config ignores repository config, so these do not take a `struct
520 * repository` parameter.
522 void git_protected_config(config_fn_t fn, void *data);
525 * Querying For Specific Variables
526 * -------------------------------
528 * For programs wanting to query for specific variables in a non-callback
529 * manner, the config API provides two functions `git_config_get_value`
530 * and `git_config_get_value_multi`. They both read values from an internal
531 * cache generated previously from reading the config files.
535 * Finds the highest-priority value for the configuration variable `key`,
536 * stores the pointer to it in `value` and returns 0. When the
537 * configuration variable `key` is not found, returns 1 without touching
538 * `value`. The caller should not free or modify `value`, as it is owned
539 * by the cache.
541 int git_config_get_value(const char *key, const char **value);
544 * Finds and returns the value list, sorted in order of increasing priority
545 * for the configuration variable `key`. When the configuration variable
546 * `key` is not found, returns NULL. The caller should not free or modify
547 * the returned pointer, as it is owned by the cache.
549 const struct string_list *git_config_get_value_multi(const char *key);
552 * Resets and invalidates the config cache.
554 void git_config_clear(void);
557 * Allocates and copies the retrieved string into the `dest` parameter for
558 * the configuration variable `key`; if NULL string is given, prints an
559 * error message and returns -1. When the configuration variable `key` is
560 * not found, returns 1 without touching `dest`.
562 int git_config_get_string(const char *key, char **dest);
565 * Similar to `git_config_get_string`, but does not allocate any new
566 * memory; on success `dest` will point to memory owned by the config
567 * machinery, which could be invalidated if it is discarded and reloaded.
569 int git_config_get_string_tmp(const char *key, const char **dest);
572 * Finds and parses the value to an integer for the configuration variable
573 * `key`. Dies on error; otherwise, stores the value of the parsed integer in
574 * `dest` and returns 0. When the configuration variable `key` is not found,
575 * returns 1 without touching `dest`.
577 int git_config_get_int(const char *key, int *dest);
580 * Similar to `git_config_get_int` but for unsigned longs.
582 int git_config_get_ulong(const char *key, unsigned long *dest);
585 * Finds and parses the value into a boolean value, for the configuration
586 * variable `key` respecting keywords like "true" and "false". Integer
587 * values are converted into true/false values (when they are non-zero or
588 * zero, respectively). Other values cause a die(). If parsing is successful,
589 * stores the value of the parsed result in `dest` and returns 0. When the
590 * configuration variable `key` is not found, returns 1 without touching
591 * `dest`.
593 int git_config_get_bool(const char *key, int *dest);
596 * Similar to `git_config_get_bool`, except that integers are copied as-is,
597 * and `is_bool` flag is unset.
599 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
602 * Similar to `git_config_get_bool`, except that it returns -1 on error
603 * rather than dying.
605 int git_config_get_maybe_bool(const char *key, int *dest);
608 * Similar to `git_config_get_string`, but expands `~` or `~user` into
609 * the user's home directory when found at the beginning of the path.
611 int git_config_get_pathname(const char *key, const char **dest);
613 int git_config_get_index_threads(int *dest);
614 int git_config_get_split_index(void);
615 int git_config_get_max_percent_split_change(void);
617 /* This dies if the configured or default date is in the future */
618 int git_config_get_expiry(const char *key, const char **output);
620 /* parse either "this many days" integer, or "5.days.ago" approxidate */
621 int git_config_get_expiry_in_days(const char *key, timestamp_t *, timestamp_t now);
623 struct key_value_info {
624 const char *filename;
625 int linenr;
626 enum config_origin_type origin_type;
627 enum config_scope scope;
631 * First prints the error message specified by the caller in `err` and then
632 * dies printing the line number and the file name of the highest priority
633 * value for the configuration variable `key`.
635 NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
638 * Helper function which formats the die error message according to the
639 * parameters entered. Used by `git_die_config()`. It can be used by callers
640 * handling `git_config_get_value_multi()` to print the correct error message
641 * for the desired value.
643 NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
645 #define LOOKUP_CONFIG(mapping, var) \
646 lookup_config(mapping, ARRAY_SIZE(mapping), var)
647 int lookup_config(const char **mapping, int nr_mapping, const char *var);
649 #endif /* CONFIG_H */