glossary: Add definitions for dangling and unreachable objects
[git/mingw/4msysgit/kblees.git] / builtin-branch.c
blob2d8d61b453ede72b8d0319cb192f9f06a024d8c0
1 /*
2 * Builtin "git branch"
4 * Copyright (c) 2006 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-branch.sh by Junio C Hamano.
6 */
8 #include "cache.h"
9 #include "color.h"
10 #include "refs.h"
11 #include "commit.h"
12 #include "builtin.h"
14 static const char builtin_branch_usage[] =
15 "git-branch [-r] (-d | -D) <branchname> | [-l] [-f] <branchname> [<start-point>] | (-m | -M) [<oldbranch>] <newbranch> | [--color | --no-color] [-r | -a] [-v [--abbrev=<length>]]";
17 #define REF_UNKNOWN_TYPE 0x00
18 #define REF_LOCAL_BRANCH 0x01
19 #define REF_REMOTE_BRANCH 0x02
20 #define REF_TAG 0x04
22 static const char *head;
23 static unsigned char head_sha1[20];
25 static int branch_use_color;
26 static char branch_colors[][COLOR_MAXLEN] = {
27 "\033[m", /* reset */
28 "", /* PLAIN (normal) */
29 "\033[31m", /* REMOTE (red) */
30 "", /* LOCAL (normal) */
31 "\033[32m", /* CURRENT (green) */
33 enum color_branch {
34 COLOR_BRANCH_RESET = 0,
35 COLOR_BRANCH_PLAIN = 1,
36 COLOR_BRANCH_REMOTE = 2,
37 COLOR_BRANCH_LOCAL = 3,
38 COLOR_BRANCH_CURRENT = 4,
41 static int parse_branch_color_slot(const char *var, int ofs)
43 if (!strcasecmp(var+ofs, "plain"))
44 return COLOR_BRANCH_PLAIN;
45 if (!strcasecmp(var+ofs, "reset"))
46 return COLOR_BRANCH_RESET;
47 if (!strcasecmp(var+ofs, "remote"))
48 return COLOR_BRANCH_REMOTE;
49 if (!strcasecmp(var+ofs, "local"))
50 return COLOR_BRANCH_LOCAL;
51 if (!strcasecmp(var+ofs, "current"))
52 return COLOR_BRANCH_CURRENT;
53 die("bad config variable '%s'", var);
56 int git_branch_config(const char *var, const char *value)
58 if (!strcmp(var, "color.branch")) {
59 branch_use_color = git_config_colorbool(var, value);
60 return 0;
62 if (!strncmp(var, "color.branch.", 13)) {
63 int slot = parse_branch_color_slot(var, 13);
64 color_parse(value, var, branch_colors[slot]);
65 return 0;
67 return git_default_config(var, value);
70 const char *branch_get_color(enum color_branch ix)
72 if (branch_use_color)
73 return branch_colors[ix];
74 return "";
77 static int delete_branches(int argc, const char **argv, int force, int kinds)
79 struct commit *rev, *head_rev = head_rev;
80 unsigned char sha1[20];
81 char *name = NULL;
82 const char *fmt, *remote;
83 int i;
84 int ret = 0;
86 switch (kinds) {
87 case REF_REMOTE_BRANCH:
88 fmt = "refs/remotes/%s";
89 remote = "remote ";
90 force = 1;
91 break;
92 case REF_LOCAL_BRANCH:
93 fmt = "refs/heads/%s";
94 remote = "";
95 break;
96 default:
97 die("cannot use -a with -d");
100 if (!force) {
101 head_rev = lookup_commit_reference(head_sha1);
102 if (!head_rev)
103 die("Couldn't look up commit object for HEAD");
105 for (i = 0; i < argc; i++) {
106 if (kinds == REF_LOCAL_BRANCH && !strcmp(head, argv[i])) {
107 error("Cannot delete the branch '%s' "
108 "which you are currently on.", argv[i]);
109 ret = 1;
110 continue;
113 if (name)
114 free(name);
116 name = xstrdup(mkpath(fmt, argv[i]));
117 if (!resolve_ref(name, sha1, 1, NULL)) {
118 error("%sbranch '%s' not found.",
119 remote, argv[i]);
120 ret = 1;
121 continue;
124 rev = lookup_commit_reference(sha1);
125 if (!rev) {
126 error("Couldn't look up commit object for '%s'", name);
127 ret = 1;
128 continue;
131 /* This checks whether the merge bases of branch and
132 * HEAD contains branch -- which means that the HEAD
133 * contains everything in both.
136 if (!force &&
137 !in_merge_bases(rev, head_rev)) {
138 error("The branch '%s' is not a strict subset of "
139 "your current HEAD.\n"
140 "If you are sure you want to delete it, "
141 "run 'git branch -D %s'.", argv[i], argv[i]);
142 ret = 1;
143 continue;
146 if (delete_ref(name, sha1)) {
147 error("Error deleting %sbranch '%s'", remote,
148 argv[i]);
149 ret = 1;
150 } else
151 printf("Deleted %sbranch %s.\n", remote, argv[i]);
155 if (name)
156 free(name);
158 return(ret);
161 struct ref_item {
162 char *name;
163 unsigned int kind;
164 unsigned char sha1[20];
167 struct ref_list {
168 int index, alloc, maxwidth;
169 struct ref_item *list;
170 int kinds;
173 static int append_ref(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
175 struct ref_list *ref_list = (struct ref_list*)(cb_data);
176 struct ref_item *newitem;
177 int kind = REF_UNKNOWN_TYPE;
178 int len;
180 /* Detect kind */
181 if (!strncmp(refname, "refs/heads/", 11)) {
182 kind = REF_LOCAL_BRANCH;
183 refname += 11;
184 } else if (!strncmp(refname, "refs/remotes/", 13)) {
185 kind = REF_REMOTE_BRANCH;
186 refname += 13;
187 } else if (!strncmp(refname, "refs/tags/", 10)) {
188 kind = REF_TAG;
189 refname += 10;
192 /* Don't add types the caller doesn't want */
193 if ((kind & ref_list->kinds) == 0)
194 return 0;
196 /* Resize buffer */
197 if (ref_list->index >= ref_list->alloc) {
198 ref_list->alloc = alloc_nr(ref_list->alloc);
199 ref_list->list = xrealloc(ref_list->list,
200 ref_list->alloc * sizeof(struct ref_item));
203 /* Record the new item */
204 newitem = &(ref_list->list[ref_list->index++]);
205 newitem->name = xstrdup(refname);
206 newitem->kind = kind;
207 hashcpy(newitem->sha1, sha1);
208 len = strlen(newitem->name);
209 if (len > ref_list->maxwidth)
210 ref_list->maxwidth = len;
212 return 0;
215 static void free_ref_list(struct ref_list *ref_list)
217 int i;
219 for (i = 0; i < ref_list->index; i++)
220 free(ref_list->list[i].name);
221 free(ref_list->list);
224 static int ref_cmp(const void *r1, const void *r2)
226 struct ref_item *c1 = (struct ref_item *)(r1);
227 struct ref_item *c2 = (struct ref_item *)(r2);
229 if (c1->kind != c2->kind)
230 return c1->kind - c2->kind;
231 return strcmp(c1->name, c2->name);
234 static void print_ref_item(struct ref_item *item, int maxwidth, int verbose,
235 int abbrev, int current)
237 char c;
238 int color;
239 struct commit *commit;
240 char subject[256];
242 switch (item->kind) {
243 case REF_LOCAL_BRANCH:
244 color = COLOR_BRANCH_LOCAL;
245 break;
246 case REF_REMOTE_BRANCH:
247 color = COLOR_BRANCH_REMOTE;
248 break;
249 default:
250 color = COLOR_BRANCH_PLAIN;
251 break;
254 c = ' ';
255 if (current) {
256 c = '*';
257 color = COLOR_BRANCH_CURRENT;
260 if (verbose) {
261 commit = lookup_commit(item->sha1);
262 if (commit && !parse_commit(commit))
263 pretty_print_commit(CMIT_FMT_ONELINE, commit, ~0,
264 subject, sizeof(subject), 0,
265 NULL, NULL, 0);
266 else
267 strcpy(subject, " **** invalid ref ****");
268 printf("%c %s%-*s%s %s %s\n", c, branch_get_color(color),
269 maxwidth, item->name,
270 branch_get_color(COLOR_BRANCH_RESET),
271 find_unique_abbrev(item->sha1, abbrev), subject);
272 } else {
273 printf("%c %s%s%s\n", c, branch_get_color(color), item->name,
274 branch_get_color(COLOR_BRANCH_RESET));
278 static void print_ref_list(int kinds, int detached, int verbose, int abbrev)
280 int i;
281 struct ref_list ref_list;
283 memset(&ref_list, 0, sizeof(ref_list));
284 ref_list.kinds = kinds;
285 for_each_ref(append_ref, &ref_list);
287 qsort(ref_list.list, ref_list.index, sizeof(struct ref_item), ref_cmp);
289 detached = (detached && (kinds & REF_LOCAL_BRANCH));
290 if (detached) {
291 struct ref_item item;
292 item.name = "(no branch)";
293 item.kind = REF_LOCAL_BRANCH;
294 hashcpy(item.sha1, head_sha1);
295 if (strlen(item.name) > ref_list.maxwidth)
296 ref_list.maxwidth = strlen(item.name);
297 print_ref_item(&item, ref_list.maxwidth, verbose, abbrev, 1);
300 for (i = 0; i < ref_list.index; i++) {
301 int current = !detached &&
302 (ref_list.list[i].kind == REF_LOCAL_BRANCH) &&
303 !strcmp(ref_list.list[i].name, head);
304 print_ref_item(&ref_list.list[i], ref_list.maxwidth, verbose,
305 abbrev, current);
308 free_ref_list(&ref_list);
311 static void create_branch(const char *name, const char *start_name,
312 unsigned char *start_sha1,
313 int force, int reflog)
315 struct ref_lock *lock;
316 struct commit *commit;
317 unsigned char sha1[20];
318 char ref[PATH_MAX], msg[PATH_MAX + 20];
319 int forcing = 0;
321 snprintf(ref, sizeof ref, "refs/heads/%s", name);
322 if (check_ref_format(ref))
323 die("'%s' is not a valid branch name.", name);
325 if (resolve_ref(ref, sha1, 1, NULL)) {
326 if (!force)
327 die("A branch named '%s' already exists.", name);
328 else if (!is_bare_repository() && !strcmp(head, name))
329 die("Cannot force update the current branch.");
330 forcing = 1;
333 if (start_sha1)
334 /* detached HEAD */
335 hashcpy(sha1, start_sha1);
336 else if (get_sha1(start_name, sha1))
337 die("Not a valid object name: '%s'.", start_name);
339 if ((commit = lookup_commit_reference(sha1)) == NULL)
340 die("Not a valid branch point: '%s'.", start_name);
341 hashcpy(sha1, commit->object.sha1);
343 lock = lock_any_ref_for_update(ref, NULL);
344 if (!lock)
345 die("Failed to lock ref for update: %s.", strerror(errno));
347 if (reflog)
348 log_all_ref_updates = 1;
350 if (forcing)
351 snprintf(msg, sizeof msg, "branch: Reset from %s",
352 start_name);
353 else
354 snprintf(msg, sizeof msg, "branch: Created from %s",
355 start_name);
357 if (write_ref_sha1(lock, sha1, msg) < 0)
358 die("Failed to write ref: %s.", strerror(errno));
361 static void rename_branch(const char *oldname, const char *newname, int force)
363 char oldref[PATH_MAX], newref[PATH_MAX], logmsg[PATH_MAX*2 + 100];
364 unsigned char sha1[20];
366 if (!oldname)
367 die("cannot rename the current branch while not on any.");
369 if (snprintf(oldref, sizeof(oldref), "refs/heads/%s", oldname) > sizeof(oldref))
370 die("Old branchname too long");
372 if (check_ref_format(oldref))
373 die("Invalid branch name: %s", oldref);
375 if (snprintf(newref, sizeof(newref), "refs/heads/%s", newname) > sizeof(newref))
376 die("New branchname too long");
378 if (check_ref_format(newref))
379 die("Invalid branch name: %s", newref);
381 if (resolve_ref(newref, sha1, 1, NULL) && !force)
382 die("A branch named '%s' already exists.", newname);
384 snprintf(logmsg, sizeof(logmsg), "Branch: renamed %s to %s",
385 oldref, newref);
387 if (rename_ref(oldref, newref, logmsg))
388 die("Branch rename failed");
390 /* no need to pass logmsg here as HEAD didn't really move */
391 if (!strcmp(oldname, head) && create_symref("HEAD", newref, NULL))
392 die("Branch renamed to %s, but HEAD is not updated!", newname);
395 int cmd_branch(int argc, const char **argv, const char *prefix)
397 int delete = 0, force_delete = 0, force_create = 0;
398 int rename = 0, force_rename = 0;
399 int verbose = 0, abbrev = DEFAULT_ABBREV, detached = 0;
400 int reflog = 0;
401 int kinds = REF_LOCAL_BRANCH;
402 int i;
404 git_config(git_branch_config);
406 for (i = 1; i < argc; i++) {
407 const char *arg = argv[i];
409 if (arg[0] != '-')
410 break;
411 if (!strcmp(arg, "--")) {
412 i++;
413 break;
415 if (!strcmp(arg, "-d")) {
416 delete = 1;
417 continue;
419 if (!strcmp(arg, "-D")) {
420 delete = 1;
421 force_delete = 1;
422 continue;
424 if (!strcmp(arg, "-f")) {
425 force_create = 1;
426 continue;
428 if (!strcmp(arg, "-m")) {
429 rename = 1;
430 continue;
432 if (!strcmp(arg, "-M")) {
433 rename = 1;
434 force_rename = 1;
435 continue;
437 if (!strcmp(arg, "-r")) {
438 kinds = REF_REMOTE_BRANCH;
439 continue;
441 if (!strcmp(arg, "-a")) {
442 kinds = REF_REMOTE_BRANCH | REF_LOCAL_BRANCH;
443 continue;
445 if (!strcmp(arg, "-l")) {
446 reflog = 1;
447 continue;
449 if (!strncmp(arg, "--abbrev=", 9)) {
450 abbrev = atoi(arg+9);
451 continue;
453 if (!strcmp(arg, "-v")) {
454 verbose = 1;
455 continue;
457 if (!strcmp(arg, "--color")) {
458 branch_use_color = 1;
459 continue;
461 if (!strcmp(arg, "--no-color")) {
462 branch_use_color = 0;
463 continue;
465 usage(builtin_branch_usage);
468 if ((delete && rename) || (delete && force_create) ||
469 (rename && force_create))
470 usage(builtin_branch_usage);
472 head = xstrdup(resolve_ref("HEAD", head_sha1, 0, NULL));
473 if (!head)
474 die("Failed to resolve HEAD as a valid ref.");
475 if (!strcmp(head, "HEAD")) {
476 detached = 1;
478 else {
479 if (strncmp(head, "refs/heads/", 11))
480 die("HEAD not found below refs/heads!");
481 head += 11;
484 if (delete)
485 return delete_branches(argc - i, argv + i, force_delete, kinds);
486 else if (i == argc)
487 print_ref_list(kinds, detached, verbose, abbrev);
488 else if (rename && (i == argc - 1))
489 rename_branch(head, argv[i], force_rename);
490 else if (rename && (i == argc - 2))
491 rename_branch(argv[i], argv[i + 1], force_rename);
492 else if (i == argc - 1)
493 create_branch(argv[i], head, head_sha1, force_create, reflog);
494 else if (i == argc - 2)
495 create_branch(argv[i], argv[i+1], NULL, force_create, reflog);
496 else
497 usage(builtin_branch_usage);
499 return 0;