prompt.h File Reference

Go to the source code of this file.

Functions
asciichat_error_t	ui_prompt_present (const char *prompt, const char *visible, size_t cursor, bool secret)
asciichat_error_t	ui_prompt_present_kind (const char *prompt, const char *visible, size_t cursor, bool secret, ui_prompt_kind_t kind)
const char *	ui_prompt_kind_name (ui_prompt_kind_t kind)
const char *	ui_prompt_usage_name (const void *snapshot)
void	ui_prompt_dismiss (int previous)
void	ui_prompt_remove (void)
const char *	ui_prompt_title (const void *snapshot)
int	ui_prompt_required_rows (const void *snapshot, int cols)
void	ui_media_panel_render (frame_buffer_t *buffer, terminal_size_t size, const char *title, const char *instruction, const char *text, size_t cursor)
asciichat_error_t	ui_media_loading_present (void)
asciichat_error_t	ui_password_prompt_present (const char *target, const char *masked, size_t cursor, size_t selected_button, bool incorrect, bool can_confirm, bool newline_limit)

Function Documentation

ui_media_loading_present()

asciichat_error_t ui_media_loading_present

(

void

)

Present the media-loading screen while capture resolves its next source.

Definition at line 332 of file prompt.c.

                                                 {
  return ui_controller_submit(UI_SCREEN_RENDER_PROGRESS, STDERR_FILENO, (terminal_size_t){.cols = 40, .rows = 8},
                              render_media_loading, "", 1);
}

References ui_controller_submit(), and UI_SCREEN_RENDER_PROGRESS.

ui_media_panel_render()

void ui_media_panel_render	(	frame_buffer_t *	buffer,
		terminal_size_t	size,
		const char *	title,
		const char *	instruction,
		const char *	text,
		size_t	cursor )

Shared centered media panel with the animated splash logo. NULL text shows loading.

Definition at line 72 of file prompt.c.

                                                            {
  bool compact = size.cols < 52;
  int logo_rows = compact ? 1 : 4;
  int lines = 1;
  if (text) {
    for (size_t i = 0; text[i]; ++i) {
      if (text[i] == '\n') {
        ++lines;
      }
    }
  }
  int available = size.rows - logo_rows - 5;
  if (available < 1)
    available = 1;
  int shown = text ? (lines < available ? lines : available) : 0;
  int height = logo_rows + 3 + (text ? 1 + shown : 0);
  int top = (size.rows - height) / 2 + 1;
  if (top < 1)
    top = 1;
  bool colors = !GET_OPTION(strip_ansi) &&
                terminal_should_color_output(frame_buffer_get_screen_output_fd(), options_terminal_settings());
  frame_buffer_append(buffer, "\033[0m\033[H\033[?25l", 13);
  frame_buffer_printf(buffer, "\033[%d;1H", top);
  const animation_sample_t *sample = ui_controller_animation_sample();
  int tick = sample ? (int)(sample->seconds * 60) : (int)((time_get_ns() / NS_PER_MS_INT / 16) % 100000);
  invitation_render_logo(buffer, size.cols, tick, colors, compact);
  media_center_line(buffer, title, top + logo_rows + 1, size.cols);
  media_center_line(buffer, instruction, top + logo_rows + 2, size.cols);
  if (!text) {
    media_panel_clear_background(buffer, size, top, logo_rows, 0);
    return;
  }
  int width = size.cols - 6;
  if (width > 76)
    width = 76;
  int longest = 20;
  const char *line = text;
  for (const char *p = text;; ++p) {
    if (!*p || *p == '\n') {
      int n = utf8_display_width_n(line, (size_t)(p - line));
      if (n > longest)
        longest = n;
      if (!*p)
        break;
      line = p + 1;
    }
  }
  if (longest < width)
    width = longest;
  int col = (size.cols - (width + 2)) / 2 + 1;
  for (int i = 0; i < shown; ++i)
    frame_buffer_printf(buffer, "\033[%d;1H\033[K", top + logo_rows + 4 + i);
  ui_input_render(buffer, top + logo_rows + 4, col, width, shown, text, cursor, true);
  media_panel_clear_background(buffer, size, top, logo_rows, shown);
}

References colors, frame_buffer_append(), frame_buffer_get_screen_output_fd(), frame_buffer_printf(), GET_OPTION, height, invitation_render_logo(), NS_PER_MS_INT, options_terminal_settings, animation_sample_t::seconds, ui_controller_animation_sample(), ui_input_render(), utf8_display_width_n(), and width.

ui_password_prompt_present()

asciichat_error_t ui_password_prompt_present	(	const char *	target,
		const char *	masked,
		size_t	cursor,
		size_t	selected_button,
		bool	incorrect,
		bool	can_confirm,
		bool	newline_limit )

The snapshot contains masked text only. Selection: confirm=0, cancel=1.

