ui_ncurses.c File Reference

NCurses UI backend — lifecycle, surface management, and capabilities. More...

#include "cm.h"
#include "ui_ncurses_internal.h"
#include <locale.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

Include dependency graph for ui_ncurses.c:

Go to the source code of this file.

Macros
#define	_XOPEN_SOURCE_EXTENDED   1

Functions
void	fast_exit (UiSurface *s)
	Exit the UI application quickly, cleaning up resources.
uint	ui__mbstr_to_cellstr (UiCell *cmplx_buf, const char *str, const UiCell *cell_base, uint *p, const uint atmost)
uint	ui_add_pair (uint fg, uint bg)
	Add a new color pair to the UI, or retrieve the index of an existing pair.
int	ui_bkgd (UiSurface *s, ss_t w, const UiCell *cell)
	Set the background of a specific window within a UiSurface.
int	ui_bkgdset (UiSurface *s, ss_t w, const UiCell *cell)
	Set the background for new content to be written to a specific window within a UiSurface.
int	ui_bkgrnd (UiSurface *s, ss_t w, const UiCell *cell)
	Set the background of a specific window within a UiSurface.
int	ui_bkgrndset (UiSurface *s, ss_t w, const UiCell *cell)
	Set the background for new content to be written to a specific window within a UiSurface.
UiCell	ui_cell_from_ucp (const wchar_t *ucp, const uint32_t *fg, const uint32_t *bg)
	Convert a Unicode code point to a curses UiCell with specified foreground and background colors.
int	ui_chg_color (uint16_t color_idx, uint32_t *color)
	Change the RGB color value for a given color index.
int	ui_chg_pair (uint pair, uint fg, uint bg)
	Change the foreground and background colors of an existing color pair.
int	ui_clear ()
	Clear the entire screen.
int	ui_color_content (uint color, uint *r, uint *g, uint *b)
int	ui_color_from_rgb (RGB *rgb)
	Convert RGB to curses color index, adding new color if necessary.
int	ui_curs_set (int visibility)
	Set the visibility of the cursor.
int	ui_cursor_enable (UiSurface *s, ss_t w, bool visible)
	Enable or disable the cursor for a UiSurface.
int	ui_cursor_enable_yx (UiSurface *s, ss_t w, uint y, uint x, bool visible)
	Enable or disable the cursor at a specific position within a UiSurface.
int	ui_cursor_move (UiSurface *s, ss_t w, uint y, uint x)
	Move the cursor to a specified position within a UiSurface.
void	ui_def_prog_mode ()
void	ui_destroy_curses ()
int	ui_doupdate ()
	Refresh the display by updating the screen.
void	ui_endwin ()
	End the UI application, cleaning up resources and shutting down the UI runtime.
int	ui_erase ()
	Erase the entire screen.
UiBackend	ui_get_backend ()
	Get the UI backend type.
void	ui_get_caps (UiCaps *caps)
	Get the UI backend capabilities.
uint32_t	ui_get_color (uint16_t color_idx)
	Get the RGB color value for a given color index.
void	ui_get_screen_size (uint *lines, uint *cols)
	Get the current screen size (number of lines and columns).
int	ui_getcchar (const UiCell *cell, wchar_t *wstr, attr_t *attrs, short *pair, const void *opts)
	Get the character and attributes from a UiCell.
int	ui_getmaxx (UiSurface *s, ss_t w)
	Get the maximum number of columns of a UiSurface.
int	ui_getmaxy (UiSurface *s, ss_t w)
	Get the maximum number of lines (rows) of a UiSurface.
void	ui_getmaxyx (UiSurface *s, ss_t w, uint *lines, uint *cols)
	Get the maximum dimensions of a UiSurface.
void	ui_getyx (UiSurface *s, ss_t w, uint *lines, uint *cols)
	Get the current cursor position within a window of a UI surface.
RGB	ui_hex_to_rgb (char *s)
	Convert a hexadecimal color string to an RGB structure.
int	ui_idcok (UiSurface *s, ss_t w, bool enable)
	Enable or disable the use of the insert/delete character capabilities for a UiSurface.
int	ui_idlok (UiSurface *s, ss_t w, bool enable)
	Enable or disable the use of the insert/delete line capabilities for a UiSurface.
struct UiRuntime *	ui_init (const UiConfig *cfg, SIO *sio)
	Initialize the UI runtime with the given configuration and SIO.
int	ui_init_color (uint color, uint r, uint g, uint b)
	Initialize a color in the curses color table with specified RGB values.
int	ui_init_pair (uint pair, uint fg, uint bg)
	Initialize a color pair in the curses color table with specified foreground and background colors.
int	ui_keypad (UiSurface *s, ss_t w, bool enable)
	Enable or disable the keypad for a UiSurface.
SCREEN *	ui_ncurses_get_screen ()
	Get the current SCREEN pointer used by the UI.
PANEL *	ui_ncurses_surface_get_panel (const UiSurface *s, ss_t w)
	Get the current PANEL pointer for a specific window within a UiSurface.
WINDOW *	ui_ncurses_surface_get_win (const UiSurface *s, ss_t w)
	Get the current FILE pointer for the TTY used by the UI.
int	ui_pair_content (uint pair, uint *fg, uint *bg)
	Get the foreground and background colors of a specified color pair.
int	ui_pair_from_hex (const char *fg, const char *bg)
	Convert hex color strings to a curses color pair index.
void	ui_render ()
	Render the UI by updating panels and refreshing the display.
int	ui_resume ()
	Resume the UI, restoring the previous program state and updating the display.
int	ui_scrollok (UiSurface *s, ss_t w, bool enable)
	Enable or disable scrolling for a UiSurface.
int	ui_setcchar (UiCell *cell, const wchar_t *wstr, const attr_t attrs, short pair, const void *opts)
	Set the character and attributes of a UiCell.
int	ui_setscrreg (UiSurface *s, ss_t w, uint top, uint bottom)
	Set the scrolling region for a UiSurface.
void	ui_shutdown ()
	Shutdown the UI runtime, cleaning up resources and freeing memory.
int	ui_surface_addpad (UiSurface *s, ss_t w, uint view_win, uint lines, uint cols, uint begy, uint begx)
	Add a new pad to the specified UiSurface.
int	ui_surface_addwin (UiSurface *s, ss_t w, uint p, uint lines, uint cols, uint y, uint x)
	Add a new window to the specified UiSurface.
UiSurface *	ui_surface_box (UiSurface *parent, uint p, uint lines, uint cols, uint y, uint x, const char *wtitle)
	Create a new UI surface with a border box and optional title.
void	ui_surface_destroy (UiSurface *s)
	Destroy a UiSurface, cleaning up its windows and panels.
int	ui_surface_hide (UiSurface *s, ss_t w)
	Hide a UiSurface, making it invisible on the screen.
int	ui_surface_move (UiSurface *s, ss_t w, uint y, uint x)
	Move a UiSurface to a new position on the screen.
UiSurface *	ui_surface_new (ss_t w, UiSurface *parent, uint p, uint lines, uint cols, uint y, uint x)
	Create a new UI surface with the specified parameters.
int	ui_surface_resize (UiSurface *s, ss_t w, uint lines, uint cols)
	Resize a UiSurface to new dimensions.
int	ui_surface_show (UiSurface *s, ss_t w)
	Show a UiSurface, making it visible on the screen.
int	ui_suspend ()
	Suspend the UI, saving the current program state and ending the window session.
int	ui_top_surface (UiSurface *s, ss_t w)
	Hide a UiSurface, making it invisible on the screen.
void	ui_update_panels ()
	Update the panels in the UI.
int	ui_wclear (UiSurface *s, ss_t w)
	Clear the contents of a UiSurface or all surfaces.
int	ui_werase (UiSurface *s, ss_t w)
	Erase the contents of a UiSurface or all surfaces.
int	ui_wmove (UiSurface *s, ss_t w, uint y, uint x)
	Move the cursor to a specified position within a UiSurface.
int	ui_wnoutrefresh (UiSurface *s, ss_t w)
	Refresh a specific window within a UiSurface.
