config.h

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