Ncurses UI Implementation

UI implementation using the ncurses library. More...

Files
file	ui_ncurses.c
	Ncurses-based UI implementation.
file	ui_ncurses_draw.c
	Implementation of drawing functions for the ncurses UI backend.
file	ui_ncurses_input.c
	Input handling for ncurses-based UI.

Functions
int	ui_clear_screen (UiRuntime *ui)
	Clear the entire screen.
int	ui_cursor_enable (UiRuntime *ui, bool visible)
	Enable or disable the cursor visibility.
int	ui_cursor_move (UiSurface *s, int y, int x)
	Move the cursor within a UI surface.
int	ui_draw_border (UiSurface *s, UiBorderKind kind, const UiStyle *style)
	Draw a border around a UiSurface.This function draws a border around the UiSurface's window based on the specified UiBorderKind. It uses the ncurses box function to draw the border with the appropriate characters. If a style is provided, it applies that style before drawing the border.
int	ui_draw_box_title (UiSurface *s, int x, const UiStyle *style, const char *title)
	Draw a title on the top border of a UiSurface.This function draws the provided title string at the specified x-coordinate on the top border of the UiSurface's window. It uses the ncurses mvwaddstr function to place the title. If a style is provided, it applies that style before drawing the title.
int	ui_draw_hline (UiSurface *s, int y, int x, int len, const UiStyle *style)
	Draw a horizontal line on a UiSurface.This function uses the ncurses mvwhline function to draw a horizontal line of a specified length at the given (y, x) coordinates on the UiSurface's window. If a style is provided, it applies that style before drawing the line.
int	ui_draw_text (UiSurface *s, int y, int x, const UiStyle *style, const char *text)
	Draw text on a UiSurface at a specified position with a given style.This function uses the ncurses mvwaddstr function to draw the provided text at the specified (y, x) coordinates on the UiSurface's window. If a style is provided, it applies that style before drawing the text.
int	ui_draw_text_n (UiSurface *s, int y, int x, const UiStyle *style, const char *text, size_t n)
	Draw a specified number of characters from a string on a UiSurface.This function is similar to ui_draw_text but allows specifying the number of characters to draw from the provided string. It uses the ncurses mvwaddnstr function to achieve this. If a style is provided, it applies that style before drawing the text.
int	ui_draw_vline (UiSurface *s, int y, int x, int len, const UiStyle *style)
	Draw a vertical line on a UiSurface.This function uses the ncurses mvwvline function to draw a vertical line of a specified length at the given (y, x) coordinates on the UiSurface's window. If a style is provided, it applies that style before drawing the line.
int	ui_get_event (UiRuntime *ui, UiSurface *target, UiEvent *ev, int timeout_ms)
	Retrieves an input event from the specified UI surface.
void	ui_get_screen_size (UiRuntime *ui, int *rows, int *cols)
	Get the current screen size.
UiRuntime *	ui_init (const UiConfig *cfg)
	Initialize NCUrses.
int	ui_ncurses_color_pair_from_style (const UiStyle *style)
	Convert an RGB value (0-255) to a 1000-based value for ncurses.Ncurses uses a 1000-based color system, so we need to convert our 0-255 RGB values to that scale.
int	ui_ncurses_style_apply (WINDOW *win, const UiStyle *style)
	Apply a UiStyle to an ncurses window.This function sets the appropriate attributes (bold, underline, reverse) on the given ncurses window based on the properties of the UiStyle.
int	ui_render (UiRuntime *ui)
	Render the UI by updating panels and refreshing the screen.
int	ui_resume (UiRuntime *ui)
	Resume the UI after being suspended, reinitializing the screen.
void	ui_shutdown (UiRuntime *ui)
	Shutdown the UI runtime and free its resources.
int	ui_surface_clear (UiSurface *s)
	Clear the contents of a UI surface.
void	ui_surface_destroy (UiSurface *s)
	Destroy a UI surface and free its resources.
int	ui_surface_erase (UiSurface *s)
	Erase the contents of a UI surface.
int	ui_surface_hide (UiSurface *s)
	Hide a UI surface.
int	ui_surface_move (UiSurface *s, int y, int x)
	Move a UI surface to a new position.
UiSurface *	ui_surface_new (UiRuntime *ui, UiSurface *parent, UiRect rect)
	Create a new UI surface.
