ui_ncurses_draw.c File Reference

NCurses UI backend — drawing functions. More...

#include "cm.h"
#include "ui_backend.h"
#include "ui_ncurses_internal.h"
#include <stdlib.h>
#include <string.h>
#include <wchar.h>

Include dependency graph for ui_ncurses_draw.c:

Go to the source code of this file.

Macros
#define	_XOPEN_SOURCE_EXTENDED   1

Functions
int	ui_draw_ch (UiSurface *s, ss_t w, const char c)
	Draw a character in a surface window.
int	ui_draw_ch_yx (UiSurface *s, ss_t w, uint y, uint x, const char c)
	Draw a character at a specific position in a surface window.
int	ui_draw_text (UiSurface *s, ss_t w, uint y, uint x, const char *text)
	on specified window, move to y, x, add string
int	ui_draw_text_fill (UiSurface *s, ss_t w, uint y, uint x, const char *text, int n)
	Draw a text string at a specific position in a surface window, filling the remaining space with spaces if the string is shorter than n.
int	ui_draw_text_n (UiSurface *s, ss_t w, uint y, uint x, const char *text, int n)
	Draw a text string at a specific position in a surface window.
int	ui_mvwadd_wch (UiSurface *s, ss_t w, uint y, uint x, const UiCell *cell)
	Draw a complex character at a specific position in a surface window.
int	ui_mvwadd_wchnstr (UiSurface *s, ss_t w, uint y, uint x, const UiCell *cmplx_buf, uint n)
	Draw a complex character string at a specific position in a surface window, with a maximum length.
int	ui_mvwadd_wchstr (UiSurface *s, ss_t w, uint y, uint x, const UiCell *cmplx_buf)
	Draw a complex character string at a specific position in a surface window.
int	ui_mvwaddch (UiSurface *s, ss_t w, uint y, uint x, const char c)
	Draw a character in a surface window.
int	ui_mvwaddnstr (UiSurface *s, ss_t w, uint y, uint x, const char *text, int m)
	Draw a text string at a specific position in a surface window, with a maximum length.
int	ui_mvwaddnwstr (UiSurface *s, ss_t w, uint y, uint x, const wchar_t *wstr, int m)
	Draw a wide-character string at a specific position in a surface window, with a maximum length.
int	ui_mvwaddstr (UiSurface *s, ss_t w, uint y, uint x, const char *text)
	Draw a text string at a specific position in a surface window.
int	ui_mvwaddstr_fill (UiSurface *s, ss_t w, uint y, uint x, const char *str, int m)
	Draw a text string at a specific position in a surface window, filling the remaining space with spaces if the string is shorter than m.
int	ui_mvwaddwstr (UiSurface *s, ss_t w, uint y, uint x, const wchar_t *wstr)
	Draw a wide-character string at a specific position in a surface window.
void	ui_restore_wins ()
	Restore the state of all windows in the UI. This function refreshes the standard screen and all surface windows, ensuring that their contents are displayed correctly.
int	ui_wadd_wch (UiSurface *s, ss_t w, const UiCell *cell)
	Draw a complex character in a surface window.
int	ui_wadd_wchnstr (UiSurface *s, ss_t w, const UiCell *cmplx_buf, uint n)
	Draw a complex character string in a surface window, with a maximum length.
int	ui_wadd_wchstr (UiSurface *s, ss_t w, const UiCell *cmplx_buf)
	Draw a complex character string in a surface window.
int	ui_waddnstr (UiSurface *s, ss_t w, const char *text, int m)
	Draw a text string in a surface window, with a maximum length.
int	ui_waddnwstr (UiSurface *s, ss_t w, const wchar_t *wstr, int m)
	Draw a wide-character string in a surface window, with a maximum length.
int	ui_waddstr (UiSurface *s, ss_t w, const char *text)
	Draw a text string in a surface window.
int	ui_waddwstr (UiSurface *s, ss_t w, const wchar_t *wstr)
	Draw a wide-character string in a surface window.
