4 * Copyright (c) 2006 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-branch.sh by Junio C Hamano.
14 #include "parse-options.h"
19 static const char * const builtin_branch_usage
[] = {
20 "git branch [options] [-r | -a] [--merged | --no-merged]",
21 "git branch [options] [-l] [-f] <branchname> [<start-point>]",
22 "git branch [options] [-r] (-d | -D) <branchname>",
23 "git branch [options] (-m | -M) [<oldbranch>] <newbranch>",
27 #define REF_LOCAL_BRANCH 0x01
28 #define REF_REMOTE_BRANCH 0x02
30 static const char *head
;
31 static unsigned char head_sha1
[20];
33 static int branch_use_color
= -1;
34 static char branch_colors
[][COLOR_MAXLEN
] = {
36 "", /* PLAIN (normal) */
37 "\033[31m", /* REMOTE (red) */
38 "", /* LOCAL (normal) */
39 "\033[32m", /* CURRENT (green) */
42 COLOR_BRANCH_RESET
= 0,
43 COLOR_BRANCH_PLAIN
= 1,
44 COLOR_BRANCH_REMOTE
= 2,
45 COLOR_BRANCH_LOCAL
= 3,
46 COLOR_BRANCH_CURRENT
= 4,
49 static enum merge_filter
{
54 static unsigned char merge_filter_ref
[20];
56 static int parse_branch_color_slot(const char *var
, int ofs
)
58 if (!strcasecmp(var
+ofs
, "plain"))
59 return COLOR_BRANCH_PLAIN
;
60 if (!strcasecmp(var
+ofs
, "reset"))
61 return COLOR_BRANCH_RESET
;
62 if (!strcasecmp(var
+ofs
, "remote"))
63 return COLOR_BRANCH_REMOTE
;
64 if (!strcasecmp(var
+ofs
, "local"))
65 return COLOR_BRANCH_LOCAL
;
66 if (!strcasecmp(var
+ofs
, "current"))
67 return COLOR_BRANCH_CURRENT
;
68 die("bad config variable '%s'", var
);
71 static int git_branch_config(const char *var
, const char *value
, void *cb
)
73 if (!strcmp(var
, "color.branch")) {
74 branch_use_color
= git_config_colorbool(var
, value
, -1);
77 if (!prefixcmp(var
, "color.branch.")) {
78 int slot
= parse_branch_color_slot(var
, 13);
80 return config_error_nonbool(var
);
81 color_parse(value
, var
, branch_colors
[slot
]);
84 return git_color_default_config(var
, value
, cb
);
87 static const char *branch_get_color(enum color_branch ix
)
89 if (branch_use_color
> 0)
90 return branch_colors
[ix
];
94 static int delete_branches(int argc
, const char **argv
, int force
, int kinds
)
96 struct commit
*rev
, *head_rev
= head_rev
;
97 unsigned char sha1
[20];
99 const char *fmt
, *remote
;
100 char section
[PATH_MAX
];
105 case REF_REMOTE_BRANCH
:
106 fmt
= "refs/remotes/%s";
110 case REF_LOCAL_BRANCH
:
111 fmt
= "refs/heads/%s";
115 die("cannot use -a with -d");
119 head_rev
= lookup_commit_reference(head_sha1
);
121 die("Couldn't look up commit object for HEAD");
123 for (i
= 0; i
< argc
; i
++) {
124 if (kinds
== REF_LOCAL_BRANCH
&& !strcmp(head
, argv
[i
])) {
125 error("Cannot delete the branch '%s' "
126 "which you are currently on.", argv
[i
]);
133 name
= xstrdup(mkpath(fmt
, argv
[i
]));
134 if (!resolve_ref(name
, sha1
, 1, NULL
)) {
135 error("%sbranch '%s' not found.",
141 rev
= lookup_commit_reference(sha1
);
143 error("Couldn't look up commit object for '%s'", name
);
148 /* This checks whether the merge bases of branch and
149 * HEAD contains branch -- which means that the HEAD
150 * contains everything in both.
154 !in_merge_bases(rev
, &head_rev
, 1)) {
155 error("The branch '%s' is not an ancestor of "
156 "your current HEAD.\n"
157 "If you are sure you want to delete it, "
158 "run 'git branch -D %s'.", argv
[i
], argv
[i
]);
163 if (delete_ref(name
, sha1
, 0)) {
164 error("Error deleting %sbranch '%s'", remote
,
168 printf("Deleted %sbranch %s.\n", remote
, argv
[i
]);
169 snprintf(section
, sizeof(section
), "branch.%s",
171 if (git_config_rename_section(section
, NULL
) < 0)
172 warning("Update of config-file failed");
184 struct commit
*commit
;
188 struct rev_info revs
;
189 int index
, alloc
, maxwidth
;
190 struct ref_item
*list
;
191 struct commit_list
*with_commit
;
195 static int has_commit(struct commit
*commit
, struct commit_list
*with_commit
)
199 while (with_commit
) {
200 struct commit
*other
;
202 other
= with_commit
->item
;
203 with_commit
= with_commit
->next
;
204 if (in_merge_bases(other
, &commit
, 1))
210 static int append_ref(const char *refname
, const unsigned char *sha1
, int flags
, void *cb_data
)
212 struct ref_list
*ref_list
= (struct ref_list
*)(cb_data
);
213 struct ref_item
*newitem
;
214 struct commit
*commit
;
219 if (!prefixcmp(refname
, "refs/heads/")) {
220 kind
= REF_LOCAL_BRANCH
;
222 } else if (!prefixcmp(refname
, "refs/remotes/")) {
223 kind
= REF_REMOTE_BRANCH
;
228 commit
= lookup_commit_reference_gently(sha1
, 1);
230 return error("branch '%s' does not point at a commit", refname
);
232 /* Filter with with_commit if specified */
233 if (!has_commit(commit
, ref_list
->with_commit
))
236 /* Don't add types the caller doesn't want */
237 if ((kind
& ref_list
->kinds
) == 0)
240 if (merge_filter
!= NO_FILTER
)
241 add_pending_object(&ref_list
->revs
,
242 (struct object
*)commit
, refname
);
245 if (ref_list
->index
>= ref_list
->alloc
) {
246 ref_list
->alloc
= alloc_nr(ref_list
->alloc
);
247 ref_list
->list
= xrealloc(ref_list
->list
,
248 ref_list
->alloc
* sizeof(struct ref_item
));
251 /* Record the new item */
252 newitem
= &(ref_list
->list
[ref_list
->index
++]);
253 newitem
->name
= xstrdup(refname
);
254 newitem
->kind
= kind
;
255 newitem
->commit
= commit
;
256 len
= strlen(newitem
->name
);
257 if (len
> ref_list
->maxwidth
)
258 ref_list
->maxwidth
= len
;
263 static void free_ref_list(struct ref_list
*ref_list
)
267 for (i
= 0; i
< ref_list
->index
; i
++)
268 free(ref_list
->list
[i
].name
);
269 free(ref_list
->list
);
272 static int ref_cmp(const void *r1
, const void *r2
)
274 struct ref_item
*c1
= (struct ref_item
*)(r1
);
275 struct ref_item
*c2
= (struct ref_item
*)(r2
);
277 if (c1
->kind
!= c2
->kind
)
278 return c1
->kind
- c2
->kind
;
279 return strcmp(c1
->name
, c2
->name
);
282 static void fill_tracking_info(char *stat
, const char *branch_name
)
285 struct branch
*branch
= branch_get(branch_name
);
287 if (!stat_tracking_info(branch
, &ours
, &theirs
) || (!ours
&& !theirs
))
290 sprintf(stat
, "[behind %d] ", theirs
);
292 sprintf(stat
, "[ahead %d] ", ours
);
294 sprintf(stat
, "[ahead %d, behind %d] ", ours
, theirs
);
297 static int matches_merge_filter(struct commit
*commit
)
301 if (merge_filter
== NO_FILTER
)
304 is_merged
= !!(commit
->object
.flags
& UNINTERESTING
);
305 return (is_merged
== (merge_filter
== SHOW_MERGED
));
308 static void print_ref_item(struct ref_item
*item
, int maxwidth
, int verbose
,
309 int abbrev
, int current
)
313 struct commit
*commit
= item
->commit
;
315 if (!matches_merge_filter(commit
))
318 switch (item
->kind
) {
319 case REF_LOCAL_BRANCH
:
320 color
= COLOR_BRANCH_LOCAL
;
322 case REF_REMOTE_BRANCH
:
323 color
= COLOR_BRANCH_REMOTE
;
326 color
= COLOR_BRANCH_PLAIN
;
333 color
= COLOR_BRANCH_CURRENT
;
337 struct strbuf subject
;
338 const char *sub
= " **** invalid ref ****";
341 strbuf_init(&subject
, 0);
344 commit
= item
->commit
;
345 if (commit
&& !parse_commit(commit
)) {
346 pretty_print_commit(CMIT_FMT_ONELINE
, commit
,
347 &subject
, 0, NULL
, NULL
, 0, 0);
351 if (item
->kind
== REF_LOCAL_BRANCH
)
352 fill_tracking_info(stat
, item
->name
);
354 printf("%c %s%-*s%s %s %s%s\n", c
, branch_get_color(color
),
355 maxwidth
, item
->name
,
356 branch_get_color(COLOR_BRANCH_RESET
),
357 find_unique_abbrev(item
->commit
->object
.sha1
, abbrev
),
359 strbuf_release(&subject
);
361 printf("%c %s%s%s\n", c
, branch_get_color(color
), item
->name
,
362 branch_get_color(COLOR_BRANCH_RESET
));
366 static int calc_maxwidth(struct ref_list
*refs
)
369 for (i
= 0; i
< refs
->index
; i
++) {
370 if (!matches_merge_filter(refs
->list
[i
].commit
))
372 l
= strlen(refs
->list
[i
].name
);
379 static void print_ref_list(int kinds
, int detached
, int verbose
, int abbrev
, struct commit_list
*with_commit
)
382 struct ref_list ref_list
;
383 struct commit
*head_commit
= lookup_commit_reference_gently(head_sha1
, 1);
385 memset(&ref_list
, 0, sizeof(ref_list
));
386 ref_list
.kinds
= kinds
;
387 ref_list
.with_commit
= with_commit
;
388 if (merge_filter
!= NO_FILTER
)
389 init_revisions(&ref_list
.revs
, NULL
);
390 for_each_ref(append_ref
, &ref_list
);
391 if (merge_filter
!= NO_FILTER
) {
392 struct commit
*filter
;
393 filter
= lookup_commit_reference_gently(merge_filter_ref
, 0);
394 filter
->object
.flags
|= UNINTERESTING
;
395 add_pending_object(&ref_list
.revs
,
396 (struct object
*) filter
, "");
397 ref_list
.revs
.limited
= 1;
398 prepare_revision_walk(&ref_list
.revs
);
400 ref_list
.maxwidth
= calc_maxwidth(&ref_list
);
403 qsort(ref_list
.list
, ref_list
.index
, sizeof(struct ref_item
), ref_cmp
);
405 detached
= (detached
&& (kinds
& REF_LOCAL_BRANCH
));
406 if (detached
&& head_commit
&& has_commit(head_commit
, with_commit
)) {
407 struct ref_item item
;
408 item
.name
= xstrdup("(no branch)");
409 item
.kind
= REF_LOCAL_BRANCH
;
410 item
.commit
= head_commit
;
411 if (strlen(item
.name
) > ref_list
.maxwidth
)
412 ref_list
.maxwidth
= strlen(item
.name
);
413 print_ref_item(&item
, ref_list
.maxwidth
, verbose
, abbrev
, 1);
417 for (i
= 0; i
< ref_list
.index
; i
++) {
418 int current
= !detached
&&
419 (ref_list
.list
[i
].kind
== REF_LOCAL_BRANCH
) &&
420 !strcmp(ref_list
.list
[i
].name
, head
);
421 print_ref_item(&ref_list
.list
[i
], ref_list
.maxwidth
, verbose
,
425 free_ref_list(&ref_list
);
428 static void rename_branch(const char *oldname
, const char *newname
, int force
)
430 char oldref
[PATH_MAX
], newref
[PATH_MAX
], logmsg
[PATH_MAX
*2 + 100];
431 unsigned char sha1
[20];
432 char oldsection
[PATH_MAX
], newsection
[PATH_MAX
];
435 die("cannot rename the current branch while not on any.");
437 if (snprintf(oldref
, sizeof(oldref
), "refs/heads/%s", oldname
) > sizeof(oldref
))
438 die("Old branchname too long");
440 if (check_ref_format(oldref
))
441 die("Invalid branch name: %s", oldref
);
443 if (snprintf(newref
, sizeof(newref
), "refs/heads/%s", newname
) > sizeof(newref
))
444 die("New branchname too long");
446 if (check_ref_format(newref
))
447 die("Invalid branch name: %s", newref
);
449 if (resolve_ref(newref
, sha1
, 1, NULL
) && !force
)
450 die("A branch named '%s' already exists.", newname
);
452 snprintf(logmsg
, sizeof(logmsg
), "Branch: renamed %s to %s",
455 if (rename_ref(oldref
, newref
, logmsg
))
456 die("Branch rename failed");
458 /* no need to pass logmsg here as HEAD didn't really move */
459 if (!strcmp(oldname
, head
) && create_symref("HEAD", newref
, NULL
))
460 die("Branch renamed to %s, but HEAD is not updated!", newname
);
462 snprintf(oldsection
, sizeof(oldsection
), "branch.%s", oldref
+ 11);
463 snprintf(newsection
, sizeof(newsection
), "branch.%s", newref
+ 11);
464 if (git_config_rename_section(oldsection
, newsection
) < 0)
465 die("Branch is renamed, but update of config-file failed");
468 static int opt_parse_with_commit(const struct option
*opt
, const char *arg
, int unset
)
470 unsigned char sha1
[20];
471 struct commit
*commit
;
475 if (get_sha1(arg
, sha1
))
476 die("malformed object name %s", arg
);
477 commit
= lookup_commit_reference(sha1
);
479 die("no such commit %s", arg
);
480 commit_list_insert(commit
, opt
->value
);
484 static int opt_parse_merge_filter(const struct option
*opt
, const char *arg
, int unset
)
486 merge_filter
= ((opt
->long_name
[0] == 'n')
490 merge_filter
= SHOW_NOT_MERGED
; /* b/c for --no-merged */
493 if (get_sha1(arg
, merge_filter_ref
))
494 die("malformed object name %s", arg
);
498 int cmd_branch(int argc
, const char **argv
, const char *prefix
)
500 int delete = 0, rename
= 0, force_create
= 0;
501 int verbose
= 0, abbrev
= DEFAULT_ABBREV
, detached
= 0;
503 enum branch_track track
;
504 int kinds
= REF_LOCAL_BRANCH
;
505 struct commit_list
*with_commit
= NULL
;
507 struct option options
[] = {
508 OPT_GROUP("Generic options"),
509 OPT__VERBOSE(&verbose
),
510 OPT_SET_INT( 0 , "track", &track
, "set up tracking mode (see git-pull(1))",
511 BRANCH_TRACK_EXPLICIT
),
512 OPT_BOOLEAN( 0 , "color", &branch_use_color
, "use colored output"),
513 OPT_SET_INT('r', NULL
, &kinds
, "act on remote-tracking branches",
516 OPTION_CALLBACK
, 0, "contains", &with_commit
, "commit",
517 "print only branches that contain the commit",
518 PARSE_OPT_LASTARG_DEFAULT
,
519 opt_parse_with_commit
, (intptr_t)"HEAD",
522 OPTION_CALLBACK
, 0, "with", &with_commit
, "commit",
523 "print only branches that contain the commit",
524 PARSE_OPT_HIDDEN
| PARSE_OPT_LASTARG_DEFAULT
,
525 opt_parse_with_commit
, (intptr_t) "HEAD",
527 OPT__ABBREV(&abbrev
),
529 OPT_GROUP("Specific git-branch actions:"),
530 OPT_SET_INT('a', NULL
, &kinds
, "list both remote-tracking and local branches",
531 REF_REMOTE_BRANCH
| REF_LOCAL_BRANCH
),
532 OPT_BIT('d', NULL
, &delete, "delete fully merged branch", 1),
533 OPT_BIT('D', NULL
, &delete, "delete branch (even if not merged)", 2),
534 OPT_BIT('m', NULL
, &rename
, "move/rename a branch and its reflog", 1),
535 OPT_BIT('M', NULL
, &rename
, "move/rename a branch, even if target exists", 2),
536 OPT_BOOLEAN('l', NULL
, &reflog
, "create the branch's reflog"),
537 OPT_BOOLEAN('f', NULL
, &force_create
, "force creation (when already exists)"),
539 OPTION_CALLBACK
, 0, "no-merged", &merge_filter_ref
,
540 "commit", "print only not merged branches",
541 PARSE_OPT_LASTARG_DEFAULT
| PARSE_OPT_NONEG
,
542 opt_parse_merge_filter
, (intptr_t) "HEAD",
545 OPTION_CALLBACK
, 0, "merged", &merge_filter_ref
,
546 "commit", "print only merged branches",
547 PARSE_OPT_LASTARG_DEFAULT
| PARSE_OPT_NONEG
,
548 opt_parse_merge_filter
, (intptr_t) "HEAD",
553 git_config(git_branch_config
, NULL
);
555 if (branch_use_color
== -1)
556 branch_use_color
= git_use_color_default
;
558 track
= git_branch_track
;
560 head
= resolve_ref("HEAD", head_sha1
, 0, NULL
);
562 die("Failed to resolve HEAD as a valid ref.");
563 head
= xstrdup(head
);
564 if (!strcmp(head
, "HEAD")) {
567 if (prefixcmp(head
, "refs/heads/"))
568 die("HEAD not found below refs/heads!");
571 hashcpy(merge_filter_ref
, head_sha1
);
573 argc
= parse_options(argc
, argv
, options
, builtin_branch_usage
, 0);
574 if (!!delete + !!rename
+ !!force_create
> 1)
575 usage_with_options(builtin_branch_usage
, options
);
578 return delete_branches(argc
, argv
, delete > 1, kinds
);
580 print_ref_list(kinds
, detached
, verbose
, abbrev
, with_commit
);
581 else if (rename
&& (argc
== 1))
582 rename_branch(head
, argv
[0], rename
> 1);
583 else if (rename
&& (argc
== 2))
584 rename_branch(argv
[0], argv
[1], rename
> 1);
586 create_branch(head
, argv
[0], (argc
== 2) ? argv
[1] : head
,
587 force_create
, reflog
, track
);
589 usage_with_options(builtin_branch_usage
, options
);