int	ui_surface_resize (UiSurface *s, int rows, int cols)
	Resize a UI surface to new dimensions.
int	ui_surface_set_base (UiSurface *s, const UiStyle *style, uint32_t fill_ch)
	Set the base fill character and style for a UiSurface.This function sets the background fill character for the UiSurface's ncurses window and applies the given UiStyle. If fill_ch is 0, it defaults to a space character.
int	ui_surface_set_style (UiSurface *s, const UiStyle *style)
	Set the style for a UiSurface.This function applies the given UiStyle to the ncurses window associated with the UiSurface. It uses the ui_ncurses_style_apply function to set the appropriate attributes on the window.
int	ui_surface_show (UiSurface *s)
	Show a UI surface.
int	ui_suspend (UiRuntime *ui)
	Suspend the UI, restoring the terminal to its normal state.

Detailed Description

UI implementation using the ncurses library.

This module provides functions for creating and managing UI surfaces, handling input, and rendering the UI using ncurses. It is designed to be used as part of a larger UI framework and can be extended with additional features as needed.

Function Documentation

ui_clear_screen()

int ui_clear_screen

(

UiRuntime *

ui

)

Clear the entire screen.

Parameters

ui	The UiRuntime instance.

Returns

0 on success, or -1 on failure.

Definition at line 284 of file ui_ncurses.c.

                                   {
    (void)ui;
    erase();
    return 0;
}

ui_cursor_enable()

int ui_cursor_enable	(	UiRuntime *	ui,
		bool	visible )

Enable or disable the cursor visibility.

Parameters

ui	The UiRuntime instance.
visible	true to show the cursor, false to hide it.

Returns

0 on success, or -1 on failure.

Definition at line 322 of file ui_ncurses.c.

                                                  {
    if (!ui)
        return -1;
    ui->cursor_visible = visible;
    curs_set(visible ? 1 : 0);
    return 0;
}

References UiRuntime::cursor_visible.

ui_cursor_move()

int ui_cursor_move	(	UiSurface *	s,
		int	y,
		int	x )

Move the cursor within a UI surface.

Parameters

s	The UiSurface to move the cursor in.
y	The new y-coordinate of the cursor.
x	The new x-coordinate of the cursor.

Returns

0 on success, or -1 on failure.

Definition at line 170 of file ui_ncurses.c.

                                               {
    if (!s)
        return -1;
    return wmove(s->win, y, x);
}

References UiSurface::win.

ui_draw_border()

int ui_draw_border	(	UiSurface *	s,
		UiBorderKind	kind,
		const UiStyle *	style )

Draw a border around a UiSurface.This function draws a border around the UiSurface's window based on the specified UiBorderKind. It uses the ncurses box function to draw the border with the appropriate characters. If a style is provided, it applies that style before drawing the border.

Parameters

s	The UiSurface on which to draw the border.
kind	The kind of border to draw (e.g., none, ASCII, light, rounded).
style	The UiStyle to apply to the border (can be NULL for default).

Returns

0 on success, -1 on failure (e.g., if s is NULL).

Definition at line 194 of file ui_ncurses_draw.c.

                                                                          {
    if (!s)
        return -1;
    if (style)
        ui_ncurses_style_apply(s->win, style);
 
    switch (kind) {
    case UI_BORDER_NONE:
        return 0;
    case UI_BORDER_ASCII:
        box(s->win, '|', '-');
        return 0;
    case UI_BORDER_LIGHT:
    case UI_BORDER_ROUNDED:
    default:
        box(s->win, 0, 0);
        return 0;
    }
}

References UI_BORDER_ASCII, UI_BORDER_LIGHT, UI_BORDER_NONE, UI_BORDER_ROUNDED, ui_ncurses_style_apply(), and UiSurface::win.

Here is the call graph for this function:

ui_draw_box_title()

int ui_draw_box_title	(	UiSurface *	s,
		int	x,
		const UiStyle *	style,
		const char *	title )

Draw a title on the top border of a UiSurface.This function draws the provided title string at the specified x-coordinate on the top border of the UiSurface's window. It uses the ncurses mvwaddstr function to place the title. If a style is provided, it applies that style before drawing the title.

Parameters

