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:

Macros
#define	_XOPEN_SOURCE_EXTENDED 1

Functions
void	fast_exit (UiSurface *s)
int	ui_add_color_rgb (RGB *rgb)
uint	ui_add_pair (uint fg, uint bg)
int	ui_bkgd (UiSurface s, uint w, const UiCell cell)
int	ui_bkgdset (UiSurface s, uint w, const UiCell cell)
int	ui_bkgrnd (UiSurface s, uint w, const UiCell cell)
int	ui_bkgrndset (UiSurface s, uint w, const UiCell cell)
UiSurface *	ui_box_surface_new (UiSurface parent, uint p, uint lines, uint cols, uint y, uint x, char wtitle)
UiCell	ui_cell_from_ucp (const wchar_t ucp, const uint32_t fg, const uint32_t *bg)
int	ui_chg_color (uint16_t color_idx, uint32_t *color)
int	ui_chg_pair (uint pair, uint fg, uint bg)
int	ui_clear ()
int	ui_color_content (uint color, uint r, uint g, uint *b)
int	ui_curs_set (int visibility)
int	ui_cursor_enable (UiSurface *s, uint w, bool visible)
	Disable (visible = false) or enable (visibile = true) the cursor at its current position on the surface and plane specified.
int	ui_cursor_enable_yx (UiSurface *s, uint w, uint y, uint x, bool visible)
	Disable (visible = false) or enable (visibile = true) the cursor at a specified position on the surface and plane specified. Include workaround for NotCurses cursor position bug.
int	ui_cursor_move (UiSurface *s, uint w, uint y, uint x)
int	ui_doupdate ()
void	ui_endwin ()
int	ui_erase ()
UiBackend	ui_get_backend ()
	Return which backend is powering this runtime.
void	ui_get_caps (UiCaps *caps)
	Query the capabilities of the active backend.
uint32_t	ui_get_color (uint16_t color_idx)
void	ui_get_screen_size (uint lines, uint cols)
int	ui_getcchar (const UiCell uc, wchar_t wstr, attr_t attrs, uint16_t pair, void *opts)
int	ui_getmaxx (UiSurface *s, uint w)
int	ui_getmaxy (UiSurface *s, uint w)
void	ui_getmaxyx (UiSurface s, uint w, uint lines, uint *cols)
void	ui_getyx (UiSurface s, uint w, uint lines, uint *cols)
RGB	ui_hex_to_rgb (char *s)
int	ui_idcok (UiSurface *s, uint w, bool enable)
int	ui_idlok (UiSurface *s, uint w, bool enable)
struct UiRuntime *	ui_init (const UiConfig *cfg)
int	ui_init_color (uint color, uint r, uint g, uint b)
int	ui_init_pair (uint pair, uint fg, uint bg)
int	ui_keypad (UiSurface *s, uint w, bool enable)
SCREEN *	ui_ncurses_get_screen ()
PANEL *	ui_ncurses_surface_get_panel (const UiSurface *s, uint w)
	Return the raw NCurses `PANEL*` underlying a surface.
WINDOW *	ui_ncurses_surface_get_win (const UiSurface *s, uint w)
	Return the raw NCurses `WINDOW*` underlying a surface.
int	ui_pair_content (uint pair, uint fg, uint bg)
int	ui_pair_from_hex (const char fg, const char bg)
void	ui_render ()
int	ui_resume ()
int	ui_scrollok (UiSurface *s, uint w, bool enable)
int	ui_setcchar (cchar_t wch, const wchar_t wc, const attr_t attrs, short pair, const void *opts)
int	ui_setscrreg (UiSurface *s, uint w, uint top, uint bottom)
void	ui_shutdown ()
int	ui_surface_addpad (UiSurface *s, uint w, uint view_win, uint lines, uint cols)
int	ui_surface_addwin (UiSurface *s, uint w, uint p, uint lines, uint cols, uint y, uint x)
void	ui_surface_destroy (UiSurface *s)
int	ui_surface_hide (UiSurface *s, uint w)
int	ui_surface_move (UiSurface *s, uint w, uint y, uint x)
UiSurface *	ui_surface_new (uint w, UiSurface *parent, uint p, uint lines, uint cols, uint y, uint x)
int	ui_surface_resize (UiSurface *s, uint w, uint lines, uint cols)
int	ui_surface_show (UiSurface *s, uint w)
int	ui_suspend ()
int	ui_top_panel (UiSurface *s, uint w)
void	ui_update_panels ()
int	ui_wclear (UiSurface *s, uint w)
int	ui_werase (UiSurface *s, uint w)
int	ui_wmove (UiSurface *s, uint w, uint y, uint x)
int	ui_wnoutrefresh (UiSurface *s, uint w)
int	ui_wscrl (UiSurface *s, uint w, uint n)