int	ui_wclrtobot (UiSurface *s, ss_t w)
	Set the style of a surface window.
int	ui_wclrtoeol (UiSurface *s, ss_t w)
	Clear to the end of the line in a surface window.

Detailed Description

NCurses UI backend — drawing functions.

Implements the drawing operations declared in ui_backend.h using the NCurses wide-character API.

Definition in file ui_ncurses_draw.c.

Macro Definition Documentation

_XOPEN_SOURCE_EXTENDED

#define _XOPEN_SOURCE_EXTENDED   1

Definition at line 9 of file ui_ncurses_draw.c.

Function Documentation

ui_draw_ch()

int ui_draw_ch	(	UiSurface *	s,
		ss_t	w,
		const char	c )

Draw a character in a surface window.

Parameters

s	The surface to modify.
w	The window index within the surface.
c	The character to draw.

Returns

0 on success, -1 on error.

Definition at line 53 of file ui_ncurses_draw.c.

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

ui_draw_ch_yx()

int ui_draw_ch_yx	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x,
		const char	c )

Draw a character at a specific position in a surface window.

Parameters

s	The surface to modify.
w	The window index within the surface.
y	The y-coordinate (row) to draw the character.
x	The x-coordinate (column) to draw the character.
c	The character to draw.

Returns

0 on success, -1 on error.

Definition at line 67 of file ui_ncurses_draw.c.

                                                                      {
    if (!s)
        return -1;
    mvwaddch(s->mwin[w], y, x, c);
    return 0;
}

ui_draw_text()

int ui_draw_text	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x,
		const char *	text )

on specified window, move to y, x, add string

Parameters

s	surface
w	window
y	row
x	column
text	string

Returns

0 on success, -1 on error

Definition at line 74 of file ui_ncurses_draw.c.

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

ui_draw_text_fill()

int ui_draw_text_fill	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x,
		const char *	text,
		int	n )

Draw a text string at a specific position in a surface window, filling the remaining space with spaces if the string is shorter than n.

Parameters

s	The surface to modify.
w	The window index within the surface.
y	The y-coordinate (row) to draw the text.
x	The x-coordinate (column) to draw the text.
text	The text string to draw.
n	The number of characters to draw, padding with spaces if necessary.

Returns

0 on success, -1 on error.

Definition at line 103 of file ui_ncurses_draw.c.

                                                                                     {
    if (!s || !text)
        return -1;
    uint l = strlen(text);
    if (l < (uint)n) {
        char *tmp_str = (char *)malloc(n + 1);
        if (!tmp_str)
            return -1;
        strcpy(tmp_str, text);
        for (int i = l; i < (int)n; i++) {
            tmp_str[i] = ' ';
        }
        tmp_str[n] = '\0';
        mvwaddstr(s->mwin[w], y, x, tmp_str);
        free(tmp_str);
    } else {
        mvwaddnstr(s->mwin[w], y, x, text, (int)n);
    }
    return 0;
}

ui_draw_text_n()

int ui_draw_text_n	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x,
		const char *	text,
		int	n )

Draw a text string at a specific position in a surface window.

Parameters

s	The surface to modify.
w	The window index within the surface.
y	The y-coordinate (row) to draw the text.
x	The x-coordinate (column) to draw the text.
text	The text string to draw.

Returns

0 on success, -1 on error.

Definition at line 88 of file ui_ncurses_draw.c.

                                                                                  {
    if (!s || !text)
        return -1;
    mvwaddnstr(s->mwin[w], y, x, text, (int)n);
    return 0;
}

ui_mvwadd_wch()

int ui_mvwadd_wch	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x,
		const UiCell *	cell )

Draw a complex character at a specific position in a surface window.

on specified window, move to y, x, add cell

Parameters

s	The surface to modify.
w	The window index within the surface.
y	The y-coordinate (row) to draw the complex character.
x	The x-coordinate (column) to draw the complex character.
cell	The complex character (UiCell) to draw.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
y	row
x	column
cell	cell string

Returns

0 on success, -1 on error

Definition at line 305 of file ui_ncurses_draw.c.

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