s	The UiSurface on which to draw the box title.
x	The x-coordinate (column) where the title should start.
style	The UiStyle to apply to the title (can be NULL for default).
title	The null-terminated string to use as the box title.

Returns

0 on success, -1 on failure (e.g., if s or title is NULL).

Definition at line 226 of file ui_ncurses_draw.c.

                                                                                    {
    if (!s || !title)
        return -1;
    if (style)
        ui_ncurses_style_apply(s->win, style);
    mvwaddstr(s->win, 0, x, title);
    return 0;
}

References ui_ncurses_style_apply(), and UiSurface::win.

Here is the call graph for this function:

ui_draw_hline()

int ui_draw_hline	(	UiSurface *	s,
		int	y,
		int	x,
		int	len,
		const UiStyle *	style )

Draw a horizontal line on a UiSurface.This function uses the ncurses mvwhline function to draw a horizontal line of a specified length at the given (y, x) coordinates on the UiSurface's window. If a style is provided, it applies that style before drawing the line.

Parameters

s	The UiSurface on which to draw the horizontal line.
y	The y-coordinate (row) where the line should be drawn.
x	The x-coordinate (column) where the line should start.
len	The length of the horizontal line to draw.
style	The UiStyle to apply to the line (can be NULL for default).

Returns

0 on success, -1 on failure (e.g., if s is NULL).

Definition at line 153 of file ui_ncurses_draw.c.

                                                                             {
    if (!s)
        return -1;
    if (style)
        ui_ncurses_style_apply(s->win, style);
    mvwhline(s->win, y, x, 0, len);
    return 0;
}

References ui_ncurses_style_apply(), and UiSurface::win.

Here is the call graph for this function:

ui_draw_text()

int ui_draw_text	(	UiSurface *	s,
		int	y,
		int	x,
		const UiStyle *	style,
		const char *	text )

Draw text on a UiSurface at a specified position with a given style.This function uses the ncurses mvwaddstr function to draw the provided text at the specified (y, x) coordinates on the UiSurface's window. If a style is provided, it applies that style before drawing the text.

Parameters

s	The UiSurface on which to draw the text.
y	The y-coordinate (row) where the text should be drawn.
x	The x-coordinate (column) where the text should be drawn.
style	The UiStyle to apply to the text (can be NULL for default).
text	The null-terminated string to draw.

Returns

0 on success, -1 on failure (e.g., if s or text is NULL).

Definition at line 109 of file ui_ncurses_draw.c.

                                                                                     {
    if (!s || !text)
        return -1;
    if (style)
        ui_ncurses_style_apply(s->win, style);
    mvwaddstr(s->win, y, x, text);
    return 0;
}

References ui_ncurses_style_apply(), and UiSurface::win.

Here is the call graph for this function:

ui_draw_text_n()

int ui_draw_text_n	(	UiSurface *	s,
		int	y,
		int	x,
		const UiStyle *	style,
		const char *	text,
		size_t	n )

Draw a specified number of characters from a string on a UiSurface.This function is similar to ui_draw_text but allows specifying the number of characters to draw from the provided string. It uses the ncurses mvwaddnstr function to achieve this. If a style is provided, it applies that style before drawing the text.

Parameters

s	The UiSurface on which to draw the text.
y	The y-coordinate (row) where the text should be drawn.
x	The x-coordinate (column) where the text should be drawn.
style	The UiStyle to apply to the text (can be NULL for default).
text	The string from which to draw characters (not necessarily null-terminated).
n	The number of characters to draw from the string.

Returns

0 on success, -1 on failure (e.g., if s or text is NULL).

Definition at line 132 of file ui_ncurses_draw.c.

                                                                                                 {
    if (!s || !text)
        return -1;
    if (style)
        ui_ncurses_style_apply(s->win, style);
    mvwaddnstr(s->win, y, x, text, (int)n);
    return 0;
}

References ui_ncurses_style_apply(), and UiSurface::win.

Here is the call graph for this function:

ui_draw_vline()

int ui_draw_vline	(	UiSurface *	s,
		int	y,
		int	x,
		int	len,
		const UiStyle *	style )

Draw a vertical line on a UiSurface.This function uses the ncurses mvwvline function to draw a vertical line of a specified length at the given (y, x) coordinates on the UiSurface's window. If a style is provided, it applies that style before drawing the line.

