config.h

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