config.h

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