Parameters

s	The UiSurface on which to draw the vertical line.
y	The y-coordinate (row) where the line should start.
x	The x-coordinate (column) where the line should be drawn.
len	The length of the vertical line to draw.
style	The UiStyle to apply to the line (can be NULL for default).

Returns

0 on success, -1 on failure (e.g., if s is NULL).

Definition at line 174 of file ui_ncurses_draw.c.

                                                                             {
    if (!s)
        return -1;
    if (style)
        ui_ncurses_style_apply(s->win, style);
    mvwvline(s->win, y, x, 0, len);
    return 0;
}

References ui_ncurses_style_apply(), and UiSurface::win.

Here is the call graph for this function:

ui_get_event()

int ui_get_event	(	UiRuntime *	ui,
		UiSurface *	target,
		UiEvent *	ev,
		int	timeout_ms )

Retrieves an input event from the specified UI surface.

This function waits for an input event on the given UI surface (or the standard screen if no surface is specified) and fills the provided UiEvent structure with the details of the event. It handles both keyboard and mouse events.

Parameters

ui	The UI runtime context (unused in this implementation).
target	The UI surface to monitor for events, or NULL to use stdscr.
ev	A pointer to a UiEvent structure to be filled with event details.
timeout_ms	The maximum time to wait for an event in milliseconds, or -1 to wait indefinitely.

Returns

0 on success, or -1 on error (e.g., if ev is NULL).

Definition at line 108 of file ui_ncurses_input.c.

                                                                                {
    int ch;
    WINDOW *win;
 
    (void)ui;
    if (!ev)
        return -1;
    memset(ev, 0, sizeof(*ev));
 
    win = target ? target->win : stdscr;
 
    if (timeout_ms < 0) {
        wtimeout(win, -1);
    } else {
        wtimeout(win, timeout_ms);
    }
 
    ch = wgetch(win);
    ev->key = translate_key(ch);
 
    if (ev->key == UI_KEY_CHAR) {
        ev->ch = (uint32_t)ch;
    } else if (ev->key == UI_KEY_MOUSE) {
        MEVENT me;
        if (getmouse(&me) == OK) {
            ev->y = me.y;
            ev->x = me.x;
#ifdef BUTTON4_PRESSED
            if (me.bstate & BUTTON4_PRESSED) {
                ev->mouse_action = UI_MOUSE_SCROLL_UP;
#endif
#ifdef BUTTON5_PRESSED
            } else if (me.bstate & BUTTON5_PRESSED) {
                ev->mouse_action = UI_MOUSE_SCROLL_DOWN;
#endif
            } else if (me.bstate & BUTTON1_PRESSED) {
                ev->mouse_action = UI_MOUSE_PRESS;
            } else if (me.bstate & BUTTON1_RELEASED) {
                ev->mouse_action = UI_MOUSE_RELEASE;
            }
        }
    }
 
    return 0;
}

References UiEvent::ch, UiEvent::key, UiEvent::mouse_action, UI_KEY_CHAR, UI_KEY_MOUSE, UI_MOUSE_PRESS, UI_MOUSE_RELEASE, UI_MOUSE_SCROLL_DOWN, UI_MOUSE_SCROLL_UP, UiSurface::win, UiEvent::x, and UiEvent::y.

ui_get_screen_size()

void ui_get_screen_size	(	UiRuntime *	ui,
		int *	rows,
		int *	cols )

Get the current screen size.

Parameters

ui	The UiRuntime instance.
rows	Output parameter for the number of rows.
cols	Output parameter for the number of columns.

Definition at line 257 of file ui_ncurses.c.

                                                             {
    if (!ui)
        return;
    getmaxyx(stdscr, ui->rows, ui->cols);
    if (rows)
        *rows = ui->rows;
    if (cols)
        *cols = ui->cols;
}

References UiRuntime::cols, and UiRuntime::rows.

Referenced by bare_box_new().

Here is the caller graph for this function:

ui_init()

UiRuntime * ui_init

(

const UiConfig *

cfg

)

Initialize NCUrses.

Parameters

cfg	The UI runtime instance.

Returns

0 on success, or -1 on failure.

