Documentation: New GUI configuration and command-line options.
[git.git] / wt-status.c
blob6a7645ed86fd5879e959460011a8add015d392d9
1 #include "cache.h"
2 #include "wt-status.h"
3 #include "color.h"
4 #include "object.h"
5 #include "dir.h"
6 #include "commit.h"
7 #include "diff.h"
8 #include "revision.h"
9 #include "diffcore.h"
10 #include "quote.h"
11 #include "run-command.h"
12 #include "remote.h"
14 int wt_status_relative_paths = 1;
15 int wt_status_use_color = -1;
16 int wt_status_submodule_summary;
17 static char wt_status_colors[][COLOR_MAXLEN] = {
18 "", /* WT_STATUS_HEADER: normal */
19 "\033[32m", /* WT_STATUS_UPDATED: green */
20 "\033[31m", /* WT_STATUS_CHANGED: red */
21 "\033[31m", /* WT_STATUS_UNTRACKED: red */
22 "\033[31m", /* WT_STATUS_NOBRANCH: red */
25 enum untracked_status_type show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
27 static int parse_status_slot(const char *var, int offset)
29 if (!strcasecmp(var+offset, "header"))
30 return WT_STATUS_HEADER;
31 if (!strcasecmp(var+offset, "updated")
32 || !strcasecmp(var+offset, "added"))
33 return WT_STATUS_UPDATED;
34 if (!strcasecmp(var+offset, "changed"))
35 return WT_STATUS_CHANGED;
36 if (!strcasecmp(var+offset, "untracked"))
37 return WT_STATUS_UNTRACKED;
38 if (!strcasecmp(var+offset, "nobranch"))
39 return WT_STATUS_NOBRANCH;
40 die("bad config variable '%s'", var);
43 static const char* color(int slot)
45 return wt_status_use_color > 0 ? wt_status_colors[slot] : "";
48 void wt_status_prepare(struct wt_status *s)
50 unsigned char sha1[20];
51 const char *head;
53 memset(s, 0, sizeof(*s));
54 head = resolve_ref("HEAD", sha1, 0, NULL);
55 s->branch = head ? xstrdup(head) : NULL;
56 s->reference = "HEAD";
57 s->fp = stdout;
58 s->index_file = get_index_file();
61 static void wt_status_print_cached_header(struct wt_status *s)
63 const char *c = color(WT_STATUS_HEADER);
64 color_fprintf_ln(s->fp, c, "# Changes to be committed:");
65 if (!s->is_initial) {
66 color_fprintf_ln(s->fp, c, "# (use \"git reset %s <file>...\" to unstage)", s->reference);
67 } else {
68 color_fprintf_ln(s->fp, c, "# (use \"git rm --cached <file>...\" to unstage)");
70 color_fprintf_ln(s->fp, c, "#");
73 static void wt_status_print_dirty_header(struct wt_status *s,
74 int has_deleted)
76 const char *c = color(WT_STATUS_HEADER);
77 color_fprintf_ln(s->fp, c, "# Changed but not updated:");
78 if (!has_deleted)
79 color_fprintf_ln(s->fp, c, "# (use \"git add <file>...\" to update what will be committed)");
80 else
81 color_fprintf_ln(s->fp, c, "# (use \"git add/rm <file>...\" to update what will be committed)");
82 color_fprintf_ln(s->fp, c, "# (use \"git checkout -- <file>...\" to discard changes in working directory)");
83 color_fprintf_ln(s->fp, c, "#");
86 static void wt_status_print_untracked_header(struct wt_status *s)
88 const char *c = color(WT_STATUS_HEADER);
89 color_fprintf_ln(s->fp, c, "# Untracked files:");
90 color_fprintf_ln(s->fp, c, "# (use \"git add <file>...\" to include in what will be committed)");
91 color_fprintf_ln(s->fp, c, "#");
94 static void wt_status_print_trailer(struct wt_status *s)
96 color_fprintf_ln(s->fp, color(WT_STATUS_HEADER), "#");
99 #define quote_path quote_path_relative
101 static void wt_status_print_filepair(struct wt_status *s,
102 int t, struct diff_filepair *p)
104 const char *c = color(t);
105 const char *one, *two;
106 struct strbuf onebuf = STRBUF_INIT, twobuf = STRBUF_INIT;
108 one = quote_path(p->one->path, -1, &onebuf, s->prefix);
109 two = quote_path(p->two->path, -1, &twobuf, s->prefix);
111 color_fprintf(s->fp, color(WT_STATUS_HEADER), "#\t");
112 switch (p->status) {
113 case DIFF_STATUS_ADDED:
114 color_fprintf(s->fp, c, "new file: %s", one);
115 break;
116 case DIFF_STATUS_COPIED:
117 color_fprintf(s->fp, c, "copied: %s -> %s", one, two);
118 break;
119 case DIFF_STATUS_DELETED:
120 color_fprintf(s->fp, c, "deleted: %s", one);
121 break;
122 case DIFF_STATUS_MODIFIED:
123 color_fprintf(s->fp, c, "modified: %s", one);
124 break;
125 case DIFF_STATUS_RENAMED:
126 color_fprintf(s->fp, c, "renamed: %s -> %s", one, two);
127 break;
128 case DIFF_STATUS_TYPE_CHANGED:
129 color_fprintf(s->fp, c, "typechange: %s", one);
130 break;
131 case DIFF_STATUS_UNKNOWN:
132 color_fprintf(s->fp, c, "unknown: %s", one);
133 break;
134 case DIFF_STATUS_UNMERGED:
135 color_fprintf(s->fp, c, "unmerged: %s", one);
136 break;
137 default:
138 die("bug: unhandled diff status %c", p->status);
140 fprintf(s->fp, "\n");
141 strbuf_release(&onebuf);
142 strbuf_release(&twobuf);
145 static void wt_status_print_updated_cb(struct diff_queue_struct *q,
146 struct diff_options *options,
147 void *data)
149 struct wt_status *s = data;
150 int shown_header = 0;
151 int i;
152 for (i = 0; i < q->nr; i++) {
153 if (q->queue[i]->status == 'U')
154 continue;
155 if (!shown_header) {
156 wt_status_print_cached_header(s);
157 s->commitable = 1;
158 shown_header = 1;
160 wt_status_print_filepair(s, WT_STATUS_UPDATED, q->queue[i]);
162 if (shown_header)
163 wt_status_print_trailer(s);
166 static void wt_status_print_changed_cb(struct diff_queue_struct *q,
167 struct diff_options *options,
168 void *data)
170 struct wt_status *s = data;
171 int i;
172 if (q->nr) {
173 int has_deleted = 0;
174 s->workdir_dirty = 1;
175 for (i = 0; i < q->nr; i++)
176 if (q->queue[i]->status == DIFF_STATUS_DELETED) {
177 has_deleted = 1;
178 break;
180 wt_status_print_dirty_header(s, has_deleted);
182 for (i = 0; i < q->nr; i++)
183 wt_status_print_filepair(s, WT_STATUS_CHANGED, q->queue[i]);
184 if (q->nr)
185 wt_status_print_trailer(s);
188 static void wt_status_print_initial(struct wt_status *s)
190 int i;
191 struct strbuf buf = STRBUF_INIT;
193 if (active_nr) {
194 s->commitable = 1;
195 wt_status_print_cached_header(s);
197 for (i = 0; i < active_nr; i++) {
198 color_fprintf(s->fp, color(WT_STATUS_HEADER), "#\t");
199 color_fprintf_ln(s->fp, color(WT_STATUS_UPDATED), "new file: %s",
200 quote_path(active_cache[i]->name, -1,
201 &buf, s->prefix));
203 if (active_nr)
204 wt_status_print_trailer(s);
205 strbuf_release(&buf);
208 static void wt_status_print_updated(struct wt_status *s)
210 struct rev_info rev;
211 init_revisions(&rev, NULL);
212 setup_revisions(0, NULL, &rev, s->reference);
213 rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
214 rev.diffopt.format_callback = wt_status_print_updated_cb;
215 rev.diffopt.format_callback_data = s;
216 rev.diffopt.detect_rename = 1;
217 rev.diffopt.rename_limit = 200;
218 rev.diffopt.break_opt = 0;
219 run_diff_index(&rev, 1);
222 static void wt_status_print_changed(struct wt_status *s)
224 struct rev_info rev;
225 init_revisions(&rev, "");
226 setup_revisions(0, NULL, &rev, NULL);
227 rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
228 rev.diffopt.format_callback = wt_status_print_changed_cb;
229 rev.diffopt.format_callback_data = s;
230 run_diff_files(&rev, 0);
233 static void wt_status_print_submodule_summary(struct wt_status *s)
235 struct child_process sm_summary;
236 char summary_limit[64];
237 char index[PATH_MAX];
238 const char *env[] = { index, NULL };
239 const char *argv[] = {
240 "submodule",
241 "summary",
242 "--cached",
243 "--for-status",
244 "--summary-limit",
245 summary_limit,
246 s->amend ? "HEAD^" : "HEAD",
247 NULL
250 sprintf(summary_limit, "%d", wt_status_submodule_summary);
251 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", s->index_file);
253 memset(&sm_summary, 0, sizeof(sm_summary));
254 sm_summary.argv = argv;
255 sm_summary.env = env;
256 sm_summary.git_cmd = 1;
257 sm_summary.no_stdin = 1;
258 fflush(s->fp);
259 sm_summary.out = dup(fileno(s->fp)); /* run_command closes it */
260 run_command(&sm_summary);
263 static void wt_status_print_untracked(struct wt_status *s)
265 struct dir_struct dir;
266 int i;
267 int shown_header = 0;
268 struct strbuf buf = STRBUF_INIT;
270 memset(&dir, 0, sizeof(dir));
272 if (!s->untracked) {
273 dir.show_other_directories = 1;
274 dir.hide_empty_directories = 1;
276 setup_standard_excludes(&dir);
278 read_directory(&dir, ".", "", 0, NULL);
279 for(i = 0; i < dir.nr; i++) {
280 struct dir_entry *ent = dir.entries[i];
281 if (!cache_name_is_other(ent->name, ent->len))
282 continue;
283 if (!shown_header) {
284 s->workdir_untracked = 1;
285 wt_status_print_untracked_header(s);
286 shown_header = 1;
288 color_fprintf(s->fp, color(WT_STATUS_HEADER), "#\t");
289 color_fprintf_ln(s->fp, color(WT_STATUS_UNTRACKED), "%s",
290 quote_path(ent->name, ent->len,
291 &buf, s->prefix));
293 strbuf_release(&buf);
296 static void wt_status_print_verbose(struct wt_status *s)
298 struct rev_info rev;
300 init_revisions(&rev, NULL);
301 setup_revisions(0, NULL, &rev, s->reference);
302 rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
303 rev.diffopt.detect_rename = 1;
304 DIFF_OPT_SET(&rev.diffopt, ALLOW_TEXTCONV);
305 rev.diffopt.file = s->fp;
306 rev.diffopt.close_file = 0;
308 * If we're not going to stdout, then we definitely don't
309 * want color, since we are going to the commit message
310 * file (and even the "auto" setting won't work, since it
311 * will have checked isatty on stdout).
313 if (s->fp != stdout)
314 DIFF_OPT_CLR(&rev.diffopt, COLOR_DIFF);
315 run_diff_index(&rev, 1);
318 static void wt_status_print_tracking(struct wt_status *s)
320 struct strbuf sb = STRBUF_INIT;
321 const char *cp, *ep;
322 struct branch *branch;
324 assert(s->branch && !s->is_initial);
325 if (prefixcmp(s->branch, "refs/heads/"))
326 return;
327 branch = branch_get(s->branch + 11);
328 if (!format_tracking_info(branch, &sb))
329 return;
331 for (cp = sb.buf; (ep = strchr(cp, '\n')) != NULL; cp = ep + 1)
332 color_fprintf_ln(s->fp, color(WT_STATUS_HEADER),
333 "# %.*s", (int)(ep - cp), cp);
334 color_fprintf_ln(s->fp, color(WT_STATUS_HEADER), "#");
337 void wt_status_print(struct wt_status *s)
339 unsigned char sha1[20];
340 const char *branch_color = color(WT_STATUS_HEADER);
342 s->is_initial = get_sha1(s->reference, sha1) ? 1 : 0;
343 if (s->branch) {
344 const char *on_what = "On branch ";
345 const char *branch_name = s->branch;
346 if (!prefixcmp(branch_name, "refs/heads/"))
347 branch_name += 11;
348 else if (!strcmp(branch_name, "HEAD")) {
349 branch_name = "";
350 branch_color = color(WT_STATUS_NOBRANCH);
351 on_what = "Not currently on any branch.";
353 color_fprintf(s->fp, color(WT_STATUS_HEADER), "# ");
354 color_fprintf_ln(s->fp, branch_color, "%s%s", on_what, branch_name);
355 if (!s->is_initial)
356 wt_status_print_tracking(s);
359 if (s->is_initial) {
360 color_fprintf_ln(s->fp, color(WT_STATUS_HEADER), "#");
361 color_fprintf_ln(s->fp, color(WT_STATUS_HEADER), "# Initial commit");
362 color_fprintf_ln(s->fp, color(WT_STATUS_HEADER), "#");
363 wt_status_print_initial(s);
365 else {
366 wt_status_print_updated(s);
369 wt_status_print_changed(s);
370 if (wt_status_submodule_summary)
371 wt_status_print_submodule_summary(s);
372 if (show_untracked_files)
373 wt_status_print_untracked(s);
374 else if (s->commitable)
375 fprintf(s->fp, "# Untracked files not listed (use -u option to show untracked files)\n");
377 if (s->verbose && !s->is_initial)
378 wt_status_print_verbose(s);
379 if (!s->commitable) {
380 if (s->amend)
381 fprintf(s->fp, "# No changes\n");
382 else if (s->nowarn)
383 ; /* nothing */
384 else if (s->workdir_dirty)
385 printf("no changes added to commit (use \"git add\" and/or \"git commit -a\")\n");
386 else if (s->workdir_untracked)
387 printf("nothing added to commit but untracked files present (use \"git add\" to track)\n");
388 else if (s->is_initial)
389 printf("nothing to commit (create/copy files and use \"git add\" to track)\n");
390 else if (!show_untracked_files)
391 printf("nothing to commit (use -u to show untracked files)\n");
392 else
393 printf("nothing to commit (working directory clean)\n");
397 int git_status_config(const char *k, const char *v, void *cb)
399 if (!strcmp(k, "status.submodulesummary")) {
400 int is_bool;
401 wt_status_submodule_summary = git_config_bool_or_int(k, v, &is_bool);
402 if (is_bool && wt_status_submodule_summary)
403 wt_status_submodule_summary = -1;
404 return 0;
406 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
407 wt_status_use_color = git_config_colorbool(k, v, -1);
408 return 0;
410 if (!prefixcmp(k, "status.color.") || !prefixcmp(k, "color.status.")) {
411 int slot = parse_status_slot(k, 13);
412 if (!v)
413 return config_error_nonbool(k);
414 color_parse(v, k, wt_status_colors[slot]);
415 return 0;
417 if (!strcmp(k, "status.relativepaths")) {
418 wt_status_relative_paths = git_config_bool(k, v);
419 return 0;
421 if (!strcmp(k, "status.showuntrackedfiles")) {
422 if (!v)
423 return config_error_nonbool(k);
424 else if (!strcmp(v, "no"))
425 show_untracked_files = SHOW_NO_UNTRACKED_FILES;
426 else if (!strcmp(v, "normal"))
427 show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
428 else if (!strcmp(v, "all"))
429 show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
430 else
431 return error("Invalid untracked files mode '%s'", v);
432 return 0;
434 return git_diff_ui_config(k, v, cb);