Merge branch 'cn/doc-config-bare-subsection'
[git/mingw.git] / builtin / config.c
blob0315ad76f881aab9a64084f8d2fdd2019907e4cb
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, use_local_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)
48 #define TYPE_PATH (1<<3)
50 static struct option builtin_config_options[] = {
51 OPT_GROUP("Config file location"),
52 OPT_BOOLEAN(0, "global", &use_global_config, "use global config file"),
53 OPT_BOOLEAN(0, "system", &use_system_config, "use system config file"),
54 OPT_BOOLEAN(0, "local", &use_local_config, "use repository config file"),
55 OPT_STRING('f', "file", &given_config_file, "file", "use given config file"),
56 OPT_GROUP("Action"),
57 OPT_BIT(0, "get", &actions, "get value: name [value-regex]", ACTION_GET),
58 OPT_BIT(0, "get-all", &actions, "get all values: key [value-regex]", ACTION_GET_ALL),
59 OPT_BIT(0, "get-regexp", &actions, "get values for regexp: name-regex [value-regex]", ACTION_GET_REGEXP),
60 OPT_BIT(0, "replace-all", &actions, "replace all matching variables: name value [value_regex]", ACTION_REPLACE_ALL),
61 OPT_BIT(0, "add", &actions, "adds a new variable: name value", ACTION_ADD),
62 OPT_BIT(0, "unset", &actions, "removes a variable: name [value-regex]", ACTION_UNSET),
63 OPT_BIT(0, "unset-all", &actions, "removes all matches: name [value-regex]", ACTION_UNSET_ALL),
64 OPT_BIT(0, "rename-section", &actions, "rename section: old-name new-name", ACTION_RENAME_SECTION),
65 OPT_BIT(0, "remove-section", &actions, "remove a section: name", ACTION_REMOVE_SECTION),
66 OPT_BIT('l', "list", &actions, "list all", ACTION_LIST),
67 OPT_BIT('e', "edit", &actions, "opens an editor", ACTION_EDIT),
68 OPT_STRING(0, "get-color", &get_color_slot, "slot", "find the color configured: [default]"),
69 OPT_STRING(0, "get-colorbool", &get_colorbool_slot, "slot", "find the color setting: [stdout-is-tty]"),
70 OPT_GROUP("Type"),
71 OPT_BIT(0, "bool", &types, "value is \"true\" or \"false\"", TYPE_BOOL),
72 OPT_BIT(0, "int", &types, "value is decimal number", TYPE_INT),
73 OPT_BIT(0, "bool-or-int", &types, "value is --bool or --int", TYPE_BOOL_OR_INT),
74 OPT_BIT(0, "path", &types, "value is a path (file or directory name)", TYPE_PATH),
75 OPT_GROUP("Other"),
76 OPT_BOOLEAN('z', "null", &end_null, "terminate values with NUL byte"),
77 OPT_END(),
80 static void check_argc(int argc, int min, int max) {
81 if (argc >= min && argc <= max)
82 return;
83 error("wrong number of arguments");
84 usage_with_options(builtin_config_usage, builtin_config_options);
87 static int show_all_config(const char *key_, const char *value_, void *cb)
89 if (value_)
90 printf("%s%c%s%c", key_, delim, value_, term);
91 else
92 printf("%s%c", key_, term);
93 return 0;
96 static int show_config(const char *key_, const char *value_, void *cb)
98 char value[256];
99 const char *vptr = value;
100 int must_free_vptr = 0;
101 int dup_error = 0;
102 int must_print_delim = 0;
104 if (!use_key_regexp && strcmp(key_, key))
105 return 0;
106 if (use_key_regexp && regexec(key_regexp, key_, 0, NULL, 0))
107 return 0;
108 if (regexp != NULL &&
109 (do_not_match ^ !!regexec(regexp, (value_?value_:""), 0, NULL, 0)))
110 return 0;
112 if (show_keys) {
113 printf("%s", key_);
114 must_print_delim = 1;
116 if (seen && !do_all)
117 dup_error = 1;
118 if (types == TYPE_INT)
119 sprintf(value, "%d", git_config_int(key_, value_?value_:""));
120 else if (types == TYPE_BOOL)
121 vptr = git_config_bool(key_, value_) ? "true" : "false";
122 else if (types == TYPE_BOOL_OR_INT) {
123 int is_bool, v;
124 v = git_config_bool_or_int(key_, value_, &is_bool);
125 if (is_bool)
126 vptr = v ? "true" : "false";
127 else
128 sprintf(value, "%d", v);
129 } else if (types == TYPE_PATH) {
130 git_config_pathname(&vptr, key_, value_);
131 must_free_vptr = 1;
132 } else if (value_) {
133 vptr = value_;
134 } else {
135 /* Just show the key name */
136 vptr = "";
137 must_print_delim = 0;
139 seen++;
140 if (dup_error) {
141 error("More than one value for the key %s: %s",
142 key_, vptr);
144 else {
145 if (must_print_delim)
146 printf("%c", key_delim);
147 printf("%s%c", vptr, term);
149 if (must_free_vptr)
150 /* If vptr must be freed, it's a pointer to a
151 * dynamically allocated buffer, it's safe to cast to
152 * const.
154 free((char *)vptr);
156 return 0;
159 static int get_value(const char *key_, const char *regex_)
161 int ret = -1;
162 char *global = NULL, *repo_config = NULL;
163 const char *system_wide = NULL, *local;
165 local = config_exclusive_filename;
166 if (!local) {
167 const char *home = getenv("HOME");
168 local = repo_config = git_pathdup("config");
169 if (home)
170 global = xstrdup(mkpath("%s/.gitconfig", home));
171 if (git_config_system())
172 system_wide = git_etc_gitconfig();
175 if (use_key_regexp) {
176 char *tl;
179 * NEEDSWORK: this naive pattern lowercasing obviously does not
180 * work for more complex patterns like "^[^.]*Foo.*bar".
181 * Perhaps we should deprecate this altogether someday.
184 key = xstrdup(key_);
185 for (tl = key + strlen(key) - 1;
186 tl >= key && *tl != '.';
187 tl--)
188 *tl = tolower(*tl);
189 for (tl = key; *tl && *tl != '.'; tl++)
190 *tl = tolower(*tl);
192 key_regexp = (regex_t*)xmalloc(sizeof(regex_t));
193 if (regcomp(key_regexp, key, REG_EXTENDED)) {
194 fprintf(stderr, "Invalid key pattern: %s\n", key_);
195 free(key);
196 goto free_strings;
198 } else {
199 if (git_config_parse_key(key_, &key, NULL))
200 goto free_strings;
203 if (regex_) {
204 if (regex_[0] == '!') {
205 do_not_match = 1;
206 regex_++;
209 regexp = (regex_t*)xmalloc(sizeof(regex_t));
210 if (regcomp(regexp, regex_, REG_EXTENDED)) {
211 fprintf(stderr, "Invalid pattern: %s\n", regex_);
212 goto free_strings;
216 if (do_all && system_wide)
217 git_config_from_file(show_config, system_wide, NULL);
218 if (do_all && global)
219 git_config_from_file(show_config, global, NULL);
220 if (do_all)
221 git_config_from_file(show_config, local, NULL);
222 git_config_from_parameters(show_config, NULL);
223 if (!do_all && !seen)
224 git_config_from_file(show_config, local, NULL);
225 if (!do_all && !seen && global)
226 git_config_from_file(show_config, global, NULL);
227 if (!do_all && !seen && system_wide)
228 git_config_from_file(show_config, system_wide, NULL);
230 free(key);
231 if (regexp) {
232 regfree(regexp);
233 free(regexp);
236 if (do_all)
237 ret = !seen;
238 else
239 ret = (seen == 1) ? 0 : seen > 1 ? 2 : 1;
241 free_strings:
242 free(repo_config);
243 free(global);
244 return ret;
247 static char *normalize_value(const char *key, const char *value)
249 char *normalized;
251 if (!value)
252 return NULL;
254 if (types == 0 || types == TYPE_PATH)
256 * We don't do normalization for TYPE_PATH here: If
257 * the path is like ~/foobar/, we prefer to store
258 * "~/foobar/" in the config file, and to expand the ~
259 * when retrieving the value.
261 normalized = xstrdup(value);
262 else {
263 normalized = xmalloc(64);
264 if (types == TYPE_INT) {
265 int v = git_config_int(key, value);
266 sprintf(normalized, "%d", v);
268 else if (types == TYPE_BOOL)
269 sprintf(normalized, "%s",
270 git_config_bool(key, value) ? "true" : "false");
271 else if (types == TYPE_BOOL_OR_INT) {
272 int is_bool, v;
273 v = git_config_bool_or_int(key, value, &is_bool);
274 if (!is_bool)
275 sprintf(normalized, "%d", v);
276 else
277 sprintf(normalized, "%s", v ? "true" : "false");
281 return normalized;
284 static int get_color_found;
285 static const char *get_color_slot;
286 static const char *get_colorbool_slot;
287 static char parsed_color[COLOR_MAXLEN];
289 static int git_get_color_config(const char *var, const char *value, void *cb)
291 if (!strcmp(var, get_color_slot)) {
292 if (!value)
293 config_error_nonbool(var);
294 color_parse(value, var, parsed_color);
295 get_color_found = 1;
297 return 0;
300 static void get_color(const char *def_color)
302 get_color_found = 0;
303 parsed_color[0] = '\0';
304 git_config(git_get_color_config, NULL);
306 if (!get_color_found && def_color)
307 color_parse(def_color, "command line", parsed_color);
309 fputs(parsed_color, stdout);
312 static int get_colorbool_found;
313 static int get_diff_color_found;
314 static int get_color_ui_found;
315 static int git_get_colorbool_config(const char *var, const char *value,
316 void *cb)
318 if (!strcmp(var, get_colorbool_slot))
319 get_colorbool_found = git_config_colorbool(var, value);
320 else if (!strcmp(var, "diff.color"))
321 get_diff_color_found = git_config_colorbool(var, value);
322 else if (!strcmp(var, "color.ui"))
323 get_color_ui_found = git_config_colorbool(var, value);
324 return 0;
327 static int get_colorbool(int print)
329 get_colorbool_found = -1;
330 get_diff_color_found = -1;
331 git_config(git_get_colorbool_config, NULL);
333 if (get_colorbool_found < 0) {
334 if (!strcmp(get_colorbool_slot, "color.diff"))
335 get_colorbool_found = get_diff_color_found;
336 if (get_colorbool_found < 0)
337 get_colorbool_found = get_color_ui_found;
340 get_colorbool_found = want_color(get_colorbool_found);
342 if (print) {
343 printf("%s\n", get_colorbool_found ? "true" : "false");
344 return 0;
345 } else
346 return get_colorbool_found ? 0 : 1;
349 int cmd_config(int argc, const char **argv, const char *prefix)
351 int nongit = !startup_info->have_repository;
352 char *value;
354 config_exclusive_filename = getenv(CONFIG_ENVIRONMENT);
356 argc = parse_options(argc, argv, prefix, builtin_config_options,
357 builtin_config_usage,
358 PARSE_OPT_STOP_AT_NON_OPTION);
360 if (use_global_config + use_system_config + use_local_config + !!given_config_file > 1) {
361 error("only one config file at a time.");
362 usage_with_options(builtin_config_usage, builtin_config_options);
365 if (use_global_config) {
366 char *home = getenv("HOME");
367 if (home) {
368 char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
369 config_exclusive_filename = user_config;
370 } else {
371 die("$HOME not set");
374 else if (use_system_config)
375 config_exclusive_filename = git_etc_gitconfig();
376 else if (use_local_config)
377 config_exclusive_filename = git_pathdup("config");
378 else if (given_config_file) {
379 if (!is_absolute_path(given_config_file) && prefix)
380 config_exclusive_filename = prefix_filename(prefix,
381 strlen(prefix),
382 given_config_file);
383 else
384 config_exclusive_filename = given_config_file;
387 if (end_null) {
388 term = '\0';
389 delim = '\n';
390 key_delim = '\n';
393 if (HAS_MULTI_BITS(types)) {
394 error("only one type at a time.");
395 usage_with_options(builtin_config_usage, builtin_config_options);
398 if (get_color_slot)
399 actions |= ACTION_GET_COLOR;
400 if (get_colorbool_slot)
401 actions |= ACTION_GET_COLORBOOL;
403 if ((get_color_slot || get_colorbool_slot) && types) {
404 error("--get-color and variable type are incoherent");
405 usage_with_options(builtin_config_usage, builtin_config_options);
408 if (HAS_MULTI_BITS(actions)) {
409 error("only one action at a time.");
410 usage_with_options(builtin_config_usage, builtin_config_options);
412 if (actions == 0)
413 switch (argc) {
414 case 1: actions = ACTION_GET; break;
415 case 2: actions = ACTION_SET; break;
416 case 3: actions = ACTION_SET_ALL; break;
417 default:
418 usage_with_options(builtin_config_usage, builtin_config_options);
421 if (actions == ACTION_LIST) {
422 check_argc(argc, 0, 0);
423 if (git_config(show_all_config, NULL) < 0) {
424 if (config_exclusive_filename)
425 die_errno("unable to read config file '%s'",
426 config_exclusive_filename);
427 else
428 die("error processing config file(s)");
431 else if (actions == ACTION_EDIT) {
432 check_argc(argc, 0, 0);
433 if (!config_exclusive_filename && nongit)
434 die("not in a git directory");
435 git_config(git_default_config, NULL);
436 launch_editor(config_exclusive_filename ?
437 config_exclusive_filename : git_path("config"),
438 NULL, NULL);
440 else if (actions == ACTION_SET) {
441 int ret;
442 check_argc(argc, 2, 2);
443 value = normalize_value(argv[0], argv[1]);
444 ret = git_config_set(argv[0], value);
445 if (ret == CONFIG_NOTHING_SET)
446 error("cannot overwrite multiple values with a single value\n"
447 " Use a regexp, --add or --set-all to change %s.", argv[0]);
448 return ret;
450 else if (actions == ACTION_SET_ALL) {
451 check_argc(argc, 2, 3);
452 value = normalize_value(argv[0], argv[1]);
453 return git_config_set_multivar(argv[0], value, argv[2], 0);
455 else if (actions == ACTION_ADD) {
456 check_argc(argc, 2, 2);
457 value = normalize_value(argv[0], argv[1]);
458 return git_config_set_multivar(argv[0], value, "^$", 0);
460 else if (actions == ACTION_REPLACE_ALL) {
461 check_argc(argc, 2, 3);
462 value = normalize_value(argv[0], argv[1]);
463 return git_config_set_multivar(argv[0], value, argv[2], 1);
465 else if (actions == ACTION_GET) {
466 check_argc(argc, 1, 2);
467 return get_value(argv[0], argv[1]);
469 else if (actions == ACTION_GET_ALL) {
470 do_all = 1;
471 check_argc(argc, 1, 2);
472 return get_value(argv[0], argv[1]);
474 else if (actions == ACTION_GET_REGEXP) {
475 show_keys = 1;
476 use_key_regexp = 1;
477 do_all = 1;
478 check_argc(argc, 1, 2);
479 return get_value(argv[0], argv[1]);
481 else if (actions == ACTION_UNSET) {
482 check_argc(argc, 1, 2);
483 if (argc == 2)
484 return git_config_set_multivar(argv[0], NULL, argv[1], 0);
485 else
486 return git_config_set(argv[0], NULL);
488 else if (actions == ACTION_UNSET_ALL) {
489 check_argc(argc, 1, 2);
490 return git_config_set_multivar(argv[0], NULL, argv[1], 1);
492 else if (actions == ACTION_RENAME_SECTION) {
493 int ret;
494 check_argc(argc, 2, 2);
495 ret = git_config_rename_section(argv[0], argv[1]);
496 if (ret < 0)
497 return ret;
498 if (ret == 0)
499 die("No such section!");
501 else if (actions == ACTION_REMOVE_SECTION) {
502 int ret;
503 check_argc(argc, 1, 1);
504 ret = git_config_rename_section(argv[0], NULL);
505 if (ret < 0)
506 return ret;
507 if (ret == 0)
508 die("No such section!");
510 else if (actions == ACTION_GET_COLOR) {
511 get_color(argv[0]);
513 else if (actions == ACTION_GET_COLORBOOL) {
514 if (argc == 1)
515 color_stdout_is_tty = git_config_bool("command line", argv[0]);
516 return get_colorbool(argc != 0);
519 return 0;
522 int cmd_repo_config(int argc, const char **argv, const char *prefix)
524 fprintf(stderr, "WARNING: git repo-config is deprecated in favor of git config.\n");
525 return cmd_config(argc, argv, prefix);