Variables
wchar_t *	border_double = L"═║╠╣╦╩╬╔╗╚╝"
wchar_t *	border_heavy = L"━┃┣┫┳┻╋┏┓┗┛"
wchar_t *	border_none = L" "
wchar_t *	border_rounded = L"─│├┤┬┴┼╭╮╰╯"
wchar_t *	border_single = L"─│├┤┬┴┼┌┐└┘"
BorderWide	bw
const wchar_t *	bw_chk = L"\x2611"
const wchar_t *	bw_da = L"\x2193"
const wchar_t *	bw_h09 = L"\x23BD"
const wchar_t *	bw_la = L"\x2190"
const wchar_t *	bw_lan = L"\x276E"
const wchar_t *	bw_ra = L"\x2192"
const wchar_t *	bw_ran = L"\x276F"
const wchar_t *	bw_rbl = L"\x2570"
const wchar_t *	bw_rbr = L"\x256f"
const wchar_t *	bw_rtl = L"\x256d"
const wchar_t *	bw_rtr = L"\x256e"
const wchar_t *	bw_sp = L"\x20"
const wchar_t *	bw_ua = L"\x2191"
int	sfc_ptr = -1
STDRGB	std_color []
UiSurface *	stdsfc
UiRuntime *	ui = NULL
uint	ui_color_cnt = 0
uint	ui_pair_cnt = 0
UiSurface *	ui_surface [UI_SFC_MAX]
int	win_ptr = -1

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 )

Definition at line 490 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_add_color_rgb()

int ui_add_color_rgb ( RGB * rgb )

Definition at line 138 of file ui_ncurses.c.

                               {
    uint i;
    RGB tmp;
    apply_gamma(rgb);
    rgb->r = (rgb->r * 1000) / 255;
    rgb->g = (rgb->g * 1000) / 255;
    rgb->b = (rgb->b * 1000) / 255;
    rgb->a = 0;
    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;
}

◆ ui_add_pair()

uint ui_add_pair	(	uint	fg,
		uint	bg )

Definition at line 105 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);
        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);
        display_error(em0, em1, em2, nullptr);
        return (EXIT_FAILURE);
    }
    ui_pair_cnt++;
    return (int)(ui_pair_cnt - 1);
}

Referenced by initialize_cells(), parse_ansi(), parse_ansi_str(), ui_cell_from_ucp(), ui_getcchar(), and ui_pair_from_hex().

Here is the caller graph for this function:

◆ ui_bkgd()

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

Definition at line 753 of file ui_ncurses.c.

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

◆ ui_bkgdset()

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

Definition at line 760 of file ui_ncurses.c.

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

◆ ui_bkgrnd()

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

Definition at line 767 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,
		uint	w,
		const UiCell *	cell )

Definition at line 774 of file ui_ncurses.c.

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

◆ ui_box_surface_new()

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

Definition at line 453 of file ui_ncurses.c.

                                                                                                              {
    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 + 2, cols + 2, y, x);
        if (!s->mwin[BOX]) {
            free(s);
            return NULL;
        }
    } else {
        s->mwin[BOX] = newwin(lines + 2, cols + 2, 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);
    border_draw(s);
    border_title(s, wtitle);
#ifdef DEBUG_UI
    immedok(s->mwin[BOX], true);
#endif
    return s;
}

◆ ui_cell_from_ucp()

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

Definition at line 239 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_add_color_rgb(&rgb);
    rgb.r = (*bg >> 16) & 0xff;
    rgb.g = (*bg >> 8) & 0xff;
    rgb.b = *bg & 0xff;
    int b_idx = ui_add_color_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;
}

◆ ui_chg_color()

int ui_chg_color	(	uint16_t	color_idx,
		uint32_t *	color )