Referenced by display_form(), and get_cmd_char().

Here is the caller graph for this function:

ui_mvwadd_wchnstr()

int ui_mvwadd_wchnstr	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x,
		const UiCell *	cell,
		uint	m )

Draw a complex character string at a specific position in a surface window, with a maximum length.

on specified window, move to y, x, add cell string, at most m columns

Parameters

s	The surface to modify.
w	The window index within the surface.
y	The y-coordinate (row) to draw the complex character string.
x	The x-coordinate (column) to draw the complex character string.
cmplx_buf	The complex character string (array of UiCell) to draw.
n	The maximum number of complex characters to draw from the complex character string.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
y	row
x	column
cell	cell string
m	maximum number of columns to write

Returns

0 on success, -1 on error

Definition at line 359 of file ui_ncurses_draw.c.

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

Referenced by deselect_object(), form_display_accept_field(), form_display_field(), form_display_fields(), get_cmd_arg(), get_cmd_char(), picker(), remove_right_angle(), reverse_object(), toggle_object(), ui_border_draw(), ui_border_title(), ui_border_ysplit(), ui_border_ysplit_text(), unreverse_object(), and view_cmd_processor().

Here is the caller graph for this function:

ui_mvwadd_wchstr()

int ui_mvwadd_wchstr	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x,
		const UiCell *	cell )

Draw a complex character string at a specific position in a surface window.

on specified window, move to y, x, add cell string

Parameters

s	The surface to modify.
w	The window index within the surface.
y	The y-coordinate (row) to draw the complex character string.
x	The x-coordinate (column) to draw the complex character string.
cmplx_buf	The complex character string (array of UiCell) to draw.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
y	row
x	column
cell	cell string

Returns

0 on success, -1 on error

Definition at line 331 of file ui_ncurses_draw.c.

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

Referenced by display_field(), display_line(), form_display_fields(), and ui_display_chyron().

Here is the caller graph for this function:

ui_mvwaddch()

int ui_mvwaddch	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x,
		const char	c )

Draw a character in a surface window.

on specified window, move to y, x, add character

Parameters

s	The surface to modify.
w	The window index within the surface.
c	The character to draw.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
y	row
x	column
c	character

Returns

0 on success, -1 on error

Definition at line 132 of file ui_ncurses_draw.c.

                                                                    {
    if (!s)
        return -1;
    mvwaddch(s->mwin[w], y, x, c);
    return 0;
}

Referenced by get_cmd_char(), and menu_engine().

Here is the caller graph for this function:

ui_mvwaddnstr()

int ui_mvwaddnstr	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x,
		const char *	text,
		int	m )

Draw a text string at a specific position in a surface window, with a maximum length.

on specified window, move to y, x, add string, at most m columns

Parameters

s	The surface to modify.
w	The window index within the surface.
y	The y-coordinate (row) to draw the text.
x	The x-coordinate (column) to draw the text.
text	The text string to draw.
m	The maximum number of characters to draw from the text string.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
y	row
x	column
text	string
m	maximum number of columns to write

Returns

0 on success, -1 on error

Definition at line 189 of file ui_ncurses_draw.c.

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

ui_mvwaddnwstr()

int ui_mvwaddnwstr	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x,
		const wchar_t *	wstr,
		int	m )

Draw a wide-character string at a specific position in a surface window, with a maximum length.

on specified window, move to y, x, add string, at most m columns

Parameters

s	The surface to modify.
w	The window index within the surface.
y	The y-coordinate (row) to draw the wide-character string.
x	The x-coordinate (column) to draw the wide-character string.
wstr	The wide-character string to draw.
m	The maximum number of wide characters to draw from the wide-character string.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
y	row
x	column
wchar_t	string
m	maximum number of columns to write

Returns

0 on success, -1 on error

Definition at line 276 of file ui_ncurses_draw.c.

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

Referenced by ui_border_title(), and ui_border_ysplit_text().

Here is the caller graph for this function:

ui_mvwaddstr()

int ui_mvwaddstr	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x,
		const char *	text )