int	ui_wscrl (UiSurface *s, ss_t w, int n)
	Scroll the contents of a UiSurface by a specified number of lines.

Variables
int	sfc_ptr = -1
UiSurface *	stdsfc
UiRuntime *	ui = NULL
uint	ui_color_cnt = 0
uint	ui_pair_cnt = 0
UiSurface *	ui_surface [UI_SFC_MAX]

Detailed Description

NCurses UI backend — lifecycle, surface management, and capabilities.

Implements all UiRuntime and UiSurface operations declared in ui_backend.h using the NCurses / panelw library.

When compiled as part of the main C-Menu build (UAL_LEGACY_COMPAT defined), the legacy globals screen and tty_fp from dwin.c are kept in sync so that code not yet migrated to the UAL API continues to work.

Definition in file ui_ncurses.c.

Macro Definition Documentation

_XOPEN_SOURCE_EXTENDED

#define _XOPEN_SOURCE_EXTENDED   1

Definition at line 13 of file ui_ncurses.c.

Function Documentation

fast_exit()

void fast_exit

(

UiSurface *

s

)

Exit the UI application quickly, cleaning up resources.

Parameters

s	Pointer to the UiSurface to be cleaned up before exiting.

Definition at line 339 of file ui_ncurses.c.

                             {
    update_panels();
    doupdate();
    for (int i = SUB_SFC_MAX; i >= 0; i--) {
        if (s->mpan[i]) {
            hide_panel(s->mpan[i]);
            del_panel(s->mpan[i]);
            s->mpan[i] = NULL;
        }
    }
    for (int i = SUB_SFC_MAX; i >= 0; i--) {
        if (s->mwin[i]) {
            delwin(s->mwin[i]);
            s->mwin[i] = NULL;
        }
    }
    endwin();
    exit(EXIT_SUCCESS);
}

References SUB_SFC_MAX.

ui__mbstr_to_cellstr()

uint ui__mbstr_to_cellstr	(	UiCell *	cmplx_buf,
		const char *	str,
		const UiCell *	cell_base,
		uint *	p,
		const uint	atmost )

Definition at line 1223 of file ui_ncurses.c.

                                                                                                                   {
    attr_t attrs;
    short cp;
    uint p1 = 0;
    uint *pos = &p1;
    if (p)
        pos = p;
    else
        pos = &p1;
    uint i = 0, len = 0;
    const char *s;
    UiCell cc = {};
    wchar_t wstr[5];
    getcchar(cell_base, &wstr[0], &attrs, &cp, nullptr);
    mbstate_t mbstate;
    memset(&mbstate, 0, sizeof(mbstate));
    if (pos && *pos >= atmost - 1)
        return 0;
    while (str[i] != '\0') {
        s = &str[i];
        len = mbrtowc(wstr, s, MB_CUR_MAX, &mbstate);
        if (len <= 0) {
            wstr[0] = L'?';
            wstr[1] = L'\0';
            len = 1;
        }
        wstr[1] = L'\0';
        if (*pos > atmost)
            break;
        if (setcchar(&cc, wstr, attrs, cp, nullptr) != ERR) {
            if (len > 0 && (*pos + len) < atmost)
                cmplx_buf[(*pos)++] = cc;
        }
        i += len;
    }
    wstr[0] = L'\0';
    wstr[1] = L'\0';
    setcchar(&cc, wstr, attrs, cp, nullptr);
    cmplx_buf[*pos] = cc;
    return *pos;
}

ui_add_pair()

uint ui_add_pair	(	uint	fg,
		uint	bg )

Add a new color pair to the UI, or retrieve the index of an existing pair.

Add a new color pair to the UI color pair palette.

Parameters

fg	The foreground color index for the new color pair.
bg	The background color index for the new color pair.

Returns

The index of the new or existing color pair, or EXIT_FAILURE on failure.

Parameters

fg	The foreground color index for the new color pair.
bg	The background color index for the new color pair.

Returns

The index of the newly added color pair, or EXIT_FAILURE if the maximum number of pairs is exceeded.

This function adds a new color pair to the UI color pair palette. It checks if the specified foreground and background colors already exist in the palette. If they do, it returns the existing index. If not, it adds the new color pair and returns its index. If the maximum number of pairs is exceeded, it displays an error message and returns EXIT_FAILURE.

Definition at line 1014 of file ui_ncurses.c.

                                   {
    int rc;
    uint i;
    uint pfg, pbg;
    for (i = 1; i < ui_pair_cnt; i++) {
        ui_pair_content(i, &pfg, &pbg);
        if (pfg == fg && pbg == bg)
            return i;
    }
    if (i + 1 >= UI_PAIRS) {
        ssnprintf(em0, MAXLEN - 1, _("%s, line: %d"), __FILE__, __LINE__ - 1);
        ssnprintf(em1, MAXLEN - 1, _("ui_add_pair failed for pair: %d"), i);
        strerror_r(errno, em2, MAXLEN);
        ui_display_error(em0, em1, em2, nullptr);
        return (EXIT_FAILURE);
    }
    rc = init_extended_pair(i, fg, bg);
    if (rc == ERR) {
        ssnprintf(em0, MAXLEN - 1, _("%s, line: %d"), __FILE__, __LINE__ - 1);
        ssnprintf(em1, MAXLEN - 1, _("init_extended_pair failed for pair: %d"), i);
        ssnprintf(em2, MAXLEN - 1, _("fg: %d, bg: %d, ui_pair_cnt: %d"), fg, bg, ui_pair_cnt);
        ui_display_error(em0, em1, em2, nullptr);
        return (EXIT_FAILURE);
    }
    ui_pair_cnt++;
    return (int)(ui_pair_cnt - 1);
}

References em0, em1, em2, ssnprintf(), ui_display_error(), ui_pair_cnt, and ui_pair_content().

Referenced by parse_ansi_str(), ui_cell_from_ucp(), ui_get_nccell(), ui_initialize_sio(), ui_pair_from_hex(), and ui_parse_ansi().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_bkgd()

int ui_bkgd	(	UiSurface *	s,
		ss_t	w,
		const UiCell *	cell )

Set the background of a specific window within a UiSurface.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface for which to set the background.
cell	Pointer to a UiCell structure representing the desired background attributes.

Returns

0 on success, or -1 on failure.

Definition at line 927 of file ui_ncurses.c.

                                                      {
    if (!s)
        return -1;
    wbkgrnd(s->mwin[w], cell);
    return 0;
}

ui_bkgdset()

int ui_bkgdset	(	UiSurface *	s,
		ss_t	w,
		const UiCell *	cell )

Set the background for new content to be written to a specific window within a UiSurface.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface for which to set the background for new content.
cell	Pointer to a UiCell structure representing the desired background attributes for new content.

Returns

0 on success, or -1 on failure.

Definition at line 941 of file ui_ncurses.c.

                                                         {
    if (!s)
        return -1;
    wbkgrndset(s->mwin[w], cell);
    return 0;
}

ui_bkgrnd()

int ui_bkgrnd	(	UiSurface *	s,
		ss_t	w,
		const UiCell *	cell )

Set the background of a specific window within a UiSurface.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface for which to set the background.
cell	Pointer to a UiCell structure representing the desired background attributes.

Returns

0 on success, or -1 on failure.

Definition at line 955 of file ui_ncurses.c.

                                                        {
    if (!s->mwin[w])
        return -1;
    wbkgrnd(s->mwin[w], cell);
    return 0;
}

ui_bkgrndset()

int ui_bkgrndset	(	UiSurface *	s,
		ss_t	w,
		const UiCell *	cell )

Set the background for new content to be written to a specific window within a UiSurface.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface for which to set the background for new content.
cell	Pointer to a UiCell structure representing the desired background attributes for new content.

Returns

0 on success, or -1 on failure.

Definition at line 969 of file ui_ncurses.c.

                                                           {
    if (!s->mwin[w])
        return -1;
    wbkgrndset(s->mwin[w], cell);
    return 0;
}

ui_cell_from_ucp()

UiCell ui_cell_from_ucp	(	const wchar_t *	ucp,
		const uint32_t *	fg,
		const uint32_t *	bg )

