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