Draw a text string at a specific position in a surface window.

on specified window, move to y, x, add string

Parameters

s	The surface to modify.
w	The window index within the surface.
y	The y-coordinate (row) to draw the text.
x	The x-coordinate (column) to draw the text.
text	The text string to draw.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
y	row
x	column
text	string

Returns

0 on success, -1 on error

Definition at line 174 of file ui_ncurses_draw.c.

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

Referenced by cf_accept(), display_form(), display_line(), display_pick_page(), display_prompt(), display_split_line(), main(), pick_engine(), picker(), and popup_ckeys().

Here is the caller graph for this function:

ui_mvwaddstr_fill()

int ui_mvwaddstr_fill	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x,
		const char *	text,
		int	m )

Draw a text string at a specific position in a surface window, filling the remaining space with spaces if the string is shorter than m.

on specified window, move to y, x, add string, at most m columns, fill with spaces if text is shorter than m

Parameters

s	The surface to modify.
w	The window index within the surface.
y	The y-coordinate (row) to draw the text.
x	The x-coordinate (column) to draw the text.
str	The text string to draw.
m	The number of characters to draw, padding with spaces if necessary.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
y	row
x	column
text	string
m	maximum number of columns to write

Returns

0 on success, -1 on error

Definition at line 204 of file ui_ncurses_draw.c.

                                                                                    {
    char *d, *e;
    uint maxy, maxx;
    char tmp_str[MAXLEN];
    getmaxyx(s->mwin[w], maxy, maxx);
    y = min(y, maxy);
    m = min(m, maxx);
    m = min(m, (uint)MAXLEN - 1);
    e = d = tmp_str;
    e += m;
    while (d < e) {
        if (*str == '\0' || *str == '\n')
            *d++ = ' ';
        else
            *d++ = *str++;
    }
    *d = '\0';
    m = strlen(tmp_str);
    mvwaddnstr(s->mwin[w], y, x, tmp_str, m);
    return 0;
}

Referenced by display_pick_page(), picker(), reverse_object(), and unreverse_object().

Here is the caller graph for this function:

ui_mvwaddwstr()

int ui_mvwaddwstr	(	UiSurface *	s,
		ss_t	w,
		uint	y,
		uint	x,
		const wchar_t *	wstr )

Draw a wide-character string at a specific position in a surface window.

on specified window, move to y, x, add wchar_t string

Parameters

s	The surface to modify.
w	The window index within the surface.
y	The y-coordinate (row) to draw the wide-character string.
x	The x-coordinate (column) to draw the wide-character string.
wstr	The wide-character string to draw.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
wchar_t	string

Returns

0 on success, -1 on error

Definition at line 248 of file ui_ncurses_draw.c.

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

ui_restore_wins()

void ui_restore_wins

(

)

Restore the state of all windows in the UI. This function refreshes the standard screen and all surface windows, ensuring that their contents are displayed correctly.

Definition at line 371 of file ui_ncurses_draw.c.

                       {
    touchwin(stdscr);
    for (int s = 0; s <= sfc_ptr; s++) {
        for (ss_t w = BOX; w < SUB_SFC_MAX; w++)
            if (ui_surface[s]->mwin[w] != nullptr)
                touchwin(ui_surface[s]->mwin[w]);
    }
    ui_render();
}

ui_wadd_wch()

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

Draw a complex character in a surface window.

on specified window, at current location, add cell

Parameters

s	The surface to modify.
w	The window index within the surface.
cell	The complex character (UiCell) to draw.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
cell	cell string

Returns

0 on success, -1 on error

Definition at line 291 of file ui_ncurses_draw.c.

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

ui_wadd_wchnstr()

int ui_wadd_wchnstr	(	UiSurface *	s,
		ss_t	w,
		const UiCell *	cell,
		uint	m )

Draw a complex character string in a surface window, with a maximum length.

on specified window, add cell string, at most m columns

Parameters