Convert a Unicode code point to a curses UiCell with specified foreground and background colors.

Create a UiCell from a Unicode codepoint and specified foreground and background colors.

Parameters

ucp	Pointer to a wide character string containing the Unicode code point.
fg	Pointer to a 32-bit integer representing the foreground color in hex format (e.g., 0xRRGGBB).
bg	Pointer to a 32-bit integer representing the background color in hex format (e.g., 0xRRGGBB).

Returns

A UiCell structure representing the Unicode character with the specified colors.

Parameters

ucp	Pointer to a wide character string representing the Unicode codepoint.
fg	Pointer to a 32-bit unsigned integer representing the foreground color.
bg	Pointer to a 32-bit unsigned integer representing the background color.

Returns

A UiCell structure representing the created cell.

This function creates a UiCell from a Unicode codepoint and specified foreground and background colors. It initializes the cell, sets its width based on the Unicode codepoint, converts the codepoint to UTF-8, and sets the styles and channels for the cell. The resulting UiCell can be used for rendering text in a UI surface.

Definition at line 101 of file ui_ncurses.c.

                                                                                    {
    UiCell cc = {0};
    RGB rgb;
    rgb.r = (*fg >> 16) & 0xff;
    rgb.g = (*fg >> 8) & 0xff;
    rgb.b = *fg & 0xff;
    int f_idx = ui_color_from_rgb(&rgb);
    rgb.r = (*bg >> 16) & 0xff;
    rgb.g = (*bg >> 8) & 0xff;
    rgb.b = *bg & 0xff;
    int b_idx = ui_color_from_rgb(&rgb);
    short cp = ui_add_pair(f_idx, b_idx);
    wchar_t wstr[2] = {L'\0', L'\0'};
    wstr[0] = *ucp;
    wstr[1] = L'\0';
    setcchar(&cc, wstr, WA_NORMAL, cp, nullptr);
    return cc;
}

References ui_add_pair(), and ui_color_from_rgb().

Referenced by ui_initialize_sio().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_chg_color()

int ui_chg_color	(	uint16_t	color_idx,
		uint32_t *	color )

Change the RGB color value for a given color index.

Change the color at a specified index in the UI color palette.

Parameters

color_idx	The index of the color in the curses color table to be changed.
color	Pointer to a 32-bit unsigned integer representing the new RGB color value (0xRRGGBB).

Returns

0 on success, or -1 on failure.

Parameters

color_idx	The index of the color to change in the UI color palette.
color	Pointer to a 32-bit unsigned integer representing the new color value.

Returns

0 on success, -1 on error (if the color index is out of bounds).

This function changes the color at a specified index in the UI color palette. It applies gamma correction to the new color value and updates both the standard and UI color arrays with the new RGB components. If the color index is out of bounds, it returns -1.

Definition at line 1169 of file ui_ncurses.c.

                                                      {
    if (color_idx + 1 >= UI_COLORS)
        return -1;
    RGB rgb;
    rgb.r = (*color >> 16) & 0xff;
    rgb.g = (*color >> 8) & 0xff;
    rgb.b = *color & 0xff;
    ui_apply_gamma(&rgb);
    if (color_idx < 16) {
        std_color[color_idx].r = rgb.r;
        std_color[color_idx].g = rgb.g;
        std_color[color_idx].b = rgb.b;
    }
    rgb.r = (rgb.r * 1000) / 255;
    rgb.g = (rgb.g * 1000) / 255;
    rgb.b = (rgb.b * 1000) / 255;
    init_extended_color(color_idx, rgb.r, rgb.g, rgb.b);
    return 0;
}

References std_color, and ui_apply_gamma().

Referenced by ui_init_clr_palette().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_chg_pair()

int ui_chg_pair	(	uint	pair,
		uint	fg,
		uint	bg )

Change the foreground and background colors of an existing color pair.

Parameters

pair	The index of the color pair to be modified.
fg	The new foreground color index for the color pair.
bg	The new background color index for the color pair.

Returns

0 on success, or -1 on failure.

Definition at line 1048 of file ui_ncurses.c.

                                             {
    if (pair + 1 >= UI_PAIRS)
        return -1;
    init_extended_pair(pair, fg, bg);
    return 0;
}

ui_clear()

int ui_clear

(

)

Clear the entire screen.

Returns

0 on success, or -1 on failure.

Definition at line 599 of file ui_ncurses.c.

               {
    clear();
    return 0;
}

ui_color_content()

int ui_color_content	(	uint	color,
		uint *	r,
		uint *	g,
		uint *	b )

Definition at line 1116 of file ui_ncurses.c.

                                                            {
    int _color = (int)color;
    int _r, _g, _b;
    extended_color_content(_color, &_r, &_g, &_b);
    *r = (uint)_r;
    *g = (uint)_g;
    *b = (uint)_b;
    return 0;
}

Referenced by ui_color_from_rgb(), ui_get_channels_from_pair(), and ui_set_nccell().

Here is the caller graph for this function:

ui_color_from_rgb()

uint ui_color_from_rgb

(

RGB *

rgb

)

Convert RGB to curses color index, adding new color if necessary.

Convert an RGB color to a color index in the UI color palette.

was rgb_to_curses_clr

Parameters

rgb	Pointer to RGB struct with r, g, b values (0-255).

Returns

Color index in curses color table, or 0 on failure.

Parameters

rgb	Pointer to an RGB structure representing the color to convert.

Returns

The color index corresponding to the RGB color, or -1 if the color cannot be added.

This function converts an RGB color to a color index in the UI color palette. It applies gamma correction to the RGB values and checks if the color already exists in the palette. If it does, it returns the existing index. If not, it adds the new color to the palette and returns its index. If the palette is full, it returns -1.

Definition at line 1060 of file ui_ncurses.c.

                                {
    if (rgb->r == rgb->g && rgb->g == rgb->b && rgb->b == 0)
        return 0;
    // #ifdef DEBUG_COLOR
    if (rgb->r > 255 || rgb->g > 255 || rgb->b > 255) {
        ssnprintf(em0, MAXLEN - 1, _("%s, line: %d"), __FILE__, __LINE__ - 1);
        ui_log(ERROR, "%s", em0);
        ssnprintf(em1, MAXLEN - 1, _("ui_color_from_rgb failed for RGB: %d,%d,%d"), rgb->r, rgb->g, rgb->b);
        ui_log(ERROR, "%s", em0);
        // return (EXIT_FAILURE);
    }
    // #endif
    uint i;
    RGB tmp;
    ui_apply_gamma(rgb);
    rgb->r = (rgb->r * 1000) / 255;
    rgb->g = (rgb->g * 1000) / 255;
    rgb->b = (rgb->b * 1000) / 255;
    for (i = 0; i < ui_color_cnt && i < UI_COLORS; i++) {
        extended_color_content(i, &tmp.r, &tmp.g, &tmp.b);
        if (rgb->r == tmp.r && rgb->g == tmp.g && rgb->b == tmp.b)
            return i;
    }
    if (i < UI_COLORS) {
        if (i < 16) {
            std_color[i].r = rgb->r;
            std_color[i].g = rgb->g;
            std_color[i].b = rgb->b;
        }
        init_extended_color(i, rgb->r, rgb->g, rgb->b);
        if (ui_color_cnt + 1 < UI_COLORS)
            ui_color_cnt++;
        return ui_color_cnt - 1;
    }
    return 0;
}

References em0, em1, ssnprintf(), std_color, ui_apply_gamma(), and ui_color_cnt.

Referenced by parse_ansi_str(), ui_cell_from_ucp(), ui_get_nccell(), ui_pair_from_hex(), and ui_parse_ansi().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_curs_set()

int ui_curs_set

(

int

visibility

)

Set the visibility of the cursor.

Parameters

visibility

An integer value indicating the desired cursor visibility: 0 - Invisible 1 - Visible 2 - Very visible (e.g., block cursor)

Returns

0 on success, or -1 on failure.

Definition at line 840 of file ui_ncurses.c.

                                {
    curs_set(visibility);
    return 0;
}

ui_cursor_enable()

