[thirdparty/git.git] / config.h

#ifndef CONFIG_H
#define CONFIG_H

/* git_config_parse_key() returns these negated: */
#define CONFIG_INVALID_KEY 1
#define CONFIG_NO_SECTION_OR_NAME 2
/* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
#define CONFIG_NO_LOCK -1
#define CONFIG_INVALID_FILE 3
#define CONFIG_NO_WRITE 4
#define CONFIG_NOTHING_SET 5
#define CONFIG_INVALID_PATTERN 6
#define CONFIG_GENERIC_ERROR 7

#define CONFIG_REGEX_NONE ((void *)1)

struct git_config_source {
	unsigned int use_stdin:1;
	const char *file;
	const char *blob;
};

enum config_origin_type {
	CONFIG_ORIGIN_BLOB,
	CONFIG_ORIGIN_FILE,
	CONFIG_ORIGIN_STDIN,
	CONFIG_ORIGIN_SUBMODULE_BLOB,
	CONFIG_ORIGIN_CMDLINE
};

enum config_event_t {
	CONFIG_EVENT_SECTION,
	CONFIG_EVENT_ENTRY,
	CONFIG_EVENT_WHITESPACE,
	CONFIG_EVENT_COMMENT,
	CONFIG_EVENT_EOF,
	CONFIG_EVENT_ERROR
};

/*
 * The parser event function (if not NULL) is called with the event type and
 * the begin/end offsets of the parsed elements.
 *
 * Note: for CONFIG_EVENT_ENTRY (i.e. config variables), the trailing newline
 * character is considered part of the element.
 */
typedef int (*config_parser_event_fn_t)(enum config_event_t type,
					size_t begin_offset, size_t end_offset,
					void *event_fn_data);

struct config_options {
	unsigned int respect_includes : 1;
	const char *commondir;
	const char *git_dir;
	config_parser_event_fn_t event_fn;
	void *event_fn_data;
	enum config_error_action {
		CONFIG_ERROR_UNSET = 0, /* use source-specific default */
		CONFIG_ERROR_DIE, /* die() on error */
		CONFIG_ERROR_ERROR, /* error() on error, return -1 */
		CONFIG_ERROR_SILENT, /* return -1 */
	} error_action;
};

typedef int (*config_fn_t)(const char *, const char *, void *);
extern int git_default_config(const char *, const char *, void *);
extern int git_config_from_file(config_fn_t fn, const char *, void *);
extern int git_config_from_file_with_options(config_fn_t fn, const char *,
					     void *,
					     const struct config_options *);
extern int git_config_from_mem(config_fn_t fn,
			       const enum config_origin_type,
			       const char *name,
			       const char *buf, size_t len,
			       void *data, const struct config_options *opts);
extern int git_config_from_blob_oid(config_fn_t fn, const char *name,
				    const struct object_id *oid, void *data);
extern void git_config_push_parameter(const char *text);
extern int git_config_from_parameters(config_fn_t fn, void *data);
extern void read_early_config(config_fn_t cb, void *data);
extern void git_config(config_fn_t fn, void *);
extern int config_with_options(config_fn_t fn, void *,
			       struct git_config_source *config_source,
			       const struct config_options *opts);
extern int git_parse_ssize_t(const char *, ssize_t *);
extern int git_parse_ulong(const char *, unsigned long *);
extern int git_parse_maybe_bool(const char *);
extern int git_config_int(const char *, const char *);
extern int64_t git_config_int64(const char *, const char *);
extern unsigned long git_config_ulong(const char *, const char *);
extern ssize_t git_config_ssize_t(const char *, const char *);
extern int git_config_bool_or_int(const char *, const char *, int *);
extern int git_config_bool(const char *, const char *);
extern int git_config_string(const char **, const char *, const char *);
extern int git_config_pathname(const char **, const char *, const char *);
extern int git_config_expiry_date(timestamp_t *, const char *, const char *);
extern int git_config_color(char *, const char *, const char *);
extern int git_config_set_in_file_gently(const char *, const char *, const char *);
extern void git_config_set_in_file(const char *, const char *, const char *);
extern int git_config_set_gently(const char *, const char *);
extern void git_config_set(const char *, const char *);
extern int git_config_parse_key(const char *, char **, int *);
extern int git_config_key_is_valid(const char *key);
extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
extern void git_config_set_multivar(const char *, const char *, const char *, int);
extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
extern int git_config_rename_section(const char *, const char *);
extern int git_config_rename_section_in_file(const char *, const char *, const char *);
extern int git_config_copy_section(const char *, const char *);
extern int git_config_copy_section_in_file(const char *, const char *, const char *);
extern const char *git_etc_gitconfig(void);
extern int git_env_bool(const char *, int);
extern unsigned long git_env_ulong(const char *, unsigned long);
extern int git_config_system(void);
extern int config_error_nonbool(const char *);
#if defined(__GNUC__)
#define config_error_nonbool(s) (config_error_nonbool(s), const_error())
#endif

extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);

enum config_scope {
	CONFIG_SCOPE_UNKNOWN = 0,
	CONFIG_SCOPE_SYSTEM,
	CONFIG_SCOPE_GLOBAL,
	CONFIG_SCOPE_REPO,
	CONFIG_SCOPE_CMDLINE,
};

extern enum config_scope current_config_scope(void);
extern const char *current_config_origin_type(void);
extern const char *current_config_name(void);

struct config_include_data {
	int depth;
	config_fn_t fn;
	void *data;
	const struct config_options *opts;
};
#define CONFIG_INCLUDE_INIT { 0 }
extern int git_config_include(const char *name, const char *value, void *data);

/*
 * Match and parse a config key of the form:
 *
 *   section.(subsection.)?key
 *
 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
 * we return -1 if it does not match, 0 otherwise. The subsection and key
 * out-parameters are filled by the function (and *subsection is NULL if it is
 * missing).
 *
 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if
 * there is no subsection at all.
 */
extern int parse_config_key(const char *var,
			    const char *section,
			    const char **subsection, int *subsection_len,
			    const char **key);

struct config_set_element {
	struct hashmap_entry ent;
	char *key;
	struct string_list value_list;
};

struct configset_list_item {
	struct config_set_element *e;
	int value_index;
};

/*
 * the contents of the list are ordered according to their
 * position in the config files and order of parsing the files.
 * (i.e. key-value pair at the last position of .git/config will
 * be at the last item of the list)
 */
struct configset_list {
	struct configset_list_item *items;
	unsigned int nr, alloc;
};

struct config_set {
	struct hashmap config_hash;
	int hash_initialized;
	struct configset_list list;
};

extern void git_configset_init(struct config_set *cs);
extern int git_configset_add_file(struct config_set *cs, const char *filename);
extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
extern void git_configset_clear(struct config_set *cs);

/*
 * These functions return 1 if not found, and 0 if found, leaving the found
 * value in the 'dest' pointer.
 */
extern int git_configset_get_value(struct config_set *cs, const char *key, const char **dest);
extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);

/* Functions for reading a repository's config */
struct repository;
extern void repo_config(struct repository *repo, config_fn_t fn, void *data);
extern int repo_config_get_value(struct repository *repo,
				 const char *key, const char **value);
extern const struct string_list *repo_config_get_value_multi(struct repository *repo,
							     const char *key);
extern int repo_config_get_string_const(struct repository *repo,
					const char *key, const char **dest);
extern int repo_config_get_string(struct repository *repo,
				  const char *key, char **dest);
extern int repo_config_get_int(struct repository *repo,
			       const char *key, int *dest);
extern int repo_config_get_ulong(struct repository *repo,
				 const char *key, unsigned long *dest);
extern int repo_config_get_bool(struct repository *repo,
				const char *key, int *dest);
extern int repo_config_get_bool_or_int(struct repository *repo,
				       const char *key, int *is_bool, int *dest);
extern int repo_config_get_maybe_bool(struct repository *repo,
				      const char *key, int *dest);
extern int repo_config_get_pathname(struct repository *repo,
				    const char *key, const char **dest);

