error_popup.c File Reference

Go to the source code of this file.

Macros
#define	TUI_ERROR_POPUP_WRAPPED_BUFFER_SIZE   65536
#define	TUI_ERROR_POPUP_STYLE_BUFFER_SIZE   128
#define	TUI_ERROR_POPUP_THREAD_BUFFER_SIZE   160
#define	TUI_ERROR_POPUP_FILE_BUFFER_SIZE   1024
#define	TUI_ERROR_POPUP_FUNCTION_BUFFER_SIZE   256
#define	TUI_ERROR_POPUP_LINE_BUFFER_SIZE   24
#define	TUI_ERROR_POPUP_ADDRESS_BUFFER_SIZE   40
#define	TUI_ERROR_POPUP_TITLE_BUFFER_SIZE   128
#define	TUI_ERROR_POPUP_HEADING_BUFFER_SIZE   256
#define	TUI_ERROR_POPUP_CODE_BUFFER_SIZE   512
#define	TUI_ERROR_POPUP_CELL_BUFFER_SIZE   1024
#define	TUI_ERROR_POPUP_FINAL_OUTPUT_BUFFER_SIZE   65536
#define	ERROR_POPUP_LINE_CAPACITY   2048

Functions
bool	ui_error_popup_visible (void)
uint64_t	ui_error_popup_revision (void)
terminal_size_t	ui_error_popup_minimum (void)
void	ui_error_popup_key (keyboard_key_t key)
void	ui_error_popup_render (frame_buffer_t *out, terminal_size_t size)
void	ui_error_popup_reset (void)
void	ui_error_popup_preserve (int fd, terminal_size_t size)
void	ui_error_popup_flush (void)

Macro Definition Documentation

ERROR_POPUP_LINE_CAPACITY

#define ERROR_POPUP_LINE_CAPACITY   2048

Definition at line 17 of file error_popup.c.

TUI_ERROR_POPUP_ADDRESS_BUFFER_SIZE

#define TUI_ERROR_POPUP_ADDRESS_BUFFER_SIZE   40

Definition at line 9 of file error_popup.c.

TUI_ERROR_POPUP_CELL_BUFFER_SIZE

#define TUI_ERROR_POPUP_CELL_BUFFER_SIZE   1024

Definition at line 13 of file error_popup.c.

Referenced by ui_error_popup_preserve(), and ui_error_popup_render().

TUI_ERROR_POPUP_CODE_BUFFER_SIZE

#define TUI_ERROR_POPUP_CODE_BUFFER_SIZE   512

Definition at line 12 of file error_popup.c.

Referenced by ui_error_popup_preserve(), and ui_error_popup_render().

TUI_ERROR_POPUP_FILE_BUFFER_SIZE

#define TUI_ERROR_POPUP_FILE_BUFFER_SIZE   1024

Definition at line 6 of file error_popup.c.

TUI_ERROR_POPUP_FINAL_OUTPUT_BUFFER_SIZE

#define TUI_ERROR_POPUP_FINAL_OUTPUT_BUFFER_SIZE   65536

Definition at line 14 of file error_popup.c.

TUI_ERROR_POPUP_FUNCTION_BUFFER_SIZE

#define TUI_ERROR_POPUP_FUNCTION_BUFFER_SIZE   256

Definition at line 7 of file error_popup.c.

TUI_ERROR_POPUP_HEADING_BUFFER_SIZE

#define TUI_ERROR_POPUP_HEADING_BUFFER_SIZE   256

Definition at line 11 of file error_popup.c.

Referenced by ui_error_popup_render().

TUI_ERROR_POPUP_LINE_BUFFER_SIZE

#define TUI_ERROR_POPUP_LINE_BUFFER_SIZE   24

Definition at line 8 of file error_popup.c.

TUI_ERROR_POPUP_STYLE_BUFFER_SIZE

#define TUI_ERROR_POPUP_STYLE_BUFFER_SIZE   128

Definition at line 4 of file error_popup.c.

TUI_ERROR_POPUP_THREAD_BUFFER_SIZE

#define TUI_ERROR_POPUP_THREAD_BUFFER_SIZE   160

Definition at line 5 of file error_popup.c.

TUI_ERROR_POPUP_TITLE_BUFFER_SIZE

#define TUI_ERROR_POPUP_TITLE_BUFFER_SIZE   128

Definition at line 10 of file error_popup.c.

Referenced by ui_error_popup_render().

TUI_ERROR_POPUP_WRAPPED_BUFFER_SIZE

#define TUI_ERROR_POPUP_WRAPPED_BUFFER_SIZE   65536

Definition at line 3 of file error_popup.c.

Referenced by ui_error_popup_preserve().

Function Documentation

ui_error_popup_flush()

void ui_error_popup_flush

(

void

)

Write preserved terminal output after shutdown diagnostics, without allocating or using options.

