config: create config.h
[git/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
31struct config_options {
32 unsigned int respect_includes : 1;
33 const char *git_dir;
34};
35
36typedef int (*config_fn_t)(const char *, const char *, void *);
37extern int git_default_config(const char *, const char *, void *);
38extern int git_config_from_file(config_fn_t fn, const char *, void *);
39extern int git_config_from_mem(config_fn_t fn, const enum config_origin_type,
40 const char *name, const char *buf, size_t len, void *data);
41extern int git_config_from_blob_sha1(config_fn_t fn, const char *name,
42 const unsigned char *sha1, void *data);
43extern void git_config_push_parameter(const char *text);
44extern int git_config_from_parameters(config_fn_t fn, void *data);
45extern void read_early_config(config_fn_t cb, void *data);
46extern void git_config(config_fn_t fn, void *);
47extern int git_config_with_options(config_fn_t fn, void *,
48 struct git_config_source *config_source,
49 const struct config_options *opts);
50extern int git_parse_ulong(const char *, unsigned long *);
51extern int git_parse_maybe_bool(const char *);
52extern int git_config_int(const char *, const char *);
53extern int64_t git_config_int64(const char *, const char *);
54extern unsigned long git_config_ulong(const char *, const char *);
55extern ssize_t git_config_ssize_t(const char *, const char *);
56extern int git_config_bool_or_int(const char *, const char *, int *);
57extern int git_config_bool(const char *, const char *);
58extern int git_config_maybe_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 const char *git_etc_gitconfig(void);
74extern int git_env_bool(const char *, int);
75extern unsigned long git_env_ulong(const char *, unsigned long);
76extern int git_config_system(void);
77extern int config_error_nonbool(const char *);
78#if defined(__GNUC__)
79#define config_error_nonbool(s) (config_error_nonbool(s), const_error())
80#endif
81
82extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
83
84enum config_scope {
85 CONFIG_SCOPE_UNKNOWN = 0,
86 CONFIG_SCOPE_SYSTEM,
87 CONFIG_SCOPE_GLOBAL,
88 CONFIG_SCOPE_REPO,
89 CONFIG_SCOPE_CMDLINE,
90};
91
92extern enum config_scope current_config_scope(void);
93extern const char *current_config_origin_type(void);
94extern const char *current_config_name(void);
95
96struct config_include_data {
97 int depth;
98 config_fn_t fn;
99 void *data;
100 const struct config_options *opts;
101};
102#define CONFIG_INCLUDE_INIT { 0 }
103extern int git_config_include(const char *name, const char *value, void *data);
104
105/*
106 * Match and parse a config key of the form:
107 *
108 * section.(subsection.)?key
109 *
110 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
111 * we return -1 if it does not match, 0 otherwise. The subsection and key
112 * out-parameters are filled by the function (and *subsection is NULL if it is
113 * missing).
114 *
115 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if
116 * there is no subsection at all.
117 */
118extern int parse_config_key(const char *var,
119 const char *section,
120 const char **subsection, int *subsection_len,
121 const char **key);
122
123struct config_set_element {
124 struct hashmap_entry ent;
125 char *key;
126 struct string_list value_list;
127};
128
129struct configset_list_item {
130 struct config_set_element *e;
131 int value_index;
132};
133
134/*
135 * the contents of the list are ordered according to their
136 * position in the config files and order of parsing the files.
137 * (i.e. key-value pair at the last position of .git/config will
138 * be at the last item of the list)
139 */
140struct configset_list {
141 struct configset_list_item *items;
142 unsigned int nr, alloc;
143};
144
145struct config_set {
146 struct hashmap config_hash;
147 int hash_initialized;
148 struct configset_list list;
149};
150
151extern void git_configset_init(struct config_set *cs);
152extern int git_configset_add_file(struct config_set *cs, const char *filename);
153extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
154extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
155extern void git_configset_clear(struct config_set *cs);
156extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
157extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
158extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
159extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
160extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
161extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
162extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
163extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
164
165extern int git_config_get_value(const char *key, const char **value);
166extern const struct string_list *git_config_get_value_multi(const char *key);
167extern void git_config_clear(void);
168extern void git_config_iter(config_fn_t fn, void *data);
169extern int git_config_get_string_const(const char *key, const char **dest);
170extern int git_config_get_string(const char *key, char **dest);
171extern int git_config_get_int(const char *key, int *dest);
172extern int git_config_get_ulong(const char *key, unsigned long *dest);
173extern int git_config_get_bool(const char *key, int *dest);
174extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
175extern int git_config_get_maybe_bool(const char *key, int *dest);
176extern int git_config_get_pathname(const char *key, const char **dest);
177extern int git_config_get_untracked_cache(void);
178extern int git_config_get_split_index(void);
179extern int git_config_get_max_percent_split_change(void);
180
181/* This dies if the configured or default date is in the future */
182extern int git_config_get_expiry(const char *key, const char **output);
183
184struct key_value_info {
185 const char *filename;
186 int linenr;
187 enum config_origin_type origin_type;
188 enum config_scope scope;
189};
190
191extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
192extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
193
194#endif /* CONFIG_H */