help_menu.h File Reference

Go to the source code of this file.

Data Structures
struct	ui_help_entry_t
struct	ui_help_menu_t
	ui help entry keeps the values that move through the subsystem: Keys Module, description. Some members are pointers into caller- or subsystem-owned memory, so lifetime follows the API that populated them rather than the struct copy itself. More...

Functions
terminal_size_t	ui_help_menu_measure (const ui_help_menu_t *menu)
bool	ui_help_menu_render (frame_buffer_t *output, terminal_size_t size, const ui_help_menu_t *menu)
void	ui_help_keys (char *output, size_t capacity, const char *keys)

Function Documentation

ui_help_keys()

void ui_help_keys	(	char *	output,
		size_t	capacity,
		const char *	keys )

Key tokens are yellow; spaces, slashes, parentheses and pipes stay uncolored.

Definition at line 25 of file help_menu.c.

                                                           {
  if (!out || !cap) {
    SET_ERRNO(ERROR_INVALID_PARAM, "Help keys require output storage");
    return;
  }
  size_t used = 0;
  out[0] = '\0';
  if (!keys)
    return;
  for (const char *p = keys; *p;) {
    if (used + 1 >= cap) {
      SET_ERRNO(ERROR_BUFFER_OVERFLOW, "Help key output buffer is too small");
      return;
    }
    if (*p == ' ' || *p == '/' || *p == '|' || *p == '(' || *p == ')') {
      out[used++] = *p++;
      out[used] = '\0';
    } else {
      const char *start = p;
      while (*p && *p != ' ' && *p != '/' && *p != '|' && *p != '(' && *p != ')')
        ++p;
      char key[UI_HELP_MENU_KEY_BUFFER_SIZE];
      if ((size_t)(p - start) >= sizeof(key)) {
        SET_ERRNO(ERROR_BUFFER_OVERFLOW, "Help key token is too long");
        return;
      }
      snprintf(key, sizeof(key), "%.*s", (int)(p - start), start);
      const char *styled = colored_string(LOG_COLOR_WARN, key);
      size_t length = strlen(styled);
      if (length >= cap - used) {
        SET_ERRNO(ERROR_BUFFER_OVERFLOW, "Help key output buffer is too small");
        return;
      }
      memcpy(out + used, styled, length + 1);
      used += length;
    }
  }
}

References colored_string(), ERROR_BUFFER_OVERFLOW, ERROR_INVALID_PARAM, LOG_COLOR_WARN, out, SET_ERRNO, and UI_HELP_MENU_KEY_BUFFER_SIZE.

Referenced by terminal_screen_logs_render_help(), and ui_help_menu_render().

ui_help_menu_measure()

terminal_size_t ui_help_menu_measure

(

const ui_help_menu_t *

menu

)

Definition at line 85 of file help_menu.c.

                                                              {
  if (!m || (m->count && !m->entries) || (m->settings_count && !m->settings)) {
    SET_ERRNO(ERROR_INVALID_PARAM, "Invalid help menu entries or settings");
    return (terminal_size_t){0};
  }
  int keys, left, right;
  measure(m, &keys, &left, &right);
  int width = left + (right ? right + 3 : 0);
  if (m->title && display_width(m->title) > width)
    width = display_width(m->title);
  if (m->footer && display_width(m->footer) > width)
    width = display_width(m->footer);
  size_t rows = m->count > m->settings_count ? m->count : m->settings_count;
  return (terminal_size_t){.cols = width + 6, .rows = (int)rows + 8 + m->top_margin};
}

References ui_help_menu_t::count, display_width(), ui_help_menu_t::entries, ERROR_INVALID_PARAM, ui_help_menu_t::footer, SET_ERRNO, ui_help_menu_t::settings, ui_help_menu_t::settings_count, ui_help_menu_t::title, ui_help_menu_t::top_margin, and width.

Referenced by ui_session_context_help_render(), and ui_session_help_render().

ui_help_menu_render()

bool ui_help_menu_render	(	frame_buffer_t *	output,
		terminal_size_t	size,
		const ui_help_menu_t *	menu )