Definition at line 458 of file error_popup.c.

                                {
  if (g_final_length)
    platform_write_all(g_final_fd, g_final_output, g_final_length);
  g_final_length = 0;
}

References platform_write_all().

Referenced by asciichat_shared_destroy().

ui_error_popup_key()

void ui_error_popup_key

(

keyboard_key_t

key

)

Definition at line 87 of file error_popup.c.

                                            {
  lock_state();
  refresh_locked();
  uint64_t dismiss = 0;
  size_t previous = g_selected;
  size_t previous_scroll = g_scroll;
  switch ((int)key) {
  case KEY_ESCAPE:
  case 'q':
  case '\r':
  case '\n':
    /* Dismiss all notifications currently shown.  The popup may receive the
     * first key before its presentation-thread snapshot has been rendered. */
    dismiss = UINT64_MAX;
    break;
  case KEY_LEFT:
    if (g_selected)
      --g_selected;
    break;
  case KEY_RIGHT:
    if (g_selected + 1 < g_count)
      ++g_selected;
    break;
  case KEY_HOME:
    g_selected = 0;
    break;
  case KEY_END:
    g_selected = g_count ? g_count - 1 : 0;
    break;
  case KEY_UP:
    if (g_scroll)
      --g_scroll;
    break;
  case KEY_DOWN:
    ++g_scroll;
    break;
  case KEY_PAGEUP:
    g_scroll = g_scroll > g_page_rows ? g_scroll - g_page_rows : 0;
    break;
  case KEY_PAGEDOWN:
    g_scroll += g_page_rows;
    break;
  default:
    break;
  }
  if (g_selected != previous)
    g_scroll = 0;
  size_t maximum = g_body_rows > g_page_rows ? g_body_rows - g_page_rows : 0;
  if (g_scroll > maximum)
    g_scroll = maximum;
  bool selection_changed = previous != g_selected;
  bool scrolled = previous_scroll != g_scroll && !selection_changed;
  unlock_state();
  if (selection_changed)
    ascii_otel_ui_usage("error", "selected", 0);
  if (scrolled)
    ascii_otel_ui_usage("error", "details_scrolled", 0);
  if (dismiss)
    ascii_otel_ui_usage("error", "dismissed", 0);
  if (dismiss)
    errno_notifications_dismiss(dismiss);
  ui_controller_redraw();
}

References ascii_otel_ui_usage(), errno_notifications_dismiss(), KEY_DOWN, KEY_END, KEY_ESCAPE, KEY_HOME, KEY_LEFT, KEY_PAGEDOWN, KEY_PAGEUP, KEY_RIGHT, KEY_UP, and ui_controller_redraw().

Referenced by ui_input_read_key().

ui_error_popup_minimum()

terminal_size_t ui_error_popup_minimum

(

void

)

Definition at line 83 of file error_popup.c.

                                             {
  return (terminal_size_t){.cols = 60, .rows = 14};
}

Referenced by ui_controller_state(), and ui_error_popup_render().

ui_error_popup_preserve()

void ui_error_popup_preserve	(	int	fd,
		terminal_size_t	size )

Preserve pending notifications using cached terminal dimensions before queue retirement. Callers own an interactive terminal and must prevent concurrent rendering. This formatter performs no console queries and does not wait for input.