Definition at line 180 of file ui_ncurses.c.

                                        {
    UiRuntime *ui = calloc(1, sizeof(*ui));
    if (!ui)
        return NULL;
    char tty_name[XLEN];
 
    // Get the name of the terminal device
    if (ttyname_r(STDERR_FILENO, tty_name, sizeof(tty_name)) != 0) {
        Perror("ui_init: ttyname_r() failed");
        exit(EXIT_FAILURE);
    }
    // open the terminal device for NCurses input and output
    tty_fp = fopen(tty_name, "r+");
    if (tty_fp == nullptr) {
        Perror("ui_init: fopen() failed");
        exit(EXIT_FAILURE);
    }
    // newterm() allows us to specify a tty device for NCurses input and
    // output. nullptr for the first argument means to use the default terminal type.
    screen = newterm(nullptr, tty_fp, tty_fp);
    if (screen == nullptr) {
        Perror("ui_init: newterm() failed");
        exit(EXIT_FAILURE);
    }
    set_term(screen);
    f_curses_open = true;
    if (!has_colors()) {
        ui_shutdown(ui);
        Perror("Terminal does not support colors");
        exit(EXIT_FAILURE);
    }
    if (!can_change_color()) {
        ui_shutdown(ui);
        Perror("Terminal cannot change colors");
        exit(EXIT_FAILURE);
    }
    start_color();
    use_default_colors();
    cbreak();
    noecho();
    keypad(stdscr, TRUE);
    if (cfg) {
        ui->mouse_enabled = cfg->enable_mouse;
        ui->alt_screen = cfg->enable_alt_screen;
        ui->cursor_visible = cfg->cursor_visible;
    } else {
        ui->cursor_visible = true;
    }
    if (ui->mouse_enabled)
        mousemask(ALL_MOUSE_EVENTS | REPORT_MOUSE_POSITION, NULL);
    curs_set(ui->cursor_visible ? 1 : 0);
    getmaxyx(stdscr, ui->rows, ui->cols);
    win_ptr = -1;
    return ui;
}

References UiRuntime::alt_screen, UiRuntime::cols, UiConfig::cursor_visible, UiRuntime::cursor_visible, UiConfig::enable_alt_screen, UiConfig::enable_mouse, f_curses_open, UiRuntime::mouse_enabled, Perror(), UiRuntime::rows, screen, tty_fp, ui_shutdown(), and win_ptr.

Here is the call graph for this function:

ui_ncurses_color_pair_from_style()

int ui_ncurses_color_pair_from_style

(

const UiStyle *

style

)

Convert an RGB value (0-255) to a 1000-based value for ncurses.Ncurses uses a 1000-based color system, so we need to convert our 0-255 RGB values to that scale.

Parameters

v	The RGB value (0-255).

Returns

The corresponding 1000-based value for ncurses.

Convert a UiStyle to an ncurses color pair index.

This function maps the foreground and background colors from a UiStyle to an ncurses color pair index. For simplicity, this example assumes a limited set of colors and does not handle all possible combinations.

Parameters

style

The UiStyle containing the foreground and background colors.

Returns

The ncurses color pair index corresponding to the style.

Definition at line 32 of file ui_ncurses_draw.c.

                                                           {
    (void)style;
    return 0;
}

ui_ncurses_style_apply()

int ui_ncurses_style_apply	(	WINDOW *	win,
		const UiStyle *	style )

Apply a UiStyle to an ncurses window.This function sets the appropriate attributes (bold, underline, reverse) on the given ncurses window based on the properties of the UiStyle.

Parameters

win	The ncurses window to which the style should be applied.
style	The UiStyle containing the attributes to apply.

Returns

0 on success, -1 on failure (e.g., if win or style is NULL).

Definition at line 45 of file ui_ncurses_draw.c.

                                                              {
    if (!win || !style)
        return -1;
    wchar_t wstr[2] = {L'\0', L'\0'};
    cchar_t cc = {0};
    attr_t attrs = 0;
    uint32_t cpx = 0;
    attrs |= style->bold ? WA_BOLD : 0;
    attrs |= style->dim ? WA_DIM : 0;
    attrs |= style->italic ? WA_ITALIC : 0;
    attrs |= style->underline ? WA_UNDERLINE : 0;
    attrs |= style->blink ? WA_BLINK : 0;
    attrs |= style->reverse ? WA_REVERSE : 0;
    attrs |= style->invis ? WA_INVIS : 0;
    setcchar(&cc, wstr, attrs, cpx, nullptr);
    return 0;
}

