Andrew's git - gitweb.git/blob

   1#ifndef CONFIG_H
   2#define CONFIG_H
   3
   4#include "hashmap.h"
   5#include "string-list.h"
   6
   7struct object_id;
   8
   9/* git_config_parse_key() returns these negated: */
  10#define CONFIG_INVALID_KEY 1
  11#define CONFIG_NO_SECTION_OR_NAME 2
  12/* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
  13#define CONFIG_NO_LOCK -1
  14#define CONFIG_INVALID_FILE 3
  15#define CONFIG_NO_WRITE 4
  16#define CONFIG_NOTHING_SET 5
  17#define CONFIG_INVALID_PATTERN 6
  18#define CONFIG_GENERIC_ERROR 7
  19
  20#define CONFIG_REGEX_NONE ((void *)1)
  21
  22struct git_config_source {
  23        unsigned int use_stdin:1;
  24        const char *file;
  25        const char *blob;
  26};
  27
  28enum config_origin_type {
  29        CONFIG_ORIGIN_BLOB,
  30        CONFIG_ORIGIN_FILE,
  31        CONFIG_ORIGIN_STDIN,
  32        CONFIG_ORIGIN_SUBMODULE_BLOB,
  33        CONFIG_ORIGIN_CMDLINE
  34};
  35
  36enum config_event_t {
  37        CONFIG_EVENT_SECTION,
  38        CONFIG_EVENT_ENTRY,
  39        CONFIG_EVENT_WHITESPACE,
  40        CONFIG_EVENT_COMMENT,
  41        CONFIG_EVENT_EOF,
  42        CONFIG_EVENT_ERROR
  43};
  44
  45/*
  46 * The parser event function (if not NULL) is called with the event type and
  47 * the begin/end offsets of the parsed elements.
  48 *
  49 * Note: for CONFIG_EVENT_ENTRY (i.e. config variables), the trailing newline
  50 * character is considered part of the element.
  51 */
  52typedef int (*config_parser_event_fn_t)(enum config_event_t type,
  53                                        size_t begin_offset, size_t end_offset,
  54                                        void *event_fn_data);
  55
  56struct config_options {
  57        unsigned int respect_includes : 1;
  58        unsigned int ignore_repo : 1;
  59        unsigned int ignore_worktree : 1;
  60        unsigned int ignore_cmdline : 1;
  61        const char *commondir;
  62        const char *git_dir;
  63        config_parser_event_fn_t event_fn;
  64        void *event_fn_data;
  65        enum config_error_action {
  66                CONFIG_ERROR_UNSET = 0, /* use source-specific default */
  67                CONFIG_ERROR_DIE, /* die() on error */
  68                CONFIG_ERROR_ERROR, /* error() on error, return -1 */
  69                CONFIG_ERROR_SILENT, /* return -1 */
  70        } error_action;
  71};
  72
  73typedef int (*config_fn_t)(const char *, const char *, void *);
  74extern int git_default_config(const char *, const char *, void *);
  75extern int git_config_from_file(config_fn_t fn, const char *, void *);
  76extern int git_config_from_file_with_options(config_fn_t fn, const char *,
  77                                             void *,
  78                                             const struct config_options *);
  79extern int git_config_from_mem(config_fn_t fn,
  80                               const enum config_origin_type,
  81                               const char *name,
  82                               const char *buf, size_t len,
  83                               void *data, const struct config_options *opts);
  84extern int git_config_from_blob_oid(config_fn_t fn, const char *name,
  85                                    const struct object_id *oid, void *data);
  86extern void git_config_push_parameter(const char *text);
  87extern int git_config_from_parameters(config_fn_t fn, void *data);
  88extern void read_early_config(config_fn_t cb, void *data);
  89extern void read_very_early_config(config_fn_t cb, void *data);
  90extern void git_config(config_fn_t fn, void *);
  91extern int config_with_options(config_fn_t fn, void *,
  92                               struct git_config_source *config_source,
  93                               const struct config_options *opts);
  94extern int git_parse_ssize_t(const char *, ssize_t *);
  95extern int git_parse_ulong(const char *, unsigned long *);
  96extern int git_parse_maybe_bool(const char *);
  97extern int git_config_int(const char *, const char *);
  98extern int64_t git_config_int64(const char *, const char *);
  99extern unsigned long git_config_ulong(const char *, const char *);
 100extern ssize_t git_config_ssize_t(const char *, const char *);
 101extern int git_config_bool_or_int(const char *, const char *, int *);
 102extern int git_config_bool(const char *, const char *);
 103extern int git_config_string(const char **, const char *, const char *);
 104extern int git_config_pathname(const char **, const char *, const char *);
 105extern int git_config_expiry_date(timestamp_t *, const char *, const char *);
 106extern int git_config_color(char *, const char *, const char *);
 107extern int git_config_set_in_file_gently(const char *, const char *, const char *);
 108extern void git_config_set_in_file(const char *, const char *, const char *);
 109extern int git_config_set_gently(const char *, const char *);
 110extern void git_config_set(const char *, const char *);
 111extern int git_config_parse_key(const char *, char **, int *);
 112extern int git_config_key_is_valid(const char *key);
 113extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
 114extern void git_config_set_multivar(const char *, const char *, const char *, int);
 115extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
 116extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
 117extern int git_config_rename_section(const char *, const char *);
 118extern int git_config_rename_section_in_file(const char *, const char *, const char *);
 119extern int git_config_copy_section(const char *, const char *);
 120extern int git_config_copy_section_in_file(const char *, const char *, const char *);
 121extern const char *git_etc_gitconfig(void);
 122extern int git_env_bool(const char *, int);
 123extern unsigned long git_env_ulong(const char *, unsigned long);
 124extern int git_config_system(void);
 125extern int config_error_nonbool(const char *);
 126#if defined(__GNUC__)
 127#define config_error_nonbool(s) (config_error_nonbool(s), const_error())
 128#endif
 129
 130extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
 131
 132enum config_scope {
 133        CONFIG_SCOPE_UNKNOWN = 0,
 134        CONFIG_SCOPE_SYSTEM,
 135        CONFIG_SCOPE_GLOBAL,
 136        CONFIG_SCOPE_REPO,
 137        CONFIG_SCOPE_CMDLINE,
 138};
 139
 140extern enum config_scope current_config_scope(void);
 141extern const char *current_config_origin_type(void);
 142extern const char *current_config_name(void);
 143
 144struct config_include_data {
 145        int depth;
 146        config_fn_t fn;
 147        void *data;
 148        const struct config_options *opts;
 149};
 150#define CONFIG_INCLUDE_INIT { 0 }
 151extern int git_config_include(const char *name, const char *value, void *data);
 152
 153/*
 154 * Match and parse a config key of the form:
 155 *
 156 *   section.(subsection.)?key
 157 *
 158 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
 159 * we return -1 if it does not match, 0 otherwise. The subsection and key
 160 * out-parameters are filled by the function (and *subsection is NULL if it is
 161 * missing).
 162 *
 163 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if
 164 * there is no subsection at all.
 165 */
 166extern int parse_config_key(const char *var,
 167                            const char *section,
 168                            const char **subsection, int *subsection_len,
 169                            const char **key);
 170
 171struct config_set_element {
 172        struct hashmap_entry ent;
 173        char *key;
 174        struct string_list value_list;
 175};
 176
 177struct configset_list_item {
 178        struct config_set_element *e;
 179        int value_index;
 180};
 181
 182/*
 183 * the contents of the list are ordered according to their
 184 * position in the config files and order of parsing the files.
 185 * (i.e. key-value pair at the last position of .git/config will
 186 * be at the last item of the list)
 187 */
 188struct configset_list {
 189        struct configset_list_item *items;
 190        unsigned int nr, alloc;
 191};
 192
 193struct config_set {
 194        struct hashmap config_hash;
 195        int hash_initialized;
 196        struct configset_list list;
 197};
 198
 199extern void git_configset_init(struct config_set *cs);
 200extern int git_configset_add_file(struct config_set *cs, const char *filename);
 201extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
 202extern void git_configset_clear(struct config_set *cs);
 203
 204/*
 205 * These functions return 1 if not found, and 0 if found, leaving the found
 206 * value in the 'dest' pointer.
 207 */
 208extern int git_configset_get_value(struct config_set *cs, const char *key, const char **dest);
 209extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
 210extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
 211extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
 212extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
 213extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
 214extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
 215extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
 216extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
 217
 218/* Functions for reading a repository's config */
 219struct repository;
 220extern void repo_config(struct repository *repo, config_fn_t fn, void *data);
 221extern int repo_config_get_value(struct repository *repo,
 222                                 const char *key, const char **value);
 223extern const struct string_list *repo_config_get_value_multi(struct repository *repo,
 224                                                             const char *key);
 225extern int repo_config_get_string_const(struct repository *repo,
 226                                        const char *key, const char **dest);
 227extern int repo_config_get_string(struct repository *repo,
 228                                  const char *key, char **dest);
 229extern int repo_config_get_int(struct repository *repo,
 230                               const char *key, int *dest);
 231extern int repo_config_get_ulong(struct repository *repo,
 232                                 const char *key, unsigned long *dest);
 233extern int repo_config_get_bool(struct repository *repo,
 234                                const char *key, int *dest);
 235extern int repo_config_get_bool_or_int(struct repository *repo,
 236                                       const char *key, int *is_bool, int *dest);
 237extern int repo_config_get_maybe_bool(struct repository *repo,
 238                                      const char *key, int *dest);
 239extern int repo_config_get_pathname(struct repository *repo,
 240                                    const char *key, const char **dest);
 241
 242extern int git_config_get_value(const char *key, const char **value);
 243extern const struct string_list *git_config_get_value_multi(const char *key);
 244extern void git_config_clear(void);
 245extern int git_config_get_string_const(const char *key, const char **dest);
 246extern int git_config_get_string(const char *key, char **dest);
 247extern int git_config_get_int(const char *key, int *dest);
 248extern int git_config_get_ulong(const char *key, unsigned long *dest);
 249extern int git_config_get_bool(const char *key, int *dest);
 250extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
 251extern int git_config_get_maybe_bool(const char *key, int *dest);
 252extern int git_config_get_pathname(const char *key, const char **dest);
 253extern int git_config_get_index_threads(int *dest);
 254extern int git_config_get_untracked_cache(void);
 255extern int git_config_get_split_index(void);
 256extern int git_config_get_max_percent_split_change(void);
 257extern int git_config_get_fsmonitor(void);
 258
 259/* This dies if the configured or default date is in the future */
 260extern int git_config_get_expiry(const char *key, const char **output);
 261
 262/* parse either "this many days" integer, or "5.days.ago" approxidate */
 263extern int git_config_get_expiry_in_days(const char *key, timestamp_t *, timestamp_t now);
 264
 265struct key_value_info {
 266        const char *filename;
 267        int linenr;
 268        enum config_origin_type origin_type;
 269        enum config_scope scope;
 270};
 271
 272extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
 273extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
 274
 275#define LOOKUP_CONFIG(mapping, var) \
 276        lookup_config(mapping, ARRAY_SIZE(mapping), var)
 277int lookup_config(const char **mapping, int nr_mapping, const char *var);
 278
 279#endif /* CONFIG_H */