Documentation: tiny git config manual tweaks
[git/wpalmer.git] / builtin-config.c
bloba2d656edb383da47fb3622f1f7c2d1524285ac00
1 #include "builtin.h"
2 #include "cache.h"
3 #include "color.h"
4 #include "parse-options.h"
6 static const char *const builtin_config_usage[] = {
7 "git config [options]",
8 NULL
9 };
11 static char *key;
12 static regex_t *key_regexp;
13 static regex_t *regexp;
14 static int show_keys;
15 static int use_key_regexp;
16 static int do_all;
17 static int do_not_match;
18 static int seen;
19 static char delim = '=';
20 static char key_delim = ' ';
21 static char term = '\n';
23 static int use_global_config, use_system_config;
24 static const char *given_config_file;
25 static int actions, types;
26 static const char *get_color_slot, *get_colorbool_slot;
27 static int end_null;
29 #define ACTION_GET (1<<0)
30 #define ACTION_GET_ALL (1<<1)
31 #define ACTION_GET_REGEXP (1<<2)
32 #define ACTION_REPLACE_ALL (1<<3)
33 #define ACTION_ADD (1<<4)
34 #define ACTION_UNSET (1<<5)
35 #define ACTION_UNSET_ALL (1<<6)
36 #define ACTION_RENAME_SECTION (1<<7)
37 #define ACTION_REMOVE_SECTION (1<<8)
38 #define ACTION_LIST (1<<9)
39 #define ACTION_EDIT (1<<10)
40 #define ACTION_SET (1<<11)
41 #define ACTION_SET_ALL (1<<12)
42 #define ACTION_GET_COLOR (1<<13)
43 #define ACTION_GET_COLORBOOL (1<<14)
45 #define TYPE_BOOL (1<<0)
46 #define TYPE_INT (1<<1)
47 #define TYPE_BOOL_OR_INT (1<<2)
49 static struct option builtin_config_options[] = {
50 OPT_GROUP("Config file location"),
51 OPT_BOOLEAN(0, "global", &use_global_config, "use global config file"),
52 OPT_BOOLEAN(0, "system", &use_system_config, "use system config file"),
53 OPT_STRING('f', "file", &given_config_file, "FILE", "use given config file"),
54 OPT_GROUP("Action"),
55 OPT_BIT(0, "get", &actions, "get value: name [value-regex]", ACTION_GET),
56 OPT_BIT(0, "get-all", &actions, "get all values: key [value-regex]", ACTION_GET_ALL),
57 OPT_BIT(0, "get-regexp", &actions, "get values for regexp: name-regex [value-regex]", ACTION_GET_REGEXP),
58 OPT_BIT(0, "replace-all", &actions, "replace all matching variables: name value [value_regex]", ACTION_REPLACE_ALL),
59 OPT_BIT(0, "add", &actions, "adds a new variable: name value", ACTION_ADD),
60 OPT_BIT(0, "unset", &actions, "removes a variable: name [value-regex]", ACTION_UNSET),
61 OPT_BIT(0, "unset-all", &actions, "removes all matches: name [value-regex]", ACTION_UNSET_ALL),
62 OPT_BIT(0, "rename-section", &actions, "rename section: old-name new-name", ACTION_RENAME_SECTION),
63 OPT_BIT(0, "remove-section", &actions, "remove a section: name", ACTION_REMOVE_SECTION),
64 OPT_BIT('l', "list", &actions, "list all", ACTION_LIST),
65 OPT_BIT('e', "edit", &actions, "opens an editor", ACTION_EDIT),
66 OPT_STRING(0, "get-color", &get_color_slot, "slot", "find the color configured: [default]"),
67 OPT_STRING(0, "get-colorbool", &get_colorbool_slot, "slot", "find the color setting: [stdout-is-tty]"),
68 OPT_GROUP("Type"),
69 OPT_BIT(0, "bool", &types, "value is \"true\" or \"false\"", TYPE_BOOL),
70 OPT_BIT(0, "int", &types, "value is decimal number", TYPE_INT),
71 OPT_BIT(0, "bool-or-int", &types, "value is --bool or --int", TYPE_BOOL_OR_INT),
72 OPT_GROUP("Other"),
73 OPT_BOOLEAN('z', "null", &end_null, "terminate values with NUL byte"),
74 OPT_END(),
77 static void check_argc(int argc, int min, int max) {
78 if (argc >= min && argc <= max)
79 return;
80 error("wrong number of arguments");
81 usage_with_options(builtin_config_usage, builtin_config_options);
84 static int show_all_config(const char *key_, const char *value_, void *cb)
86 if (value_)
87 printf("%s%c%s%c", key_, delim, value_, term);
88 else
89 printf("%s%c", key_, term);
90 return 0;
93 static int show_config(const char *key_, const char *value_, void *cb)
95 char value[256];
96 const char *vptr = value;
97 int dup_error = 0;
99 if (!use_key_regexp && strcmp(key_, key))
100 return 0;
101 if (use_key_regexp && regexec(key_regexp, key_, 0, NULL, 0))
102 return 0;
103 if (regexp != NULL &&
104 (do_not_match ^ !!regexec(regexp, (value_?value_:""), 0, NULL, 0)))
105 return 0;
107 if (show_keys) {
108 if (value_)
109 printf("%s%c", key_, key_delim);
110 else
111 printf("%s", key_);
113 if (seen && !do_all)
114 dup_error = 1;
115 if (types == TYPE_INT)
116 sprintf(value, "%d", git_config_int(key_, value_?value_:""));
117 else if (types == TYPE_BOOL)
118 vptr = git_config_bool(key_, value_) ? "true" : "false";
119 else if (types == TYPE_BOOL_OR_INT) {
120 int is_bool, v;
121 v = git_config_bool_or_int(key_, value_, &is_bool);
122 if (is_bool)
123 vptr = v ? "true" : "false";
124 else
125 sprintf(value, "%d", v);
127 else
128 vptr = value_?value_:"";
129 seen++;
130 if (dup_error) {
131 error("More than one value for the key %s: %s",
132 key_, vptr);
134 else
135 printf("%s%c", vptr, term);
137 return 0;
140 static int get_value(const char *key_, const char *regex_)
142 int ret = -1;
143 char *tl;
144 char *global = NULL, *repo_config = NULL;
145 const char *system_wide = NULL, *local;
147 local = config_exclusive_filename;
148 if (!local) {
149 const char *home = getenv("HOME");
150 local = repo_config = git_pathdup("config");
151 if (git_config_global() && home)
152 global = xstrdup(mkpath("%s/.gitconfig", home));
153 if (git_config_system())
154 system_wide = git_etc_gitconfig();
157 key = xstrdup(key_);
158 for (tl=key+strlen(key)-1; tl >= key && *tl != '.'; --tl)
159 *tl = tolower(*tl);
160 for (tl=key; *tl && *tl != '.'; ++tl)
161 *tl = tolower(*tl);
163 if (use_key_regexp) {
164 key_regexp = (regex_t*)xmalloc(sizeof(regex_t));
165 if (regcomp(key_regexp, key, REG_EXTENDED)) {
166 fprintf(stderr, "Invalid key pattern: %s\n", key_);
167 goto free_strings;
171 if (regex_) {
172 if (regex_[0] == '!') {
173 do_not_match = 1;
174 regex_++;
177 regexp = (regex_t*)xmalloc(sizeof(regex_t));
178 if (regcomp(regexp, regex_, REG_EXTENDED)) {
179 fprintf(stderr, "Invalid pattern: %s\n", regex_);
180 goto free_strings;
184 if (do_all && system_wide)
185 git_config_from_file(show_config, system_wide, NULL);
186 if (do_all && global)
187 git_config_from_file(show_config, global, NULL);
188 git_config_from_file(show_config, local, NULL);
189 if (!do_all && !seen && global)
190 git_config_from_file(show_config, global, NULL);
191 if (!do_all && !seen && system_wide)
192 git_config_from_file(show_config, system_wide, NULL);
194 free(key);
195 if (regexp) {
196 regfree(regexp);
197 free(regexp);
200 if (do_all)
201 ret = !seen;
202 else
203 ret = (seen == 1) ? 0 : seen > 1 ? 2 : 1;
205 free_strings:
206 free(repo_config);
207 free(global);
208 return ret;
211 static char *normalize_value(const char *key, const char *value)
213 char *normalized;
215 if (!value)
216 return NULL;
218 if (types == 0)
219 normalized = xstrdup(value);
220 else {
221 normalized = xmalloc(64);
222 if (types == TYPE_INT) {
223 int v = git_config_int(key, value);
224 sprintf(normalized, "%d", v);
226 else if (types == TYPE_BOOL)
227 sprintf(normalized, "%s",
228 git_config_bool(key, value) ? "true" : "false");
229 else if (types == TYPE_BOOL_OR_INT) {
230 int is_bool, v;
231 v = git_config_bool_or_int(key, value, &is_bool);
232 if (!is_bool)
233 sprintf(normalized, "%d", v);
234 else
235 sprintf(normalized, "%s", v ? "true" : "false");
239 return normalized;
242 static int get_color_found;
243 static const char *get_color_slot;
244 static const char *get_colorbool_slot;
245 static char parsed_color[COLOR_MAXLEN];
247 static int git_get_color_config(const char *var, const char *value, void *cb)
249 if (!strcmp(var, get_color_slot)) {
250 if (!value)
251 config_error_nonbool(var);
252 color_parse(value, var, parsed_color);
253 get_color_found = 1;
255 return 0;
258 static void get_color(const char *def_color)
260 get_color_found = 0;
261 parsed_color[0] = '\0';
262 git_config(git_get_color_config, NULL);
264 if (!get_color_found && def_color)
265 color_parse(def_color, "command line", parsed_color);
267 fputs(parsed_color, stdout);
270 static int stdout_is_tty;
271 static int get_colorbool_found;
272 static int get_diff_color_found;
273 static int git_get_colorbool_config(const char *var, const char *value,
274 void *cb)
276 if (!strcmp(var, get_colorbool_slot)) {
277 get_colorbool_found =
278 git_config_colorbool(var, value, stdout_is_tty);
280 if (!strcmp(var, "diff.color")) {
281 get_diff_color_found =
282 git_config_colorbool(var, value, stdout_is_tty);
284 if (!strcmp(var, "color.ui")) {
285 git_use_color_default = git_config_colorbool(var, value, stdout_is_tty);
286 return 0;
288 return 0;
291 static int get_colorbool(int print)
293 get_colorbool_found = -1;
294 get_diff_color_found = -1;
295 git_config(git_get_colorbool_config, NULL);
297 if (get_colorbool_found < 0) {
298 if (!strcmp(get_colorbool_slot, "color.diff"))
299 get_colorbool_found = get_diff_color_found;
300 if (get_colorbool_found < 0)
301 get_colorbool_found = git_use_color_default;
304 if (print) {
305 printf("%s\n", get_colorbool_found ? "true" : "false");
306 return 0;
307 } else
308 return get_colorbool_found ? 0 : 1;
311 int cmd_config(int argc, const char **argv, const char *unused_prefix)
313 int nongit;
314 char *value;
315 const char *prefix = setup_git_directory_gently(&nongit);
317 config_exclusive_filename = getenv(CONFIG_ENVIRONMENT);
319 argc = parse_options(argc, argv, prefix, builtin_config_options,
320 builtin_config_usage,
321 PARSE_OPT_STOP_AT_NON_OPTION);
323 if (use_global_config + use_system_config + !!given_config_file > 1) {
324 error("only one config file at a time.");
325 usage_with_options(builtin_config_usage, builtin_config_options);
328 if (use_global_config) {
329 char *home = getenv("HOME");
330 if (home) {
331 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
332 config_exclusive_filename = user_config;
333 } else {
334 die("$HOME not set");
337 else if (use_system_config)
338 config_exclusive_filename = git_etc_gitconfig();
339 else if (given_config_file) {
340 if (!is_absolute_path(given_config_file) && prefix)
341 config_exclusive_filename = prefix_filename(prefix,
342 strlen(prefix),
343 argv[2]);
344 else
345 config_exclusive_filename = given_config_file;
348 if (end_null) {
349 term = '\0';
350 delim = '\n';
351 key_delim = '\n';
354 if (HAS_MULTI_BITS(types)) {
355 error("only one type at a time.");
356 usage_with_options(builtin_config_usage, builtin_config_options);
359 if (get_color_slot)
360 actions |= ACTION_GET_COLOR;
361 if (get_colorbool_slot)
362 actions |= ACTION_GET_COLORBOOL;
364 if ((get_color_slot || get_colorbool_slot) && types) {
365 error("--get-color and variable type are incoherent");
366 usage_with_options(builtin_config_usage, builtin_config_options);
369 if (HAS_MULTI_BITS(actions)) {
370 error("only one action at a time.");
371 usage_with_options(builtin_config_usage, builtin_config_options);
373 if (actions == 0)
374 switch (argc) {
375 case 1: actions = ACTION_GET; break;
376 case 2: actions = ACTION_SET; break;
377 case 3: actions = ACTION_SET_ALL; break;
378 default:
379 usage_with_options(builtin_config_usage, builtin_config_options);
382 if (actions == ACTION_LIST) {
383 check_argc(argc, 0, 0);
384 if (git_config(show_all_config, NULL) < 0) {
385 if (config_exclusive_filename)
386 die_errno("unable to read config file '%s'",
387 config_exclusive_filename);
388 else
389 die("error processing config file(s)");
392 else if (actions == ACTION_EDIT) {
393 check_argc(argc, 0, 0);
394 if (!config_exclusive_filename && nongit)
395 die("not in a git directory");
396 git_config(git_default_config, NULL);
397 launch_editor(config_exclusive_filename ?
398 config_exclusive_filename : git_path("config"),
399 NULL, NULL);
401 else if (actions == ACTION_SET) {
402 check_argc(argc, 2, 2);
403 value = normalize_value(argv[0], argv[1]);
404 return git_config_set(argv[0], value);
406 else if (actions == ACTION_SET_ALL) {
407 check_argc(argc, 2, 3);
408 value = normalize_value(argv[0], argv[1]);
409 return git_config_set_multivar(argv[0], value, argv[2], 0);
411 else if (actions == ACTION_ADD) {
412 check_argc(argc, 2, 2);
413 value = normalize_value(argv[0], argv[1]);
414 return git_config_set_multivar(argv[0], value, "^$", 0);
416 else if (actions == ACTION_REPLACE_ALL) {
417 check_argc(argc, 2, 3);
418 value = normalize_value(argv[0], argv[1]);
419 return git_config_set_multivar(argv[0], value, argv[2], 1);
421 else if (actions == ACTION_GET) {
422 check_argc(argc, 1, 2);
423 return get_value(argv[0], argv[1]);
425 else if (actions == ACTION_GET_ALL) {
426 do_all = 1;
427 check_argc(argc, 1, 2);
428 return get_value(argv[0], argv[1]);
430 else if (actions == ACTION_GET_REGEXP) {
431 show_keys = 1;
432 use_key_regexp = 1;
433 do_all = 1;
434 check_argc(argc, 1, 2);
435 return get_value(argv[0], argv[1]);
437 else if (actions == ACTION_UNSET) {
438 check_argc(argc, 1, 2);
439 if (argc == 2)
440 return git_config_set_multivar(argv[0], NULL, argv[1], 0);
441 else
442 return git_config_set(argv[0], NULL);
444 else if (actions == ACTION_UNSET_ALL) {
445 check_argc(argc, 1, 2);
446 return git_config_set_multivar(argv[0], NULL, argv[1], 1);
448 else if (actions == ACTION_RENAME_SECTION) {
449 int ret;
450 check_argc(argc, 2, 2);
451 ret = git_config_rename_section(argv[0], argv[1]);
452 if (ret < 0)
453 return ret;
454 if (ret == 0)
455 die("No such section!");
457 else if (actions == ACTION_REMOVE_SECTION) {
458 int ret;
459 check_argc(argc, 1, 1);
460 ret = git_config_rename_section(argv[0], NULL);
461 if (ret < 0)
462 return ret;
463 if (ret == 0)
464 die("No such section!");
466 else if (actions == ACTION_GET_COLOR) {
467 get_color(argv[0]);
469 else if (actions == ACTION_GET_COLORBOOL) {
470 if (argc == 1)
471 stdout_is_tty = git_config_bool("command line", argv[0]);
472 else if (argc == 0)
473 stdout_is_tty = isatty(1);
474 return get_colorbool(argc != 0);
477 return 0;