References UiStyle::blink, UiStyle::bold, UiStyle::dim, UiStyle::invis, UiStyle::italic, UiStyle::reverse, and UiStyle::underline.

Referenced by ui_draw_border(), ui_draw_box_title(), ui_draw_hline(), ui_draw_text(), ui_draw_text_n(), ui_draw_vline(), ui_surface_set_base(), and ui_surface_set_style().

Here is the caller graph for this function:

ui_render()

int ui_render

(

UiRuntime *

ui

)

Render the UI by updating panels and refreshing the screen.

Parameters

ui	The UiRuntime instance.

Returns

0 on success, or -1 on failure.

Definition at line 272 of file ui_ncurses.c.

                             {
    (void)ui;
    update_panels();
    doupdate();
    return 0;
}

ui_resume()

int ui_resume

(

UiRuntime *

ui

)

Resume the UI after being suspended, reinitializing the screen.

Parameters

ui	The UiRuntime instance.

Returns

0 on success, or -1 on failure.

Definition at line 307 of file ui_ncurses.c.

                             {
    (void)ui;
    reset_prog_mode();
    refresh();
    update_panels();
    doupdate();
    return 0;
}

ui_shutdown()

void ui_shutdown

(

UiRuntime *

ui

)

Shutdown the UI runtime and free its resources.

Parameters

ui	The UiRuntime instance to shutdown.

Definition at line 240 of file ui_ncurses.c.

                                {
    if (!ui)
        return;
    // ui_surface_destroy  (ui->surface[0]);
    endwin();
    delscreen(screen);
    fclose(tty_fp);
    f_curses_open = false;
    free(ui);
}

References f_curses_open, screen, and tty_fp.

Referenced by ui_init().

Here is the caller graph for this function:

ui_surface_clear()

int ui_surface_clear

(

UiSurface *

s

)

Clear the contents of a UI surface.

Parameters

s	The UiSurface to clear.

Returns

0 on success, or -1 on failure.

Definition at line 119 of file ui_ncurses.c.

                                   {
    if (!s)
        return -1;
    wclear(s->win);
    return 0;
}

References UiSurface::win.

ui_surface_destroy()

void ui_surface_destroy

(

UiSurface *

s

)

Destroy a UI surface and free its resources.

Parameters

s	The UiSurface to destroy.

Definition at line 74 of file ui_ncurses.c.

                                      {
    if (!s)
        return;
    if (s->pan)
        del_panel(s->pan);
    if (s->win)
        delwin(s->win);
    free(s);
}

References UiSurface::pan, and UiSurface::win.

ui_surface_erase()

int ui_surface_erase

(

UiSurface *

s

)

Erase the contents of a UI surface.

Parameters

s	The UiSurface to erase.

Returns

0 on success, or -1 on failure.

Definition at line 131 of file ui_ncurses.c.

                                   {
    if (!s)
        return -1;
    werase(s->win);
    return 0;
}

References UiSurface::win.

ui_surface_hide()

int ui_surface_hide

(

UiSurface *

s

)

Hide a UI surface.

Parameters

s	The UiSurface to hide.

Returns

0 on success, or -1 on failure.

Definition at line 155 of file ui_ncurses.c.

                                  {
    if (!s)
        return -1;
    hide_panel(s->pan);
    s->hidden = true;
    return 0;
}

References UiSurface::hidden, and UiSurface::pan.

ui_surface_move()

int ui_surface_move	(	UiSurface *	s,
		int	y,
		int	x )

Move a UI surface to a new position.

Parameters

s	The UiSurface to move.
y	The new y-coordinate of the surface.
x	The new x-coordinate of the surface.

Returns

0 on success, or -1 on failure.

Definition at line 91 of file ui_ncurses.c.

                                                {
    if (!s)
        return -1;
    s->y = y;
    s->x = x;
    return move_panel(s->pan, y, x);
}

References UiSurface::pan, UiSurface::x, and UiSurface::y.

ui_surface_new()

UiSurface * ui_surface_new	(	UiRuntime *	ui,
		UiSurface *	parent,
		UiRect	rect )

Create a new UI surface.

*

Parameters

