]>
Commit | Line | Data |
---|---|---|
e67a57fc BW |
1 | #ifndef CONFIG_H |
2 | #define CONFIG_H | |
3 | ||
ef3ca954 EN |
4 | #include "hashmap.h" |
5 | #include "string-list.h" | |
9b6b06c1 | 6 | #include "repository.h" |
b1bda751 | 7 | #include "parse.h" |
6c96630c HW |
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 | ||
ef3ca954 EN |
24 | struct object_id; |
25 | ||
e67a57fc BW |
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 | ||
e37efa40 MR |
39 | enum 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, | |
9a83d088 | 46 | CONFIG_SCOPE_SUBMODULE, |
e37efa40 MR |
47 | }; |
48 | const char *config_scope_name(enum config_scope scope); | |
49 | ||
e67a57fc BW |
50 | struct git_config_source { |
51 | unsigned int use_stdin:1; | |
52 | const char *file; | |
53 | const char *blob; | |
e37efa40 | 54 | enum config_scope scope; |
e67a57fc BW |
55 | }; |
56 | ||
57 | enum config_origin_type { | |
e2016508 | 58 | CONFIG_ORIGIN_UNKNOWN = 0, |
e67a57fc BW |
59 | CONFIG_ORIGIN_BLOB, |
60 | CONFIG_ORIGIN_FILE, | |
61 | CONFIG_ORIGIN_STDIN, | |
62 | CONFIG_ORIGIN_SUBMODULE_BLOB, | |
63 | CONFIG_ORIGIN_CMDLINE | |
64 | }; | |
65 | ||
8032cc44 JS |
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 | ||
6e8e7981 | 75 | struct config_source; |
8032cc44 JS |
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 | */ | |
83 | typedef int (*config_parser_event_fn_t)(enum config_event_t type, | |
84 | size_t begin_offset, size_t end_offset, | |
6e8e7981 | 85 | struct config_source *cs, |
8032cc44 JS |
86 | void *event_fn_data); |
87 | ||
e67a57fc BW |
88 | struct config_options { |
89 | unsigned int respect_includes : 1; | |
800a7f99 JH |
90 | unsigned int ignore_repo : 1; |
91 | unsigned int ignore_worktree : 1; | |
92 | unsigned int ignore_cmdline : 1; | |
f672deec | 93 | unsigned int system_gently : 1; |
399b1984 JT |
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 | ||
a577fb5f | 103 | const char *commondir; |
e67a57fc | 104 | const char *git_dir; |
6e8e7981 GC |
105 | /* |
106 | * event_fn and event_fn_data are for internal use only. Handles events | |
107 | * emitted by the config parser. | |
108 | */ | |
8032cc44 JS |
109 | config_parser_event_fn_t event_fn; |
110 | void *event_fn_data; | |
66f97228 JK |
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 */ | |
63583203 | 115 | CONFIG_ERROR_SILENT, /* return -1 */ |
66f97228 | 116 | } error_action; |
e67a57fc BW |
117 | }; |
118 | ||
a4e7e317 GC |
119 | /* Config source metadata for a given config key-value pair */ |
120 | struct key_value_info { | |
121 | const char *filename; | |
122 | int linenr; | |
123 | enum config_origin_type origin_type; | |
124 | enum config_scope scope; | |
908857a9 | 125 | const char *path; |
a4e7e317 GC |
126 | }; |
127 | #define KVI_INIT { \ | |
128 | .filename = NULL, \ | |
129 | .linenr = -1, \ | |
130 | .origin_type = CONFIG_ORIGIN_UNKNOWN, \ | |
131 | .scope = CONFIG_SCOPE_UNKNOWN, \ | |
908857a9 | 132 | .path = NULL, \ |
a4e7e317 GC |
133 | } |
134 | ||
135 | /* Captures additional information that a config callback can use. */ | |
136 | struct 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 | ||
6c96630c | 142 | /** |
a4e7e317 | 143 | * A config callback function takes four parameters: |
6c96630c HW |
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 | * | |
a4e7e317 GC |
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 | * | |
6c96630c HW |
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 | */ | |
a4e7e317 GC |
165 | typedef int (*config_fn_t)(const char *, const char *, |
166 | const struct config_context *, void *); | |
6c96630c | 167 | |
a4e7e317 GC |
168 | int git_default_config(const char *, const char *, |
169 | const struct config_context *, void *); | |
6c96630c HW |
170 | |
171 | /** | |
172 | * Read a specific file in git-config format. | |
173 | * This function takes the same callback and data parameters as `git_config`. | |
ed69e11b JT |
174 | * |
175 | * Unlike git_config(), this function does not respect includes. | |
6c96630c | 176 | */ |
55454427 | 177 | int git_config_from_file(config_fn_t fn, const char *, void *); |
6c96630c | 178 | |
55454427 | 179 | int git_config_from_file_with_options(config_fn_t fn, const char *, |
809d8680 | 180 | void *, enum config_scope, |
ad6dad09 | 181 | const struct config_options *); |
55454427 | 182 | int git_config_from_mem(config_fn_t fn, |
ad6dad09 DL |
183 | const enum config_origin_type, |
184 | const char *name, | |
185 | const char *buf, size_t len, | |
809d8680 GC |
186 | void *data, enum config_scope scope, |
187 | const struct config_options *opts); | |
55454427 | 188 | int git_config_from_blob_oid(config_fn_t fn, const char *name, |
e3e8bf04 | 189 | struct repository *repo, |
809d8680 GC |
190 | const struct object_id *oid, void *data, |
191 | enum config_scope scope); | |
55454427 | 192 | void git_config_push_parameter(const char *text); |
ce81b1da | 193 | void git_config_push_env(const char *spec); |
55454427 DL |
194 | int git_config_from_parameters(config_fn_t fn, void *data); |
195 | void read_early_config(config_fn_t cb, void *data); | |
4aeeef37 | 196 | void read_very_early_config(config_fn_t cb, void *data); |
6c96630c HW |
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). | |
ed69e11b JT |
210 | * |
211 | * Unlike git_config_from_file(), this function respects includes. | |
6c96630c | 212 | */ |
55454427 | 213 | void git_config(config_fn_t fn, void *); |
6c96630c HW |
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 | */ | |
55454427 | 234 | int config_with_options(config_fn_t fn, void *, |
ad6dad09 | 235 | struct git_config_source *config_source, |
9b6b06c1 | 236 | struct repository *repo, |
ad6dad09 | 237 | const struct config_options *opts); |
6c96630c HW |
238 | |
239 | /** | |
240 | * Value Parsing Helpers | |
241 | * --------------------- | |
242 | * | |
243 | * The following helper functions aid in parsing string values | |
244 | */ | |
245 | ||
6c96630c HW |
246 | /** |
247 | * Parse the string to an integer, including unit factors. Dies on error; | |
248 | * otherwise, returns the parsed result. | |
249 | */ | |
8868b1eb | 250 | int git_config_int(const char *, const char *, const struct key_value_info *); |
6c96630c | 251 | |
8868b1eb GC |
252 | int64_t git_config_int64(const char *, const char *, |
253 | const struct key_value_info *); | |
6c96630c HW |
254 | |
255 | /** | |
256 | * Identical to `git_config_int`, but for unsigned longs. | |
257 | */ | |
8868b1eb GC |
258 | unsigned long git_config_ulong(const char *, const char *, |
259 | const struct key_value_info *); | |
6c96630c | 260 | |
8868b1eb GC |
261 | ssize_t git_config_ssize_t(const char *, const char *, |
262 | const struct key_value_info *); | |
6c96630c HW |
263 | |
264 | /** | |
265 | * Same as `git_config_bool`, except that integers are returned as-is, and | |
266 | * an `is_bool` flag is unset. | |
267 | */ | |
8868b1eb GC |
268 | int git_config_bool_or_int(const char *, const char *, |
269 | const struct key_value_info *, int *); | |
6c96630c HW |
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 | */ | |
55454427 | 277 | int git_config_bool(const char *, const char *); |
6c96630c HW |
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 | */ | |
55454427 | 283 | int git_config_string(const char **, const char *, const char *); |
6c96630c HW |
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 | */ | |
55454427 | 289 | int git_config_pathname(const char **, const char *, const char *); |
6c96630c | 290 | |
55454427 DL |
291 | int git_config_expiry_date(timestamp_t *, const char *, const char *); |
292 | int git_config_color(char *, const char *, const char *); | |
293 | int git_config_set_in_file_gently(const char *, const char *, const char *); | |
6c96630c HW |
294 | |
295 | /** | |
296 | * write config values to a specific config file, takes a key/value pair as | |
297 | * parameter. | |
298 | */ | |
55454427 | 299 | void git_config_set_in_file(const char *, const char *, const char *); |
6c96630c | 300 | |
55454427 | 301 | int git_config_set_gently(const char *, const char *); |
6c96630c | 302 | |
fe187339 DS |
303 | /** |
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 | */ | |
308 | int repo_config_set_worktree_gently(struct repository *, const char *, const char *); | |
309 | ||
6c96630c HW |
310 | /** |
311 | * write config values to `.git/config`, takes a key/value pair as parameter. | |
312 | */ | |
55454427 | 313 | void git_config_set(const char *, const char *); |
6c96630c | 314 | |
f011a965 | 315 | int git_config_parse_key(const char *, char **, size_t *); |
504ee129 DS |
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 | ||
c90702a1 DS |
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 | ||
504ee129 DS |
336 | int git_config_set_multivar_gently(const char *, const char *, const char *, unsigned); |
337 | void git_config_set_multivar(const char *, const char *, const char *, unsigned); | |
fe187339 | 338 | int repo_config_set_multivar_gently(struct repository *, const char *, const char *, const char *, unsigned); |
504ee129 | 339 | int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, unsigned); |
6c96630c HW |
340 | |
341 | /** | |
342 | * takes four parameters: | |
343 | * | |
344 | * - the name of the file, as a string, to which key/value pairs will be written. | |
345 | * | |
346 | * - the name of key, as a string. This is in canonical "flat" form: the section, | |
347 | * subsection, and variable segments will be separated by dots, and the section | |
348 | * and variable segments will be all lowercase. | |
349 | * E.g., `core.ignorecase`, `diff.SomeType.textconv`. | |
350 | * | |
351 | * - the value of the variable, as a string. If value is equal to NULL, it will | |
352 | * remove the matching key from the config file. | |
353 | * | |
354 | * - the value regex, as a string. It will disregard key/value pairs where value | |
355 | * does not match. | |
356 | * | |
504ee129 | 357 | * - a flags value with bits corresponding to the CONFIG_FLAG_* macros. |
6c96630c HW |
358 | * |
359 | * It returns 0 on success. | |
360 | */ | |
504ee129 DS |
361 | void git_config_set_multivar_in_file(const char *config_filename, |
362 | const char *key, | |
363 | const char *value, | |
247e2f82 | 364 | const char *value_pattern, |
504ee129 | 365 | unsigned flags); |
6c96630c HW |
366 | |
367 | /** | |
368 | * rename or remove sections in the config file | |
369 | * parameters `old_name` and `new_name` | |
370 | * If NULL is passed through `new_name` parameter, | |
371 | * the section will be removed from the config file. | |
372 | */ | |
55454427 | 373 | int git_config_rename_section(const char *, const char *); |
6c96630c | 374 | |
55454427 DL |
375 | int git_config_rename_section_in_file(const char *, const char *, const char *); |
376 | int git_config_copy_section(const char *, const char *); | |
377 | int git_config_copy_section_in_file(const char *, const char *, const char *); | |
55454427 DL |
378 | int git_config_system(void); |
379 | int config_error_nonbool(const char *); | |
e67a57fc BW |
380 | #if defined(__GNUC__) |
381 | #define config_error_nonbool(s) (config_error_nonbool(s), const_error()) | |
382 | #endif | |
383 | ||
c62a999c | 384 | char *git_system_config(void); |
c15129b6 | 385 | char *git_global_config(void); |
ecffa3ed | 386 | void git_global_config_paths(char **user, char **xdg); |
c62a999c | 387 | |
55454427 | 388 | int git_config_parse_parameter(const char *, config_fn_t fn, void *data); |
e67a57fc | 389 | |
6021e1d1 | 390 | const char *config_origin_type_name(enum config_origin_type type); |
26b66932 | 391 | void kvi_from_param(struct key_value_info *out); |
e67a57fc | 392 | |
e67a57fc BW |
393 | /* |
394 | * Match and parse a config key of the form: | |
395 | * | |
396 | * section.(subsection.)?key | |
397 | * | |
398 | * (i.e., what gets handed to a config_fn_t). The caller provides the section; | |
399 | * we return -1 if it does not match, 0 otherwise. The subsection and key | |
400 | * out-parameters are filled by the function (and *subsection is NULL if it is | |
401 | * missing). | |
402 | * | |
403 | * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if | |
404 | * there is no subsection at all. | |
405 | */ | |
55454427 | 406 | int parse_config_key(const char *var, |
ad6dad09 | 407 | const char *section, |
f5914f4b | 408 | const char **subsection, size_t *subsection_len, |
ad6dad09 | 409 | const char **key); |
e67a57fc | 410 | |
6c96630c HW |
411 | /** |
412 | * Custom Configsets | |
413 | * ----------------- | |
414 | * | |
415 | * A `config_set` can be used to construct an in-memory cache for | |
416 | * config-like files that the caller specifies (i.e., files like `.gitmodules`, | |
417 | * `~/.gitconfig` etc.). For example, | |
418 | * | |
419 | * ---------------------------------------- | |
420 | * struct config_set gm_config; | |
421 | * git_configset_init(&gm_config); | |
422 | * int b; | |
423 | * //we add config files to the config_set | |
424 | * git_configset_add_file(&gm_config, ".gitmodules"); | |
425 | * git_configset_add_file(&gm_config, ".gitmodules_alt"); | |
426 | * | |
427 | * if (!git_configset_get_bool(gm_config, "submodule.frotz.ignore", &b)) { | |
428 | * //hack hack hack | |
429 | * } | |
430 | * | |
431 | * when we are done with the configset: | |
432 | * git_configset_clear(&gm_config); | |
433 | * ---------------------------------------- | |
434 | * | |
435 | * Configset API provides functions for the above mentioned work flow | |
436 | */ | |
437 | ||
e67a57fc BW |
438 | struct config_set_element { |
439 | struct hashmap_entry ent; | |
440 | char *key; | |
441 | struct string_list value_list; | |
442 | }; | |
443 | ||
444 | struct configset_list_item { | |
445 | struct config_set_element *e; | |
446 | int value_index; | |
447 | }; | |
448 | ||
449 | /* | |
450 | * the contents of the list are ordered according to their | |
451 | * position in the config files and order of parsing the files. | |
452 | * (i.e. key-value pair at the last position of .git/config will | |
453 | * be at the last item of the list) | |
454 | */ | |
455 | struct configset_list { | |
456 | struct configset_list_item *items; | |
457 | unsigned int nr, alloc; | |
458 | }; | |
459 | ||
460 | struct config_set { | |
461 | struct hashmap config_hash; | |
462 | int hash_initialized; | |
463 | struct configset_list list; | |
464 | }; | |
465 | ||
6c96630c HW |
466 | /** |
467 | * Initializes the config_set `cs`. | |
468 | */ | |
55454427 | 469 | void git_configset_init(struct config_set *cs); |
6c96630c HW |
470 | |
471 | /** | |
472 | * Parses the file and adds the variable-value pairs to the `config_set`, | |
473 | * dies if there is an error in parsing the file. Returns 0 on success, or | |
0e20b229 FC |
474 | * -1 if the file does not exist or is inaccessible. The caller decides |
475 | * whether to free the incomplete configset or continue using it when | |
6c96630c HW |
476 | * the function returns -1. |
477 | */ | |
55454427 | 478 | int git_configset_add_file(struct config_set *cs, const char *filename); |
6c96630c HW |
479 | |
480 | /** | |
481 | * Finds and returns the value list, sorted in order of increasing priority | |
482 | * for the configuration variable `key` and config set `cs`. When the | |
a4286193 ÆAB |
483 | * configuration variable `key` is not found, returns 1 without touching |
484 | * `value`. | |
485 | * | |
486 | * The key will be parsed for validity with git_config_parse_key(), on | |
487 | * error a negative value will be returned. | |
488 | * | |
489 | * The caller should not free or modify the returned pointer, as it is | |
490 | * owned by the cache. | |
6c96630c | 491 | */ |
a4286193 ÆAB |
492 | RESULT_MUST_BE_USED |
493 | int git_configset_get_value_multi(struct config_set *cs, const char *key, | |
494 | const struct string_list **dest); | |
6c96630c | 495 | |
9e2d884d ÆAB |
496 | /** |
497 | * A validation wrapper for git_configset_get_value_multi() which does | |
498 | * for it what git_configset_get_string() does for | |
499 | * git_configset_get_value(). | |
500 | * | |
501 | * The configuration syntax allows for "[section] key", which will | |
502 | * give us a NULL entry in the "struct string_list", as opposed to | |
503 | * "[section] key =" which is the empty string. Most users of the API | |
504 | * are not prepared to handle NULL in a "struct string_list". | |
505 | */ | |
506 | int git_configset_get_string_multi(struct config_set *cs, const char *key, | |
507 | const struct string_list **dest); | |
6c96630c HW |
508 | |
509 | /** | |
510 | * Clears `config_set` structure, removes all saved variable-value pairs. | |
511 | */ | |
55454427 | 512 | void git_configset_clear(struct config_set *cs); |
8ad169c4 HWN |
513 | |
514 | /* | |
515 | * These functions return 1 if not found, and 0 if found, leaving the found | |
516 | * value in the 'dest' pointer. | |
517 | */ | |
6c96630c | 518 | |
b83efcec ÆAB |
519 | /** |
520 | * git_configset_get() returns negative values on error, see | |
521 | * repo_config_get() below. | |
522 | */ | |
523 | RESULT_MUST_BE_USED | |
524 | int git_configset_get(struct config_set *cs, const char *key); | |
525 | ||
6c96630c HW |
526 | /* |
527 | * Finds the highest-priority value for the configuration variable `key` | |
528 | * and config set `cs`, stores the pointer to it in `value` and returns 0. | |
529 | * When the configuration variable `key` is not found, returns 1 without | |
530 | * touching `value`. The caller should not free or modify `value`, as it | |
531 | * is owned by the cache. | |
532 | */ | |
8868b1eb GC |
533 | int git_configset_get_value(struct config_set *cs, const char *key, |
534 | const char **dest, struct key_value_info *kvi); | |
6c96630c | 535 | |
55454427 DL |
536 | int git_configset_get_string(struct config_set *cs, const char *key, char **dest); |
537 | int git_configset_get_int(struct config_set *cs, const char *key, int *dest); | |
538 | int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest); | |
539 | int git_configset_get_bool(struct config_set *cs, const char *key, int *dest); | |
540 | int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest); | |
541 | int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest); | |
542 | int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest); | |
e67a57fc | 543 | |
3b256228 BW |
544 | /* Functions for reading a repository's config */ |
545 | struct repository; | |
55454427 | 546 | void repo_config(struct repository *repo, config_fn_t fn, void *data); |
b83efcec ÆAB |
547 | |
548 | /** | |
549 | * Run only the discover part of the repo_config_get_*() functions | |
550 | * below, in addition to 1 if not found, returns negative values on | |
551 | * error (e.g. if the key itself is invalid). | |
552 | */ | |
553 | RESULT_MUST_BE_USED | |
554 | int repo_config_get(struct repository *repo, const char *key); | |
55454427 | 555 | int repo_config_get_value(struct repository *repo, |
ad6dad09 | 556 | const char *key, const char **value); |
a4286193 ÆAB |
557 | RESULT_MUST_BE_USED |
558 | int repo_config_get_value_multi(struct repository *repo, const char *key, | |
559 | const struct string_list **dest); | |
9e2d884d ÆAB |
560 | RESULT_MUST_BE_USED |
561 | int repo_config_get_string_multi(struct repository *repo, const char *key, | |
562 | const struct string_list **dest); | |
55454427 | 563 | int repo_config_get_string(struct repository *repo, |
ad6dad09 | 564 | const char *key, char **dest); |
f1de981e JK |
565 | int repo_config_get_string_tmp(struct repository *repo, |
566 | const char *key, const char **dest); | |
55454427 | 567 | int repo_config_get_int(struct repository *repo, |
ad6dad09 | 568 | const char *key, int *dest); |
55454427 | 569 | int repo_config_get_ulong(struct repository *repo, |
ad6dad09 | 570 | const char *key, unsigned long *dest); |
55454427 | 571 | int repo_config_get_bool(struct repository *repo, |
ad6dad09 | 572 | const char *key, int *dest); |
55454427 | 573 | int repo_config_get_bool_or_int(struct repository *repo, |
ad6dad09 | 574 | const char *key, int *is_bool, int *dest); |
55454427 | 575 | int repo_config_get_maybe_bool(struct repository *repo, |
3b256228 | 576 | const char *key, int *dest); |
55454427 | 577 | int repo_config_get_pathname(struct repository *repo, |
ad6dad09 | 578 | const char *key, const char **dest); |
3b256228 | 579 | |
5b3c6507 GC |
580 | /* |
581 | * Functions for reading protected config. By definition, protected | |
582 | * config ignores repository config, so these do not take a `struct | |
583 | * repository` parameter. | |
584 | */ | |
585 | void git_protected_config(config_fn_t fn, void *data); | |
586 | ||
6c96630c HW |
587 | /** |
588 | * Querying For Specific Variables | |
589 | * ------------------------------- | |
590 | * | |
591 | * For programs wanting to query for specific variables in a non-callback | |
592 | * manner, the config API provides two functions `git_config_get_value` | |
593 | * and `git_config_get_value_multi`. They both read values from an internal | |
594 | * cache generated previously from reading the config files. | |
b83efcec ÆAB |
595 | * |
596 | * For those git_config_get*() functions that aren't documented, | |
597 | * consult the corresponding repo_config_get*() function's | |
598 | * documentation. | |
6c96630c HW |
599 | */ |
600 | ||
b83efcec ÆAB |
601 | RESULT_MUST_BE_USED |
602 | int git_config_get(const char *key); | |
603 | ||
6c96630c HW |
604 | /** |
605 | * Finds the highest-priority value for the configuration variable `key`, | |
606 | * stores the pointer to it in `value` and returns 0. When the | |
607 | * configuration variable `key` is not found, returns 1 without touching | |
608 | * `value`. The caller should not free or modify `value`, as it is owned | |
609 | * by the cache. | |
610 | */ | |
55454427 | 611 | int git_config_get_value(const char *key, const char **value); |
6c96630c HW |
612 | |
613 | /** | |
614 | * Finds and returns the value list, sorted in order of increasing priority | |
615 | * for the configuration variable `key`. When the configuration variable | |
a4286193 ÆAB |
616 | * `key` is not found, returns 1 without touching `value`. |
617 | * | |
618 | * The caller should not free or modify the returned pointer, as it is | |
619 | * owned by the cache. | |
6c96630c | 620 | */ |
a4286193 ÆAB |
621 | RESULT_MUST_BE_USED |
622 | int git_config_get_value_multi(const char *key, | |
623 | const struct string_list **dest); | |
9e2d884d ÆAB |
624 | RESULT_MUST_BE_USED |
625 | int git_config_get_string_multi(const char *key, | |
626 | const struct string_list **dest); | |
6c96630c HW |
627 | |
628 | /** | |
629 | * Resets and invalidates the config cache. | |
630 | */ | |
55454427 | 631 | void git_config_clear(void); |
6c96630c HW |
632 | |
633 | /** | |
634 | * Allocates and copies the retrieved string into the `dest` parameter for | |
635 | * the configuration variable `key`; if NULL string is given, prints an | |
636 | * error message and returns -1. When the configuration variable `key` is | |
637 | * not found, returns 1 without touching `dest`. | |
638 | */ | |
55454427 | 639 | int git_config_get_string(const char *key, char **dest); |
6c96630c | 640 | |
f1de981e | 641 | /** |
9a53219f | 642 | * Similar to `git_config_get_string`, but does not allocate any new |
f1de981e JK |
643 | * memory; on success `dest` will point to memory owned by the config |
644 | * machinery, which could be invalidated if it is discarded and reloaded. | |
645 | */ | |
646 | int git_config_get_string_tmp(const char *key, const char **dest); | |
647 | ||
6c96630c HW |
648 | /** |
649 | * Finds and parses the value to an integer for the configuration variable | |
650 | * `key`. Dies on error; otherwise, stores the value of the parsed integer in | |
651 | * `dest` and returns 0. When the configuration variable `key` is not found, | |
652 | * returns 1 without touching `dest`. | |
653 | */ | |
55454427 | 654 | int git_config_get_int(const char *key, int *dest); |
6c96630c HW |
655 | |
656 | /** | |
657 | * Similar to `git_config_get_int` but for unsigned longs. | |
658 | */ | |
55454427 | 659 | int git_config_get_ulong(const char *key, unsigned long *dest); |
6c96630c HW |
660 | |
661 | /** | |
662 | * Finds and parses the value into a boolean value, for the configuration | |
663 | * variable `key` respecting keywords like "true" and "false". Integer | |
664 | * values are converted into true/false values (when they are non-zero or | |
665 | * zero, respectively). Other values cause a die(). If parsing is successful, | |
666 | * stores the value of the parsed result in `dest` and returns 0. When the | |
667 | * configuration variable `key` is not found, returns 1 without touching | |
668 | * `dest`. | |
669 | */ | |
55454427 | 670 | int git_config_get_bool(const char *key, int *dest); |
6c96630c HW |
671 | |
672 | /** | |
673 | * Similar to `git_config_get_bool`, except that integers are copied as-is, | |
674 | * and `is_bool` flag is unset. | |
675 | */ | |
55454427 | 676 | int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest); |
6c96630c HW |
677 | |
678 | /** | |
679 | * Similar to `git_config_get_bool`, except that it returns -1 on error | |
680 | * rather than dying. | |
681 | */ | |
55454427 | 682 | int git_config_get_maybe_bool(const char *key, int *dest); |
6c96630c HW |
683 | |
684 | /** | |
685 | * Similar to `git_config_get_string`, but expands `~` or `~user` into | |
686 | * the user's home directory when found at the beginning of the path. | |
687 | */ | |
55454427 | 688 | int git_config_get_pathname(const char *key, const char **dest); |
6c96630c | 689 | |
55454427 | 690 | int git_config_get_index_threads(int *dest); |
55454427 DL |
691 | int git_config_get_split_index(void); |
692 | int git_config_get_max_percent_split_change(void); | |
e67a57fc BW |
693 | |
694 | /* This dies if the configured or default date is in the future */ | |
55454427 | 695 | int git_config_get_expiry(const char *key, const char **output); |
e67a57fc | 696 | |
6e96cb52 | 697 | /* parse either "this many days" integer, or "5.days.ago" approxidate */ |
55454427 | 698 | int git_config_get_expiry_in_days(const char *key, timestamp_t *, timestamp_t now); |
6e96cb52 | 699 | |
6c96630c HW |
700 | /** |
701 | * First prints the error message specified by the caller in `err` and then | |
702 | * dies printing the line number and the file name of the highest priority | |
703 | * value for the configuration variable `key`. | |
704 | */ | |
b199d714 | 705 | NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3))); |
6c96630c HW |
706 | |
707 | /** | |
708 | * Helper function which formats the die error message according to the | |
709 | * parameters entered. Used by `git_die_config()`. It can be used by callers | |
710 | * handling `git_config_get_value_multi()` to print the correct error message | |
711 | * for the desired value. | |
712 | */ | |
55454427 | 713 | NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr); |
e67a57fc | 714 | |
a73b3680 NTND |
715 | #define LOOKUP_CONFIG(mapping, var) \ |
716 | lookup_config(mapping, ARRAY_SIZE(mapping), var) | |
717 | int lookup_config(const char **mapping, int nr_mapping, const char *var); | |
718 | ||
e67a57fc | 719 | #endif /* CONFIG_H */ |