Definition at line 395 of file error_popup.c.

                                                           {
  if (!errno_notifications_pending())
    return;
  asciichat_error_context_t entries[ASCIICHAT_ERRNO_HISTORY_SIZE];
  size_t count = errno_notifications_snapshot(entries, ARRAY_SIZE(entries), NULL);
  if (!count)
    return;
  bool previous = errno_notifications_suppress(true);
  frame_buffer_t *output = frame_buffer_create(0, 0);
  if (output) {
    bool colors = !GET_OPTION(strip_ansi) && terminal_should_color_output(fd, options_terminal_settings());
    bool unicode = terminal_should_use_utf8(GET_OPTION(force_utf8));
    int width = MIN(size.cols > 0 ? size.cols - 1 : 79, 100);
    width = MAX(width, 8);
    int body_width = width - 4;
    size_t first = count > 4 ? count - 4 : 0;
    frame_buffer_append(output, "\033[0m\033[?25h\r\n", 12);
    if (first)
      frame_buffer_printf(output, "%zu pending notifications; showing the latest 4.\n", count);
    for (size_t i = first; i < count; ++i) {
      char cell[TUI_ERROR_POPUP_CELL_BUFFER_SIZE], code[TUI_ERROR_POPUP_CODE_BUFFER_SIZE];
      const char *side = unicode ? "│" : "|";
      ui_popup_rule(output, width, UI_POPUP_TOP, false, unicode, LOG_COLOR_RESET);
      frame_buffer_append(output, "\n", 1);
      ui_text_cell(cell, sizeof(cell), "ERROR", body_width, UI_ALIGN_LEFT);
      frame_buffer_printf(output, "%s %s %s\n", side, colors ? colored_string(LOG_COLOR_ERROR, cell) : cell, side);
      format_error_heading(code, sizeof(code), &entries[i]);
      ui_text_cell(cell, sizeof(cell), code, body_width, UI_ALIGN_LEFT);
      frame_buffer_printf(output, "%s %s %s\n", side, cell, side);
      build_body(&entries[i], body_width, colors);
      for (size_t line = 0; line < g_line_count; ++line) {
        const char *start = g_wrapped + g_lines[line];
        const char *end = strchr(start, '\n');
        char line_text[TUI_ERROR_POPUP_WRAPPED_BUFFER_SIZE];
        size_t length = end ? (size_t)(end - start) : strlen(start);
        length = MIN(length, sizeof(line_text) - 1);
        memcpy(line_text, start, length);
        line_text[length] = '\0';
        ui_text_cell(cell, sizeof(cell), line_text, body_width, UI_ALIGN_LEFT);
        frame_buffer_printf(output, "%s %s%s %s\n", side, cell, colors ? "\033[0m" : "", side);
      }
      ui_popup_rule(output, width, UI_POPUP_BOTTOM, false, unicode, LOG_COLOR_RESET);
      frame_buffer_append(output, "\n", 1);
    }
    if (frame_buffer_get_length(output) <= sizeof(g_final_output)) {
      g_final_length = frame_buffer_get_length(output);
      memcpy(g_final_output, frame_buffer_get_content(output), g_final_length);
      g_final_fd = fd;
    } else {
      char message[ASCIICHAT_ERRNO_MESSAGE_MAX];
      sanitize(message, sizeof(message), entries[count - 1].context_message);
      int length = safe_snprintf(g_final_output, sizeof(g_final_output), "\nERROR\n%s (%d): %s\nDetails: %s\n",
                                 asciichat_error_name(entries[count - 1].code), entries[count - 1].code,
                                 asciichat_error_string(entries[count - 1].code), message);
      g_final_length = length > 0 ? MIN((size_t)length, sizeof(g_final_output) - 1) : 0;
      g_final_fd = fd;
    }
  }
  if (output)
    frame_buffer_destroy(output);
  errno_notifications_suppress(previous);
}

References ARRAY_SIZE, ASCIICHAT_ERRNO_HISTORY_SIZE, ASCIICHAT_ERRNO_MESSAGE_MAX, colored_string(), colors, errno_notifications_pending(), errno_notifications_snapshot(), errno_notifications_suppress(), frame_buffer_append(), frame_buffer_create(), frame_buffer_destroy(), frame_buffer_get_content(), frame_buffer_get_length(), frame_buffer_printf(), GET_OPTION, LOG_COLOR_ERROR, LOG_COLOR_RESET, MAX, MIN, options_terminal_settings, safe_snprintf(), TUI_ERROR_POPUP_CELL_BUFFER_SIZE, TUI_ERROR_POPUP_CODE_BUFFER_SIZE, TUI_ERROR_POPUP_WRAPPED_BUFFER_SIZE, UI_ALIGN_LEFT, UI_POPUP_BOTTOM, ui_popup_rule(), UI_POPUP_TOP, ui_text_cell(), and width.

Referenced by ui_controller_shutdown().

ui_error_popup_render()

void ui_error_popup_render	(	frame_buffer_t *	out,
		terminal_size_t	size )

