🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.45.0 / . / config.h
blob: f4966e374948a59cbe95af6f999f0e70d44aa1e9 [file] [log] [blame]
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]1#ifndef CONFIG_H
2#define CONFIG_H
3
Elijah Newrenef3ca952018-08-15 17:54:05[diff] [blame]4#include "hashmap.h"
5#include "string-list.h"
Victoria Dye9b6b06c2023-05-26 01:32:59[diff] [blame]6#include "repository.h"
Calvin Wanb1bda752023-09-29 21:20:51[diff] [blame]7#include "parse.h"
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]8
9/**
10 * The config API gives callers a way to access Git configuration files
11 * (and files which have the same syntax).
12 *
13 * General Usage
14 * -------------
15 *
16 * Config files are parsed linearly, and each variable found is passed to a
17 * caller-provided callback function. The callback function is responsible
18 * for any actions to be taken on the config option, and is free to ignore
19 * some options. It is not uncommon for the configuration to be parsed
20 * several times during the run of a Git program, with different callbacks
21 * picking out different variables useful to themselves.
22 */
23
Elijah Newrenef3ca952018-08-15 17:54:05[diff] [blame]24struct object_id;
25
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]26/* git_config_parse_key() returns these negated: */
27#define CONFIG_INVALID_KEY 1
28#define CONFIG_NO_SECTION_OR_NAME 2
29/* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
30#define CONFIG_NO_LOCK -1
31#define CONFIG_INVALID_FILE 3
32#define CONFIG_NO_WRITE 4
33#define CONFIG_NOTHING_SET 5
34#define CONFIG_INVALID_PATTERN 6
35#define CONFIG_GENERIC_ERROR 7
36
37#define CONFIG_REGEX_NONE ((void *)1)
38
Matthew Rogerse37efa42020-02-10 00:30:57[diff] [blame]39enum config_scope {
40 CONFIG_SCOPE_UNKNOWN = 0,
41 CONFIG_SCOPE_SYSTEM,
42 CONFIG_SCOPE_GLOBAL,
43 CONFIG_SCOPE_LOCAL,
44 CONFIG_SCOPE_WORKTREE,
45 CONFIG_SCOPE_COMMAND,
Matthew Rogers9a83d082020-02-10 00:30:58[diff] [blame]46 CONFIG_SCOPE_SUBMODULE,
Matthew Rogerse37efa42020-02-10 00:30:57[diff] [blame]47};
48const char *config_scope_name(enum config_scope scope);
49
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]50struct git_config_source {
51 unsigned int use_stdin:1;
52 const char *file;
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]53 const char *blob;
Matthew Rogerse37efa42020-02-10 00:30:57[diff] [blame]54 enum config_scope scope;
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]55};
56
57enum config_origin_type {
Glen Chooe2016502023-03-28 17:51:53[diff] [blame]58 CONFIG_ORIGIN_UNKNOWN = 0,
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]59 CONFIG_ORIGIN_BLOB,
60 CONFIG_ORIGIN_FILE,
61 CONFIG_ORIGIN_STDIN,
62 CONFIG_ORIGIN_SUBMODULE_BLOB,
63 CONFIG_ORIGIN_CMDLINE
64};
65
Johannes Schindelin8032cc42018-04-09 08:32:05[diff] [blame]66enum 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
Glen Choo6e8e79812023-06-28 19:26:30[diff] [blame]75struct config_source;
Johannes Schindelin8032cc42018-04-09 08:32:05[diff] [blame]76/*
77 * The parser event function (if not NULL) is called with the event type and
78 * the begin/end offsets of the parsed elements.
79 *
80 * Note: for CONFIG_EVENT_ENTRY (i.e. config variables), the trailing newline
81 * character is considered part of the element.
82 */
83typedef int (*config_parser_event_fn_t)(enum config_event_t type,
84 size_t begin_offset, size_t end_offset,
Glen Choo6e8e79812023-06-28 19:26:30[diff] [blame]85 struct config_source *cs,
Johannes Schindelin8032cc42018-04-09 08:32:05[diff] [blame]86 void *event_fn_data);
87
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]88struct config_options {
89 unsigned int respect_includes : 1;
Jeff Hostetler800a7f92019-04-15 20:39:46[diff] [blame]90 unsigned int ignore_repo : 1;
91 unsigned int ignore_worktree : 1;
92 unsigned int ignore_cmdline : 1;
Jeff Hostetlerf672dee2019-04-29 20:14:22[diff] [blame]93 unsigned int system_gently : 1;
Jonathan Tan399b1982022-01-18 17:47:40[diff] [blame]94
95 /*
96 * For internal use. Include all includeif.hasremoteurl paths without
97 * checking if the repo has that remote URL, and when doing so, verify
98 * that files included in this way do not configure any remote URLs
99 * themselves.
100 */
101 unsigned int unconditional_remote_url : 1;
102
Brandon Williamsa577fb52017-06-14 18:07:38[diff] [blame]103 const char *commondir;
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]104 const char *git_dir;
Glen Choo6e8e79812023-06-28 19:26:30[diff] [blame]105 /*
106 * event_fn and event_fn_data are for internal use only. Handles events
107 * emitted by the config parser.
108 */
Johannes Schindelin8032cc42018-04-09 08:32:05[diff] [blame]109 config_parser_event_fn_t event_fn;
110 void *event_fn_data;
Jeff King66f97222018-06-28 22:05:00[diff] [blame]111 enum config_error_action {
112 CONFIG_ERROR_UNSET = 0, /* use source-specific default */
113 CONFIG_ERROR_DIE, /* die() on error */
114 CONFIG_ERROR_ERROR, /* error() on error, return -1 */
Jeff King63583202018-06-28 22:05:09[diff] [blame]115 CONFIG_ERROR_SILENT, /* return -1 */
Jeff King66f97222018-06-28 22:05:00[diff] [blame]116 } error_action;
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]117};
118
Glen Chooa4e7e312023-06-28 19:26:22[diff] [blame]119/* Config source metadata for a given config key-value pair */
120struct key_value_info {
121 const char *filename;
122 int linenr;
123 enum config_origin_type origin_type;
124 enum config_scope scope;
Glen Choo908857a2023-06-28 19:26:29[diff] [blame]125 const char *path;
Glen Chooa4e7e312023-06-28 19:26:22[diff] [blame]126};
127#define KVI_INIT { \
128 .filename = NULL, \
129 .linenr = -1, \
130 .origin_type = CONFIG_ORIGIN_UNKNOWN, \
131 .scope = CONFIG_SCOPE_UNKNOWN, \
Glen Choo908857a2023-06-28 19:26:29[diff] [blame]132 .path = NULL, \
Glen Chooa4e7e312023-06-28 19:26:22[diff] [blame]133}
134
135/* Captures additional information that a config callback can use. */
136struct config_context {
137 /* Config source metadata for key and value. */
138 const struct key_value_info *kvi;
139};
140#define CONFIG_CONTEXT_INIT { 0 }
141
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]142/**
Glen Chooa4e7e312023-06-28 19:26:22[diff] [blame]143 * A config callback function takes four parameters:
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]144 *
145 * - the name of the parsed variable. This is in canonical "flat" form: the
146 * section, subsection, and variable segments will be separated by dots,
147 * and the section and variable segments will be all lowercase. E.g.,
148 * `core.ignorecase`, `diff.SomeType.textconv`.
149 *
150 * - the value of the found variable, as a string. If the variable had no
151 * value specified, the value will be NULL (typically this means it
152 * should be interpreted as boolean true).
153 *
Glen Chooa4e7e312023-06-28 19:26:22[diff] [blame]154 * - the 'config context', that is, additional information about the config
155 * iteration operation provided by the config machinery. For example, this
156 * includes information about the config source being parsed (e.g. the
157 * filename).
158 *
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]159 * - a void pointer passed in by the caller of the config API; this can
160 * contain callback-specific data
161 *
162 * A config callback should return 0 for success, or -1 if the variable
163 * could not be parsed properly.
164 */
Glen Chooa4e7e312023-06-28 19:26:22[diff] [blame]165typedef int (*config_fn_t)(const char *, const char *,
166 const struct config_context *, void *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]167
Glen Chooa4e7e312023-06-28 19:26:22[diff] [blame]168int git_default_config(const char *, const char *,
169 const struct config_context *, void *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]170
171/**
172 * Read a specific file in git-config format.
173 * This function takes the same callback and data parameters as `git_config`.
Jonathan Taned69e112022-01-18 17:47:39[diff] [blame]174 *
175 * Unlike git_config(), this function does not respect includes.
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]176 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]177int git_config_from_file(config_fn_t fn, const char *, void *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]178
Denton Liu55454422019-04-29 08:28:14[diff] [blame]179int git_config_from_file_with_options(config_fn_t fn, const char *,
Glen Choo809d8682023-06-28 19:26:24[diff] [blame]180 void *, enum config_scope,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]181 const struct config_options *);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]182int git_config_from_mem(config_fn_t fn,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]183 const enum config_origin_type,
184 const char *name,
185 const char *buf, size_t len,
Glen Choo809d8682023-06-28 19:26:24[diff] [blame]186 void *data, enum config_scope scope,
187 const struct config_options *opts);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]188int git_config_from_blob_oid(config_fn_t fn, const char *name,
Jonathan Tane3e8bf02021-08-16 21:09:57[diff] [blame]189 struct repository *repo,
Glen Choo809d8682023-06-28 19:26:24[diff] [blame]190 const struct object_id *oid, void *data,
191 enum config_scope scope);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]192void git_config_push_parameter(const char *text);
Patrick Steinhardtce81b1d2021-01-12 12:26:45[diff] [blame]193void git_config_push_env(const char *spec);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]194int git_config_from_parameters(config_fn_t fn, void *data);
195void read_early_config(config_fn_t cb, void *data);
Junio C Hamano4aeeef32019-05-13 14:50:32[diff] [blame]196void read_very_early_config(config_fn_t cb, void *data);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]197
198/**
199 * Most programs will simply want to look up variables in all config files
200 * that Git knows about, using the normal precedence rules. To do this,
201 * call `git_config` with a callback function and void data pointer.
202 *
203 * `git_config` will read all config sources in order of increasing
204 * priority. Thus a callback should typically overwrite previously-seen
205 * entries with new ones (e.g., if both the user-wide `~/.gitconfig` and
206 * repo-specific `.git/config` contain `color.ui`, the config machinery
207 * will first feed the user-wide one to the callback, and then the
208 * repo-specific one; by overwriting, the higher-priority repo-specific
209 * value is left at the end).
Jonathan Taned69e112022-01-18 17:47:39[diff] [blame]210 *
211 * Unlike git_config_from_file(), this function respects includes.
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]212 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]213void git_config(config_fn_t fn, void *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]214
215/**
216 * Lets the caller examine config while adjusting some of the default
217 * behavior of `git_config`. It should almost never be used by "regular"
218 * Git code that is looking up configuration variables.
219 * It is intended for advanced callers like `git-config`, which are
220 * intentionally tweaking the normal config-lookup process.
221 * It takes two extra parameters:
222 *
223 * - `config_source`
224 * If this parameter is non-NULL, it specifies the source to parse for
225 * configuration, rather than looking in the usual files. See `struct
226 * git_config_source` in `config.h` for details. Regular `git_config` defaults
227 * to `NULL`.
228 *
229 * - `opts`
230 * Specify options to adjust the behavior of parsing config files. See `struct
231 * config_options` in `config.h` for details. As an example: regular `git_config`
232 * sets `opts.respect_includes` to `1` by default.
233 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]234int config_with_options(config_fn_t fn, void *,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]235 struct git_config_source *config_source,
Victoria Dye9b6b06c2023-05-26 01:32:59[diff] [blame]236 struct repository *repo,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]237 const struct config_options *opts);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]238
239/**
240 * Value Parsing Helpers
241 * ---------------------
242 *
243 * The following helper functions aid in parsing string values
244 */
245
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]246/**
247 * Parse the string to an integer, including unit factors. Dies on error;
248 * otherwise, returns the parsed result.
249 */
Glen Choo8868b1e2023-06-28 19:26:27[diff] [blame]250int git_config_int(const char *, const char *, const struct key_value_info *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]251
Glen Choo8868b1e2023-06-28 19:26:27[diff] [blame]252int64_t git_config_int64(const char *, const char *,
253 const struct key_value_info *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]254
255/**
256 * Identical to `git_config_int`, but for unsigned longs.
257 */
Glen Choo8868b1e2023-06-28 19:26:27[diff] [blame]258unsigned long git_config_ulong(const char *, const char *,
259 const struct key_value_info *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]260
Glen Choo8868b1e2023-06-28 19:26:27[diff] [blame]261ssize_t git_config_ssize_t(const char *, const char *,
262 const struct key_value_info *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]263
264/**
265 * Same as `git_config_bool`, except that integers are returned as-is, and
266 * an `is_bool` flag is unset.
267 */
Glen Choo8868b1e2023-06-28 19:26:27[diff] [blame]268int git_config_bool_or_int(const char *, const char *,
269 const struct key_value_info *, int *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]270
271/**
272 * Parse a string into a boolean value, respecting keywords like "true" and
273 * "false". Integer values are converted into true/false values (when they
274 * are non-zero or zero, respectively). Other values cause a die(). If
275 * parsing is successful, the return value is the result.
276 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]277int git_config_bool(const char *, const char *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]278
279/**
280 * Allocates and copies the value string into the `dest` parameter; if no
281 * string is given, prints an error message and returns -1.
282 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]283int git_config_string(const char **, const char *, const char *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]284
285/**
286 * Similar to `git_config_string`, but expands `~` or `~user` into the
287 * user's home directory when found at the beginning of the path.
288 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]289int git_config_pathname(const char **, const char *, const char *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]290
Denton Liu55454422019-04-29 08:28:14[diff] [blame]291int git_config_expiry_date(timestamp_t *, const char *, const char *);
292int git_config_color(char *, const char *, const char *);
Ralph Seichter42d5c032024-03-12 21:47:00[diff] [blame]293int git_config_set_in_file_gently(const char *, const char *, const char *, const char *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]294
295/**
296 * write config values to a specific config file, takes a key/value pair as
297 * parameter.
298 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]299void git_config_set_in_file(const char *, const char *, const char *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]300
Denton Liu55454422019-04-29 08:28:14[diff] [blame]301int git_config_set_gently(const char *, const char *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]302
303/**
Derrick Stoleefe187332022-02-07 21:33:00[diff] [blame]304 * Write a config value that should apply to the current worktree. If
305 * extensions.worktreeConfig is enabled, then the write will happen in the
306 * current worktree's config. Otherwise, write to the common config file.
307 */
308int repo_config_set_worktree_gently(struct repository *, const char *, const char *);
309
310/**
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]311 * write config values to `.git/config`, takes a key/value pair as parameter.
312 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]313void git_config_set(const char *, const char *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]314
Jeff Kingf011a962020-04-10 19:46:07[diff] [blame]315int git_config_parse_key(const char *, char **, size_t *);
Derrick Stolee504ee122020-11-25 22:12:49[diff] [blame]316
317/*
318 * The following macros specify flag bits that alter the behavior
319 * of the git_config_set_multivar*() methods.
320 */
321
322/*
323 * When CONFIG_FLAGS_MULTI_REPLACE is specified, all matching key/values
324 * are removed before a single new pair is written. If the flag is not
325 * present, then set operations replace only the first match.
326 */
327#define CONFIG_FLAGS_MULTI_REPLACE (1 << 0)
328
Derrick Stoleec90702a2020-11-25 22:12:54[diff] [blame]329/*
330 * When CONFIG_FLAGS_FIXED_VALUE is specified, match key/value pairs
331 * by string comparison (not regex match) to the provided value_pattern
332 * parameter.
333 */
334#define CONFIG_FLAGS_FIXED_VALUE (1 << 1)
335
Derrick Stolee504ee122020-11-25 22:12:49[diff] [blame]336int git_config_set_multivar_gently(const char *, const char *, const char *, unsigned);
337void git_config_set_multivar(const char *, const char *, const char *, unsigned);
Derrick Stoleefe187332022-02-07 21:33:00[diff] [blame]338int repo_config_set_multivar_gently(struct repository *, const char *, const char *, const char *, unsigned);
Ralph Seichter42d5c032024-03-12 21:47:00[diff] [blame]339int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, const char *, unsigned);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]340
Junio C Hamano31399a62024-03-15 22:26:40[diff] [blame]341const char *git_config_prepare_comment_string(const char *);
342
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]343/**
344 * takes four parameters:
345 *
346 * - the name of the file, as a string, to which key/value pairs will be written.
347 *
348 * - the name of key, as a string. This is in canonical "flat" form: the section,
349 * subsection, and variable segments will be separated by dots, and the section
350 * and variable segments will be all lowercase.
351 * E.g., `core.ignorecase`, `diff.SomeType.textconv`.
352 *
353 * - the value of the variable, as a string. If value is equal to NULL, it will
354 * remove the matching key from the config file.
355 *
356 * - the value regex, as a string. It will disregard key/value pairs where value
357 * does not match.
358 *
Derrick Stolee504ee122020-11-25 22:12:49[diff] [blame]359 * - a flags value with bits corresponding to the CONFIG_FLAG_* macros.
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]360 *
361 * It returns 0 on success.
362 */
Derrick Stolee504ee122020-11-25 22:12:49[diff] [blame]363void git_config_set_multivar_in_file(const char *config_filename,
364 const char *key,
365 const char *value,
Derrick Stolee247e2f82020-11-25 22:12:50[diff] [blame]366 const char *value_pattern,
Derrick Stolee504ee122020-11-25 22:12:49[diff] [blame]367 unsigned flags);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]368
369/**
370 * rename or remove sections in the config file
371 * parameters `old_name` and `new_name`
372 * If NULL is passed through `new_name` parameter,
373 * the section will be removed from the config file.
374 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]375int git_config_rename_section(const char *, const char *);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]376
Denton Liu55454422019-04-29 08:28:14[diff] [blame]377int git_config_rename_section_in_file(const char *, const char *, const char *);
378int git_config_copy_section(const char *, const char *);
379int git_config_copy_section_in_file(const char *, const char *, const char *);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]380int git_config_system(void);
381int config_error_nonbool(const char *);
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]382#if defined(__GNUC__)
383#define config_error_nonbool(s) (config_error_nonbool(s), const_error())
384#endif
385
Patrick Steinhardtc62a9992021-04-19 12:31:08[diff] [blame]386char *git_system_config(void);
Kristoffer Haugsbakkc15129b2024-01-18 16:12:51[diff] [blame]387char *git_global_config(void);
Kristoffer Haugsbakkecffa3e2024-01-18 16:12:50[diff] [blame]388void git_global_config_paths(char **user, char **xdg);
Patrick Steinhardtc62a9992021-04-19 12:31:08[diff] [blame]389
Denton Liu55454422019-04-29 08:28:14[diff] [blame]390int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]391
Glen Choo6021e1d2023-06-28 19:26:23[diff] [blame]392const char *config_origin_type_name(enum config_origin_type type);
Glen Choo26b66932023-06-28 19:26:25[diff] [blame]393void kvi_from_param(struct key_value_info *out);
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]394
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]395/*
396 * Match and parse a config key of the form:
397 *
398 * section.(subsection.)?key
399 *
400 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
401 * we return -1 if it does not match, 0 otherwise. The subsection and key
402 * out-parameters are filled by the function (and *subsection is NULL if it is
403 * missing).
404 *
405 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if
406 * there is no subsection at all.
407 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]408int parse_config_key(const char *var,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]409 const char *section,
Jeff Kingf5914f42020-04-10 19:44:28[diff] [blame]410 const char **subsection, size_t *subsection_len,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]411 const char **key);
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]412
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]413/**
414 * Custom Configsets
415 * -----------------
416 *
417 * A `config_set` can be used to construct an in-memory cache for
418 * config-like files that the caller specifies (i.e., files like `.gitmodules`,
419 * `~/.gitconfig` etc.). For example,
420 *
421 * ----------------------------------------
422 * struct config_set gm_config;
423 * git_configset_init(&gm_config);
424 * int b;
425 * //we add config files to the config_set
426 * git_configset_add_file(&gm_config, ".gitmodules");
427 * git_configset_add_file(&gm_config, ".gitmodules_alt");
428 *
429 * if (!git_configset_get_bool(gm_config, "submodule.frotz.ignore", &b)) {
430 * //hack hack hack
431 * }
432 *
433 * when we are done with the configset:
434 * git_configset_clear(&gm_config);
435 * ----------------------------------------
436 *
437 * Configset API provides functions for the above mentioned work flow
438 */
439
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]440struct config_set_element {
441 struct hashmap_entry ent;
442 char *key;
443 struct string_list value_list;
444};
445
446struct configset_list_item {
447 struct config_set_element *e;
448 int value_index;
449};
450
451/*
452 * the contents of the list are ordered according to their
453 * position in the config files and order of parsing the files.
454 * (i.e. key-value pair at the last position of .git/config will
455 * be at the last item of the list)
456 */
457struct configset_list {
458 struct configset_list_item *items;
459 unsigned int nr, alloc;
460};
461
462struct config_set {
463 struct hashmap config_hash;
464 int hash_initialized;
465 struct configset_list list;
466};
467
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]468/**
469 * Initializes the config_set `cs`.
470 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]471void git_configset_init(struct config_set *cs);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]472
473/**
474 * Parses the file and adds the variable-value pairs to the `config_set`,
475 * dies if there is an error in parsing the file. Returns 0 on success, or
Felipe Contreras0e20b222021-06-15 14:11:10[diff] [blame]476 * -1 if the file does not exist or is inaccessible. The caller decides
477 * whether to free the incomplete configset or continue using it when
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]478 * the function returns -1.
479 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]480int git_configset_add_file(struct config_set *cs, const char *filename);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]481
482/**
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]483 * Finds and returns the value list, sorted in order of increasing priority
484 * for the configuration variable `key` and config set `cs`. When the
Ævar Arnfjörð Bjarmasona4286192023-03-28 14:04:24[diff] [blame]485 * configuration variable `key` is not found, returns 1 without touching
486 * `value`.
487 *
488 * The key will be parsed for validity with git_config_parse_key(), on
489 * error a negative value will be returned.
490 *
491 * The caller should not free or modify the returned pointer, as it is
492 * owned by the cache.
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]493 */
Ævar Arnfjörð Bjarmasona4286192023-03-28 14:04:24[diff] [blame]494RESULT_MUST_BE_USED
495int git_configset_get_value_multi(struct config_set *cs, const char *key,
496 const struct string_list **dest);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]497
498/**
Ævar Arnfjörð Bjarmason9e2d8842023-03-28 14:04:27[diff] [blame]499 * A validation wrapper for git_configset_get_value_multi() which does
500 * for it what git_configset_get_string() does for
501 * git_configset_get_value().
502 *
503 * The configuration syntax allows for "[section] key", which will
504 * give us a NULL entry in the "struct string_list", as opposed to
505 * "[section] key =" which is the empty string. Most users of the API
506 * are not prepared to handle NULL in a "struct string_list".
507 */
508int git_configset_get_string_multi(struct config_set *cs, const char *key,
509 const struct string_list **dest);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]510
511/**
512 * Clears `config_set` structure, removes all saved variable-value pairs.
513 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]514void git_configset_clear(struct config_set *cs);
Han-Wen Nienhuys8ad169c2018-08-06 14:33:12[diff] [blame]515
516/*
517 * These functions return 1 if not found, and 0 if found, leaving the found
518 * value in the 'dest' pointer.
519 */
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]520
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 14:04:22[diff] [blame]521/**
522 * git_configset_get() returns negative values on error, see
523 * repo_config_get() below.
524 */
525RESULT_MUST_BE_USED
526int git_configset_get(struct config_set *cs, const char *key);
527
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]528/*
529 * Finds the highest-priority value for the configuration variable `key`
530 * and config set `cs`, stores the pointer to it in `value` and returns 0.
531 * When the configuration variable `key` is not found, returns 1 without
532 * touching `value`. The caller should not free or modify `value`, as it
533 * is owned by the cache.
534 */
Glen Choo8868b1e2023-06-28 19:26:27[diff] [blame]535int git_configset_get_value(struct config_set *cs, const char *key,
536 const char **dest, struct key_value_info *kvi);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]537
Denton Liu55454422019-04-29 08:28:14[diff] [blame]538int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
539int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
540int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
541int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
542int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
543int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
544int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]545
Brandon Williams3b256222017-06-22 18:43:42[diff] [blame]546/* Functions for reading a repository's config */
547struct repository;
Denton Liu55454422019-04-29 08:28:14[diff] [blame]548void repo_config(struct repository *repo, config_fn_t fn, void *data);
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 14:04:22[diff] [blame]549
550/**
551 * Run only the discover part of the repo_config_get_*() functions
552 * below, in addition to 1 if not found, returns negative values on
553 * error (e.g. if the key itself is invalid).
554 */
555RESULT_MUST_BE_USED
556int repo_config_get(struct repository *repo, const char *key);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]557int repo_config_get_value(struct repository *repo,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]558 const char *key, const char **value);
Ævar Arnfjörð Bjarmasona4286192023-03-28 14:04:24[diff] [blame]559RESULT_MUST_BE_USED
560int repo_config_get_value_multi(struct repository *repo, const char *key,
561 const struct string_list **dest);
Ævar Arnfjörð Bjarmason9e2d8842023-03-28 14:04:27[diff] [blame]562RESULT_MUST_BE_USED
563int repo_config_get_string_multi(struct repository *repo, const char *key,
564 const struct string_list **dest);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]565int repo_config_get_string(struct repository *repo,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]566 const char *key, char **dest);
Jeff Kingf1de9812020-08-14 16:17:36[diff] [blame]567int repo_config_get_string_tmp(struct repository *repo,
568 const char *key, const char **dest);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]569int repo_config_get_int(struct repository *repo,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]570 const char *key, int *dest);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]571int repo_config_get_ulong(struct repository *repo,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]572 const char *key, unsigned long *dest);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]573int repo_config_get_bool(struct repository *repo,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]574 const char *key, int *dest);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]575int repo_config_get_bool_or_int(struct repository *repo,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]576 const char *key, int *is_bool, int *dest);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]577int repo_config_get_maybe_bool(struct repository *repo,
Brandon Williams3b256222017-06-22 18:43:42[diff] [blame]578 const char *key, int *dest);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]579int repo_config_get_pathname(struct repository *repo,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]580 const char *key, const char **dest);
Brandon Williams3b256222017-06-22 18:43:42[diff] [blame]581
Glen Choo5b3c6502022-07-14 21:27:59[diff] [blame]582/*
583 * Functions for reading protected config. By definition, protected
584 * config ignores repository config, so these do not take a `struct
585 * repository` parameter.
586 */
587void git_protected_config(config_fn_t fn, void *data);
588
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]589/**
590 * Querying For Specific Variables
591 * -------------------------------
592 *
593 * For programs wanting to query for specific variables in a non-callback
594 * manner, the config API provides two functions `git_config_get_value`
595 * and `git_config_get_value_multi`. They both read values from an internal
596 * cache generated previously from reading the config files.
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 14:04:22[diff] [blame]597 *
598 * For those git_config_get*() functions that aren't documented,
599 * consult the corresponding repo_config_get*() function's
600 * documentation.
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]601 */
602
Ævar Arnfjörð Bjarmasonb83efce2023-03-28 14:04:22[diff] [blame]603RESULT_MUST_BE_USED
604int git_config_get(const char *key);
605
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]606/**
607 * Finds the highest-priority value for the configuration variable `key`,
608 * stores the pointer to it in `value` and returns 0. When the
609 * configuration variable `key` is not found, returns 1 without touching
610 * `value`. The caller should not free or modify `value`, as it is owned
611 * by the cache.
612 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]613int git_config_get_value(const char *key, const char **value);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]614
615/**
616 * Finds and returns the value list, sorted in order of increasing priority
617 * for the configuration variable `key`. When the configuration variable
Ævar Arnfjörð Bjarmasona4286192023-03-28 14:04:24[diff] [blame]618 * `key` is not found, returns 1 without touching `value`.
619 *
620 * The caller should not free or modify the returned pointer, as it is
621 * owned by the cache.
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]622 */
Ævar Arnfjörð Bjarmasona4286192023-03-28 14:04:24[diff] [blame]623RESULT_MUST_BE_USED
624int git_config_get_value_multi(const char *key,
625 const struct string_list **dest);
Ævar Arnfjörð Bjarmason9e2d8842023-03-28 14:04:27[diff] [blame]626RESULT_MUST_BE_USED
627int git_config_get_string_multi(const char *key,
628 const struct string_list **dest);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]629
630/**
631 * Resets and invalidates the config cache.
632 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]633void git_config_clear(void);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]634
635/**
636 * Allocates and copies the retrieved string into the `dest` parameter for
637 * the configuration variable `key`; if NULL string is given, prints an
638 * error message and returns -1. When the configuration variable `key` is
639 * not found, returns 1 without touching `dest`.
640 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]641int git_config_get_string(const char *key, char **dest);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]642
643/**
Jeff King9a532192020-08-17 21:33:11[diff] [blame]644 * Similar to `git_config_get_string`, but does not allocate any new
Jeff Kingf1de9812020-08-14 16:17:36[diff] [blame]645 * memory; on success `dest` will point to memory owned by the config
646 * machinery, which could be invalidated if it is discarded and reloaded.
647 */
648int git_config_get_string_tmp(const char *key, const char **dest);
649
650/**
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]651 * Finds and parses the value to an integer for the configuration variable
652 * `key`. Dies on error; otherwise, stores the value of the parsed integer in
653 * `dest` and returns 0. When the configuration variable `key` is not found,
654 * returns 1 without touching `dest`.
655 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]656int git_config_get_int(const char *key, int *dest);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]657
658/**
659 * Similar to `git_config_get_int` but for unsigned longs.
660 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]661int git_config_get_ulong(const char *key, unsigned long *dest);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]662
663/**
664 * Finds and parses the value into a boolean value, for the configuration
665 * variable `key` respecting keywords like "true" and "false". Integer
666 * values are converted into true/false values (when they are non-zero or
667 * zero, respectively). Other values cause a die(). If parsing is successful,
668 * stores the value of the parsed result in `dest` and returns 0. When the
669 * configuration variable `key` is not found, returns 1 without touching
670 * `dest`.
671 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]672int git_config_get_bool(const char *key, int *dest);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]673
674/**
675 * Similar to `git_config_get_bool`, except that integers are copied as-is,
676 * and `is_bool` flag is unset.
677 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]678int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]679
680/**
681 * Similar to `git_config_get_bool`, except that it returns -1 on error
682 * rather than dying.
683 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]684int git_config_get_maybe_bool(const char *key, int *dest);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]685
686/**
687 * Similar to `git_config_get_string`, but expands `~` or `~user` into
688 * the user's home directory when found at the beginning of the path.
689 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]690int git_config_get_pathname(const char *key, const char **dest);
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]691
Denton Liu55454422019-04-29 08:28:14[diff] [blame]692int git_config_get_index_threads(int *dest);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]693int git_config_get_split_index(void);
694int git_config_get_max_percent_split_change(void);
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]695
696/* This dies if the configured or default date is in the future */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]697int git_config_get_expiry(const char *key, const char **output);
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]698
Junio C Hamano6e96cb52017-08-19 18:43:39[diff] [blame]699/* parse either "this many days" integer, or "5.days.ago" approxidate */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]700int git_config_get_expiry_in_days(const char *key, timestamp_t *, timestamp_t now);
Junio C Hamano6e96cb52017-08-19 18:43:39[diff] [blame]701
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]702/**
703 * First prints the error message specified by the caller in `err` and then
704 * dies printing the line number and the file name of the highest priority
705 * value for the configuration variable `key`.
706 */
Denton Liub199d712019-04-29 08:28:20[diff] [blame]707NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
Heba Waly6c966302019-10-23 05:30:52[diff] [blame]708
709/**
710 * Helper function which formats the die error message according to the
711 * parameters entered. Used by `git_die_config()`. It can be used by callers
712 * handling `git_config_get_value_multi()` to print the correct error message
713 * for the desired value.
714 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]715NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]716
Nguyễn Thái Ngọc Duya73b3682018-05-26 13:55:21[diff] [blame]717#define LOOKUP_CONFIG(mapping, var) \
718 lookup_config(mapping, ARRAY_SIZE(mapping), var)
719int lookup_config(const char **mapping, int nr_mapping, const char *var);
720
Brandon Williamse67a57f2017-06-14 18:07:34[diff] [blame]721#endif /* CONFIG_H */