Definition at line 101 of file help_menu.c.

                                                                                             {
  if (!out || !m || (m->count && !m->entries) || (m->settings_count && !m->settings) || m->count > 62 ||
      m->settings_count > 62) {
    SET_ERRNO(ERROR_INVALID_PARAM, "Invalid help output or entry counts");
    return false;
  }
  char text[UI_HELP_MENU_TEXT_COUNT][HELP_MENU_TEXT_LINE_BUFFER_SIZE];
  const char *lines[UI_HELP_MENU_TEXT_COUNT];
  size_t rows = m->count > m->settings_count ? m->count : m->settings_count;
  int keys, left, right;
  measure(m, &keys, &left, &right);
  lines[0] = "";
  for (size_t i = 0; i < rows; ++i) {
    char lhs[UI_HELP_MENU_LHS_BUFFER_SIZE] = "", rhs[UI_HELP_MENU_RHS_BUFFER_SIZE] = "",
         padded[UI_HELP_MENU_PADDED_BUFFER_SIZE];
    if (i < m->count) {
      const ui_help_entry_t *entry = &m->entries[i];
      if (!entry->keys)
        snprintf(lhs, sizeof(lhs), "%s", entry->description);
      else {
        char key[UI_HELP_MENU_KEY_EXTENDED_BUFFER_SIZE], description[UI_HELP_MENU_DESCRIPTION_BUFFER_SIZE];
        char styled_keys[UI_HELP_MENU_STYLED_KEYS_BUFFER_SIZE];
        ui_help_keys(styled_keys, sizeof(styled_keys), entry->keys);
        ui_text_cell(key, sizeof(key), styled_keys, keys, UI_ALIGN_LEFT);
        ui_text_values_style(description, sizeof(description), entry->description, LOG_COLOR_FATAL);
        snprintf(lhs, sizeof(lhs), "%s  %s", key, description);
      }
    }
    if (i < m->settings_count) {
      const char *setting = m->settings[i];
      const char *end = setting[0] == '(' ? strchr(setting, ')') : NULL;
      if (end) {
        char binding[UI_HELP_MENU_BINDING_BUFFER_SIZE], styled[UI_HELP_MENU_STYLED_BUFFER_SIZE];
        snprintf(binding, sizeof(binding), "%.*s", (int)(end + 1 - setting), setting);
        ui_help_keys(styled, sizeof(styled), binding);
        char values[UI_HELP_MENU_VALUES_BUFFER_SIZE];
        ui_text_values_style(values, sizeof(values), end + 1, LOG_COLOR_FATAL);
        snprintf(rhs, sizeof(rhs), "%s%s", styled, values);
      } else
        ui_text_values_style(rhs, sizeof(rhs), setting, LOG_COLOR_FATAL);
    }
    ui_text_cell(padded, sizeof(padded), lhs, left, UI_ALIGN_LEFT);
    snprintf(text[i], sizeof(text[i]), "%s%s%s", padded, right ? "   " : "", rhs);
    lines[i + 1] = text[i];
  }
  ui_popup_t box = {
      .title = m->title, .lines = lines, .line_count = rows + 1, .footer = m->footer, .top_margin = m->top_margin};
  return ui_popup_render(out, size, &box);
}

References ui_help_menu_t::count, ui_help_entry_t::description, ui_help_menu_t::entries, ERROR_INVALID_PARAM, ui_help_menu_t::footer, HELP_MENU_TEXT_LINE_BUFFER_SIZE, ui_help_entry_t::keys, LOG_COLOR_FATAL, out, SET_ERRNO, ui_help_menu_t::settings, ui_help_menu_t::settings_count, ui_help_menu_t::title, ui_help_menu_t::top_margin, UI_ALIGN_LEFT, ui_help_keys(), UI_HELP_MENU_BINDING_BUFFER_SIZE, UI_HELP_MENU_DESCRIPTION_BUFFER_SIZE, UI_HELP_MENU_KEY_EXTENDED_BUFFER_SIZE, UI_HELP_MENU_LHS_BUFFER_SIZE, UI_HELP_MENU_PADDED_BUFFER_SIZE, UI_HELP_MENU_RHS_BUFFER_SIZE, UI_HELP_MENU_STYLED_BUFFER_SIZE, UI_HELP_MENU_STYLED_KEYS_BUFFER_SIZE, UI_HELP_MENU_TEXT_COUNT, UI_HELP_MENU_VALUES_BUFFER_SIZE, ui_popup_render(), ui_text_cell(), and ui_text_values_style().

Referenced by terminal_screen_logs_render_help(), ui_session_context_help_render(), and ui_session_help_render().