int ui_cursor_enable	(	UiSurface *	s,
		ss_t	w,
		bool	visible )

Enable or disable the cursor for a UiSurface.

Parameters

s	Pointer to the UiSurface where the cursor will be enabled or disabled.
w	The index of the window within the surface where the cursor will be enabled or disabled.
visible	A boolean value indicating whether to make the cursor visible (true) or invisible (false).

Returns

0 on success, or -1 on failure.

Definition at line 870 of file ui_ncurses.c.

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

ui_cursor_enable_yx()

int ui_cursor_enable_yx	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x,
		bool	visible )

Enable or disable the cursor at a specific position within a UiSurface.

Parameters

s	Pointer to the UiSurface where the cursor will be enabled or disabled.
w	The index of the window within the surface where the cursor will be enabled or disabled.
y	The y-coordinate (row) for the cursor's position.
x	The x-coordinate (column) for the cursor's position.
visible	A boolean value indicating whether to make the cursor visible (true) or invisible (false).

Returns

0 on success, or -1 on failure.

Definition at line 855 of file ui_ncurses.c.

                                                                            {
    if (!ui)
        return -1;
    wmove(s->mwin[w], y, x);
    ui->cursor_visible = visible;
    curs_set(visible ? 2 : 0);
    return 0;
}

ui_cursor_move()

int ui_cursor_move	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x )

Move the cursor to a specified position within a UiSurface.

Parameters

s	Pointer to the UiSurface where the cursor will be moved.
w	The index of the window within the surface where the cursor will be moved.
y	The new y-coordinate (row) for the cursor's position.
x	The new x-coordinate (column) for the cursor's position.

Returns

0 on success, or -1 on failure.

Definition at line 666 of file ui_ncurses.c.

                                                         {
    if (!s || !s->mwin[w])
        return -1;
    return wmove(s->mwin[w], y, x);
}

ui_def_prog_mode()

void ui_def_prog_mode

(

)

Definition at line 826 of file ui_ncurses.c.

                        {
    def_prog_mode();
}

Referenced by fork_exec().

Here is the caller graph for this function:

ui_destroy_curses()

void ui_destroy_curses

(

)

Definition at line 1264 of file ui_ncurses.c.

                         {
    if (!f_ncurses_open && !f_notcurses_open)
        return;
    ui_shutdown();
    f_ncurses_open = false;
    restore_shell_tioctl();
    sig_dfl_mode();
    return;
}

References f_ncurses_open, f_notcurses_open, restore_shell_tioctl(), sig_dfl_mode(), and ui_shutdown().

Here is the call graph for this function:

ui_doupdate()

int ui_doupdate

(

)

Refresh the display by updating the screen.

Definition at line 895 of file ui_ncurses.c.

                  {
    doupdate();
    return 0;
}

ui_endwin()

void ui_endwin

(

)

End the UI application, cleaning up resources and shutting down the UI runtime.

Destroy a UI surface and free its resources.

Parameters

s	Pointer to the UiSurface to be destroyed.

This function destroys a UI surface by freeing its associated ncplanes and metadata. It also frees the memory allocated for the UiSurface structure. If the provided pointer is NULL, the function does nothing.

Definition at line 412 of file ui_ncurses.c.

                 {
    endwin();
    // ui_shutdown();
}

ui_erase()

int ui_erase

(

)

Erase the entire screen.

Returns

0 on success, or -1 on failure.

Definition at line 591 of file ui_ncurses.c.

               {
    erase();
    return 0;
}

ui_get_caps()

void ui_get_caps

(

UiCaps *

caps

)

Get the UI backend capabilities.

Parameters

caps	Pointer to a UiCaps struct to be filled with the backend capabilities.

Definition at line 62 of file ui_ncurses.c.

                               {
    if (!caps)
        return;
    memset(caps, 0, sizeof(*caps));
    if (!ui)
        return;
    // Will add code to actually check later. For now, just lie.
    caps->truecolor = true;
    caps->palette256 = true;
    caps->mouse = ui->mouse_enabled;
    caps->unicode = true;
    caps->resize = true;
    caps->color_pairs = 0;
}

ui_get_color()

uint32_t ui_get_color

(

uint16_t

color_idx

)

Get the RGB color value for a given color index.

Parameters

color_idx

The index of the color in the curses color table.

Returns

The RGB color value as a 32-bit unsigned integer (0xRRGGBB), or -1 on failure.

Definition at line 1101 of file ui_ncurses.c.

                                          {
    if (color_idx + 1 >= UI_COLORS)
        return -1;
    RGB rgb;
    extended_color_content(color_idx, &rgb.r, &rgb.g, &rgb.b);
    rgb.r = (rgb.r * 255) / 1000;
    rgb.g = (rgb.g * 255) / 1000;
    rgb.b = (rgb.b * 255) / 1000;
    return 0;
}

ui_get_screen_size()

void ui_get_screen_size	(	uint *	lines,
		uint *	cols )

Get the current screen size (number of lines and columns).

Parameters

lines	Pointer to a uint variable where the number of lines (rows) will be stored.
cols	Pointer to a uint variable where the number of columns will be stored.

Definition at line 722 of file ui_ncurses.c.

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

ui_getcchar()

int ui_getcchar	(	const UiCell *	cell,
		wchar_t *	wstr,
		attr_t *	attrs,
		short *	pair,
		const void *	opts )

Get the character and attributes from a UiCell.

Parameters

cell	Pointer to the UiCell from which to retrieve the character and attributes.
wstr	Pointer to a wchar_t array where the retrieved character will be stored.
attrs	Pointer to an attr_t variable where the retrieved attributes will be stored.
pair	Pointer to a short variable where the retrieved color pair will be stored.
opts	Pointer to additional options (not used in this implementation).

Returns

0 on success, or -1 on failure.

Definition at line 987 of file ui_ncurses.c.

                                                                                                 {
    (void)opts;
    getcchar(cell, wstr, attrs, pair, nullptr);
    return 0;
}

ui_getmaxx()

int ui_getmaxx	(	UiSurface *	s,
		ss_t	w )

Get the maximum number of columns of a UiSurface.

Parameters

s	Pointer to the UiSurface for which to retrieve the maximum number of columns.
w	The index of the window within the surface for which to retrieve the maximum number of columns.

Returns

The maximum number of columns of the specified UiSurface, or -1 on failure.

Definition at line 712 of file ui_ncurses.c.

                                     {
    if (!s->mwin[w])
        return -1;
    return (int)(getmaxx(s->mwin[w]));
}

ui_getmaxy()

int ui_getmaxy	(	UiSurface *	s,
		ss_t	w )

Get the maximum number of lines (rows) of a UiSurface.

Parameters

s	Pointer to the UiSurface for which to retrieve the maximum number of lines.
w	The index of the window within the surface for which to retrieve the maximum number of lines.

Returns

The maximum number of lines (rows) of the specified UiSurface, or -1 on failure.

Definition at line 701 of file ui_ncurses.c.

                                     {
    if (!s->mwin[w])
        return -1;
    return (int)(getmaxy(s->mwin[w]));
}

ui_getmaxyx()

void ui_getmaxyx	(	UiSurface *	s,
		ss_t	w,
		uint *	lines,
		uint *	cols )

Get the maximum dimensions of a UiSurface.

Parameters

s	Pointer to the UiSurface for which to retrieve the maximum dimensions.
w	The index of the window within the surface for which to retrieve the maximum dimensions.
lines	Pointer to a uint variable where the maximum number of lines (rows) will be stored.
cols	Pointer to a uint variable where the maximum number of columns will be stored.

Definition at line 690 of file ui_ncurses.c.

                                                                {
    if (!s->mwin[w])
        return;
    getmaxyx(s->mwin[w], *lines, *cols);
}

ui_getyx()

void ui_getyx	(	UiSurface *	s,
		ss_t	w,
		uint *	lines,
		uint *	cols )

Get the current cursor position within a window of a UI surface.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
y	Pointer to an unsigned integer to store the y-coordinate of the cursor.
x	Pointer to an unsigned integer to store the x-coordinate of the cursor.

