describe: fix --no-exact-match
[git.git] / config.h
blob247b572b37bc28e46a88118e3484795078c99b1a
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_UNKNOWN = 0,
60 CONFIG_ORIGIN_BLOB,
61 CONFIG_ORIGIN_FILE,
62 CONFIG_ORIGIN_STDIN,
63 CONFIG_ORIGIN_SUBMODULE_BLOB,
64 CONFIG_ORIGIN_CMDLINE
67 enum config_event_t {
68 CONFIG_EVENT_SECTION,
69 CONFIG_EVENT_ENTRY,
70 CONFIG_EVENT_WHITESPACE,
71 CONFIG_EVENT_COMMENT,
72 CONFIG_EVENT_EOF,
73 CONFIG_EVENT_ERROR
77 * The parser event function (if not NULL) is called with the event type and
78 * the begin/end offsets of the parsed elements.
80 * Note: for CONFIG_EVENT_ENTRY (i.e. config variables), the trailing newline
81 * character is considered part of the element.
83 typedef int (*config_parser_event_fn_t)(enum config_event_t type,
84 size_t begin_offset, size_t end_offset,
85 void *event_fn_data);
87 struct config_options {
88 unsigned int respect_includes : 1;
89 unsigned int ignore_repo : 1;
90 unsigned int ignore_worktree : 1;
91 unsigned int ignore_cmdline : 1;
92 unsigned int system_gently : 1;
95 * For internal use. Include all includeif.hasremoteurl paths without
96 * checking if the repo has that remote URL, and when doing so, verify
97 * that files included in this way do not configure any remote URLs
98 * themselves.
100 unsigned int unconditional_remote_url : 1;
102 const char *commondir;
103 const char *git_dir;
104 config_parser_event_fn_t event_fn;
105 void *event_fn_data;
106 enum config_error_action {
107 CONFIG_ERROR_UNSET = 0, /* use source-specific default */
108 CONFIG_ERROR_DIE, /* die() on error */
109 CONFIG_ERROR_ERROR, /* error() on error, return -1 */
110 CONFIG_ERROR_SILENT, /* return -1 */
111 } error_action;
115 * A config callback function takes three parameters:
117 * - the name of the parsed variable. This is in canonical "flat" form: the
118 * section, subsection, and variable segments will be separated by dots,
119 * and the section and variable segments will be all lowercase. E.g.,
120 * `core.ignorecase`, `diff.SomeType.textconv`.
122 * - the value of the found variable, as a string. If the variable had no
123 * value specified, the value will be NULL (typically this means it
124 * should be interpreted as boolean true).
126 * - a void pointer passed in by the caller of the config API; this can
127 * contain callback-specific data
129 * A config callback should return 0 for success, or -1 if the variable
130 * could not be parsed properly.
132 typedef int (*config_fn_t)(const char *, const char *, void *);
134 int git_default_config(const char *, const char *, void *);
137 * Read a specific file in git-config format.
138 * This function takes the same callback and data parameters as `git_config`.
140 * Unlike git_config(), this function does not respect includes.
142 int git_config_from_file(config_fn_t fn, const char *, void *);
144 int git_config_from_file_with_options(config_fn_t fn, const char *,
145 void *,
146 const struct config_options *);
147 int git_config_from_mem(config_fn_t fn,
148 const enum config_origin_type,
149 const char *name,
150 const char *buf, size_t len,
151 void *data, const struct config_options *opts);
152 int git_config_from_blob_oid(config_fn_t fn, const char *name,
153 struct repository *repo,
154 const struct object_id *oid, void *data);
155 void git_config_push_parameter(const char *text);
156 void git_config_push_env(const char *spec);
157 int git_config_from_parameters(config_fn_t fn, void *data);
158 void read_early_config(config_fn_t cb, void *data);
159 void read_very_early_config(config_fn_t cb, void *data);
162 * Most programs will simply want to look up variables in all config files
163 * that Git knows about, using the normal precedence rules. To do this,
164 * call `git_config` with a callback function and void data pointer.
166 * `git_config` will read all config sources in order of increasing
167 * priority. Thus a callback should typically overwrite previously-seen
168 * entries with new ones (e.g., if both the user-wide `~/.gitconfig` and
169 * repo-specific `.git/config` contain `color.ui`, the config machinery
170 * will first feed the user-wide one to the callback, and then the
171 * repo-specific one; by overwriting, the higher-priority repo-specific
172 * value is left at the end).
174 * Unlike git_config_from_file(), this function respects includes.
176 void git_config(config_fn_t fn, void *);
179 * Lets the caller examine config while adjusting some of the default
180 * behavior of `git_config`. It should almost never be used by "regular"
181 * Git code that is looking up configuration variables.
182 * It is intended for advanced callers like `git-config`, which are
183 * intentionally tweaking the normal config-lookup process.
184 * It takes two extra parameters:
186 * - `config_source`
187 * If this parameter is non-NULL, it specifies the source to parse for
188 * configuration, rather than looking in the usual files. See `struct
189 * git_config_source` in `config.h` for details. Regular `git_config` defaults
190 * to `NULL`.
192 * - `opts`
193 * Specify options to adjust the behavior of parsing config files. See `struct
194 * config_options` in `config.h` for details. As an example: regular `git_config`
195 * sets `opts.respect_includes` to `1` by default.
197 int config_with_options(config_fn_t fn, void *,
198 struct git_config_source *config_source,
199 const struct config_options *opts);
202 * Value Parsing Helpers
203 * ---------------------
205 * The following helper functions aid in parsing string values
208 int git_parse_ssize_t(const char *, ssize_t *);
209 int git_parse_ulong(const char *, unsigned long *);
210 int git_parse_int(const char *value, int *ret);
213 * Same as `git_config_bool`, except that it returns -1 on error rather
214 * than dying.
216 int git_parse_maybe_bool(const char *);
219 * Parse the string to an integer, including unit factors. Dies on error;
220 * otherwise, returns the parsed result.
222 int git_config_int(const char *, const char *);
224 int64_t git_config_int64(const char *, const char *);
227 * Identical to `git_config_int`, but for unsigned longs.
229 unsigned long git_config_ulong(const char *, const char *);
231 ssize_t git_config_ssize_t(const char *, const char *);
234 * Same as `git_config_bool`, except that integers are returned as-is, and
235 * an `is_bool` flag is unset.
237 int git_config_bool_or_int(const char *, const char *, int *);
240 * Parse a string into a boolean value, respecting keywords like "true" and
241 * "false". Integer values are converted into true/false values (when they
242 * are non-zero or zero, respectively). Other values cause a die(). If
243 * parsing is successful, the return value is the result.
245 int git_config_bool(const char *, const char *);
248 * Allocates and copies the value string into the `dest` parameter; if no
249 * string is given, prints an error message and returns -1.
251 int git_config_string(const char **, const char *, const char *);
254 * Similar to `git_config_string`, but expands `~` or `~user` into the
255 * user's home directory when found at the beginning of the path.
257 int git_config_pathname(const char **, const char *, const char *);
259 int git_config_expiry_date(timestamp_t *, const char *, const char *);
260 int git_config_color(char *, const char *, const char *);
261 int git_config_set_in_file_gently(const char *, const char *, const char *);
264 * write config values to a specific config file, takes a key/value pair as
265 * parameter.
267 void git_config_set_in_file(const char *, const char *, const char *);
269 int git_config_set_gently(const char *, const char *);
272 * Write a config value that should apply to the current worktree. If
273 * extensions.worktreeConfig is enabled, then the write will happen in the
274 * current worktree's config. Otherwise, write to the common config file.
276 int repo_config_set_worktree_gently(struct repository *, const char *, const char *);
279 * write config values to `.git/config`, takes a key/value pair as parameter.
281 void git_config_set(const char *, const char *);
283 int git_config_parse_key(const char *, char **, size_t *);
286 * The following macros specify flag bits that alter the behavior
287 * of the git_config_set_multivar*() methods.
291 * When CONFIG_FLAGS_MULTI_REPLACE is specified, all matching key/values
292 * are removed before a single new pair is written. If the flag is not
293 * present, then set operations replace only the first match.
295 #define CONFIG_FLAGS_MULTI_REPLACE (1 << 0)
298 * When CONFIG_FLAGS_FIXED_VALUE is specified, match key/value pairs
299 * by string comparison (not regex match) to the provided value_pattern
300 * parameter.
302 #define CONFIG_FLAGS_FIXED_VALUE (1 << 1)
304 int git_config_set_multivar_gently(const char *, const char *, const char *, unsigned);
305 void git_config_set_multivar(const char *, const char *, const char *, unsigned);
306 int repo_config_set_multivar_gently(struct repository *, const char *, const char *, const char *, unsigned);
307 int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, unsigned);
310 * takes four parameters:
312 * - the name of the file, as a string, to which key/value pairs will be written.
314 * - the name of key, as a string. This is in canonical "flat" form: the section,
315 * subsection, and variable segments will be separated by dots, and the section
316 * and variable segments will be all lowercase.
317 * E.g., `core.ignorecase`, `diff.SomeType.textconv`.
319 * - the value of the variable, as a string. If value is equal to NULL, it will
320 * remove the matching key from the config file.
322 * - the value regex, as a string. It will disregard key/value pairs where value
323 * does not match.
325 * - a flags value with bits corresponding to the CONFIG_FLAG_* macros.
327 * It returns 0 on success.
329 void git_config_set_multivar_in_file(const char *config_filename,
330 const char *key,
331 const char *value,
332 const char *value_pattern,
333 unsigned flags);
336 * rename or remove sections in the config file
337 * parameters `old_name` and `new_name`
338 * If NULL is passed through `new_name` parameter,
339 * the section will be removed from the config file.
341 int git_config_rename_section(const char *, const char *);
343 int git_config_rename_section_in_file(const char *, const char *, const char *);
344 int git_config_copy_section(const char *, const char *);
345 int git_config_copy_section_in_file(const char *, const char *, const char *);
346 int git_env_bool(const char *, int);
347 unsigned long git_env_ulong(const char *, unsigned long);
348 int git_config_system(void);
349 int config_error_nonbool(const char *);
350 #if defined(__GNUC__)
351 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
352 #endif
354 char *git_system_config(void);
355 void git_global_config(char **user, char **xdg);
357 int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
359 enum config_scope current_config_scope(void);
360 const char *current_config_origin_type(void);
361 const char *current_config_name(void);
362 int current_config_line(void);
365 * Match and parse a config key of the form:
367 * section.(subsection.)?key
369 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
370 * we return -1 if it does not match, 0 otherwise. The subsection and key
371 * out-parameters are filled by the function (and *subsection is NULL if it is
372 * missing).
374 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if
375 * there is no subsection at all.
377 int parse_config_key(const char *var,
378 const char *section,
379 const char **subsection, size_t *subsection_len,
380 const char **key);
383 * Custom Configsets
384 * -----------------
386 * A `config_set` can be used to construct an in-memory cache for
387 * config-like files that the caller specifies (i.e., files like `.gitmodules`,
388 * `~/.gitconfig` etc.). For example,
390 * ----------------------------------------
391 * struct config_set gm_config;
392 * git_configset_init(&gm_config);
393 * int b;
394 * //we add config files to the config_set
395 * git_configset_add_file(&gm_config, ".gitmodules");
396 * git_configset_add_file(&gm_config, ".gitmodules_alt");
398 * if (!git_configset_get_bool(gm_config, "submodule.frotz.ignore", &b)) {
399 * //hack hack hack
402 * when we are done with the configset:
403 * git_configset_clear(&gm_config);
404 * ----------------------------------------
406 * Configset API provides functions for the above mentioned work flow
409 struct config_set_element {
410 struct hashmap_entry ent;
411 char *key;
412 struct string_list value_list;
415 struct configset_list_item {
416 struct config_set_element *e;
417 int value_index;
421 * the contents of the list are ordered according to their
422 * position in the config files and order of parsing the files.
423 * (i.e. key-value pair at the last position of .git/config will
424 * be at the last item of the list)
426 struct configset_list {
427 struct configset_list_item *items;
428 unsigned int nr, alloc;
431 struct config_set {
432 struct hashmap config_hash;
433 int hash_initialized;
434 struct configset_list list;
438 * Initializes the config_set `cs`.
440 void git_configset_init(struct config_set *cs);
443 * Parses the file and adds the variable-value pairs to the `config_set`,
444 * dies if there is an error in parsing the file. Returns 0 on success, or
445 * -1 if the file does not exist or is inaccessible. The caller decides
446 * whether to free the incomplete configset or continue using it when
447 * the function returns -1.
449 int git_configset_add_file(struct config_set *cs, const char *filename);
452 * Finds and returns the value list, sorted in order of increasing priority
453 * for the configuration variable `key` and config set `cs`. When the
454 * configuration variable `key` is not found, returns 1 without touching
455 * `value`.
457 * The key will be parsed for validity with git_config_parse_key(), on
458 * error a negative value will be returned.
460 * The caller should not free or modify the returned pointer, as it is
461 * owned by the cache.
463 RESULT_MUST_BE_USED
464 int git_configset_get_value_multi(struct config_set *cs, const char *key,
465 const struct string_list **dest);
468 * A validation wrapper for git_configset_get_value_multi() which does
469 * for it what git_configset_get_string() does for
470 * git_configset_get_value().
472 * The configuration syntax allows for "[section] key", which will
473 * give us a NULL entry in the "struct string_list", as opposed to
474 * "[section] key =" which is the empty string. Most users of the API
475 * are not prepared to handle NULL in a "struct string_list".
477 int git_configset_get_string_multi(struct config_set *cs, const char *key,
478 const struct string_list **dest);
481 * Clears `config_set` structure, removes all saved variable-value pairs.
483 void git_configset_clear(struct config_set *cs);
486 * These functions return 1 if not found, and 0 if found, leaving the found
487 * value in the 'dest' pointer.
491 * git_configset_get() returns negative values on error, see
492 * repo_config_get() below.
494 RESULT_MUST_BE_USED
495 int git_configset_get(struct config_set *cs, const char *key);
498 * Finds the highest-priority value for the configuration variable `key`
499 * and config set `cs`, stores the pointer to it in `value` and returns 0.
500 * When the configuration variable `key` is not found, returns 1 without
501 * touching `value`. The caller should not free or modify `value`, as it
502 * is owned by the cache.
504 int git_configset_get_value(struct config_set *cs, const char *key, const char **dest);
506 int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
507 int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
508 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
509 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
510 int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
511 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
512 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
514 /* Functions for reading a repository's config */
515 struct repository;
516 void repo_config(struct repository *repo, config_fn_t fn, void *data);
519 * Run only the discover part of the repo_config_get_*() functions
520 * below, in addition to 1 if not found, returns negative values on
521 * error (e.g. if the key itself is invalid).
523 RESULT_MUST_BE_USED
524 int repo_config_get(struct repository *repo, const char *key);
525 int repo_config_get_value(struct repository *repo,
526 const char *key, const char **value);
527 RESULT_MUST_BE_USED
528 int repo_config_get_value_multi(struct repository *repo, const char *key,
529 const struct string_list **dest);
530 RESULT_MUST_BE_USED
531 int repo_config_get_string_multi(struct repository *repo, const char *key,
532 const struct string_list **dest);
533 int repo_config_get_string(struct repository *repo,
534 const char *key, char **dest);
535 int repo_config_get_string_tmp(struct repository *repo,
536 const char *key, const char **dest);
537 int repo_config_get_int(struct repository *repo,
538 const char *key, int *dest);
539 int repo_config_get_ulong(struct repository *repo,
540 const char *key, unsigned long *dest);
541 int repo_config_get_bool(struct repository *repo,
542 const char *key, int *dest);
543 int repo_config_get_bool_or_int(struct repository *repo,
544 const char *key, int *is_bool, int *dest);
545 int repo_config_get_maybe_bool(struct repository *repo,
546 const char *key, int *dest);
547 int repo_config_get_pathname(struct repository *repo,
548 const char *key, const char **dest);
551 * Functions for reading protected config. By definition, protected
552 * config ignores repository config, so these do not take a `struct
553 * repository` parameter.
555 void git_protected_config(config_fn_t fn, void *data);
558 * Querying For Specific Variables
559 * -------------------------------
561 * For programs wanting to query for specific variables in a non-callback
562 * manner, the config API provides two functions `git_config_get_value`
563 * and `git_config_get_value_multi`. They both read values from an internal
564 * cache generated previously from reading the config files.
566 * For those git_config_get*() functions that aren't documented,
567 * consult the corresponding repo_config_get*() function's
568 * documentation.
571 RESULT_MUST_BE_USED
572 int git_config_get(const char *key);
575 * Finds the highest-priority value for the configuration variable `key`,
576 * stores the pointer to it in `value` and returns 0. When the
577 * configuration variable `key` is not found, returns 1 without touching
578 * `value`. The caller should not free or modify `value`, as it is owned
579 * by the cache.
581 int git_config_get_value(const char *key, const char **value);
584 * Finds and returns the value list, sorted in order of increasing priority
585 * for the configuration variable `key`. When the configuration variable
586 * `key` is not found, returns 1 without touching `value`.
588 * The caller should not free or modify the returned pointer, as it is
589 * owned by the cache.
591 RESULT_MUST_BE_USED
592 int git_config_get_value_multi(const char *key,
593 const struct string_list **dest);
594 RESULT_MUST_BE_USED
595 int git_config_get_string_multi(const char *key,
596 const struct string_list **dest);
599 * Resets and invalidates the config cache.
601 void git_config_clear(void);
604 * Allocates and copies the retrieved string into the `dest` parameter for
605 * the configuration variable `key`; if NULL string is given, prints an
606 * error message and returns -1. When the configuration variable `key` is
607 * not found, returns 1 without touching `dest`.
609 int git_config_get_string(const char *key, char **dest);
612 * Similar to `git_config_get_string`, but does not allocate any new
613 * memory; on success `dest` will point to memory owned by the config
614 * machinery, which could be invalidated if it is discarded and reloaded.
616 int git_config_get_string_tmp(const char *key, const char **dest);
619 * Finds and parses the value to an integer for the configuration variable
620 * `key`. Dies on error; otherwise, stores the value of the parsed integer in
621 * `dest` and returns 0. When the configuration variable `key` is not found,
622 * returns 1 without touching `dest`.
624 int git_config_get_int(const char *key, int *dest);
627 * Similar to `git_config_get_int` but for unsigned longs.
629 int git_config_get_ulong(const char *key, unsigned long *dest);
632 * Finds and parses the value into a boolean value, for the configuration
633 * variable `key` respecting keywords like "true" and "false". Integer
634 * values are converted into true/false values (when they are non-zero or
635 * zero, respectively). Other values cause a die(). If parsing is successful,
636 * stores the value of the parsed result in `dest` and returns 0. When the
637 * configuration variable `key` is not found, returns 1 without touching
638 * `dest`.
640 int git_config_get_bool(const char *key, int *dest);
643 * Similar to `git_config_get_bool`, except that integers are copied as-is,
644 * and `is_bool` flag is unset.
646 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
649 * Similar to `git_config_get_bool`, except that it returns -1 on error
650 * rather than dying.
652 int git_config_get_maybe_bool(const char *key, int *dest);
655 * Similar to `git_config_get_string`, but expands `~` or `~user` into
656 * the user's home directory when found at the beginning of the path.
658 int git_config_get_pathname(const char *key, const char **dest);
660 int git_config_get_index_threads(int *dest);
661 int git_config_get_split_index(void);
662 int git_config_get_max_percent_split_change(void);
664 /* This dies if the configured or default date is in the future */
665 int git_config_get_expiry(const char *key, const char **output);
667 /* parse either "this many days" integer, or "5.days.ago" approxidate */
668 int git_config_get_expiry_in_days(const char *key, timestamp_t *, timestamp_t now);
670 struct key_value_info {
671 const char *filename;
672 int linenr;
673 enum config_origin_type origin_type;
674 enum config_scope scope;
678 * First prints the error message specified by the caller in `err` and then
679 * dies printing the line number and the file name of the highest priority
680 * value for the configuration variable `key`.
682 NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
685 * Helper function which formats the die error message according to the
686 * parameters entered. Used by `git_die_config()`. It can be used by callers
687 * handling `git_config_get_value_multi()` to print the correct error message
688 * for the desired value.
690 NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
692 #define LOOKUP_CONFIG(mapping, var) \
693 lookup_config(mapping, ARRAY_SIZE(mapping), var)
694 int lookup_config(const char **mapping, int nr_mapping, const char *var);
696 #endif /* CONFIG_H */