show-branch: color the commit status signs

Make it possible to color the status character ('*' '!' '+' '-') of each
commit corresponding to the branch it's in. This makes it easier to
follow a particular branch, especially if there are larger gaps in the
output.

Add the config option color.showbranch and the command line options
--color and --no-color to control the colored output.

Signed-off-by: Markus Heidelberg <markus.heidelberg@web.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 35056e1a9cd44af119f98465cd7c4cabb9ba0c33..1383a29b0007c01b297ce62ddb84c524d2248fd5 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -595,6 +595,12 @@ color.pager::
        A boolean to enable/disable colored output when the pager is in
        use (default is true).
 
        A boolean to enable/disable colored output when the pager is in
        use (default is true).
 

+color.showbranch::
+       A boolean to enable/disable color in the output of
+       linkgit:git-show-branch[1]. May be set to `always`,
+       `false` (or `never`) or `auto` (or `true`), in which case colors are used
+       only when the output is to a terminal. Defaults to false.
+

 color.status::
        A boolean to enable/disable color in the output of
        linkgit:git-status[1]. May be set to `always`,
 color.status::
        A boolean to enable/disable color in the output of
        linkgit:git-status[1]. May be set to `always`,

diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt
index 7e9ff3762b111d8740a99b676ea516435018f3a8..05868b68f62afa3f8c06def305e6acaf0bba7c14 100644 (file)
--- a/Documentation/git-show-branch.txt
+++ b/Documentation/git-show-branch.txt
@@ -10,6 +10,7 @@ SYNOPSIS
 [verse]
 'git show-branch' [--all] [--remotes] [--topo-order] [--current]
                [--more=<n> | --list | --independent | --merge-base]
 [verse]
 'git show-branch' [--all] [--remotes] [--topo-order] [--current]
                [--more=<n> | --list | --independent | --merge-base]

+               [--color | --no-color]

                [--no-name | --sha1-name] [--topics] [<rev> | <glob>]...
 'git show-branch' (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>]
 
                [--no-name | --sha1-name] [--topics] [<rev> | <glob>]...
 'git show-branch' (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>]
 


@@ -107,6 +108,14 @@ OPTIONS
        When no explicit <ref> parameter is given, it defaults to the
        current branch (or `HEAD` if it is detached).
 
        When no explicit <ref> parameter is given, it defaults to the
        current branch (or `HEAD` if it is detached).
 

+--color::
+       Color the status sign (one of these: `*` `!` `+` `-`) of each commit
+       corresponding to the branch it's in.
+
+--no-color::
+       Turn off colored output, even when the configuration file gives the
+       default to color output.
+

 Note that --more, --list, --independent and --merge-base options
 are mutually exclusive.
 
 Note that --more, --list, --independent and --merge-base options
 are mutually exclusive.
 

diff --git a/builtin-show-branch.c b/builtin-show-branch.c
index 828e6f86de22f8def68a49b702a27521c248a012..fc38f5e005557396af507d4b3b934ec97b32d0e2 100644 (file)
--- a/builtin-show-branch.c
+++ b/builtin-show-branch.c
@@ -2,12 +2,25 @@
 #include "commit.h"
 #include "refs.h"
 #include "builtin.h"
 #include "commit.h"
 #include "refs.h"
 #include "builtin.h"

+#include "color.h"

 
 static const char show_branch_usage[] =
 "git show-branch [--sparse] [--current] [--all] [--remotes] [--topo-order] [--more=count | --list | --independent | --merge-base ] [--topics] [<refs>...] | --reflog[=n[,b]] <branch>";
 static const char show_branch_usage_reflog[] =
 "--reflog is incompatible with --all, --remotes, --independent or --merge-base";
 
 
 static const char show_branch_usage[] =
 "git show-branch [--sparse] [--current] [--all] [--remotes] [--topo-order] [--more=count | --list | --independent | --merge-base ] [--topics] [<refs>...] | --reflog[=n[,b]] <branch>";
 static const char show_branch_usage_reflog[] =
 "--reflog is incompatible with --all, --remotes, --independent or --merge-base";
 

