Merge branch 'sg/progress-off-by-one-fix'

[thirdparty/git.git] / progress.c

diff --git a/progress.c b/progress.c
index 212d00e524819aafe17b55f1b2f54a5bcf40dd7e..a2e8cf64a8d1aa2f94c745bbb5098b9c771f3a05 100644 (file)
--- a/progress.c
+++ b/progress.c
@@ -8,11 +8,12 @@
  * published by the Free Software Foundation.
  */
 
-#include "git-compat-util.h"
+#include "cache.h"
 #include "gettext.h"
 #include "progress.h"
 #include "strbuf.h"
 #include "trace.h"
+#include "utf8.h"
 
 #define TP_IDX_MAX      8
 
@@ -37,6 +38,9 @@ struct progress {
        unsigned sparse;
        struct throughput *throughput;
        uint64_t start_ns;
+       struct strbuf counters_sb;
+       int title_len;
+       int split;
 };
 
 static volatile sig_atomic_t progress_update;
@@ -79,41 +83,64 @@ static int is_foreground_fd(int fd)
        return tpgrp < 0 || tpgrp == getpgid(0);
 }
 
-static int display(struct progress *progress, uint64_t n, const char *done)
+static void display(struct progress *progress, uint64_t n, const char *done)
 {
-       const char *eol, *tp;
+       const char *tp;
+       struct strbuf *counters_sb = &progress->counters_sb;
+       int show_update = 0;
+       int last_count_len = counters_sb->len;
 
        if (progress->delay && (!progress_update || --progress->delay))
-               return 0;
+               return;
 
        progress->last_value = n;
        tp = (progress->throughput) ? progress->throughput->display.buf : "";
-       eol = done ? done : "   \r";
        if (progress->total) {
                unsigned percent = n * 100 / progress->total;
                if (percent != progress->last_percent || progress_update) {
                        progress->last_percent = percent;
-                       if (is_foreground_fd(fileno(stderr)) || done) {
-                               fprintf(stderr, "%s: %3u%% (%"PRIuMAX"/%"PRIuMAX")%s%s",
-                                       progress->title, percent,
-                                       (uintmax_t)n, (uintmax_t)progress->total,
-                                       tp, eol);
-                               fflush(stderr);
-                       }
-                       progress_update = 0;
-                       return 1;
+
+                       strbuf_reset(counters_sb);
+                       strbuf_addf(counters_sb,
+                                   "%3u%% (%"PRIuMAX"/%"PRIuMAX")%s", percent,
+                                   (uintmax_t)n, (uintmax_t)progress->total,
+                                   tp);
+                       show_update = 1;
                }
        } else if (progress_update) {
+               strbuf_reset(counters_sb);
+               strbuf_addf(counters_sb, "%"PRIuMAX"%s", (uintmax_t)n, tp);
+               show_update = 1;
+       }
+
+       if (show_update) {
                if (is_foreground_fd(fileno(stderr)) || done) {
-                       fprintf(stderr, "%s: %"PRIuMAX"%s%s",
-                               progress->title, (uintmax_t)n, tp, eol);
+                       const char *eol = done ? done : "\r";
+                       size_t clear_len = counters_sb->len < last_count_len ?
+                                       last_count_len - counters_sb->len + 1 :
+                                       0;
+                       size_t progress_line_len = progress->title_len +
+                                               counters_sb->len + 2;
+                       int cols = term_columns();
+
+                       if (progress->split) {
+                               fprintf(stderr, "  %s%*s", counters_sb->buf,
+                                       (int) clear_len, eol);
+                       } else if (!done && cols < progress_line_len) {
+                               clear_len = progress->title_len + 1 < cols ?
+                                           cols - progress->title_len - 1 : 0;
+                               fprintf(stderr, "%s:%*s\n  %s%s",
+                                       progress->title, (int) clear_len, "",
+                                       counters_sb->buf, eol);
+                               progress->split = 1;
+                       } else {
+                               fprintf(stderr, "%s: %s%*s", progress->title,
+                                       counters_sb->buf, (int) clear_len, eol);
+                       }
                        fflush(stderr);
                }
                progress_update = 0;
-               return 1;
        }
-
-       return 0;
 }
 
 static void throughput_string(struct strbuf *buf, uint64_t total,
@@ -140,12 +167,10 @@ void display_throughput(struct progress *progress, uint64_t total)
        now_ns = getnanotime();
 
        if (!tp) {
-               progress->throughput = tp = calloc(1, sizeof(*tp));
-               if (tp) {
-                       tp->prev_total = tp->curr_total = total;
-                       tp->prev_ns = now_ns;
-                       strbuf_init(&tp->display, 0);
-               }
+               progress->throughput = tp = xcalloc(1, sizeof(*tp));
+               tp->prev_total = tp->curr_total = total;
+               tp->prev_ns = now_ns;
+               strbuf_init(&tp->display, 0);
                return;
        }
        tp->curr_total = total;
@@ -189,21 +214,16 @@ void display_throughput(struct progress *progress, uint64_t total)
                display(progress, progress->last_value, NULL);
 }
 
-int display_progress(struct progress *progress, uint64_t n)
+void display_progress(struct progress *progress, uint64_t n)
 {
-       return progress ? display(progress, n, NULL) : 0;
+       if (progress)
+               display(progress, n, NULL);
 }
 
 static struct progress *start_progress_delay(const char *title, uint64_t total,
                                             unsigned delay, unsigned sparse)
 {
-       struct progress *progress = malloc(sizeof(*progress));
-       if (!progress) {
-               /* unlikely, but here's a good fallback */
-               fprintf(stderr, "%s...\n", title);
-               fflush(stderr);
-               return NULL;
-       }
+       struct progress *progress = xmalloc(sizeof(*progress));
        progress->title = title;
        progress->total = total;
        progress->last_value = -1;
@@ -212,6 +232,9 @@ static struct progress *start_progress_delay(const char *title, uint64_t total,
        progress->sparse = sparse;
        progress->throughput = NULL;
        progress->start_ns = getnanotime();
+       strbuf_init(&progress->counters_sb, 0);
+       progress->title_len = utf8_strwidth(title);
+       progress->split = 0;
        set_progress_signal();
        return progress;
 }
@@ -285,6 +308,7 @@ void stop_progress_msg(struct progress **p_progress, const char *msg)
                free(buf);
        }
        clear_progress_signal();
+       strbuf_release(&progress->counters_sb);
        if (progress->throughput)
                strbuf_release(&progress->throughput->display);
        free(progress->throughput);