This function retrieves the current cursor position within a window of a UI surface. If the surface or window is not initialized, it does nothing.

Definition at line 675 of file ui_ncurses.c.

                                                             {
    if (!s->mwin[w])
        return;
    int _lines, _cols;
    getyx(s->mwin[w], _lines, _cols);
    *lines = (uint)(_lines);
    *cols = (uint)(_cols);
}

ui_hex_to_rgb()

RGB ui_hex_to_rgb

(

char *

s

)

Convert a hexadecimal color string to an RGB structure.

Parameters

s	A string representing the color in hexadecimal format (e.g., "#RRGGBB").

Returns

An RGB structure containing the red, green, and blue components of the color.

This function converts a hexadecimal color string to an RGB structure. It uses sscanf to parse the hex string and extract the red, green, and blue components. The resulting RGB structure is returned.

Definition at line 1111 of file ui_ncurses.c.

                           {
    RGB rgb;
    sscanf(s, "#%02x%02x%02x", &rgb.r, &rgb.g, &rgb.b);
    return rgb;
}

Referenced by ui_init_color_hex().

Here is the caller graph for this function:

ui_idcok()

int ui_idcok	(	UiSurface *	s,
		ss_t	w,
		bool	enable )

Enable or disable the use of the insert/delete character capabilities for a UiSurface.

Parameters

s	Pointer to the UiSurface for which to enable or disable the insert/delete character capabilities.
w	The index of the window within the surface for which to enable or disable the insert/delete character capabilities.
enable	A boolean value indicating whether to enable (true) or disable (false) the insert/delete character capabilities.

Returns

0 on success, or -1 on failure.

Definition at line 803 of file ui_ncurses.c.

                                                {
    if (!s->mwin[w])
        return -1;
    if (enable)
        idcok(s->mwin[w], true);
    else
        idcok(s->mwin[w], false);
    return 0;
}

ui_idlok()

int ui_idlok	(	UiSurface *	s,
		ss_t	w,
		bool	enable )

Enable or disable the use of the insert/delete line capabilities for a UiSurface.

Parameters

s	Pointer to the UiSurface for which to enable or disable the insert/delete line capabilities.
w	The index of the window within the surface for which to enable or disable the insert/delete line capabilities.
enable	A boolean value indicating whether to enable (true) or disable (false) the insert/delete line capabilities.

Returns

0 on success, or -1 on failure.

Definition at line 787 of file ui_ncurses.c.

                                                {
    if (!s->mwin[w])
        return -1;
    if (enable)
        idlok(s->mwin[w], true);
    else
        idlok(s->mwin[w], false);
    return 0;
}

ui_init()

struct UiRuntime * ui_init	(	const UiConfig *	cfg,
		SIO *	sio )

Initialize the UI runtime with the given configuration and SIO.

Parameters

cfg	Pointer to a UiConfig structure containing the configuration settings.
sio	Pointer to an SIO structure for input/output operations.

Returns

A pointer to the initialized UiRuntime structure, or NULL on failure.

Definition at line 129 of file ui_ncurses.c.

                                                         {
    setlocale(LC_ALL, "en_US.UTF-8");
    ui = calloc(1, sizeof(*ui));
    if (!ui)
        return NULL;
    char tty_name[MAXLEN];
    if (ttyname_r(STDERR_FILENO, tty_name, sizeof(tty_name)) != 0) {
        free(ui);
        return NULL;
    }
    ui->tty_fp = fopen(tty_name, "r+");
    if (!ui->tty_fp) {
        free(ui);
        return NULL;
    }
    ui->tty_fd = fileno(ui->tty_fp);
    ui_min_log_level = cfg->log_level;
 
    ui_log(INFO, _("ui_init: using tty: %s"), tty_name);
    ui->screen = newterm(NULL, ui->tty_fp, ui->tty_fp);
    f_ncurses_open = true;
    if (!ui->screen) {
        fclose(ui->tty_fp);
        free(ui);
        return NULL;
    }
    set_term(ui->screen);
    if (!has_colors() || !can_change_color()) {
        ui_shutdown();
        return NULL;
    }
    start_color();
    use_default_colors();
    cbreak();
    noecho();
    keypad(stdscr, TRUE);
    if (ui->mouse_enabled)
        mousemask(ALL_MOUSE_EVENTS | REPORT_MOUSE_POSITION, NULL);
    getmaxyx(stdscr, ui->lines, ui->cols);
 
    stdsfc = calloc(1, sizeof(*stdsfc));
    if (!stdsfc)
        return NULL;
    stdsfc->runtime = ui;
    stdsfc->parent = NULL;
    stdsfc->meta[BOX].lines = (int)ui->lines;
    stdsfc->meta[BOX].cols = (int)ui->cols;
    stdsfc->meta[BOX].y = 0;
    stdsfc->meta[BOX].x = 0;
    stdsfc->mwin[BOX] = stdscr;
    stdsfc->mpan[BOX] = new_panel(stdsfc->mwin[BOX]);
    if (!stdsfc->mpan[BOX]) {
        free(stdsfc);
        ui_log(ERROR, _("new_panel failed for stdsfc->mpan[BOX]"));
        exit(EXIT_FAILURE);
    }
    if (cfg->border_style)
        ui->border_style = cfg->border_style;
    if (!ui->border_style)
        ui->border_style = UI_BORDER_ROUNDED;
    if (cfg) {
        switch (ui->border_style) {
        case UI_BORDER_SINGLE:
            memcpy(bw.str, border_single, sizeof(bw.str));
            break;
        case UI_BORDER_DOUBLE:
            memcpy(bw.str, border_double, sizeof(bw.str));
            break;
        case UI_BORDER_ROUNDED:
            memcpy(bw.str, border_rounded, sizeof(bw.str));
            break;
        case UI_BORDER_HEAVY:
            memcpy(bw.str, border_heavy, sizeof(bw.str));
            break;
        case UI_BORDER_NONE:
            memcpy(bw.str, border_none, sizeof(bw.str));
            break;
        default:
            memcpy(bw.str, border_rounded, sizeof(bw.str));
            break;
        }
    }
    ui_initialize_sio(sio);
    ui_log(INFO, _("ui_init: stdsfc->mwin[BOX]: %p, stdsfc->mpan[BOX]: %p"), (void *)stdsfc->mwin[BOX], (void *)stdsfc->mpan[BOX]);
    return ui;
}

ui_init_color()

int ui_init_color	(	uint	color,
		uint	r,
		uint	g,
		uint	b )

Initialize a color in the curses color table with specified RGB values.

Parameters

color	The index of the color to be initialized.
r	The red component of the color (0-255).
g	The green component of the color (0-255).
b	The blue component of the color (0-255).

Returns

0 on success, or -1 on failure.

Definition at line 1133 of file ui_ncurses.c.

                                                      {
    init_extended_color(color, r, g, b);
    return 0;
}

Referenced by ui_color_from_rgb().

Here is the caller graph for this function:

ui_init_pair()

int ui_init_pair	(	uint	pair,
		uint	fg,
		uint	bg )

Initialize a color pair in the curses color table with specified foreground and background colors.

Parameters

pair	The index of the color pair to be initialized.
fg	The foreground color index for the color pair.
bg	The background color index for the color pair.

Returns

0 on success, or -1 on failure.

Definition at line 1159 of file ui_ncurses.c.

                                              {
    init_extended_pair(pair, fg, bg);
    return 0;
}

ui_keypad()

int ui_keypad	(	UiSurface *	s,
		ss_t	w,
		bool	enable )

Enable or disable the keypad for a UiSurface.

Parameters

s	Pointer to the UiSurface for which to enable or disable the keypad.
w	The index of the window within the surface for which to enable or disable the keypad.
enable	A boolean value indicating whether to enable (true) or disable (false) the keypad.

Returns

0 on success, or -1 on failure.

Definition at line 771 of file ui_ncurses.c.

                                                 {
    if (!s->mwin[w])
        return -1;
    if (enable)
        keypad(s->mwin[w], true);
    else
        keypad(s->mwin[w], false);
    return 0;
}

ui_ncurses_get_screen()