extern int git_config_get_value(const char *key, const char **value);
extern const struct string_list *git_config_get_value_multi(const char *key);
extern void git_config_clear(void);
extern int git_config_get_string_const(const char *key, const char **dest);
extern int git_config_get_string(const char *key, char **dest);
extern int git_config_get_int(const char *key, int *dest);
extern int git_config_get_ulong(const char *key, unsigned long *dest);
extern int git_config_get_bool(const char *key, int *dest);
extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
extern int git_config_get_maybe_bool(const char *key, int *dest);
extern int git_config_get_pathname(const char *key, const char **dest);
extern int git_config_get_untracked_cache(void);
extern int git_config_get_split_index(void);
extern int git_config_get_max_percent_split_change(void);
extern int git_config_get_fsmonitor(void);

/* This dies if the configured or default date is in the future */
extern int git_config_get_expiry(const char *key, const char **output);

/* parse either "this many days" integer, or "5.days.ago" approxidate */
extern int git_config_get_expiry_in_days(const char *key, timestamp_t *, timestamp_t now);

struct key_value_info {
	const char *filename;
	int linenr;
	enum config_origin_type origin_type;
	enum config_scope scope;
};

extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);

#define LOOKUP_CONFIG(mapping, var) \
	lookup_config(mapping, ARRAY_SIZE(mapping), var)
int lookup_config(const char **mapping, int nr_mapping, const char *var);

#endif /* CONFIG_H */
Commit	Line	Data
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
	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
8032cc44 JS	31	enum 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	*/
	47	typedef 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	51	struct config_options {
e67a57fc BW	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;
8032cc44 JS	56	void *event_fn_data;
66f97228 JK	57	enum config_error_action {
	58	CONFIG_ERROR_UNSET = 0, /* use source-specific default */
	59	CONFIG_ERROR_DIE, /* die() on error */
	60	CONFIG_ERROR_ERROR, /* error() on error, return -1 */
63583203	61	CONFIG_ERROR_SILENT, /* return -1 */
66f97228	62	} error_action;
e67a57fc BW	63	};
	64
	65	typedef int (config_fn_t)(const char , const char , void );
	66	extern int git_default_config(const char , const char , void *);
	67	extern int git_config_from_file(config_fn_t fn, const char , void );
8032cc44 JS	68	extern int git_config_from_file_with_options(config_fn_t fn, const char *,
	69	void *,
	70	const struct config_options *);
4574f1aa JK	71	extern int git_config_from_mem(config_fn_t fn,
	72	const enum config_origin_type,
	73	const char *name,
	74	const char *buf, size_t len,
	75	void data, const struct config_options opts);
cd73de47	76	extern int git_config_from_blob_oid(config_fn_t fn, const char *name,
cd73de47	77	const struct object_id oid, void data);
e67a57fc BW	78	extern void git_config_push_parameter(const char *text);
	79	extern int git_config_from_parameters(config_fn_t fn, void *data);
	80	extern void read_early_config(config_fn_t cb, void *data);
	81	extern void git_config(config_fn_t fn, void *);
dc8441fd BW	82	extern int config_with_options(config_fn_t fn, void *,
	83	struct git_config_source *config_source,
	84	const struct config_options *opts);
c79edf73	85	extern int git_parse_ssize_t(const char , ssize_t );
e67a57fc BW	86	extern int git_parse_ulong(const char , unsigned long );
	87	extern int git_parse_maybe_bool(const char *);
	88	extern int git_config_int(const char , const char );
	89	extern int64_t git_config_int64(const char , const char );
	90	extern unsigned long git_config_ulong(const char , const char );
	91	extern ssize_t git_config_ssize_t(const char , const char );
	92	extern int git_config_bool_or_int(const char , const char , int *);
	93	extern int git_config_bool(const char , const char );