Definition at line 206 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;
    apply_gamma(&rgb);
    rgb.r = (rgb.r * 1000) / 255;
    rgb.g = (rgb.g * 1000) / 255;
    rgb.b = (rgb.b * 1000) / 255;
    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;
    }
    init_extended_color(color_idx, rgb.r, rgb.g, rgb.b);
    return 0;
}

◆ ui_chg_pair()

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

Definition at line 132 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 ( )

Definition at line 594 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 179 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_add_color_rgb(), ui_get_channels_from_pair(), and ui_setcchar().

Here is the caller graph for this function:

◆ ui_curs_set()

int ui_curs_set ( int visibility )

Definition at line 737 of file ui_ncurses.c.

                                {
    curs_set(visibility);
    return 0;
}

◆ ui_cursor_enable()

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

Disable (visible = false) or enable (visibile = true) the cursor at its current position on the surface and plane specified.

Definition at line 713 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,
		uint	w,
		uint	y,
		uint	x,
		bool	visible )

Disable (visible = false) or enable (visibile = true) the cursor at a specified position on the surface and plane specified. Include workaround for NotCurses cursor position bug.

Definition at line 703 of file ui_ncurses.c.

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

◆ ui_cursor_move()

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

Definition at line 727 of file ui_ncurses.c.

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

◆ ui_doupdate()

int ui_doupdate ( )

Definition at line 807 of file ui_ncurses.c.

                  {
    doupdate();
    return 0;
}

◆ ui_endwin()

void ui_endwin ( )

Definition at line 341 of file ui_ncurses.c.

                 {
    ui_shutdown();
}

◆ ui_erase()

int ui_erase ( )

Definition at line 590 of file ui_ncurses.c.

               {
    erase();
    return 0;
}

◆ ui_get_backend()

UiBackend ui_get_backend ( )

Return which backend is powering this runtime.

Parameters

ui	The UiRuntime returned by ui_init().

Returns: The UiBackend enum value for the compiled-in backend.

Definition at line 84 of file ui_ncurses.c.

                           {
    return UI_BACKEND_NCURSES;
}

◆ ui_get_caps()

void ui_get_caps ( UiCaps * caps )

Query the capabilities of the active backend.

Parameters

ui	The UiRuntime returned by ui_init().
caps	Output structure filled with capability flags.

Definition at line 88 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 )

Definition at line 164 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 )

Definition at line 692 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 *	uc,
		wchar_t *	wstr,
		attr_t *	attrs,
		uint16_t *	pair,
		void *	opts )

Definition at line 784 of file ui_ncurses.c.

                                                                                            {
    short p;
    getcchar(uc, wstr, attrs, &p, opts);
    pair = (uint16_t *)&p;
    p = (short)(*pair); // Tell compiler to forget about it!
    return 0;
}

Referenced by fmt_line(), log_cc_buf(), and mbstr_to_cellstr().

Here is the caller graph for this function:

◆ ui_getmaxx()

int ui_getmaxx	(	UiSurface *	s,
		uint	w )

Definition at line 686 of file ui_ncurses.c.

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

Referenced by border_draw(), border_title(), border_ysplit(), and border_ysplit_text().

Here is the caller graph for this function:

◆ ui_getmaxy()

int ui_getmaxy	(	UiSurface *	s,
		uint	w )

Definition at line 681 of file ui_ncurses.c.

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

Referenced by assign_chyron_win(), and border_draw().

Here is the caller graph for this function:

◆ ui_getmaxyx()

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

Definition at line 676 of file ui_ncurses.c.

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

◆ ui_getyx()

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

Definition at line 668 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 )

Definition at line 174 of file ui_ncurses.c.

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

◆ ui_idcok()

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

Definition at line 653 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,
		uint	w,
		bool	enable )

Definition at line 644 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 )