SCREEN * ui_ncurses_get_screen

(

)

Get the current SCREEN pointer used by the UI.

Returns

The SCREEN pointer if the UI is initialized, or NULL if the UI is not initialized.

Definition at line 1195 of file ui_ncurses.c.

                                {
    if (!ui)
        return NULL;
    return ui->screen;
}

References ui.

ui_ncurses_surface_get_panel()

PANEL * ui_ncurses_surface_get_panel	(	const UiSurface *	s,
		ss_t	w )

Get the current PANEL pointer for a specific window within a UiSurface.

Return the raw NCurses PANEL* underlying a surface.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface for which to retrieve the PANEL pointer.

Returns

The PANEL pointer for the specified window, or NULL if the UiSurface is NULL.

Definition at line 1215 of file ui_ncurses.c.

                                                                {
    if (!s)
        return NULL;
    return s->mpan[w];
}

ui_ncurses_surface_get_win()

WINDOW * ui_ncurses_surface_get_win	(	const UiSurface *	s,
		ss_t	w )

Get the current FILE pointer for the TTY used by the UI.

Return the raw NCurses WINDOW* underlying a surface.

Returns

The FILE pointer for the TTY if the UI is initialized, or NULL if the UI is not initialized.

Definition at line 1204 of file ui_ncurses.c.

                                                               {
    if (!s)
        return NULL;
    return s->mwin[w];
}

ui_pair_content()

int ui_pair_content	(	uint	pair,
		uint *	fg,
		uint *	bg )

Get the foreground and background colors of a specified color pair.

Parameters

pair	The index of the color pair to be queried.
fg	Pointer to a uint variable where the foreground color index will be stored.
bg	Pointer to a uint variable where the background color index will be stored.

Returns

0 on success, or -1 on failure.

Definition at line 1144 of file ui_ncurses.c.

                                                   {
    int _pair = (int)pair;
    int _fg, _bg;
    extended_pair_content(_pair, &_fg, &_bg);
    *fg = (uint)_fg;
    *bg = (uint)_bg;
    return 0;
}

Referenced by parse_ansi_str(), ui_add_pair(), and ui_parse_ansi().

Here is the caller graph for this function:

ui_pair_from_hex()

int ui_pair_from_hex	(	const char *	fg,
		const char *	bg )

Convert hex color strings to a curses color pair index.

Parameters

fg	Foreground color in hex format (e.g., "#RRGGBB").
bg	Background color in hex format (e.g., "#RRGGBB").

Returns

The curses color pair index corresponding to the given foreground and background colors.

Definition at line 86 of file ui_ncurses.c.

                                                     {
    RGB rgb;
    sscanf(fg, "#%02x%02x%02x", &rgb.r, &rgb.g, &rgb.b);
    int f_idx = ui_color_from_rgb(&rgb);
    sscanf(bg, "#%02x%02x%02x", &rgb.r, &rgb.g, &rgb.b);
    int b_idx = ui_color_from_rgb(&rgb);
    return ui_add_pair(f_idx, b_idx);
}

References ui_add_pair(), and ui_color_from_rgb().

Here is the call graph for this function:

ui_render()

void ui_render

(

)

Render the UI by updating panels and refreshing the display.

Render the UI.

This function renders the UI.

Definition at line 884 of file ui_ncurses.c.

                 {
    update_panels();
    doupdate();
}

ui_resume()

int ui_resume

(

)

Resume the UI, restoring the previous program state and updating the display.

Returns

0 on success, or -1 on failure.

Definition at line 503 of file ui_ncurses.c.

                {
    reset_prog_mode();
    update_panels();
    doupdate();
    return 0;
}

ui_scrollok()

int ui_scrollok	(	UiSurface *	s,
		ss_t	w,
		bool	enable )

Enable or disable scrolling for a UiSurface.

Parameters

s	Pointer to the UiSurface for which to enable or disable scrolling.
w	The index of the window within the surface for which to enable or disable scrolling.
enable	A boolean value indicating whether to enable (true) or disable (false) scrolling.

Returns

0 on success, or -1 on failure.

Definition at line 755 of file ui_ncurses.c.

                                                   {
    if (!s->mwin[w])
        return -1;
    if (enable)
        scrollok(s->mwin[w], true);
    else
        scrollok(s->mwin[w], false);
    return 0;
}

ui_setcchar()

int ui_setcchar	(	UiCell *	cell,
		const wchar_t *	wstr,
		const attr_t	attrs,
		short	pair,
		const void *	opts )

Set the character and attributes of a UiCell.

Parameters

cell	Pointer to the UiCell to be modified.
wstr	Pointer to a wchar_t array containing the character to be set.
attrs	The attributes to be applied to the cell.
pair	The color pair to be applied to the cell.
opts	Pointer to additional options (not used in this implementation).

Returns

0 on success, or -1 on failure.

Definition at line 1001 of file ui_ncurses.c.

                                                                                                     {
    (void)opts;
    return setcchar(cell, wstr, attrs, pair, NULL);
}

ui_setscrreg()

int ui_setscrreg	(	UiSurface *	s,
		ss_t	w,
		uint	top,
		uint	bottom )

Set the scrolling region for a UiSurface.

Parameters

s	Pointer to the UiSurface for which to set the scrolling region.
w	The index of the window within the surface for which to set the scrolling region.
top	The top line of the scrolling region (0-based).
bottom	The bottom line of the scrolling region (0-based).

Returns

0 on success, or -1 on failure.

Definition at line 820 of file ui_ncurses.c.

                                                              {
    if (!s->mwin[w])
        return -1;
    wsetscrreg(s->mwin[w], top, bottom);
    return 0;
}

ui_shutdown()

void ui_shutdown

(

)

Shutdown the UI runtime, cleaning up resources and freeing memory.

Shutdown the UI runtime and free all associated resources.

This function shuts down the UI runtime by destroying all surfaces, freeing memory, and stopping the NotCurses library. It also closes the terminal file pointer if it was opened. If the UI runtime is not initialized, the function does nothing.

Definition at line 418 of file ui_ncurses.c.

                   {
    if (ui == NULL)
        return;
    ui_log(INFO, _("ui_shutdown in progress..."));
    while (sfc_ptr >= 0) {
        if (ui_surface[sfc_ptr] != NULL) {
            ui_surface_destroy(ui_surface[sfc_ptr]);
            ui_surface[sfc_ptr] = NULL;
        }
        ui_log(INFO, _("surface destroy: %d"), sfc_ptr);
        sfc_ptr--;
    }
    if (stdsfc->mpan[0] != NULL) {
        ui_log(INFO, _("calling del_panel(stdsfc->mpan[BOX])"));
        hide_panel(stdsfc->mpan[0]);
        del_panel(stdsfc->mpan[0]);
        stdsfc->mpan[0] = NULL;
    }
    ui_log(INFO, _("calling endwin()"));
    endwin();
    f_ncurses_open = false;
    if (ui->screen != NULL) {
        ui_log(INFO, _("calling delscreen(ui->screen)"));
        delscreen(ui->screen);
        ui->screen = NULL;
    }
    if (ui->tty_fp != NULL) {
        ui_log(INFO, _("closing tty_fp"));
        fclose(ui->tty_fp);
        ui->tty_fp = NULL;
    }
    if (stdsfc != NULL) {
        ui_log(INFO, _("freeing stdsfc"));
        free(stdsfc);
        stdsfc = NULL;
    }
    if (ui != NULL) {
        if (ui->sio) {
            free(ui->sio);
            ui->sio = nullptr;
        }
        ui_log(INFO, _("freeing ui"));
        free(ui);
        ui = NULL;
    }
}

ui_surface_addpad()

int ui_surface_addpad	(	UiSurface *	s,
		ss_t	w,
		uint	view_win,
		uint	lines,
		uint	cols,
		uint	begy,
		uint	begx )

Add a new pad to the specified UiSurface.

Parameters

s	Pointer to the UiSurface to which the pad will be added.
w	The index of the window within the surface where the pad will be created.
view_win	The index of the window that will be used to view the pad.
lines	The number of lines (rows) for the new pad.
cols	The number of columns for the new pad.
begy	The y-coordinate (row) for the new pad's position (ignored in this implementation).
begx	The x-coordinate (column) for the new pad's position (ignored in this implementation).