Definition at line 337 of file prompt.c.

                                                                 {
  if (!target || !masked || selected_button > 1)
    return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid password presentation");
  size_t target_bytes = strlen(target) + 1, masked_bytes = strlen(masked) + 1;
  size_t bytes = sizeof(prompt_snapshot_t) + target_bytes + masked_bytes;
  prompt_snapshot_t *s = SAFE_CALLOC(1, bytes, prompt_snapshot_t *);
  if (!s)
    return SET_ERRNO(ERROR_MEMORY, "Cannot allocate password presentation");
  s->prompt_bytes = target_bytes;
  s->cursor = cursor;
  s->selected_button = selected_button;
  s->kind = UI_PROMPT_PASSWORD;
  s->password_dialog = true;
  s->secret = true;
  s->incorrect = incorrect;
  s->can_confirm = can_confirm;
  s->newline_limit = newline_limit;
  s->color = !GET_OPTION(strip_ansi) && terminal_should_color_output(prompt_fd(), options_terminal_settings());
  memcpy(s->text, target, target_bytes);
  memcpy(s->text + target_bytes, masked, masked_bytes);
  asciichat_error_t result = ui_controller_submit(UI_SCREEN_PROMPT, prompt_fd(),
                                                  (terminal_size_t){.cols = 40, .rows = 19}, render_prompt, s, bytes);
  SAFE_FREE(s);
  return result;
}

References prompt_snapshot_t::can_confirm, prompt_snapshot_t::color, prompt_snapshot_t::cursor, ERROR_INVALID_PARAM, ERROR_MEMORY, GET_OPTION, prompt_snapshot_t::incorrect, prompt_snapshot_t::kind, prompt_snapshot_t::newline_limit, options_terminal_settings, prompt_snapshot_t::password_dialog, prompt_snapshot_t::prompt_bytes, SAFE_CALLOC, SAFE_FREE, prompt_snapshot_t::secret, prompt_snapshot_t::selected_button, SET_ERRNO, prompt_snapshot_t::text, ui_controller_submit(), and UI_SCREEN_PROMPT.

ui_prompt_dismiss()

void ui_prompt_dismiss

(

int

previous

)

Dismiss a prompt and restore its previous interactive owner, if still live.

Definition at line 301 of file prompt.c.

                                     {
  ui_controller_dismiss(UI_SCREEN_PROMPT, previous);
  if (!ui_controller_is_presenting())
    ui_controller_write(prompt_fd(), "\r\n", 2);
}

References ui_controller_dismiss(), ui_controller_is_presenting(), ui_controller_write(), and UI_SCREEN_PROMPT.

Referenced by ui_prompt_remove().

ui_prompt_kind_name()

const char * ui_prompt_kind_name

(

ui_prompt_kind_t

kind

)

Definition at line 235 of file prompt.c.

                                                       {
  switch (kind) {
  case UI_PROMPT_PASSWORD:
    return "password_prompt";
  case UI_PROMPT_MEDIA_INPUT:
    return "media_input_prompt";
  case UI_PROMPT_CONFIRMATION:
    return "confirmation_prompt";
  case UI_PROMPT_SSH_PASSPHRASE:
    return "ssh_passphrase_prompt";
  case UI_PROMPT_GPG_PASSPHRASE:
    return "gpg_passphrase_prompt";
  case UI_PROMPT_TRUST_HOST:
    return "trust_host_prompt";
  case UI_PROMPT_UNVERIFIED_HOST:
    return "unverified_host_prompt";
  case UI_PROMPT_DISCOVERY_KEY_CHANGE:
    return "discovery_key_change_prompt";
  case UI_PROMPT_IP_DISCLOSURE:
    return "ip_disclosure_prompt";
  case UI_PROMPT_CONFIG_OVERWRITE:
    return "config_overwrite_prompt";
  case UI_PROMPT_MANPAGE_OVERWRITE:
    return "manpage_overwrite_prompt";
  case UI_PROMPT_COMPLETION_OVERWRITE:
    return "completion_overwrite_prompt";
  default:
    return "input_prompt";
  }
}

Referenced by main(), and ui_prompt_usage_name().

ui_prompt_present()

asciichat_error_t ui_prompt_present	(	const char *	prompt,
		const char *	visible,
		size_t	cursor,
		bool	secret )

Only display-safe text crosses this boundary; never pass an unmasked password.

Definition at line 266 of file prompt.c.

                                                                                                         {
  return ui_prompt_present_kind(prompt, visible, cursor, secret, secret ? UI_PROMPT_PASSWORD : UI_PROMPT_INPUT);
}

References ui_prompt_present_kind().

ui_prompt_present_kind()

asciichat_error_t ui_prompt_present_kind	(	const char *	prompt,
		const char *	visible,
		size_t	cursor,
		bool	secret,
		ui_prompt_kind_t	kind )