ui	The UI runtime instance.
parent	The parent surface, or NULL for a top-level surface.
rect	The rectangle defining the position and size of the surface.

Returns

A pointer to the newly created UiSurface, or NULL on failure.

Definition at line 37 of file ui_ncurses.c.

                                                                         {
    UiSurface *s = calloc(1, sizeof(*s));
    if (!s)
        return NULL;
 
    s->runtime = ui;
    s->parent = parent;
    s->y = rect.y;
    s->x = rect.x;
    s->rows = rect.rows;
    s->cols = rect.cols;
 
    if (parent && parent->win) {
        s->win = derwin(parent->win, rect.rows, rect.cols, rect.y, rect.x);
    } else {
        s->win = newwin(rect.rows, rect.cols, rect.y, rect.x);
    }
 
    if (!s->win) {
        free(s);
        return NULL;
    }
 
    s->pan = new_panel(s->win);
    if (!s->pan) {
        delwin(s->win);
        free(s);
        return NULL;
    }
 
    return s;
}

References UiRect::cols, UiSurface::cols, UiSurface::pan, UiSurface::parent, UiRect::rows, UiSurface::rows, UiSurface::runtime, UiSurface::win, UiRect::x, UiSurface::x, UiRect::y, and UiSurface::y.

ui_surface_resize()

int ui_surface_resize	(	UiSurface *	s,
		int	rows,
		int	cols )

Resize a UI surface to new dimensions.

Parameters

s	The UiSurface to resize.
rows	The new number of rows for the surface.
cols	The new number of columns for the surface.

Returns

0 on success, or -1 on failure.

Definition at line 106 of file ui_ncurses.c.

                                                        {
    if (!s)
        return -1;
    s->rows = rows;
    s->cols = cols;
    return wresize(s->win, rows, cols);
}

References UiSurface::cols, UiSurface::rows, and UiSurface::win.

ui_surface_set_base()

int ui_surface_set_base	(	UiSurface *	s,
		const UiStyle *	style,
		uint32_t	fill_ch )

Set the base fill character and style for a UiSurface.This function sets the background fill character for the UiSurface's ncurses window and applies the given UiStyle. If fill_ch is 0, it defaults to a space character.

Parameters

s	The UiSurface to set the base for.
style	The UiStyle to apply to the surface.
fill_ch	The character to use for filling the background (0 for space).

Returns

0 on success, -1 on failure (e.g., if s is NULL).

Definition at line 88 of file ui_ncurses_draw.c.

                                                                              {
    if (!s)
        return -1;
    if (style)
        ui_ncurses_style_apply(s->win, style);
    wbkgdset(s->win, (chtype)(fill_ch ? fill_ch : ' '));
    return 0;
}

References ui_ncurses_style_apply(), and UiSurface::win.

Here is the call graph for this function:

ui_surface_set_style()

int ui_surface_set_style	(	UiSurface *	s,
		const UiStyle *	style )

Set the style for a UiSurface.This function applies the given UiStyle to the ncurses window associated with the UiSurface. It uses the ui_ncurses_style_apply function to set the appropriate attributes on the window.

Parameters

s	The UiSurface whose style is to be set.
style	The UiStyle to apply to the surface.

Returns

0 on success, -1 on failure (e.g., if s or style is NULL).

Definition at line 72 of file ui_ncurses_draw.c.

                                                             {
    if (!s || !style)
        return -1;
    return ui_ncurses_style_apply(s->win, style);
}

References ui_ncurses_style_apply(), and UiSurface::win.

Here is the call graph for this function:

ui_surface_show()

int ui_surface_show

(

UiSurface *

s

)

Show a UI surface.

Parameters

s	The UiSurface to show.

Returns

0 on success, or -1 on failure.

Definition at line 143 of file ui_ncurses.c.

                                  {
    if (!s)
        return -1;
    show_panel(s->pan);
    s->hidden = false;
    return 0;
}

References UiSurface::hidden, and UiSurface::pan.

ui_suspend()

int ui_suspend

(

UiRuntime *

ui

)

Suspend the UI, restoring the terminal to its normal state.

Parameters

ui	The UiRuntime instance.

Returns

0 on success, or -1 on failure.

Definition at line 295 of file ui_ncurses.c.

                              {
    (void)ui;
    def_prog_mode();
    endwin();
    return 0;
}