session.c File Reference

Go to the source code of this file.

Data Structures
struct	ui_session
	This is the handoff point for ui session. Callers fill size, frame, media, logs before passing it on; consumers read the values during the operation and return ownership only where the member contract explicitly says they do. More...

Macros
#define	TUI_SESSION_DETAIL_BUFFER_SIZE   256
#define	TUI_SESSION_OFFSET_TEXT_BUFFER_SIZE   32
#define	PRESENTATION_TIME_HISTORY_COUNT   120

Functions
ui_session_t *	ui_session_create (void)
void	ui_session_destroy (ui_session_t *s)
void	ui_session_resize (ui_session_t *s, int cols, int rows)
void	ui_session_loading (ui_session_t *s, bool loading, const char *message)
void	ui_session_log (ui_session_t *s, const char *message)
asciichat_error_t	ui_session_media (ui_session_t *s, const char *data, size_t length)
ui_session_action_t	ui_session_input (ui_session_t *s, keyboard_key_t key)
int	ui_session_select_screen (uint32_t visible_screens)
bool	ui_session_is_covered (const ui_session_t *s)
size_t	ui_session_frame_length (const ui_session_t *s)
uint64_t	ui_session_next_frame_ns (const ui_session_t *s)
const char *	ui_session_render (ui_session_t *s, const ui_session_view_t *view, uint64_t now_ns)
void	ui_session_logs_render (frame_buffer_t *output, terminal_size_t size, ui_session_t *s)
bool	ui_session_logs_key (keyboard_key_t key)
const char *	ui_session_tick (ui_session_t *s, uint64_t now_ns)
void	ui_session_clear (ui_session_t *s)
terminal_size_t	ui_session_size (const ui_session_t *s)
void	ui_session_redraw (ui_session_t *s)
void	ui_session_capture_logs (ui_session_t *s)

Macro Definition Documentation

PRESENTATION_TIME_HISTORY_COUNT

#define PRESENTATION_TIME_HISTORY_COUNT   120

Definition at line 7 of file lib/tui/session.c.

TUI_SESSION_DETAIL_BUFFER_SIZE

#define TUI_SESSION_DETAIL_BUFFER_SIZE   256

Definition at line 3 of file lib/tui/session.c.

Referenced by ui_session_logs_render().

TUI_SESSION_OFFSET_TEXT_BUFFER_SIZE

#define TUI_SESSION_OFFSET_TEXT_BUFFER_SIZE   32

Definition at line 4 of file lib/tui/session.c.

Referenced by ui_session_logs_render().

Function Documentation

ui_session_capture_logs()

void ui_session_capture_logs

(

ui_session_t *

session

)

Attach this instance to the module's existing C logger. Detaches on destruction.

Definition at line 375 of file lib/tui/session.c.

                                              {
  if (s)
    log_set_session_log_buffer(s->logs);
}

References log_set_session_log_buffer(), and ui_session::logs.

Referenced by SessionUiBinding::SessionUiBinding().

ui_session_clear()

void ui_session_clear

(

ui_session_t *

s

)

Definition at line 357 of file lib/tui/session.c.

                                       {
  if (s) {
    frame_buffer_reset(s->media);
    s->help = false;
    s->show_logs = false;
    s->dirty = true;
  }
}

References ui_session::dirty, frame_buffer_reset(), ui_session::help, ui_session::media, and ui_session::show_logs.

Referenced by SessionUiBinding::clear().

ui_session_create()

ui_session_t * ui_session_create

(

void

)

Definition at line 46 of file lib/tui/session.c.

                                      {
  ui_session_t *s = SAFE_CALLOC(1, sizeof(*s), ui_session_t *);
  if (!s)
    return NULL;
  s->frame = frame_buffer_create(24, 80);
  s->media = frame_buffer_create(24, 80);
  s->logs = log_get_history_buffer();
  s->owns_logs = !s->logs;
  if (s->owns_logs)
    s->logs = session_log_buffer_create();
  if (!s->frame || !s->media || !s->logs) {
    ui_session_destroy(s);
    return NULL;
  }
  s->started = time(NULL);
  log_search_init();
  s->size = (terminal_size_t){.cols = 80, .rows = 24};
  s->active = -1;
  s->saved_volume = 1;
  s->dirty = true;
  s->splash.use_colors = true;
  animation_init(&s->animation, "session_splash",
                 (animation_config_t){
                     .type = ANIMATION_SPLASH_RAINBOW, .fps = 60, .speed = 1, .hidden_policy = ANIMATION_HIDDEN_PAUSE});
  return s;
}