Definition at line 270 of file prompt.c.

                                                                {
  size_t prompt_bytes = strlen(prompt) + 1;
  size_t visible_bytes = strlen(visible) + 1;
  prompt_snapshot_t *snapshot = SAFE_MALLOC(sizeof(*snapshot) + prompt_bytes + visible_bytes, prompt_snapshot_t *);
  if (!snapshot)
    return SET_ERRNO(ERROR_MEMORY, "Cannot allocate prompt presentation");
  snapshot->kind = kind;
  snapshot->password_dialog = snapshot->incorrect = snapshot->can_confirm = snapshot->newline_limit = false;
  snapshot->selected_button = 0;
  snapshot->prompt_bytes = prompt_bytes;
  snapshot->cursor = cursor;
  snapshot->secret = secret;
  snapshot->severity = ui_notice_prompt_severity();
  bool media = strncmp(prompt, "Open media:", 11) == 0;
  snapshot->color =
      !media && !GET_OPTION(strip_ansi) && terminal_should_color_output(prompt_fd(), options_terminal_settings());
  snapshot->unicode = !media && terminal_should_use_utf8(GET_OPTION(force_utf8));
  memcpy(snapshot->text, prompt, prompt_bytes);
  memcpy(snapshot->text + prompt_bytes, visible, visible_bytes);
  // Height is measured at the minimum width, so every larger terminal fits.
  terminal_size_t minimum = {.cols = 40,
                             .rows = ui_notice_render(NULL, prompt, snapshot->severity, 40, false, false) + 3};
  if (media)
    minimum.rows = 8;
  asciichat_error_t result = ui_controller_submit(UI_SCREEN_PROMPT, prompt_fd(), minimum, render_prompt, snapshot,
                                                  sizeof(*snapshot) + prompt_bytes + visible_bytes);
  SAFE_FREE(snapshot);
  return result;
}

References prompt_snapshot_t::can_confirm, prompt_snapshot_t::color, prompt_snapshot_t::cursor, ERROR_MEMORY, GET_OPTION, prompt_snapshot_t::incorrect, prompt_snapshot_t::kind, prompt_snapshot_t::newline_limit, options_terminal_settings, prompt_snapshot_t::password_dialog, prompt_snapshot_t::prompt_bytes, SAFE_FREE, SAFE_MALLOC, prompt_snapshot_t::secret, prompt_snapshot_t::selected_button, SET_ERRNO, prompt_snapshot_t::severity, prompt_snapshot_t::text, ui_controller_submit(), ui_notice_prompt_severity(), ui_notice_render(), UI_SCREEN_PROMPT, and prompt_snapshot_t::unicode.

Referenced by ui_input_media_begin(), ui_input_read_key(), and ui_prompt_present().

ui_prompt_remove()

void ui_prompt_remove

(

void

)

Remove an asynchronous prompt without restoring an earlier interactive view.

Definition at line 307 of file prompt.c.

                            {
  ui_prompt_dismiss(-1);
}

References ui_prompt_dismiss().

Referenced by session_handle_keyboard_input(), and ui_input_read_key().

ui_prompt_required_rows()

int ui_prompt_required_rows	(	const void *	snapshot,
		int	cols )

Definition at line 311 of file prompt.c.

                                                        {
  const prompt_snapshot_t *snapshot = data;
  if (snapshot->password_dialog) {
    int rows = 15 + password_lines(snapshot);
    return rows < 19 ? 19 : rows;
  }
  if (strncmp(snapshot->text, "Open media:", 11) == 0)
    return cols < 52 ? 8 : 11;
  return ui_notice_render(NULL, snapshot->text, snapshot->severity, cols, false, false) + 3;
}

References prompt_snapshot_t::password_dialog, prompt_snapshot_t::severity, prompt_snapshot_t::text, and ui_notice_render().

ui_prompt_title()

const char * ui_prompt_title

(

const void *

snapshot

)

Definition at line 183 of file prompt.c.

                                              {
  const prompt_snapshot_t *snapshot = data;
  if (strncmp(snapshot->text, "Open media:", 11) == 0)
    return "load file/url";
  if (strstr(snapshot->text, "(y/N)") || strstr(snapshot->text, "(Y/n)"))
    return "confirmation";
  if (snapshot->secret)
    return "password required";
  return "input";
}

References prompt_snapshot_t::secret, and prompt_snapshot_t::text.

ui_prompt_usage_name()

const char * ui_prompt_usage_name

(

const void *

snapshot

)

Definition at line 228 of file prompt.c.

                                                   {
  const prompt_snapshot_t *snapshot = data;
  if (!snapshot)
    return "input_prompt";
  return ui_prompt_kind_name(snapshot->kind);
}

References prompt_snapshot_t::kind, and ui_prompt_kind_name().