ui: add refreshing progressbar with smooth ETA

Author: nil0x42

Makefile

@@ -17,7 +17,7 @@ COVERAGEFLAGS = -O0 -D NDEBUG -std=gnu99 -g2 --coverage -fprofile-update=atomic
 
 SOURCES       = main.c thpool.c file.c chunk.c line.c dedupe.c \
                 optparse.c config.c error.c memstate.c meminfo.c bytesize.c \
-                hmap.c status.c uinput.c \
+                hmap.c status.c progressbar.c cprintferr.c \
 
 COMMON        = include/const.h include/debug.h
 OBJECTS       = $(patsubst %.c, objects/%.o, $(SOURCES))

include/const.h

@@ -26,8 +26,5 @@
 /* minimum needed memory (change with care... can throw bugs if too low */
 #define MIN_MEMORY              (65536)
 
-/* display program status periodically instead of waiting keypress */
-#define DEBUG_PROGRAM_STATUS    (0)
-
 /* max supported max-line-size */
 #define MAX_MAX_LINE_SIZE       4095

include/cprintferr.h

@@ -0,0 +1,4 @@
+#pragma once
+
+/* source file: cprintferr.c */
+int cprintferr(const char *fmt, ...);

include/debug.h

@@ -9,42 +9,33 @@
 #  include <stdio.h>
 #  include <stdarg.h>
 #  include <time.h>
+#  include "cprintferr.h"
 
 #  pragma GCC diagnostic push
 #  pragma GCC diagnostic ignored "-Wunused-function"
 static void _dlog(int level, const char *file, int line, const char *fmt, ...)
 {
-    char        out[1024] = {0};
-    int         i = 0;
-
     time_t      now;
     struct tm*  tm_info;
-
-    va_list ap;
-
-    if (isatty(STDERR_FILENO))
-        i = snprintf(&out[i], 64, "\r\033[2K\e[34;1m[\e[33;1mDLOG%d\e[0;35m ", level);
-    else
-        i = snprintf(&out[i], 64, "[DLOG%d ", level);
-
+    char        time_str[12];
     time(&now);
     tm_info = localtime(&now);
-    i += strftime(&out[i], 12, "%d %H:%M:%S", tm_info);
-
-    if (isatty(STDERR_FILENO))
-        i += snprintf(&out[i], 128, " \e[1;35m%10s:%-3d\e[34;1m]:\e[0m ",
-                &file[4], line);
-    else
-        i += snprintf(&out[i], 128, " %10s:%-3d]: ",
-                &file[4], line);
+    strftime(time_str, 12, "%d %H:%M:%S", tm_info);
 
+    va_list     ap;
+    char        msg[256];
     va_start(ap, fmt);
-    i += vsnprintf(&out[i], sizeof(out) - i, fmt, ap);
+    vsnprintf(msg, sizeof(msg), fmt, ap);
     va_end(ap);
 
-    out[i++] = '\n';
-
-    write(STDERR_FILENO, out, i);
+    cprintferr(
+            "\r\e[2K"
+            "\e[34;1m["
+            "\e[33;1mDLOG%d \e[0;35m%s \e[1;35m%13s:%-3d"
+            "\e[34;1m]"
+            ":\e[0m %s\n",
+            level, time_str, file+4, line, msg
+            );
 }
 #  pragma GCC diagnostic pop
 

include/progressbar.h

@@ -0,0 +1,5 @@
+#pragma once
+
+/* source file: progressbar.c */
+void        start_progressbar(void);
+void        stop_progressbar(void);

include/status.h

@@ -24,6 +24,6 @@ enum    e_status_set
 
 /* source file: status.c */
 void                display_report(void);
-void                display_status(void);
+void                display_status(int finished);
 void                update_status(enum e_status_update action);
 void                set_status(enum e_status_set var, size_t val);

include/uinput.h

