scrollbar.h File Reference

Go to the source code of this file.

Data Structures
struct	ui_scrollbar_geometry_t

Functions
ui_scrollbar_geometry_t	ui_scrollbar_measure (size_t total, size_t visible, size_t offset, size_t height)
void	ui_scrollbar_cell (char *output, size_t capacity, size_t row, size_t height, size_t total, size_t visible, size_t offset)
void	ui_scrollbar_render (frame_buffer_t *output, int row, int column, int height, size_t total, size_t visible, size_t offset)

Function Documentation

ui_scrollbar_cell()

void ui_scrollbar_cell	(	char *	output,
		size_t	capacity,
		size_t	row,
		size_t	height,
		size_t	total,
		size_t	visible,
		size_t	offset )

Format one track cell; caller supplies storage (no allocation or output).

Definition at line 27 of file scrollbar.c.

                                                                                                                      {
  if (!out || !cap) {
    SET_ERRNO(ERROR_INVALID_PARAM, "Scrollbar cell requires output storage");
    return;
  }
  ui_scrollbar_geometry_t g = ui_scrollbar_measure(total, visible, offset, height);
  bool thumb = g.visible && row >= g.start && row - g.start < g.length;
  const char *glyph = !g.visible                                         ? " "
                      : terminal_should_use_utf8(GET_OPTION(force_utf8)) ? (thumb ? "█" : "│")
                                                                         : (thumb ? "#" : "|");
  snprintf(out, cap, "%s", colored_string(thumb ? LOG_COLOR_DEBUG : LOG_COLOR_GREY, glyph));
}

References colored_string(), ERROR_INVALID_PARAM, GET_OPTION, height, ui_scrollbar_geometry_t::length, LOG_COLOR_DEBUG, LOG_COLOR_GREY, out, SET_ERRNO, ui_scrollbar_geometry_t::start, ui_scrollbar_measure(), and ui_scrollbar_geometry_t::visible.

Referenced by ui_scrollbar_render().

ui_scrollbar_measure()

ui_scrollbar_geometry_t ui_scrollbar_measure	(	size_t	total,
		size_t	visible,
		size_t	offset,
		size_t	height )

Definition at line 11 of file scrollbar.c.

                                                                                                         {
  ui_scrollbar_geometry_t g = {0};
  if (!height || !visible || total <= visible)
    return g;
  g.visible = true;
  g.length = (size_t)((long double)visible * height / total);
  if (!g.length)
    g.length = 1;
  if (g.length > height)
    g.length = height;
  if (offset > total - visible)
    offset = total - visible;
  g.start = (size_t)((long double)offset * (height - g.length) / (total - visible));
  return g;
}

References height, ui_scrollbar_geometry_t::length, ui_scrollbar_geometry_t::start, and ui_scrollbar_geometry_t::visible.

Referenced by ui_scrollbar_cell().

ui_scrollbar_render()

void ui_scrollbar_render	(	frame_buffer_t *	output,
		int	row,
		int	column,
		int	height,
		size_t	total,
		size_t	visible,
		size_t	offset )

Definition at line 40 of file scrollbar.c.

                                        {
  if (!out || row < 1 || col < 1 || height < 1) {
    SET_ERRNO(ERROR_INVALID_PARAM, "Invalid scrollbar output or geometry");
    return;
  }
  frame_buffer_append(out, "\0337", 2);
  for (int i = 0; i < height; ++i) {
    char cell[UI_SCROLLBAR_CELL_BUFFER_SIZE];
    ui_scrollbar_cell(cell, sizeof(cell), (size_t)i, (size_t)height, total, visible, offset);
    frame_buffer_printf(out, "\033[%d;%dH%s", row + i, col, cell);
  }
  frame_buffer_append(out, "\0338", 2);
}

References ERROR_INVALID_PARAM, frame_buffer_append(), frame_buffer_printf(), height, out, SET_ERRNO, ui_scrollbar_cell(), and UI_SCROLLBAR_CELL_BUFFER_SIZE.

Referenced by terminal_screen_compose(), ui_error_popup_render(), and ui_table_render().