+static int showbranch_use_color = -1;
+static char column_colors[][COLOR_MAXLEN] = {
+       GIT_COLOR_RED,
+       GIT_COLOR_GREEN,
+       GIT_COLOR_YELLOW,
+       GIT_COLOR_BLUE,
+       GIT_COLOR_MAGENTA,
+       GIT_COLOR_CYAN,
+};
+
+#define COLUMN_COLORS_MAX (ARRAY_SIZE(column_colors))
+

 static int default_num;
 static int default_alloc;
 static const char **default_arg;
 static int default_num;
 static int default_alloc;
 static const char **default_arg;


@@ -19,6 +32,20 @@ static const char **default_arg;
 
 #define DEFAULT_REFLOG 4
 
 
 #define DEFAULT_REFLOG 4
 

+static const char *get_color_code(int idx)
+{
+       if (showbranch_use_color)
+               return column_colors[idx];
+       return "";
+}
+
+static const char *get_color_reset_code(void)
+{
+       if (showbranch_use_color)
+               return GIT_COLOR_RESET;
+       return "";
+}
+

 static struct commit *interesting(struct commit_list *list)
 {
        while (list) {
 static struct commit *interesting(struct commit_list *list)
 {
        while (list) {


@@ -545,7 +572,12 @@ static int git_show_branch_config(const char *var, const char *value, void *cb)
                return 0;
        }
 
                return 0;
        }
 

-       return git_default_config(var, value, cb);
+       if (!strcmp(var, "color.showbranch")) {
+               showbranch_use_color = git_config_colorbool(var, value, -1);
+               return 0;
+       }
+
+       return git_color_default_config(var, value, cb);

 }
 
 static int omit_in_dense(struct commit *commit, struct commit **rev, int n)
 }
 
 static int omit_in_dense(struct commit *commit, struct commit **rev, int n)


@@ -611,6 +643,9 @@ int cmd_show_branch(int ac, const char **av, const char *prefix)
 
        git_config(git_show_branch_config, NULL);
 
 
        git_config(git_show_branch_config, NULL);
 

+       if (showbranch_use_color == -1)
+               showbranch_use_color = git_use_color_default;
+

        /* If nothing is specified, try the default first */
        if (ac == 1 && default_num) {
                ac = default_num + 1;
        /* If nothing is specified, try the default first */
        if (ac == 1 && default_num) {
                ac = default_num + 1;


@@ -658,6 +693,10 @@ int cmd_show_branch(int ac, const char **av, const char *prefix)
                        parse_reflog_param(arg + 9, &reflog, &reflog_base);
                else if (!prefixcmp(arg, "-g="))
                        parse_reflog_param(arg + 3, &reflog, &reflog_base);
                        parse_reflog_param(arg + 9, &reflog, &reflog_base);
                else if (!prefixcmp(arg, "-g="))
                        parse_reflog_param(arg + 3, &reflog, &reflog_base);

+               else if (!strcmp(arg, "--color"))
+                       showbranch_use_color = 1;
+               else if (!strcmp(arg, "--no-color"))
+                       showbranch_use_color = 0;

                else
                        usage(show_branch_usage);
                ac--; av++;
                else
                        usage(show_branch_usage);
                ac--; av++;


@@ -843,8 +882,10 @@ int cmd_show_branch(int ac, const char **av, const char *prefix)
                        else {
                                for (j = 0; j < i; j++)
                                        putchar(' ');
                        else {
                                for (j = 0; j < i; j++)
                                        putchar(' ');

-                               printf("%c [%s] ",
-                                      is_head ? '*' : '!', ref_name[i]);
+                               printf("%s%c%s [%s] ",
+                                      get_color_code(i % COLUMN_COLORS_MAX),
+                                      is_head ? '*' : '!',
+                                      get_color_reset_code(), ref_name[i]);

                        }
 
                        if (!reflog) {
                        }
 
                        if (!reflog) {


@@ -903,7 +944,9 @@ int cmd_show_branch(int ac, const char **av, const char *prefix)
                                        mark = '*';
                                else
                                        mark = '+';
                                        mark = '*';
                                else
                                        mark = '+';

-                               putchar(mark);
+                               printf("%s%c%s",
+                                      get_color_code(i % COLUMN_COLORS_MAX),
+                                      mark, get_color_reset_code());

                        }
                        putchar(' ');
                }
                        }
                        putchar(' ');
                }