Definition at line 261 of file ui_ncurses.c.

                                               {
    setlocale(LC_ALL, "");
    ui = calloc(1, sizeof(*ui));
    if (!ui)
        return NULL;
    char tty_name[MAXLEN];
    if (cfg && cfg->tty_path) {
        strncpy(tty_name, cfg->tty_path, sizeof(tty_name) - 1);
        tty_name[sizeof(tty_name) - 1] = '\0';
    } else {
        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->screen = newterm(NULL, ui->tty_fp, ui->tty_fp);
    if (!ui->screen) {
        fclose(ui->tty_fp);
        free(ui);
        return NULL;
    }
    set_term(ui->screen);
    f_curses_open = true;
    if (!has_colors() || !can_change_color()) {
        ui_shutdown();
        return NULL;
    }
    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;
        ui->border_style = cfg->border_style;
    } else {
        ui->cursor_visible = false;
        ui->alt_screen = false;
    }
    if (ui->mouse_enabled)
        mousemask(ALL_MOUSE_EVENTS | REPORT_MOUSE_POSITION, NULL);
    getmaxyx(stdscr, ui->lines, ui->cols);
    if (cfg) {
        if (ui->border_style == 'r' || ui->border_style == 'R') {
            memcpy(bw.str, border_rounded, sizeof(bw.str));
        } else if (ui->border_style == 's' || ui->border_style == 'S') {
            memcpy(bw.str, border_single, sizeof(bw.str));
        } else if (ui->border_style == 'd' || ui->border_style == 'D') {
            memcpy(bw.str, border_double, sizeof(bw.str));
        } else if (ui->border_style == 'h' || ui->border_style == 'H') {
            memcpy(bw.str, border_heavy, sizeof(bw.str));
        } else if (ui->border_style == 'n' || ui->border_style == 'N') {
            memcpy(bw.str, border_none, sizeof(bw.str));
        }
    }
    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);
        Perror("new_panel failed for stdsfc->mpan[BOX]");
        exit(EXIT_FAILURE);
    }
    return ui;
}

◆ ui_init_color()

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

Definition at line 189 of file ui_ncurses.c.

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

Referenced by ui_add_color_rgb().

Here is the caller graph for this function:

◆ ui_init_pair()

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

Definition at line 202 of file ui_ncurses.c.

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

◆ ui_keypad()

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

Definition at line 635 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 ( )

Definition at line 821 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,
		uint	w )

Return the raw NCurses PANEL* underlying a surface.

Parameters

s	The UiSurface to inspect.
w	UiSurface window

Returns: The PANEL pointer, or NULL if s is NULL.

Definition at line 833 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,
		uint	w )

Return the raw NCurses WINDOW* underlying a surface.

Parameters

s	The UiSurface to inspect.

Returns: The WINDOW pointer, or NULL if s is NULL.

Definition at line 827 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 )

Definition at line 194 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(), and ui_add_pair().

Here is the caller graph for this function:

◆ ui_pair_from_hex()

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

Definition at line 230 of file ui_ncurses.c.

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

References ui_add_color_rgb(), and ui_add_pair().

Here is the call graph for this function:

◆ ui_render()

void ui_render ( )

Definition at line 800 of file ui_ncurses.c.

                 {
    update_panels();
    doupdate();
}

◆ ui_resume()

int ui_resume ( )

Definition at line 403 of file ui_ncurses.c.

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

◆ ui_scrollok()

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

Definition at line 626 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	(	cchar_t *	wch,
		const wchar_t *	wc,
		const attr_t	attrs,
		short	pair,
		const void *	opts )

Definition at line 792 of file ui_ncurses.c.

                                                                                                   {
    (void)opts;
    return setcchar(wch, wc, attrs, pair, NULL);
}

Referenced by fmt_line(), and mbstr_to_cellstr().

Here is the caller graph for this function:

◆ ui_setscrreg()

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

Definition at line 662 of file ui_ncurses.c.

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

◆ ui_shutdown()

void ui_shutdown ( )

Definition at line 344 of file ui_ncurses.c.

                   {
    if (ui == NULL)
        return;
    for (int i = sfc_ptr; i >= 0; i--) {
        if (ui_surface[i] != NULL) {
            ui_surface_destroy(ui_surface[i]);
            ui_surface[i] = NULL;
        }
    }
    if (stdsfc->mpan[0] != NULL) {
        hide_panel(stdsfc->mpan[0]);
        del_panel(stdsfc->mpan[0]);
        stdsfc->mpan[0] = NULL;
    }
    f_curses_open = false;
    endwin();
    if (ui->screen != NULL) {
        delscreen(ui->screen);
        ui->screen = NULL;
    }
    if (ui->tty_fp != NULL) {
        fclose(ui->tty_fp);
        ui->tty_fp = NULL;
    }
    if (stdsfc != NULL) {
        free(stdsfc);
        stdsfc = NULL;
    }
    if (ui != NULL) {
        free(ui);
        ui = NULL;
    }
}

◆ ui_surface_addpad()

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