e67a57fc BW	94	extern int git_config_string(const char *, const char , const char *);
e67a57fc BW	95	extern int git_config_pathname(const char *, const char , const char *);
5f967424	96	extern int git_config_expiry_date(timestamp_t , const char , const char *);
6d2f9acc	97	extern int git_config_color(char , const char , const char *);
e67a57fc BW	98	extern int git_config_set_in_file_gently(const char , const char , const char *);
	99	extern void git_config_set_in_file(const char , const char , const char *);
	100	extern int git_config_set_gently(const char , const char );
	101	extern void git_config_set(const char , const char );
	102	extern int git_config_parse_key(const char , char , int );
	103	extern int git_config_key_is_valid(const char *key);
	104	extern int git_config_set_multivar_gently(const char , const char , const char *, int);
	105	extern void git_config_set_multivar(const char , const char , const char *, int);
	106	extern int git_config_set_multivar_in_file_gently(const char , const char , const char , const char , int);
	107	extern void git_config_set_multivar_in_file(const char , const char , const char , const char , int);
	108	extern int git_config_rename_section(const char , const char );
	109	extern int git_config_rename_section_in_file(const char , const char , const char *);
3b48045c JH	110	extern int git_config_copy_section(const char , const char );
3b48045c JH	111	extern int git_config_copy_section_in_file(const char , const char , const char *);
e67a57fc BW	112	extern const char *git_etc_gitconfig(void);
	113	extern int git_env_bool(const char *, int);
	114	extern unsigned long git_env_ulong(const char *, unsigned long);
	115	extern int git_config_system(void);
	116	extern int config_error_nonbool(const char *);
	117	#if defined(__GNUC__)
	118	#define config_error_nonbool(s) (config_error_nonbool(s), const_error())
	119	#endif
	120
	121	extern int git_config_parse_parameter(const char , config_fn_t fn, void data);
	122
	123	enum config_scope {
	124	CONFIG_SCOPE_UNKNOWN = 0,
	125	CONFIG_SCOPE_SYSTEM,
	126	CONFIG_SCOPE_GLOBAL,
	127	CONFIG_SCOPE_REPO,
	128	CONFIG_SCOPE_CMDLINE,
	129	};
	130
	131	extern enum config_scope current_config_scope(void);
	132	extern const char *current_config_origin_type(void);
	133	extern const char *current_config_name(void);
	134
	135	struct config_include_data {
	136	int depth;
	137	config_fn_t fn;
	138	void *data;
	139	const struct config_options *opts;
	140	};
	141	#define CONFIG_INCLUDE_INIT { 0 }
	142	extern int git_config_include(const char name, const char value, void *data);
	143
	144	/*
	145	* Match and parse a config key of the form:
	146	*
	147	* section.(subsection.)?key
	148	*
	149	* (i.e., what gets handed to a config_fn_t). The caller provides the section;
	150	* we return -1 if it does not match, 0 otherwise. The subsection and key
	151	* out-parameters are filled by the function (and *subsection is NULL if it is
	152	* missing).
	153	*
	154	* If the subsection pointer-to-pointer passed in is NULL, returns 0 only if
	155	* there is no subsection at all.
	156	*/
	157	extern int parse_config_key(const char *var,
	158	const char *section,
	159	const char *subsection, int subsection_len,
	160	const char **key);
	161
	162	struct config_set_element {
	163	struct hashmap_entry ent;
	164	char *key;
	165	struct string_list value_list;
	166	};
	167
	168	struct configset_list_item {
	169	struct config_set_element *e;
	170	int value_index;
	171	};
	172
	173	/*
	174	* the contents of the list are ordered according to their
	175	* position in the config files and order of parsing the files.
176	* (i.e. key-value pair at the last position of .git/config will
177	* be at the last item of the list)
178	*/
179	struct configset_list {
180	struct configset_list_item *items;
181	unsigned int nr, alloc;
182	};
183
184	struct config_set {
185	struct hashmap config_hash;
186	int hash_initialized;
187	struct configset_list list;
188	};
189
190	extern void git_configset_init(struct config_set *cs);
191	extern int git_configset_add_file(struct config_set cs, const char filename);
e67a57fc BW	192	extern const struct string_list git_configset_get_value_multi(struct config_set cs, const char *key);
e67a57fc BW	193	extern void git_configset_clear(struct config_set *cs);
8ad169c4 HWN	194
	195	/*
	196	* These functions return 1 if not found, and 0 if found, leaving the found
	197	* value in the 'dest' pointer.
	198	*/
	199	extern int git_configset_get_value(struct config_set cs, const char key, const char **dest);