References ui_session::active, ui_session::animation, animation_init(), ui_session::dirty, ui_session::frame, frame_buffer_create(), log_get_history_buffer(), log_search_init(), ui_session::logs, ui_session::media, ui_session::owns_logs, SAFE_CALLOC, ui_session::saved_volume, session_log_buffer_create(), ui_session::size, ui_session::splash, ui_session::started, ui_session_destroy(), and ui_splash_view_t::use_colors.

Referenced by SessionUiBinding::SessionUiBinding().

ui_session_destroy()

void ui_session_destroy

(

ui_session_t *

s

)

Definition at line 73 of file lib/tui/session.c.

                                         {
  if (!s)
    return;
  if (log_get_session_log_buffer() == s->logs)
    log_clear_session_log_buffer();
  animation_destroy(&s->animation);
  frame_buffer_destroy(s->frame);
  frame_buffer_destroy(s->media);
  if (s->owns_logs)
    session_log_buffer_destroy(s->logs);
  SAFE_FREE(s);
}

References ui_session::animation, animation_destroy(), ui_session::frame, frame_buffer_destroy(), log_clear_session_log_buffer(), log_get_session_log_buffer(), ui_session::logs, ui_session::media, ui_session::owns_logs, SAFE_FREE, and session_log_buffer_destroy().

Referenced by ui_controller_shutdown(), ui_session_create(), and SessionUiBinding::~SessionUiBinding().

ui_session_frame_length()

size_t ui_session_frame_length

(

const ui_session_t *

s

)

Definition at line 165 of file lib/tui/session.c.

                                                      {
  size_t length = s ? frame_buffer_get_length(s->frame) : 0;
  return length ? length - 1 : 0;
}

References ui_session::frame, and frame_buffer_get_length().

ui_session_input()

ui_session_action_t ui_session_input	(	ui_session_t *	s,
		keyboard_key_t	key )

Definition at line 129 of file lib/tui/session.c.

                                                                          {
  if (!s)
    return UI_ACTION_NONE;
  if (s->show_logs && ui_session_logs_key_sized(key, s->size)) {
    s->dirty = true;
    return UI_ACTION_LOGS;
  }
  ui_session_action_t action = ui_session_key(key, &s->saved_volume);
  if (action == UI_ACTION_HELP) {
    s->help = !s->help;
    s->show_logs = false;
  } else if (action == UI_ACTION_LOGS) {
    s->show_logs = !s->show_logs;
    s->help = false;
  } else if (action == UI_ACTION_CLOSE && s->show_logs) {
    s->show_logs = false;
    action = UI_ACTION_LOGS;
  } else if (action == UI_ACTION_CLOSE && s->help) {
    s->help = false;
    action = UI_ACTION_HELP;
  }
  s->dirty |= action != UI_ACTION_NONE;
  return action;
}

References action, ui_session::dirty, ui_session::help, ui_session::saved_volume, ui_session::show_logs, ui_session::size, UI_ACTION_CLOSE, UI_ACTION_HELP, UI_ACTION_LOGS, UI_ACTION_NONE, and ui_session_key().

Referenced by SessionUiBinding::key().

ui_session_is_covered()

bool ui_session_is_covered

(

const ui_session_t *

s

)

Definition at line 161 of file lib/tui/session.c.

                                                  {
  return s && s->covered;
}

References ui_session::covered.

ui_session_loading()

void ui_session_loading	(	ui_session_t *	s,
		bool	loading,
		const char *	message )