Definition at line 509 of file ui_ncurses.c.

                                                                                  {
    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,
		uint	w,
		uint	p,
		uint	lines,
		uint	cols,
		uint	y,
		uint	x )

Definition at line 523 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_destroy()

void ui_surface_destroy ( UiSurface * s )

Definition at line 377 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]);
            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,
		uint	w )

Definition at line 614 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,
		uint	w,
		uint	y,
		uint	x )

Definition at line 542 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	(	uint	w,
		UiSurface *	parent,
		uint	p,
		uint	lines,
		uint	cols,
		uint	y,
		uint	x )

Definition at line 414 of file ui_ncurses.c.

                                                                                                    {
    if (!ui)
        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,
		uint	w,
		uint	lines,
		uint	cols )

Definition at line 550 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,
		uint	w )

Definition at line 598 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 ( )

Definition at line 398 of file ui_ncurses.c.

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

◆ ui_top_panel()

int ui_top_panel	(	UiSurface *	s,
		uint	w )

Definition at line 607 of file ui_ncurses.c.

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

◆ ui_update_panels()

void ui_update_panels ( )

Definition at line 804 of file ui_ncurses.c.

                        {
    update_panels();
}

◆ ui_wclear()

int ui_wclear	(	UiSurface *	s,
		uint	w )

Definition at line 574 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,
		uint	w )

Definition at line 560 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,
		uint	w,
		uint	y,
		uint	x )

Definition at line 732 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,
		uint	w )

Definition at line 811 of file ui_ncurses.c.

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

◆ ui_wscrl()

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

Definition at line 741 of file ui_ncurses.c.

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

References ui_render().

Here is the call graph for this function:

Variable Documentation

◆ border_double

wchar_t* border_double = L"═║╠╣╦╩╬╔╗╚╝"

Definition at line 42 of file ui_ncurses.c.

◆ border_heavy

wchar_t* border_heavy = L"━┃┣┫┳┻╋┏┓┗┛"

Definition at line 43 of file ui_ncurses.c.

◆ border_none

wchar_t * border_none = L" "

Definition at line 44 of file ui_ncurses.c.

Referenced by ui_init(), and ui_init().

◆ border_rounded

wchar_t* border_rounded = L"─│├┤┬┴┼╭╮╰╯"

BOX WIDE UNICODE CODEPOINTS

Definition at line 41 of file ui_ncurses.c.

◆ border_single

wchar_t * border_single = L"─│├┤┬┴┼┌┐└┘"

BOX WIDE UNICODE CODEPOINTS

Definition at line 40 of file ui_ncurses.c.

Referenced by ui_init(), and ui_init().

◆ bw

BorderWide bw

Definition at line 46 of file ui_ncurses.c.

◆ bw_chk

const wchar_t* bw_chk = L"\x2611"

left_angle

Definition at line 59 of file ui_ncurses.c.

◆ bw_da

const wchar_t* bw_da = L"\x2193"

large down arrow

Definition at line 56 of file ui_ncurses.c.

◆ bw_h09

const wchar_t* bw_h09 = L"\x23BD"

horizontal line 9

Definition at line 60 of file ui_ncurses.c.

◆ bw_la

const wchar_t* bw_la = L"\x2190"

large left arrow

Definition at line 54 of file ui_ncurses.c.

◆ bw_lan

const wchar_t* bw_lan = L"\x276E"

left_angle

Definition at line 58 of file ui_ncurses.c.

◆ bw_ra

const wchar_t* bw_ra = L"\x2192"

large right arrow

Definition at line 53 of file ui_ncurses.c.

◆ bw_ran

const wchar_t* bw_ran = L"\x276F"

right_angle

Definition at line 57 of file ui_ncurses.c.

◆ bw_rbl

const wchar_t* bw_rbl = L"\x2570"

rounded bottom left

Definition at line 50 of file ui_ncurses.c.

◆ bw_rbr

const wchar_t* bw_rbr = L"\x256f"

rounded bottom right

Definition at line 51 of file ui_ncurses.c.

◆ bw_rtl

const wchar_t* bw_rtl = L"\x256d"

rounded top left

Definition at line 48 of file ui_ncurses.c.

◆ bw_rtr

const wchar_t* bw_rtr = L"\x256e"

rounded top right

Definition at line 49 of file ui_ncurses.c.