Returns

0 on success, or -1 on failure.

Definition at line 369 of file ui_ncurses.c.

                                                                                                        {
    (void)begy;
    (void)begx;
    s->mwin[w] = newpad(lines, cols);
    if (s->mwin[w] == nullptr)
        return -1;
    s->mwin[view_win] = subpad(s->mwin[PAD], lines, cols, 0, 0);
    if (s->mwin[view_win] == nullptr)
        return -1;
    s->mpan[w] = new_panel(s->mwin[view_win]);
    immedok(s->mwin[w], true);
#ifdef DEBUG_UI
#endif
    return 0;
}

ui_surface_addwin()

int ui_surface_addwin	(	UiSurface *	s,
		ss_t	w,
		uint	p,
		uint	lines,
		uint	cols,
		uint	y,
		uint	x )

Add a new window to the specified UiSurface.

Parameters

s	Pointer to the UiSurface to which the window will be added.
w	The index of the window within the surface where the new window will be created.
p	The index of the parent window from which the new window will be derived.
lines	The number of lines (rows) for the new window.
cols	The number of columns for the new window.
y	The y-coordinate (row) for the new window's position relative to the parent window.
x	The x-coordinate (column) for the new window's position relative to the parent window.

Returns

0 on success, or -1 on failure.

Definition at line 395 of file ui_ncurses.c.

                                                                                           {
    s->mwin[w] = derwin(s->mwin[p], lines, cols, y, x);
    if (!s->mwin[w]) {
        free(s);
        return -1;
    }
    s->mpan[w] = new_panel(s->mwin[w]);
    keypad(s->mwin[w], true);
    ui_bkgd(s, w, &cell_nt);
    ui_bkgdset(s, w, &cell_nt);
    immedok(s->mwin[w], true);
#ifdef DEBUG_UI
#endif
    return 0;
}

ui_surface_box()

UiSurface * ui_surface_box	(	UiSurface *	parent,
		uint	p,
		uint	lines,
		uint	cols,
		uint	y,
		uint	x,
		const char *	wtitle )

Create a new UI surface with a border box and optional title.

Parameters

parent	Pointer to the parent UiSurface, or NULL for a top-level surface.
p	The index of the parent window to derive from, if applicable.
lines	The number of lines (rows) for the new surface.
cols	The number of columns for the new surface.
y	The y-coordinate (row) for the new surface's position.
x	The x-coordinate (column) for the new surface's position.
wtitle	The title string to display in the border box, or NULL for no title.

Returns

A pointer to the newly created UiSurface with a border box, or NULL on failure.

Definition at line 288 of file ui_ncurses.c.

                                                                                                                {
    if (!ui)
        return NULL;
    uint maxy, maxx;
    ui_get_screen_size(&maxy, &maxx);
    if (lines > maxy || cols > maxx) {
        ssnprintf(em0, MAXLEN - 1, _("%s, line: %d"), __FILE__, __LINE__ - 1);
        ssnprintf(em1, MAXLEN - 1, _("ui_surface_box failed for lines: %d, cols: %d"), lines, cols);
        ssnprintf(em2, MAXLEN - 1, _("maxy: %d, maxx: %d"), maxy, maxx);
        ui_display_error(em0, em1, em2, nullptr);
        return NULL;
    }
    UiSurface *s = calloc(1, sizeof(*s));
    if (!s)
        return NULL;
    s->runtime = ui;
    s->parent = parent;
    s->meta[BOX].y = y;
    s->meta[BOX].x = x;
    s->meta[BOX].lines = lines;
    s->meta[BOX].cols = cols;
    if (parent && parent->mwin[p]) {
        s->mwin[BOX] = derwin(parent->mwin[p], lines, cols, y, x);
        if (!s->mwin[BOX]) {
            free(s);
            return NULL;
        }
    } else {
        s->mwin[BOX] = newwin(lines, cols, y, x);
        if (!s->mwin[BOX]) {
            free(s);
            return NULL;
        }
        s->mpan[BOX] = new_panel(s->mwin[BOX]);
        if (!s->mpan[BOX]) {
            delwin(s->mwin[BOX]);
            return NULL;
        }
    }
    ui_scrollok(s, BOX, false);
    ui_border_draw(s);
    ui_border_title(s, wtitle);
#ifdef DEBUG_UI
    immedok(s->mwin[BOX], true);
#endif
    return s;
}

ui_surface_destroy()

void ui_surface_destroy

(

UiSurface *

s

)

Destroy a UiSurface, cleaning up its windows and panels.

Parameters

s	Pointer to the UiSurface to be destroyed.

Definition at line 468 of file ui_ncurses.c.

                                      {
    if (!s)
        return;
    for (int i = SUB_SFC_MAX; i >= 0; i--) {
        if (s->mpan[i] != NULL) {
            hide_panel(s->mpan[i]);
            ui_render();
            del_panel(s->mpan[i]);
            s->mpan[i] = NULL;
        }
    }
    for (int i = SUB_SFC_MAX; i >= 0; i--) {
        if (s->mwin[i] != NULL) {
            delwin(s->mwin[i]);
            s->mwin[i] = NULL;
        }
    }
    if (s != NULL) {
        free(s);
        s = NULL;
    }
}

ui_surface_hide()

int ui_surface_hide	(	UiSurface *	s,
		ss_t	w )

Hide a UiSurface, making it invisible on the screen.

Parameters

s	Pointer to the UiSurface to be hidden.
w	The index of the window within the surface to be hidden.

Returns

0 on success, or -1 on failure.

Definition at line 635 of file ui_ncurses.c.

                                          {
    if (!s)
        return -1;
    hide_panel(s->mpan[w]);
    s->meta[w].hidden = true;
    return 0;
}

ui_surface_move()

int ui_surface_move	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x )

Move a UiSurface to a new position on the screen.

Parameters

s	Pointer to the UiSurface to be moved.
w	The index of the window within the surface to be moved.
y	The new y-coordinate (row) for the surface's position.
x	The new x-coordinate (column) for the surface's position.

Returns

0 on success, or -1 on failure.

Definition at line 521 of file ui_ncurses.c.

                                                          {
    if (!s)
        return -1;
    s->meta[w].y = y;
    s->meta[w].x = x;
    return move_panel(s->mpan[w], y, x);
}

ui_surface_new()

UiSurface * ui_surface_new	(	ss_t	w,
		UiSurface *	parent,
		uint	p,
		uint	lines,
		uint	cols,
		uint	y,
		uint	x )

Create a new UI surface with the specified parameters.

Parameters

w	The index of the window within the surface.
parent	Pointer to the parent UiSurface, or NULL for a top-level surface.
p	The index of the parent window to derive from, if applicable.
lines	The number of lines (rows) for the new surface.
cols	The number of columns for the new surface.
y	The y-coordinate (row) for the new surface's position.
x	The x-coordinate (column) for the new surface's position.

Returns

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

Definition at line 229 of file ui_ncurses.c.

                                                                                                    {
    if (!ui)
        return NULL;
    uint maxy, maxx;
    ui_get_screen_size(&maxy, &maxx);
    if (lines > maxy || cols > maxx) {
        ssnprintf(em0, MAXLEN - 1, _("%s, line: %d"), __FILE__, __LINE__ - 1);
        ssnprintf(em1, MAXLEN - 1, _("ui_surface_new failed for lines: %d, cols: %d"), lines, cols);
        ssnprintf(em2, MAXLEN - 1, _("maxy: %d, maxx: %d"), maxy, maxx);
        ui_display_error(em0, em1, em2, nullptr);
        return NULL;
    }
 
    UiSurface *s = calloc(1, sizeof(*s));
    if (!s)
        return NULL;
    for (int i = 0; i < SUB_SFC_MAX; i++) {
        s->mwin[i] = NULL;
        s->mpan[i] = NULL;
    }
    s->runtime = ui;
    s->parent = parent;
    s->meta[w].lines = lines;
    s->meta[w].cols = cols;
    s->meta[w].y = y;
    s->meta[w].x = x;
 
    if (parent && parent->mwin[p]) {
        s->mwin[w] = derwin(parent->mwin[p], lines, cols, y, x);
        if (!s->mwin[w]) {
            free(s);
            return NULL;
        }
    } else {
        s->mwin[w] = newwin(lines, cols, y, x);
        if (!s->mwin[w]) {
            free(s);
            return NULL;
        }
        s->mpan[w] = new_panel(s->mwin[w]);
        if (!s->mpan[w]) {
            delwin(s->mwin[w]);
            free(s);
            return NULL;
        }
    }
    return s;
}