@@ -0,0 +1,55 @@
+#include <stdio.h>
+#include <stdarg.h>
+#include <unistd.h>
+#include <string.h>
+
+static int strip_ansi_inplace(char *s)
+{
+    char *src = s, *dst = s;
+
+    while (*src) {
+        if (*src == '\x1b' && src[1] == '[') {
+            src += 2;
+            while (*src && !(*src >= '@' && *src <= '~'))
+                ++src;
+            if (*src) ++src;
+        } else {
+            *dst++ = *src++;
+        }
+    }
+    *dst = '\0';
+    return (int)(dst - s);
+}
+
+/* color‑aware stderr printf */
+int cprintferr(const char *fmt, ...)
+{
+    static int color_ok = -1;
+    if (color_ok == -1)
+        color_ok = isatty(STDERR_FILENO);
+
+    char buf[1024];
+    va_list ap;
+    va_start(ap, fmt);
+    int len = vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
+    va_end(ap);
+
+    if (len < 1)
+        return len;
+    else if (len >= (int)sizeof(buf) -1)
+        len = sizeof(buf) - 2;
+
+    if (!color_ok) {
+        len = strip_ansi_inplace(buf);
+        if (len > 0 && buf[len-1] != '\n') {
+            buf[len++] = '\n';
+            buf[len] = '\0';
+        }
+    }
+    if (len > 0) {
+        fwrite(buf, 1, len, stderr);
+        if (buf[len-1] != '\n')
+            fflush(stderr);
+    }
+    return len;
+}

src/cprintferr.c

@@ -7,7 +7,7 @@
 #include "file.h"
 #include "hmap.h"
 #include "dedupe.h"
-#include "uinput.h"
+#include "progressbar.h"
 #include "status.h"
 #include "error.h"
 
@@ -72,8 +72,7 @@ int             main(int argc, char **argv)
 {
     optparse(argc, argv); /* setup g_conf options */
 
-    if (isatty(STDIN_FILENO))
-        watch_user_input();
+    start_progressbar();
 
     update_status(FCOPY_START);
     init_files();
@@ -89,6 +88,8 @@ int             main(int argc, char **argv)
     remove_duplicates();
     cleanup_files();
 
+    stop_progressbar();
+
     display_report();
     return (0);
 }

src/main.c

@@ -0,0 +1,94 @@
+#include <stdlib.h>
+#include <unistd.h>
+#include <pthread.h>
+#include <string.h>
+#include <termios.h>
+#include <signal.h>
+#include <stdio.h>
+#include "progressbar.h"
+#include "status.h"
+#include "const.h"
+#include "error.h"
+
+#define BUF_SIZE    (1024)
+
+static struct termios           g_old_tio, g_new_tio;
+
+static pthread_t                g_pbarthread_id = 0;
+static volatile sig_atomic_t    g_pbarthread_running = 1;
+
+
+/** thread worker
+ * print progression status with print_status() on keypress
+ */
+#define SLEEPTIME_MS 250 // pbar refresh frequency
+#define ITER 25 // 25 loop iterations per loop refresh
+static void *progressbar_worker(void *arg)
+{
+    (void)arg;
+    int iter = ITER;
+    while (g_pbarthread_running)
+    {
+        if (iter == ITER) {
+            display_status(0);
+            iter = 0;
+        }
+        usleep((SLEEPTIME_MS * 1000) / ITER); // 250ms / iter
+        ++iter;
+    }
+    display_status(1);
+    return NULL;
+}
+
+
+/** restore terminal's line buffering & echo
+ */
+static void restore_termios(void)
+{
+    tcsetattr(STDERR_FILENO, TCSANOW, &g_old_tio);
+}
+
+/** disable terminal's line buffering & echo
+ */
+static void config_termios(void)
+{
+    if (tcgetattr(STDERR_FILENO, &g_old_tio) < 0)
+        error("tcgetattr(): %s", ERRNO);
+
+    g_new_tio = g_old_tio;
+    g_new_tio.c_lflag &= ~(ICANON | ECHO);
+
+    if (tcsetattr(STDERR_FILENO, TCSANOW, &g_new_tio) < 0)
+        error("tcsetattr(): %s", ERRNO);
+
+    atexit(restore_termios);
+}
+
+
+void        start_progressbar(void)
+{
+    if (!isatty(STDERR_FILENO))
+        return ;
+
+    /* Ignore if not in foreground */
+    if (tcgetpgrp(STDERR_FILENO) != getpgrp())
+        return;
+
+    config_termios();
+    if (pthread_create(
+                &g_pbarthread_id, NULL,
+                &progressbar_worker, NULL
+                ) < 0) {
+        error("cannot create watch_user_input_worker() thread: %s", ERRNO);
+    }
+}
+
+void        stop_progressbar(void)
+{
+    if (g_pbarthread_id == 0)
+        return;
+    g_pbarthread_running = 0;
+    pthread_join(g_pbarthread_id, NULL); // wait thread (ignored if already detached)
+    restore_termios();
+    g_pbarthread_id = 0;
+}