Definition at line 97 of file lib/tui/session.c.

                                                                            {
  if (!s)
    return;
  if (loading != s->loading) {
    s->loading = loading;
    animation_reset(&s->animation);
    s->dirty = true;
  }
  if (message && strcmp(message, s->splash.connection_target)) {
    SAFE_STRNCPY(s->splash.connection_target, message, sizeof(s->splash.connection_target));
    s->dirty = true;
  }
}

References ui_session::animation, animation_reset(), ui_splash_view_t::connection_target, ui_session::dirty, ui_session::loading, SAFE_STRNCPY, and ui_session::splash.

Referenced by SessionUiBinding::loading().

ui_session_log()

void ui_session_log	(	ui_session_t *	s,
		const char *	message )

Definition at line 111 of file lib/tui/session.c.

                                                          {
  if (s && message) {
    session_log_buffer_append(s->logs, message);
    s->dirty = true;
  }
}

References ui_session::dirty, ui_session::logs, and session_log_buffer_append().

Referenced by SessionUiBinding::log().

ui_session_logs_key()

bool ui_session_logs_key

(

keyboard_key_t

key

)

Existing server log-search controls; true when consumed.

Definition at line 296 of file lib/tui/session.c.

                                             {
  return ui_session_logs_key_sized(key, ui_controller_size());
}

References ui_controller_size().

ui_session_logs_render()

void ui_session_logs_render	(	frame_buffer_t *	output,
		terminal_size_t	size,
		ui_session_t *	session )

Shared live log view, used by the native adapter and browser compositor.

Definition at line 244 of file lib/tui/session.c.

                                                                                           {
  char detail[TUI_SESSION_DETAIL_BUFFER_SIZE];
  size_t offset = terminal_screen_logs_offset();
  char offset_text[TUI_SESSION_OFFSET_TEXT_BUFFER_SIZE];
  snprintf(offset_text, sizeof(offset_text), "%zu", offset);
  const char *colored_offset = colored_string(LOG_COLOR_FATAL, offset_text);
  snprintf(detail, sizeof(detail), "%s | %s rows from tail", ui_status_log_controls(), colored_offset);
  ui_status_t status = {.mode_name = "", .start_time = s->started, .detail = detail};
  terminal_screen_config_t config = {
      .fixed_header_lines = 4, .render_header = ui_status_render_header, .user_data = &status, .show_logs = true};
  terminal_screen_compose(output, size, &config, s->logs);
}

References colored_string(), LOG_COLOR_FATAL, ui_session::logs, ui_session::started, terminal_screen_compose(), terminal_screen_logs_offset(), TUI_SESSION_DETAIL_BUFFER_SIZE, TUI_SESSION_OFFSET_TEXT_BUFFER_SIZE, ui_status_log_controls(), and ui_status_render_header().

ui_session_media()

asciichat_error_t ui_session_media	(	ui_session_t *	s,
		const char *	data,
		size_t	length )