ui_surface_resize()

int ui_surface_resize	(	UiSurface *	s,
		ss_t	w,
		uint	lines,
		uint	cols )

Resize a UiSurface to new dimensions.

Parameters

s	Pointer to the UiSurface to be resized.
w	The index of the window within the surface to be resized.
lines	The new number of lines (rows) for the surface.
cols	The new number of columns for the surface.

Returns

0 on success, or -1 on failure.

Definition at line 536 of file ui_ncurses.c.

                                                                   {
    if (!s)
        return -1;
    s->meta[w].lines = lines;
    s->meta[w].cols = cols;
    wresize(s->mwin[w], lines + 2, cols + 2);
    wresize(s->mwin[w + 1], lines, cols);
    return 0;
}

ui_surface_show()

int ui_surface_show	(	UiSurface *	s,
		ss_t	w )

Show a UiSurface, making it visible on the screen.

Parameters

s	Pointer to the UiSurface to be shown.
w	The index of the window within the surface to be shown.

Returns

0 on success, or -1 on failure.

Definition at line 609 of file ui_ncurses.c.

                                          {
    if (!s)
        return -1;
    show_panel(s->mpan[w]);
    s->meta[w].hidden = false;
    return 0;
    return 0;
}

ui_suspend()

int ui_suspend

(

)

Suspend the UI, saving the current program state and ending the window session.

Returns

0 on success, or -1 on failure.

Definition at line 494 of file ui_ncurses.c.

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

ui_top_surface()

int ui_top_surface	(	UiSurface *	s,
		ss_t	w )

Hide a UiSurface, making it invisible on the screen.

Parameters

s	Pointer to the UiSurface to be hidden.
w	The index of the window within the surface to be hidden.

Returns

0 on success, or -1 on failure.

Definition at line 623 of file ui_ncurses.c.

                                         {
    if (!s)
        return -1;
    top_panel(s->mpan[w]);
    return 0;
}

ui_update_panels()

void ui_update_panels

(

)

Update the panels in the UI.

Update the panels and render the UI.

This function updates the panels and renders the UI.

Definition at line 890 of file ui_ncurses.c.

                        {
    update_panels();
}

ui_wclear()

int ui_wclear	(	UiSurface *	s,
		ss_t	w )

Clear the contents of a UiSurface or all surfaces.

Parameters

s	Pointer to the UiSurface to be cleared, or NULL to clear all surfaces.
w	The index of the window within the surface to be cleared, or ALLWINS to clear all windows.

Returns

0 on success, or -1 on failure.

Definition at line 571 of file ui_ncurses.c.

                                    {
    if (!s)
        return -1;
    if (w == ALLWINS) {
        for (int i = 1; i < SUB_SFC_MAX; i++) {
            if (s->mwin[i]) {
                wclear(s->mwin[i]);
            }
        }
    } else {
        if (s->mwin[w]) {
            wclear(s->mwin[w]);
        }
    }
    return 0;
}

ui_werase()

int ui_werase	(	UiSurface *	s,
		ss_t	w )

Erase the contents of a UiSurface or all surfaces.

Parameters

s	Pointer to the UiSurface to be erased, or NULL to erase all surfaces.
w	The index of the window within the surface to be erased, or ALLWINS to erase all windows.

Returns

0 on success, or -1 on failure.

Definition at line 551 of file ui_ncurses.c.

                                    {
    if (w == ALLWINS) {
        for (int i = 1; i < SUB_SFC_MAX; i++) {
            if (s->mwin[i]) {
                werase(s->mwin[i]);
            }
        }
    } else {
        if (s->mwin[w]) {
            werase(s->mwin[w]);
        }
    }
    return 0;
}

ui_wmove()

int ui_wmove	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x )

Move the cursor to a specified position within a UiSurface.

Parameters

s	Pointer to the UiSurface where the cursor will be moved.
w	The index of the window within the surface where the cursor will be moved.
y	The new y-coordinate (row) for the cursor's position.
x	The new x-coordinate (column) for the cursor's position.

Returns

0 on success, or -1 on failure.

Definition at line 653 of file ui_ncurses.c.

                                                   {
    if (!s || !s->mwin[w])
        return -1;
    return wmove(s->mwin[w], y, x);
}

ui_wnoutrefresh()

int ui_wnoutrefresh	(	UiSurface *	s,
		ss_t	w )

Refresh a specific window within a UiSurface.

---

Refreshing

Parameters

s	Pointer to the UiSurface containing the window to be refreshed.
w	The index of the window within the surface to be refreshed.

Returns

0 on success, or -1 on failure.

---

Refreshing

Parameters

s	Pointer to the UiSurface containing the window to be refreshed.
w	The index of the window within the surface to be refreshed.

Returns

0 on success, or -1 on failure.

Definition at line 908 of file ui_ncurses.c.

                                          {
    if (!s)
        return -1;
    wnoutrefresh(s->mwin[w]);
    return 0;
}

ui_wscrl()

int ui_wscrl	(	UiSurface *	s,
		ss_t	w,
		int	n )

Scroll the contents of a UiSurface by a specified number of lines.

Parameters

s	Pointer to the UiSurface to be scrolled.
w	The index of the window within the surface to be scrolled.
n	The number of lines to scroll. Positive values scroll down, negative values scroll up.

Returns

0 on success, or -1 on failure.

Definition at line 738 of file ui_ncurses.c.

                                          {
    if (!s->mwin[w])
        return -1;
    wscrl(s->mwin[w], n);
    return 0;
}

Variable Documentation

sfc_ptr

int sfc_ptr = -1

Definition at line 42 of file ui_ncurses.c.

stdsfc

UiSurface* stdsfc

Definition at line 46 of file ui_ncurses.c.

ui

UiRuntime * ui = NULL

Definition at line 39 of file ui_ncurses.c.

Referenced by ui_curs_set(), ui_cursor_enable(), ui_cursor_enable_yx(), ui_cursor_yx(), ui_flush_input(), ui_framed_surface_new(), ui_get_caps(), ui_get_event(), ui_get_event_no_mouse(), ui_get_screen_size(), ui_getch(), ui_init(), ui_init(), ui_initialize_sio(), ui_mice_enable(), ui_mousemask(), ui_ncurses_get_screen(), ui_notcurses_get_nc(), ui_render(), ui_resume(), ui_shutdown(), ui_surface_addpad(), ui_surface_addwin(), ui_surface_box(), ui_surface_box(), ui_surface_new(), ui_suspend(), and ui_update_panels().

ui_color_cnt

uint ui_color_cnt = 0

Definition at line 43 of file ui_ncurses.c.

Referenced by ui_color_from_rgb(), ui_init(), ui_init_clr_palette(), and ui_init_color_hex().

ui_pair_cnt

uint ui_pair_cnt = 0

Definition at line 44 of file ui_ncurses.c.

Referenced by ui_add_pair(), and ui_init().

ui_surface

UiSurface * ui_surface

Definition at line 40 of file ui_ncurses.c.

Referenced by display_field(), display_form(), field_editor(), form_display_accept_field(), form_display_field(), form_display_fields(), form_engine(), form_post(), form_process(), init_form(), main(), menu_cmd_processor(), menu_engine(), open_pick_win(), popup_ckeys(), ui_action_disposition(), ui_answer_yn(), ui_display_error(), ui_perror(), ui_restore_wins(), ui_shutdown(), ui_timeout_prompt(), ui_tracked_sfc_box(), and ui_tracked_sfc_split_box().