5 #include "string-list.h"
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
20 #define CONFIG_REGEX_NONE ((void *)1)
22 struct git_config_source
{
23 unsigned int use_stdin
:1;
28 enum config_origin_type
{
32 CONFIG_ORIGIN_SUBMODULE_BLOB
,
39 CONFIG_EVENT_WHITESPACE
,
46 * The parser event function (if not NULL) is called with the event type and
47 * the begin/end offsets of the parsed elements.
49 * Note: for CONFIG_EVENT_ENTRY (i.e. config variables), the trailing newline
50 * character is considered part of the element.
52 typedef int (*config_parser_event_fn_t
)(enum config_event_t type
,
53 size_t begin_offset
, size_t end_offset
,
56 struct config_options
{
57 unsigned int respect_includes
: 1;
58 const char *commondir
;
60 config_parser_event_fn_t event_fn
;
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 */
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 *,
75 const struct config_options
*);
76 extern int git_config_from_mem(config_fn_t fn
,
77 const enum config_origin_type
,
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_ulong(const char *, unsigned long *);
91 extern int git_parse_maybe_bool(const char *);
92 extern int git_config_int(const char *, const char *);
93 extern int64_t git_config_int64(const char *, const char *);
94 extern unsigned long git_config_ulong(const char *, const char *);
95 extern ssize_t
git_config_ssize_t(const char *, const char *);
96 extern int git_config_bool_or_int(const char *, const char *, int *);
97 extern int git_config_bool(const char *, const char *);
98 extern int git_config_string(const char **, const char *, const char *);
99 extern int git_config_pathname(const char **, const char *, const char *);
100 extern int git_config_expiry_date(timestamp_t
*, const char *, const char *);
101 extern int git_config_color(char *, const char *, const char *);
102 extern int git_config_set_in_file_gently(const char *, const char *, const char *);
103 extern void git_config_set_in_file(const char *, const char *, const char *);
104 extern int git_config_set_gently(const char *, const char *);
105 extern void git_config_set(const char *, const char *);
106 extern int git_config_parse_key(const char *, char **, int *);
107 extern int git_config_key_is_valid(const char *key
);
108 extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
109 extern void git_config_set_multivar(const char *, const char *, const char *, int);
110 extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
111 extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
112 extern int git_config_rename_section(const char *, const char *);
113 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
114 extern int git_config_copy_section(const char *, const char *);
115 extern int git_config_copy_section_in_file(const char *, const char *, const char *);
116 extern const char *git_etc_gitconfig(void);
117 extern int git_env_bool(const char *, int);
118 extern unsigned long git_env_ulong(const char *, unsigned long);
119 extern int git_config_system(void);
120 extern int config_error_nonbool(const char *);
121 #if defined(__GNUC__)
122 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
125 extern int git_config_parse_parameter(const char *, config_fn_t fn
, void *data
);
128 CONFIG_SCOPE_UNKNOWN
= 0,
132 CONFIG_SCOPE_CMDLINE
,
135 extern enum config_scope
current_config_scope(void);
136 extern const char *current_config_origin_type(void);
137 extern const char *current_config_name(void);
139 struct config_include_data
{
143 const struct config_options
*opts
;
145 #define CONFIG_INCLUDE_INIT { 0 }
146 extern int git_config_include(const char *name
, const char *value
, void *data
);
149 * Match and parse a config key of the form:
151 * section.(subsection.)?key
153 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
154 * we return -1 if it does not match, 0 otherwise. The subsection and key
155 * out-parameters are filled by the function (and *subsection is NULL if it is
158 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if
159 * there is no subsection at all.
161 extern int parse_config_key(const char *var
,
163 const char **subsection
, int *subsection_len
,
166 struct config_set_element
{
167 struct hashmap_entry ent
;
169 struct string_list value_list
;
172 struct configset_list_item
{
173 struct config_set_element
*e
;
178 * the contents of the list are ordered according to their
179 * position in the config files and order of parsing the files.
180 * (i.e. key-value pair at the last position of .git/config will
181 * be at the last item of the list)
183 struct configset_list
{
184 struct configset_list_item
*items
;
185 unsigned int nr
, alloc
;
189 struct hashmap config_hash
;
190 int hash_initialized
;
191 struct configset_list list
;
194 extern void git_configset_init(struct config_set
*cs
);
195 extern int git_configset_add_file(struct config_set
*cs
, const char *filename
);
196 extern int git_configset_get_value(struct config_set
*cs
, const char *key
, const char **value
);
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 extern int git_configset_get_string_const(struct config_set
*cs
, const char *key
, const char **dest
);
200 extern int git_configset_get_string(struct config_set
*cs
, const char *key
, char **dest
);
201 extern int git_configset_get_int(struct config_set
*cs
, const char *key
, int *dest
);
202 extern int git_configset_get_ulong(struct config_set
*cs
, const char *key
, unsigned long *dest
);
203 extern int git_configset_get_bool(struct config_set
*cs
, const char *key
, int *dest
);
204 extern int git_configset_get_bool_or_int(struct config_set
*cs
, const char *key
, int *is_bool
, int *dest
);
205 extern int git_configset_get_maybe_bool(struct config_set
*cs
, const char *key
, int *dest
);
206 extern int git_configset_get_pathname(struct config_set
*cs
, const char *key
, const char **dest
);
208 /* Functions for reading a repository's config */
210 extern void repo_config(struct repository
*repo
, config_fn_t fn
, void *data
);
211 extern int repo_config_get_value(struct repository
*repo
,
212 const char *key
, const char **value
);
213 extern const struct string_list
*repo_config_get_value_multi(struct repository
*repo
,
215 extern int repo_config_get_string_const(struct repository
*repo
,
216 const char *key
, const char **dest
);
217 extern int repo_config_get_string(struct repository
*repo
,
218 const char *key
, char **dest
);
219 extern int repo_config_get_int(struct repository
*repo
,
220 const char *key
, int *dest
);
221 extern int repo_config_get_ulong(struct repository
*repo
,
222 const char *key
, unsigned long *dest
);
223 extern int repo_config_get_bool(struct repository
*repo
,
224 const char *key
, int *dest
);
225 extern int repo_config_get_bool_or_int(struct repository
*repo
,
226 const char *key
, int *is_bool
, int *dest
);
227 extern int repo_config_get_maybe_bool(struct repository
*repo
,
228 const char *key
, int *dest
);
229 extern int repo_config_get_pathname(struct repository
*repo
,
230 const char *key
, const char **dest
);
232 extern int git_config_get_value(const char *key
, const char **value
);
233 extern const struct string_list
*git_config_get_value_multi(const char *key
);
234 extern void git_config_clear(void);
235 extern int git_config_get_string_const(const char *key
, const char **dest
);
236 extern int git_config_get_string(const char *key
, char **dest
);
237 extern int git_config_get_int(const char *key
, int *dest
);
238 extern int git_config_get_ulong(const char *key
, unsigned long *dest
);
239 extern int git_config_get_bool(const char *key
, int *dest
);
240 extern int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
);
241 extern int git_config_get_maybe_bool(const char *key
, int *dest
);
242 extern int git_config_get_pathname(const char *key
, const char **dest
);
243 extern int git_config_get_untracked_cache(void);
244 extern int git_config_get_split_index(void);
245 extern int git_config_get_max_percent_split_change(void);
246 extern int git_config_get_fsmonitor(void);
248 /* This dies if the configured or default date is in the future */
249 extern int git_config_get_expiry(const char *key
, const char **output
);
251 /* parse either "this many days" integer, or "5.days.ago" approxidate */
252 extern int git_config_get_expiry_in_days(const char *key
, timestamp_t
*, timestamp_t now
);
254 struct key_value_info
{
255 const char *filename
;
257 enum config_origin_type origin_type
;
258 enum config_scope scope
;
261 extern NORETURN
void git_die_config(const char *key
, const char *err
, ...) __attribute__((format(printf
, 2, 3)));
262 extern NORETURN
void git_die_config_linenr(const char *key
, const char *filename
, int linenr
);
264 #define LOOKUP_CONFIG(mapping, var) \
265 lookup_config(mapping, ARRAY_SIZE(mapping), var)
266 int lookup_config(const char **mapping
, int nr_mapping
, const char *var
);
268 #endif /* CONFIG_H */