e67a57fc BW	200	extern int git_configset_get_string_const(struct config_set cs, const char key, const char **dest);
	201	extern int git_configset_get_string(struct config_set cs, const char key, char **dest);
	202	extern int git_configset_get_int(struct config_set cs, const char key, int *dest);
	203	extern int git_configset_get_ulong(struct config_set cs, const char key, unsigned long *dest);
	204	extern int git_configset_get_bool(struct config_set cs, const char key, int *dest);
	205	extern int git_configset_get_bool_or_int(struct config_set cs, const char key, int is_bool, int dest);
	206	extern int git_configset_get_maybe_bool(struct config_set cs, const char key, int *dest);
	207	extern int git_configset_get_pathname(struct config_set cs, const char key, const char **dest);
	208
3b256228 BW	209	/* Functions for reading a repository's config */
	210	struct repository;
	211	extern void repo_config(struct repository repo, config_fn_t fn, void data);
	212	extern int repo_config_get_value(struct repository *repo,
	213	const char key, const char *value);
	214	extern const struct string_list repo_config_get_value_multi(struct repository repo,
	215	const char *key);
	216	extern int repo_config_get_string_const(struct repository *repo,
	217	const char key, const char *dest);
	218	extern int repo_config_get_string(struct repository *repo,
	219	const char key, char *dest);
	220	extern int repo_config_get_int(struct repository *repo,
	221	const char key, int dest);
	222	extern int repo_config_get_ulong(struct repository *repo,
	223	const char key, unsigned long dest);
	224	extern int repo_config_get_bool(struct repository *repo,
	225	const char key, int dest);
	226	extern int repo_config_get_bool_or_int(struct repository *repo,
	227	const char key, int is_bool, int *dest);
	228	extern int repo_config_get_maybe_bool(struct repository *repo,
	229	const char key, int dest);
	230	extern int repo_config_get_pathname(struct repository *repo,
	231	const char key, const char *dest);
	232
e67a57fc BW	233	extern int git_config_get_value(const char key, const char *value);
	234	extern const struct string_list git_config_get_value_multi(const char key);
	235	extern void git_config_clear(void);
e67a57fc BW	236	extern int git_config_get_string_const(const char key, const char *dest);
	237	extern int git_config_get_string(const char key, char *dest);
	238	extern int git_config_get_int(const char key, int dest);
	239	extern int git_config_get_ulong(const char key, unsigned long dest);
	240	extern int git_config_get_bool(const char key, int dest);
	241	extern int git_config_get_bool_or_int(const char key, int is_bool, int *dest);
	242	extern int git_config_get_maybe_bool(const char key, int dest);
	243	extern int git_config_get_pathname(const char key, const char *dest);
	244	extern int git_config_get_untracked_cache(void);
	245	extern int git_config_get_split_index(void);
	246	extern int git_config_get_max_percent_split_change(void);
883e248b	247	extern int git_config_get_fsmonitor(void);
e67a57fc BW	248
	249	/* This dies if the configured or default date is in the future */
	250	extern int git_config_get_expiry(const char key, const char *output);
	251
6e96cb52 JH	252	/* parse either "this many days" integer, or "5.days.ago" approxidate */
	253	extern int git_config_get_expiry_in_days(const char key, timestamp_t , timestamp_t now);
	254
e67a57fc BW	255	struct key_value_info {
	256	const char *filename;
	257	int linenr;
	258	enum config_origin_type origin_type;
	259	enum config_scope scope;
	260	};
	261
	262	extern NORETURN void git_die_config(const char key, const char err, ...) __attribute__((format(printf, 2, 3)));
	263	extern NORETURN void git_die_config_linenr(const char key, const char filename, int linenr);
	264
a73b3680 NTND	265	#define LOOKUP_CONFIG(mapping, var) \
	266	lookup_config(mapping, ARRAY_SIZE(mapping), var)
	267	int lookup_config(const char *mapping, int nr_mapping, const char var);
	268
e67a57fc	269	#endif /* CONFIG_H */