s	The surface to modify.
w	The window index within the surface.
cmplx_buf	The complex character string (array of UiCell) to draw.
n	The maximum number of complex characters to draw from the complex character string.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
cell	cell string
m	maximum number of columns to write

Returns

0 on success, -1 on error

Definition at line 344 of file ui_ncurses_draw.c.

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

Referenced by display_split_line().

Here is the caller graph for this function:

ui_wadd_wchstr()

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

Draw a complex character string in a surface window.

on specified window, at current location, add cell string

Parameters

s	The surface to modify.
w	The window index within the surface.
cmplx_buf	The complex character string (array of UiCell) to draw.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
cell	cell string

Returns

0 on success, -1 on error

Definition at line 317 of file ui_ncurses_draw.c.

                                                                  {
    if (!s || !cmplx_buf)
        return -1;
    wadd_wchstr(s->mwin[w], cmplx_buf);
    return 0;
}

ui_waddnstr()

int ui_waddnstr	(	UiSurface *	s,
		ss_t	w,
		const char *	text,
		int	m )

Draw a text string in a surface window, with a maximum length.

on specified window, at current location, add string, at most m columns

Parameters

s	The surface to modify.
w	The window index within the surface.
text	The text string to draw.
m	The maximum number of characters to draw from the text string.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
text	string
m	maximum number of columns to write

Returns

0 on success, -1 on error

Definition at line 160 of file ui_ncurses_draw.c.

                                                               {
    if (!s || !text)
        return -1;
    waddnstr(s->mwin[w], text, m);
    return 0;
}

ui_waddnwstr()

int ui_waddnwstr	(	UiSurface *	s,
		ss_t	w,
		const wchar_t *	wstr,
		int	m )

Draw a wide-character string in a surface window, with a maximum length.

on specified window, at current location, add wchar_t string, at most m columns

Parameters

s	The surface to modify.
w	The window index within the surface.
wstr	The wide-character string to draw.
m	The maximum number of wide characters to draw from the wide-character string.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
wchar_t	string
m	maximum number of columns to write

Returns

0 on success, -1 on error

Definition at line 261 of file ui_ncurses_draw.c.

                                                                   {
    if (!s || !wstr)
        return -1;
    waddnwstr(s->mwin[w], wstr, m);
    return 0;
}

ui_waddstr()

int ui_waddstr	(	UiSurface *	s,
		ss_t	w,
		const char *	text )

Draw a text string in a surface window.

on specified window, at current location, add string

Parameters

s	The surface to modify.
w	The window index within the surface.
text	The text string to draw.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
text	string

Returns

0 on success, -1 on error

Definition at line 147 of file ui_ncurses_draw.c.

                                                       {
    if (!s || !text)
        return -1;
    waddstr(s->mwin[w], text);
    return 0;
}

Referenced by display_prompt(), and get_cmd_arg().

Here is the caller graph for this function:

ui_waddwstr()

int ui_waddwstr	(	UiSurface *	s,
		ss_t	w,
		const wchar_t *	wstr )

Draw a wide-character string in a surface window.

on specified window, at current location, add wchar_t string

Parameters

s	The surface to modify.
w	The window index within the surface.
wstr	The wide-character string to draw.

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window
wchar_t	string

Returns

0 on success, -1 on error

Definition at line 234 of file ui_ncurses_draw.c.

                                                           {
    if (!s || !wstr)
        return -1;
    waddwstr(s->mwin[w], wstr);
    return 0;
}

ui_wclrtobot()

int ui_wclrtobot	(	UiSurface *	s,
		ss_t	w )

Set the style of a surface window.

Parameters

s	The surface to modify.
w	The window index within the surface.
style	The style to apply (UiStyle).

Returns

0 on success, -1 on error.

Definition at line 27 of file ui_ncurses_draw.c.

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

ui_wclrtoeol()

int ui_wclrtoeol	(	UiSurface *	s,
		ss_t	w )

Clear to the end of the line in a surface window.

Parameters

s	The surface to modify.
w	The window index within the surface.

Returns

0 on success, -1 on error.

Definition at line 38 of file ui_ncurses_draw.c.

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