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