Definition at line 312 of file error_popup.c.

                                                                      {
  asciichat_error_context_t error;
  lock_state();
  refresh_locked();
  size_t count = g_count, selected = g_selected;
  uint64_t displayed_latest = g_latest, dropped = g_dropped;
  if (count)
    error = g_entries[selected];
  unlock_state();
  if (!count)
    return;
  terminal_size_t minimum = ui_error_popup_minimum();
  frame_buffer_append(out, "\033[0m\033[?25l", 10);
  if (ui_too_small(size, minimum)) {
    ui_too_small_render(out, size, minimum);
    return;
  }
  lock_state();
  g_displayed_latest = displayed_latest;
  unlock_state();
  bool colors = !GET_OPTION(strip_ansi) &&
                terminal_should_color_output(frame_buffer_get_screen_output_fd(), options_terminal_settings());
  int width = MIN(size.cols - 4, 100);
  int body_width = width - 6;
  if (g_cached_id != error.error_id || g_cached_width != body_width || g_cached_color != colors)
    build_body(&error, body_width, colors);
  size_t desired_rows = g_trace_start ? MIN(g_line_count, g_trace_start + 12) : g_line_count;
  int body_rows = MIN(size.rows - 8, MIN(22, (int)desired_rows));
  size_t fixed_rows = g_trace_start && g_trace_start < (size_t)body_rows ? g_trace_start : 0;
  if (g_trace_start && !fixed_rows)
    body_rows = MIN(body_rows, 12);
  int height = body_rows + 6;
  int top = (size.rows - height) / 2 + 1, left = (size.cols - width) / 2 + 1;
  size_t scroll_rows = g_line_count - fixed_rows;
  size_t page_rows = (size_t)body_rows - fixed_rows;
  lock_state();
  g_body_rows = scroll_rows;
  g_page_rows = page_rows;
  size_t maximum = scroll_rows > page_rows ? scroll_rows - page_rows : 0;
  g_scroll = MIN(g_scroll, maximum);
  size_t scroll = g_scroll;
  unlock_state();
  ui_popup_frame(out, top, left, width, height, LOG_COLOR_RESET);
  char title[TUI_ERROR_POPUP_TITLE_BUFFER_SIZE];
  safe_snprintf(title, sizeof(title), "Error (%zu)   %zu of %zu%s", count, selected + 1, count,
                dropped ? " [older errors dropped]" : "");
  char heading[TUI_ERROR_POPUP_HEADING_BUFFER_SIZE];
  ui_text_cell(heading, sizeof(heading), title, width - 4, UI_ALIGN_LEFT);
  frame_buffer_printf(out, "\033[%d;%dH%s", top + 1, left + 2,
                      colors ? colored_string(LOG_COLOR_ERROR, heading) : heading);
  char code[TUI_ERROR_POPUP_CODE_BUFFER_SIZE], cell[TUI_ERROR_POPUP_CELL_BUFFER_SIZE];
  format_error_heading(code, sizeof(code), &error);
  ui_text_cell(cell, sizeof(cell), code, width - 4, UI_ALIGN_LEFT);
  frame_buffer_printf(out, "\033[%d;%dH%s", top + 2, left + 2, cell);
  for (int i = 0; i < body_rows; ++i) {
    size_t index = (size_t)i < fixed_rows ? (size_t)i : (size_t)i + scroll;
    if (index >= g_line_count)
      break;
    const char *start = g_wrapped + g_lines[index];
    const char *end = strchr(start, '\n');
    frame_buffer_printf(out, "\033[%d;%dH%.*s\033[0m", top + 4 + i, left + 2,
                        (int)(end ? end - start : (ptrdiff_t)strlen(start)), start);
  }
  ui_scrollbar_render(out, top + 4 + (int)fixed_rows, left + width - 3, (int)page_rows, scroll_rows, page_rows, scroll);
  const char *orange = colors ? ui_text_color_prefix(LOG_COLOR_DEV) : "";
  const char *reset = colors ? "\033[0m" : "";
  frame_buffer_printf(out, "\033[%d;%dH%s?%s Help", top + height - 2, left + 2, orange, reset);
  ui_button_t button = {.label = "Dismiss all", .shortcut = '\r'};
  ui_buttons_render(out, top + height - 2, left + 10, width - 20, &button, 1, 0);
}

References colored_string(), colors, asciichat_error_context_t::error_id, frame_buffer_append(), frame_buffer_get_screen_output_fd(), frame_buffer_printf(), GET_OPTION, height, index, LOG_COLOR_DEV, LOG_COLOR_ERROR, LOG_COLOR_RESET, MIN, options_terminal_settings, out, safe_snprintf(), TUI_ERROR_POPUP_CELL_BUFFER_SIZE, TUI_ERROR_POPUP_CODE_BUFFER_SIZE, TUI_ERROR_POPUP_HEADING_BUFFER_SIZE, TUI_ERROR_POPUP_TITLE_BUFFER_SIZE, UI_ALIGN_LEFT, ui_buttons_render(), ui_error_popup_minimum(), ui_popup_frame(), ui_scrollbar_render(), ui_text_cell(), ui_text_color_prefix(), ui_too_small(), ui_too_small_render(), and width.

ui_error_popup_reset()

void ui_error_popup_reset

(

void

)

Definition at line 383 of file error_popup.c.

                                {
  lock_state();
  g_count = g_selected = g_scroll = 0;
  g_latest = g_displayed_latest = g_dropped = 0;
  unlock_state();
  g_cached_id = 0;
}

Referenced by ui_controller_shutdown().

ui_error_popup_revision()

uint64_t ui_error_popup_revision

(

void

)

Definition at line 75 of file error_popup.c.

                                       {
  lock_state();
  refresh_locked();
  uint64_t revision = g_latest;
  unlock_state();
  return revision;
}

ui_error_popup_visible()

bool ui_error_popup_visible

(

void

)

Error notifications are an overlay, independent of the selected application screen.

Definition at line 71 of file error_popup.c.

                                  {
  return errno_notifications_pending();
}

References errno_notifications_pending().

Referenced by ui_controller_current_screen(), ui_input_read_key(), and update_banner_show_prompt().