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