Andrew's git - gitweb.git/blob

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