◆ bw_sp

const wchar_t* bw_sp = L"\x20"

space

Definition at line 52 of file ui_ncurses.c.

◆ bw_ua

const wchar_t* bw_ua = L"\x2191"

large up arrow

Definition at line 55 of file ui_ncurses.c.

◆ sfc_ptr

int sfc_ptr = -1

Definition at line 31 of file ui_ncurses.c.

◆ std_color

STDRGB std_color[]

Initial value:

             = {
{0, 0, 0},
{128, 0, 0},
{0, 128, 0},
{128, 128, 0},
{0, 0, 128},
{128, 0, 128},
{0, 128, 128},
{192, 192, 192},
{128, 128, 128},
{255, 0, 0},
{0, 255, 0},
{255, 255, 0},
{0, 0, 255},
{255, 0, 255},
{0, 255, 255},
{255, 255, 255}}

Definition at line 62 of file ui_ncurses.c.

                   {
    {0, 0, 0},
    {128, 0, 0},
    {0, 128, 0},
    {128, 128, 0},
    {0, 0, 128},
    {128, 0, 128},
    {0, 128, 128},
    {192, 192, 192},
    {128, 128, 128},
    {255, 0, 0},
    {0, 255, 0},
    {255, 255, 0},
    {0, 0, 255},
    {255, 0, 255},
    {0, 255, 255},
    {255, 255, 255}};

◆ stdsfc

UiSurface* stdsfc

Definition at line 36 of file ui_ncurses.c.

◆ ui

UiRuntime* ui = NULL

Definition at line 27 of file ui_ncurses.c.

◆ ui_color_cnt

uint ui_color_cnt = 0

Definition at line 33 of file ui_ncurses.c.

◆ ui_pair_cnt

uint ui_pair_cnt = 0

Definition at line 34 of file ui_ncurses.c.

◆ ui_surface

UiSurface* ui_surface[UI_SFC_MAX]

Definition at line 28 of file ui_ncurses.c.

◆ win_ptr

int win_ptr = -1

Definition at line 30 of file ui_ncurses.c.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ _XOPEN_SOURCE_EXTENDED

Function Documentation

◆ fast_exit()

◆ ui_add_color_rgb()

◆ ui_add_pair()

◆ ui_bkgd()

◆ ui_bkgdset()

◆ ui_bkgrnd()

◆ ui_bkgrndset()

◆ ui_box_surface_new()

◆ ui_cell_from_ucp()

◆ ui_chg_color()

◆ ui_chg_pair()

◆ ui_clear()

◆ ui_color_content()

◆ ui_curs_set()

◆ ui_cursor_enable()

◆ ui_cursor_enable_yx()

◆ ui_cursor_move()

◆ ui_doupdate()

◆ ui_endwin()

◆ ui_erase()

◆ ui_get_backend()

◆ ui_get_caps()

◆ ui_get_color()

◆ ui_get_screen_size()

◆ ui_getcchar()

◆ ui_getmaxx()

◆ ui_getmaxy()

◆ ui_getmaxyx()

◆ ui_getyx()

◆ ui_hex_to_rgb()

◆ ui_idcok()

◆ ui_idlok()

◆ ui_init()

◆ ui_init_color()

◆ ui_init_pair()

◆ ui_keypad()

◆ ui_ncurses_get_screen()

◆ ui_ncurses_surface_get_panel()

◆ ui_ncurses_surface_get_win()

◆ ui_pair_content()

◆ ui_pair_from_hex()

◆ ui_render()

◆ ui_resume()

◆ ui_scrollok()

◆ ui_setcchar()

◆ ui_setscrreg()

◆ ui_shutdown()

◆ ui_surface_addpad()

◆ ui_surface_addwin()

◆ ui_surface_destroy()

◆ ui_surface_hide()

◆ ui_surface_move()

◆ ui_surface_new()

◆ ui_surface_resize()

◆ ui_surface_show()

◆ ui_suspend()

◆ ui_top_panel()

◆ ui_update_panels()

◆ ui_wclear()

◆ ui_werase()

◆ ui_wmove()

◆ ui_wnoutrefresh()

◆ ui_wscrl()

Variable Documentation

◆ border_double

◆ border_heavy

◆ border_none

◆ border_rounded

◆ border_single

◆ bw

◆ bw_chk

◆ bw_da

◆ bw_h09