Definition at line 118 of file lib/tui/session.c.

                                                                                     {
  if (!s || !data || length > UI_CONTROLLER_MAX_FRAME_BYTES)
    return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid session media frame");
  frame_buffer_reset(s->media);
  frame_buffer_append(s->media, data, length);
  s->dirty = true;
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, ui_session::dirty, ERROR_INVALID_PARAM, frame_buffer_append(), frame_buffer_reset(), ui_session::media, SET_ERRNO, and UI_CONTROLLER_MAX_FRAME_BYTES.

Referenced by SessionUiBinding::media().

ui_session_next_frame_ns()

uint64_t ui_session_next_frame_ns

(

const ui_session_t *

session

)

Next visible animation deadline, or UINT64_MAX while animation is paused/hidden.

Definition at line 170 of file lib/tui/session.c.

                                                         {
  return s && s->animation.started ? s->splash.animation.next_frame_ns : UINT64_MAX;
}

References ui_session::animation, ui_splash_view_t::animation, animation_sample_t::next_frame_ns, ui_session::splash, and animation_t::started.

ui_session_redraw()

void ui_session_redraw

(

ui_session_t *

s

)

Definition at line 370 of file lib/tui/session.c.

                                        {
  if (s)
    s->dirty = true;
}

References ui_session::dirty.

Referenced by SessionUiBinding::redraw(), and ui_controller_redraw().

ui_session_render()

const char * ui_session_render	(	ui_session_t *	session,
		const ui_session_view_t *	view,
		uint64_t	now_ns )

Present a host view through the same compositor used by ui_session_tick(). A screen of -1 hides presentation. NULL means no redraw is required.

Definition at line 174 of file lib/tui/session.c.

                                                                                               {
  if (!s || !view)
    return NULL;
  bool changed = s->active != view->screen;
  s->active = view->screen;
  bool covered = view->screen >= 0 && ui_too_small(s->size, view->minimum);
  bool transition = changed || covered != s->covered || s->size.cols != s->presented_size.cols ||
                    s->size.rows != s->presented_size.rows || view->minimum.cols != s->minimum.cols ||
                    view->minimum.rows != s->minimum.rows;
  s->covered = covered;
  bool visible =
      (view->screen == UI_SCREEN_SPLASH || view->screen == UI_SCREEN_HELP || view->screen == UI_SCREEN_MDNS) &&
      !covered;
  if (visible != s->animation.visible) {
    // Account for the elapsed interval under the old visibility before changing
    // it, so resuming after an idle modal does not advance a paused animation.
    if (animation_update(&s->animation, now_ns, &s->splash.animation) != ASCIICHAT_OK)
      return NULL;
    animation_set_visible(&s->animation, visible);
  }
  if (animation_update(&s->animation, now_ns, &s->splash.animation) != ASCIICHAT_OK)
    return NULL;
  if (view->screen < 0 || !view->draw)
    return NULL;
  bool animated = visible && s->splash.animation.changed;
  bool refresh = view->refresh_ns && now_ns - s->last_render_ns >= view->refresh_ns;
  if (covered ? !(transition || s->dirty) : !(transition || s->dirty || view->dirty || animated || refresh))
    return NULL;
  s->dirty = false;
  s->presented_size = s->size;
  s->minimum = view->minimum;
  s->last_render_ns = now_ns;
  frame_buffer_reset(s->frame);
  if (transition || view->clear) {
    frame_buffer_append(s->frame, "\033[0m", 4);
    frame_buffer_clear_screen(s->frame);
  }
  if (covered)
    ui_too_small_render(s->frame, s->size, view->minimum);
  else {
    if (view->screen == UI_SCREEN_HELP) {
      int top = (s->size.rows - view->minimum.rows) / 2;
      terminal_color_mode_t mode = GET_OPTION(color_mode);
      bool colors = mode != TERM_COLOR_NONE && GET_OPTION(color) != COLOR_SETTING_FALSE && !GET_OPTION(strip_ansi) &&
                    (mode != TERM_COLOR_AUTO ||
                     detect_terminal_capabilities(options_terminal_settings()).color_level != TERM_COLOR_NONE);
      frame_buffer_printf(s->frame, "\033[%d;1H", top + 2);
      invitation_render_logo(s->frame, s->size.cols, (int)(s->splash.animation.seconds * 60), colors, false);
    }
    view->draw(s->frame, s->size, &s->splash.animation, view->context);
  }
  frame_buffer_append(s->frame, "\0", 1);
  return frame_buffer_get_content(s->frame);
}

References ui_session::active, ui_session::animation, ui_splash_view_t::animation, animation_set_visible(), animation_update(), ASCIICHAT_OK, animation_sample_t::changed, ui_session_view_t::clear, color_mode, COLOR_SETTING_FALSE, colors, ui_session_view_t::context, ui_session::covered, ui_session::dirty, ui_session_view_t::dirty, ui_session_view_t::draw, ui_session::frame, frame_buffer_append(), frame_buffer_clear_screen(), frame_buffer_get_content(), frame_buffer_printf(), frame_buffer_reset(), GET_OPTION, invitation_render_logo(), ui_session::last_render_ns, ui_session::minimum, ui_session_view_t::minimum, options_terminal_settings, ui_session::presented_size, ui_session_view_t::refresh_ns, ui_session_view_t::screen, animation_sample_t::seconds, ui_session::size, ui_session::splash, UI_SCREEN_HELP, UI_SCREEN_MDNS, UI_SCREEN_SPLASH, ui_too_small(), ui_too_small_render(), and animation_t::visible.

Referenced by ui_session_tick().

ui_session_resize()

void ui_session_resize	(	ui_session_t *	s,
		int	cols,
		int	rows )

Definition at line 86 of file lib/tui/session.c.

                                                            {
  if (!s || cols < 1 || rows < 1 || cols > 4096 || rows > 4096) {
    SET_ERRNO(ERROR_INVALID_PARAM, "Invalid TUI session or terminal dimensions");
    return;
  }
  if (cols != s->size.cols || rows != s->size.rows) {
    s->size = (terminal_size_t){.cols = cols, .rows = rows};
    s->dirty = true;
  }
}

References ui_session::dirty, ERROR_INVALID_PARAM, SET_ERRNO, and ui_session::size.

Referenced by SessionUiBinding::resize().

ui_session_select_screen()

int ui_session_select_screen

(

uint32_t

visible_screens

)

Highest visible screen from the common priority order, or -1.

Definition at line 154 of file lib/tui/session.c.

                                                       {
  for (int screen = UI_SCREEN_COUNT - 1; screen >= 0; --screen)
    if (visible_screens & (1u << screen))
      return screen;
  return -1;
}

References UI_SCREEN_COUNT.

Referenced by ui_session_tick().

ui_session_size()

terminal_size_t ui_session_size

(

const ui_session_t *

s

)

Definition at line 366 of file lib/tui/session.c.

                                                       {
  return s ? s->size : (terminal_size_t){.cols = 80, .rows = 24};
}

References ui_session::size.

Referenced by ui_controller_size().

ui_session_tick()

const char * ui_session_tick	(	ui_session_t *	session,
		uint64_t	now_ns )

No sleeps or I/O. Returned frame remains valid until the next call. NULL means unchanged.

Definition at line 319 of file lib/tui/session.c.

                                                              {
  if (!s)
    return NULL;
  if (!s->dirty && !s->show_logs && !s->help && !s->loading && s->active == UI_SCREEN_MEDIA)
    return NULL;
  uint32_t visible = 1u << UI_SCREEN_MEDIA;
  if (s->loading)
    visible |= 1u << UI_SCREEN_SPLASH;
  if (s->show_logs)
    visible |= 1u << UI_SCREEN_LOGS;
  if (s->help)
    visible |= 1u << UI_SCREEN_HELP;
  ui_session_view_t view = {
      .screen = ui_session_select_screen(visible), .minimum = {1, 1}, .clear = !s->help, .context = s};
  char *help = NULL;
  if (view.screen == UI_SCREEN_HELP) {
    help = ui_session_help_render(s->size, true, true, &view.minimum);
    if (!help)
      return NULL;
    view.draw = draw_help;
    view.context = help;
  } else if (view.screen == UI_SCREEN_LOGS) {
    view.minimum = (terminal_size_t){.cols = 40, .rows = 6};
    view.refresh_ns = 100000000;
    view.draw = draw_logs;
  } else if (view.screen == UI_SCREEN_SPLASH) {
    view.minimum = (terminal_size_t){.cols = 52, .rows = 10};
    view.draw = draw_splash;
  } else {
    view.draw = draw_media;
    if (s->dirty && frame_buffer_get_length(s->media))
      s->presentation_times[s->presentation_index++ % 120] = now_ns;
  }
  const char *frame = ui_session_render(s, &view, now_ns);
  ui_session_help_free(help);
  return frame;
}

References ui_session::active, ui_session_view_t::context, ui_session::dirty, ui_session_view_t::draw, frame_buffer_get_length(), ui_session::help, ui_session::loading, ui_session::media, ui_session_view_t::minimum, ui_session::presentation_index, ui_session::presentation_times, ui_session_view_t::refresh_ns, ui_session_view_t::screen, ui_session::show_logs, ui_session::size, UI_SCREEN_HELP, UI_SCREEN_LOGS, UI_SCREEN_MEDIA, UI_SCREEN_SPLASH, ui_session_help_free(), ui_session_help_render(), ui_session_render(), and ui_session_select_screen().

Referenced by SessionUiBinding::tick().