progress.h File Reference

Go to the source code of this file.

Functions
void	ui_progress_format (char *output, size_t capacity, double fraction, int width)
const char *	ui_spinner_glyph (uint64_t elapsed_ns, bool use_colors)
void	ui_spinner_render (frame_buffer_t *output, int row, int column, uint64_t elapsed_ns)

Function Documentation

ui_progress_format()

void ui_progress_format	(	char *	output,
		size_t	capacity,
		double	fraction,
		int	width )

Caller-owned ASCII/UTF-8 bar, styled using the active theme.

Definition at line 8 of file progress.c.

                                                                           {
  if (!out || !cap || width < 1 || !isfinite(fraction)) {
    SET_ERRNO(ERROR_INVALID_PARAM, "Invalid progress buffer, value or width");
    return;
  }
  out[0] = '\0';
  if (fraction < 0)
    fraction = 0;
  if (fraction > 1)
    fraction = 1;
  int filled = (int)(fraction * width);
  size_t used = 0;
  for (int i = 0; i < width; ++i) {
    const char *glyph =
        terminal_should_use_utf8(GET_OPTION(force_utf8)) ? (i < filled ? "█" : "░") : (i < filled ? "#" : ".");
    const char *cell = colored_string(i < filled ? LOG_COLOR_INFO : LOG_COLOR_GREY, glyph);
    size_t n = strlen(cell);
    if (n >= cap - used) {
      SET_ERRNO(ERROR_BUFFER_OVERFLOW, "Progress output buffer is too small");
      return;
    }
    memcpy(out + used, cell, n);
    used += n;
    out[used] = '\0';
  }
}

References colored_string(), ERROR_BUFFER_OVERFLOW, ERROR_INVALID_PARAM, GET_OPTION, LOG_COLOR_GREY, LOG_COLOR_INFO, out, SET_ERRNO, and width.

ui_spinner_glyph()

const char * ui_spinner_glyph	(	uint64_t	elapsed_ns,
		bool	use_colors )

Definition at line 34 of file progress.c.

                                                                   {
  // Each rotating segment has three dots spanning both Braille columns.
  static const char *unicode[] = {"⠋", "⠙", "⠴", "⠦"};
  static const char *ascii[] = {"|", "/", "-", "\\"};
  uint64_t step = elapsed_ns / 125000000;
  const char *glyph = terminal_should_use_utf8(GET_OPTION(force_utf8)) ? unicode[step % 4] : ascii[step % 4];
  return use_colors ? colored_string(LOG_COLOR_WARN, glyph) : glyph;
}

References colored_string(), GET_OPTION, and LOG_COLOR_WARN.

ui_spinner_render()

void ui_spinner_render	(	frame_buffer_t *	output,
		int	row,
		int	column,
		uint64_t	elapsed_ns )

Eight-dot animated indicator extracted from the update checker.

Definition at line 42 of file progress.c.

                                                                                   {
  if (!out || row < 1 || col < 1) {
    SET_ERRNO(ERROR_INVALID_PARAM, "Invalid spinner output or position");
    return;
  }
  static const int x[] = {3, 5, 6, 5, 3, 1, 0, 1}, y[] = {0, 0, 1, 2, 2, 2, 1, 0};
  unsigned phase = (unsigned)((elapsed_ns / 100000000) % 8);
  for (unsigned dot = 0; dot < 8; ++dot) {
    bool lit = (phase + 8 - dot) % 8 < 3;
    frame_buffer_printf(
        out, "\033[%d;%dH%s", row + y[dot], col + x[dot],
        colored_string(lit ? LOG_COLOR_WARN : LOG_COLOR_GREY, terminal_should_use_utf8(GET_OPTION(force_utf8)) ? "●"
                                                              : lit                                            ? "o"
                                                                                                               : "."));
  }
}

References colored_string(), ERROR_INVALID_PARAM, frame_buffer_printf(), GET_OPTION, LOG_COLOR_GREY, LOG_COLOR_WARN, out, and SET_ERRNO.