ui_backend.h File Reference

Backend API for terminal UI library. More...

#include <poll.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

Include dependency graph for ui_backend.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
union	border_wide
struct	ext_fd_reg_t
struct	GCluster
struct	RGB
struct	SIO
struct	STDRGB
struct	ui_context_t
struct	UiCaps
struct	UiCchar64
struct	UiCell
union	UiChannels
struct	UiConfig
struct	UiEvent
struct	UiMultiMedia
struct	UiRect
struct	UiRuntime
struct	UiSurface
struct	UiSurfaceMeta

Macros
#define	_GNU_SOURCE
#define	_XOPEN_SOURCE_EXTENDED   1
#define	ALLWINS   (uint)1000
#define	AS_ENUM(NAME)
#define	AS_ENUM(NAME)
#define	AS_ENUM(NAME)
#define	AS_ENUM(NAME)
#define	AS_ENUM(NAME)
#define	BG_COLOR   0
#define	BO_COLOR   1
#define	BORDER_STYLE(X)
#define	bw_bl   bw.bl
#define	bw_br   bw.br
#define	bw_bt   bw.bt
#define	bw_cr   bw.cr
#define	bw_ho   bw.ho
#define	bw_lt   bw.lt
#define	bw_rt   bw.rt
#define	bw_tl   bw.tl
#define	bw_tr   bw.tr
#define	bw_tt   bw.tt
#define	bw_ve   bw.ve
#define	CCHARW_MAX   5
#define	CELL_CHAR_INITIALIZER(c)
#define	CELL_INITIALIZER(c, s, chan)
#define	CHYRON_KEY_MAXLEN   64
#define	CHYRON_KEYS   20
#define	COLOR_LEN   8
#define	ERR   -1
#define	FG_COLOR   2
#define	FILE_TYPE_LIST(X)
#define	KEY_ALTDEL   0x20e
#define	KEY_ALTDOWN   0x214
#define	KEY_ALTEND   0x219
#define	KEY_ALTHOME   0x21e
#define	KEY_ALTINS   0x223
#define	KEY_ALTLEFT   0x228
#define	KEY_ALTPGDN   0x22d
#define	KEY_ALTPGUP   0x232
#define	KEY_ALTRIGHT   0x237
#define	KEY_ALTUP   0x23d
#define	LN_BG_COLOR   7
#define	LN_COLOR   4
#define	LOG_LEVEL_LIST(X)
#define	MAX_EXT_FDS   8
#define	MAXLEN   256
#define	MOUSE_ACTION(X)
#define	SFC_MAX   30
#define	SUB_SURFACE_LIST(X)
#define	UI_COLORS   512
#define	UI_PAIRS   512
#define	UI_SFC_MAX   30
#define	XTERM_256COLOR   1

Typedefs
typedef uint16_t	attr_t
typedef union border_wide	BorderWide
typedef struct ncinput	NcInput
typedef struct ncplane	NcPlane
typedef struct ncplane_options	NcPlaneOptions
typedef struct ncvisual	NcVisual
typedef struct notcurses	NotCurses
typedef struct notcurses_options	NotCursesOptions
typedef struct SIO	SIO
typedef nccell	UiCell
typedef union UiChannels	UiChannels
typedef struct UiColor	UiColor
typedef uint	UiColorIdx
typedef uint32_t	UiKey
typedef struct UiMB	UiMB
typedef struct UiPair	UiPair
typedef uint16_t	UiPairIdx
typedef struct UiRuntime	UiRuntime
typedef struct UiSplitSurface	UiSplitSurface
typedef uint16_t	UiStyle
typedef struct UiSurface	UiSurface

Enumerations
enum	ColorsEnum {   CLR_BLACK , CLR_RED , CLR_GREEN , CLR_YELLOW ,   CLR_BLUE , CLR_MAGENTA , CLR_CYAN , CLR_WHITE ,   CLR_BBLACK , CLR_BRED , CLR_BGREEN , CLR_BYELLOW ,   CLR_BBLUE , CLR_BMAGENTA , CLR_BCYAN , CLR_BWHITE ,   CLR_BORANGE , CLR_FG , CLR_BG , CLR_BOX_FG ,   CLR_BOX_BG , CLR_IND_FG , CLR_IND_BG , CLR_BRACKETS_FG ,   CLR_BRACKETS_BG , CLR_FILL_CHAR_FG , CLR_FILL_CHAR_BG , CLR_LN_FG ,   CLR_LN_BG , CLR_CMDLN_FG , CLR_CMDLN_BG , CLR_NT_FG ,   CLR_NT_BG , CLR_NT_REV_FG , CLR_NT_REV_BG , CLR_NT_HL_FG ,   CLR_NT_HL_BG , CLR_NT_HL_REV_FG , CLR_NT_HL_REV_BG , CLR_TITLE_FG ,   CLR_TITLE_BG , CLR_NCOLORS }
enum	FileType { FT_MAX }
enum	ss_t { SUB_SFC_MAX }
enum	UiBackend { UI_BACKEND_NCURSES = 0 , UI_BACKEND_NOTCURSES }
enum	UiBorderStyle { BORDER_MAX }
enum	UiLogLevel { LOG_LEVEL_COUNT }
enum	UiMouseAction { MOUSE_ACTION_MAX }

Functions
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.
int	ui_border_draw (UiSurface *sfc)
int	ui_border_title (UiSurface *sfc, const char *title)
	Draw a box with a title around the specified window.
int	ui_border_ysplit (UiSurface *sfc, uint y)
	Draw a box with a separator line around the specified window.
int	ui_border_ysplit_text (UiSurface *sfc, char *text, uint separator_line)
	Draw a box with a separator line and text around the specified window.
int	ui_clear ()
	Clear the entire screen.
int	ui_cm_surface_destroy (UiSurface *sfc)
	Destroy the most recently created surface.
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.
int	ui_doupdate ()
	Refresh the display by updating the screen.
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_hline (UiSurface *s, ss_t w, uint y, uint x, uint len, const UiStyle *style)
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 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 n.
int	ui_draw_text_n (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.
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.
int	ui_get_event_no_mouse (UiSurface *surface, ss_t w, UiEvent *ev)
	Wait for an input event on target (or stdscr if NULL) without mouse support.
void	ui_get_screen_size (uint *lines, uint *cols)
	Get the current screen size (number of lines and columns).
int	ui_getch ()
	Wait for a single input character from the NotCurses context.
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.
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.
UiRuntime *	ui_init (const UiConfig *config, SIO *sio)
	Initialize the UI runtime with the given configuration and SIO.
void	ui_initialize_sio (SIO *sio)
int	ui_keypad (UiSurface *s, ss_t w, bool enable)
	Enable or disable the keypad for a UiSurface.
int	ui_mice_enable (int mask)
	Enable or disable mouse support.
int	ui_mousemask (int mask)
	Enable or disable mouse support.
void	ui_render ()
	Render the UI by updating panels and refreshing the display.
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_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_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.
const char *	ui_sub_surface_str (ss_t w)
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 *title)
	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.
int	ui_tracked_sfc_box (uint wlines, uint wcols, uint wbegy, uint wbegx, const char *wtitle)
	Create a new surface with a box window.
int	ui_tracked_sfc_split_box (uint wlines, uint wcols, uint split_y, uint split_x, uint wbegy, uint wbegx, const char *wtitle)
	Create a new surface with a split box window.
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_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.
int	ui_werase (UiSurface *s, ss_t w)
	Erase the contents of a UiSurface or all surfaces.
int	ui_whide (UiSurface *s, ss_t w)
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_wresize (UiSurface *s, ss_t w, uint lines, uint cols)
int	ui_wscrl (UiSurface *s, ss_t w, int rows)
	Scroll the contents of a UiSurface by a specified number of lines.
int	ui_wshow (UiSurface *s, ss_t w)

Variables
const wchar_t *	border_double = L"═║╠╣╦╩╬╔╗╚╝"
const wchar_t *	border_heavy = L"━┃┣┫┳┻╋┏┓┗┛"
const wchar_t *	border_none = L" "
const wchar_t *	border_rounded = L"─│├┤┬┴┼╭╮╰╯"
const wchar_t *	border_single = L"─│├┤┬┴┼┌┐└┘"
BorderWide	bw
const wchar_t *	bw_chk = L"\u2611"
const wchar_t *	bw_da = L"\u2193"
const wchar_t *	bw_h09 = L"\u23BD"
const wchar_t *	bw_la = L"\u2190"
const wchar_t *	bw_lan = L"\u276E"
const wchar_t *	bw_ra = L"\u2192"
const wchar_t *	bw_ran = L"\u276F"
const wchar_t *	bw_rbl = L"\u2570"
const wchar_t *	bw_rbr = L"\u256f"
const wchar_t *	bw_rtl = L"\u256d"
const wchar_t *	bw_rtr = L"\u256e"
const wchar_t *	bw_sp = L"\x20"
const wchar_t *	bw_ua = L"\u2191"
UiCell	cell_bl
UiCell	cell_box
UiCell	cell_br
UiCell	cell_brktl
UiCell	cell_brktr
UiCell	cell_bs
UiCell	cell_bt
UiCell	cell_chk
UiCell	cell_cmdln
UiCell	cell_cr
UiCell	cell_default
UiCell	cell_fill_char
UiCell	cell_ho
UiCell	cell_ind
UiCell	cell_ln
UiCell	cell_ls
UiCell	cell_lt
UiCell	cell_nt
UiCell	cell_nt_hl
UiCell	cell_nt_hl_rev
UiCell	cell_nt_rev
UiCell	cell_ran
UiCell	cell_rs
UiCell	cell_rt
UiCell	cell_sp
UiCell	cell_title
UiCell	cell_tl
UiCell	cell_tr
UiCell	cell_ts
UiCell	cell_tt
UiCell	cell_ve
int	click_x
int	click_y
uint	clr_cnt
uint	clr_idx
uint	clr_pair_cnt
uint	clr_pair_idx
char const	colors_text [][10]
	Color names for .minitrc overrides.
uint	COLS
ushort	cp_blue
ushort	cp_bold
ushort	cp_box
ushort	cp_brackets
ushort	cp_cmdln_bg
ushort	cp_cmdln_fg
ushort	cp_default
ushort	cp_fill_char
ushort	cp_green
ushort	cp_highlight
ushort	cp_ind
ushort	cp_ln_bg
ushort	cp_ln_fg
ushort	cp_nt
ushort	cp_nt_hl
ushort	cp_nt_hl_rev
ushort	cp_nt_rev
ushort	cp_red
ushort	cp_title
ushort	cp_yellow
char	em0 [MAXLEN]
char	em1 [MAXLEN]
char	em2 [MAXLEN]
char	em3 [MAXLEN]
bool	f_ncurses_open = false
bool	f_notcurses_open = false
uint	LINES
int	sfc_ptr = -1
NcPlane *	stdplane
UiSurface *	stdsfc
ui_context_t	ui_ctx
int	win_ptr

Detailed Description

Backend API for terminal UI library.

Definition in file ui_backend.h.

Macro Definition Documentation

_GNU_SOURCE

#define _GNU_SOURCE

Definition at line 13 of file ui_backend.h.

_XOPEN_SOURCE_EXTENDED

#define _XOPEN_SOURCE_EXTENDED   1

Definition at line 12 of file ui_backend.h.

ALLWINS

#define ALLWINS   (uint)1000

Definition at line 195 of file ui_backend.h.

AS_ENUM [1/5]

#define AS_ENUM

(

NAME

)

Value:

NAME,

Definition at line 44 of file ui_backend.h.

AS_ENUM [2/5]

#define AS_ENUM

(

NAME

)

Value:

NAME,

Definition at line 44 of file ui_backend.h.

AS_ENUM [3/5]

#define AS_ENUM

(

NAME

)

Value:

NAME,

Definition at line 44 of file ui_backend.h.

AS_ENUM [4/5]

#define AS_ENUM

(

NAME

)

Value:

NAME,

Definition at line 44 of file ui_backend.h.

AS_ENUM [5/5]

#define AS_ENUM

(

NAME

)

Value:

NAME,

Definition at line 44 of file ui_backend.h.

BG_COLOR

#define BG_COLOR   0

default background color

Definition at line 500 of file ui_backend.h.

BO_COLOR

#define BO_COLOR   1

default bold foreground color

Definition at line 501 of file ui_backend.h.

BORDER_STYLE

#define BORDER_STYLE

(

X

)

Value:

X(UI_BORDER_NONE)    \
X(UI_BORDER_SINGLE)  \
X(UI_BORDER_DOUBLE)  \
X(UI_BORDER_ROUNDED) \
X(UI_BORDER_HEAVY)

Definition at line 170 of file ui_backend.h.

#define BORDER_STYLE(X)  \
    X(UI_BORDER_NONE)    \
    X(UI_BORDER_SINGLE)  \
    X(UI_BORDER_DOUBLE)  \
    X(UI_BORDER_ROUNDED) \
    X(UI_BORDER_HEAVY)

bw_bl

#define bw_bl   bw.bl

Definition at line 590 of file ui_backend.h.

bw_br

#define bw_br   bw.br

Definition at line 591 of file ui_backend.h.

bw_bt

#define bw_bt   bw.bt

Definition at line 586 of file ui_backend.h.

bw_cr

#define bw_cr   bw.cr

Definition at line 587 of file ui_backend.h.

bw_ho

#define bw_ho   bw.ho

Definition at line 581 of file ui_backend.h.

bw_lt

#define bw_lt   bw.lt

Definition at line 583 of file ui_backend.h.

bw_rt

#define bw_rt   bw.rt

Definition at line 584 of file ui_backend.h.

bw_tl

#define bw_tl   bw.tl

Definition at line 588 of file ui_backend.h.

bw_tr

#define bw_tr   bw.tr

Definition at line 589 of file ui_backend.h.

bw_tt

#define bw_tt   bw.tt

Definition at line 585 of file ui_backend.h.

bw_ve

#define bw_ve   bw.ve

Definition at line 582 of file ui_backend.h.

CCHARW_MAX

#define CCHARW_MAX   5

Definition at line 192 of file ui_backend.h.

CELL_CHAR_INITIALIZER

#define CELL_CHAR_INITIALIZER

(

c

)

Value:

    { \
    .gcluster = (c),               \
    .gcluster_backstop = 0,        \
    .stylemask = 0,                \
    .channels = 0,                 \
}

Definition at line 428 of file ui_backend.h.

#define CELL_CHAR_INITIALIZER(c) { \
    .gcluster = (c),               \
    .gcluster_backstop = 0,        \
    .stylemask = 0,                \
    .channels = 0,                 \
}

CELL_INITIALIZER

#define CELL_INITIALIZER	(		c,
			s,
			chan )

Value:

    { \
    .gcluster = (c),                   \
    .gcluster_backstop = 0,            \
    .stylemask = (s),                  \
    .channels = (chan),                \
}

Definition at line 434 of file ui_backend.h.

#define CELL_INITIALIZER(c, s, chan) { \
    .gcluster = (c),                   \
    .gcluster_backstop = 0,            \
    .stylemask = (s),                  \
    .channels = (chan),                \
}

CHYRON_KEY_MAXLEN

#define CHYRON_KEY_MAXLEN   64

maximum length of the command text

Definition at line 49 of file ui_backend.h.

CHYRON_KEYS

#define CHYRON_KEYS   20

maximum number of key bindings for the chyron

Definition at line 50 of file ui_backend.h.

COLOR_LEN

#define COLOR_LEN   8

length of color code strings

Definition at line 498 of file ui_backend.h.

ERR

#define ERR   -1

Definition at line 427 of file ui_backend.h.

FG_COLOR

#define FG_COLOR   2

default foreground color

Definition at line 499 of file ui_backend.h.

FILE_TYPE_LIST

#define FILE_TYPE_LIST

(

X

)

Value:

X(FT_TEXT)            \
X(FT_IMAGE)           \
X(FT_VIDEO)           \
X(FT_AUDIO)           \
X(FT_BINARY_GARBAGE)  \
X(FT_EMPTY)           \
X(FT_UNREADABLE)

Definition at line 85 of file ui_backend.h.

#define FILE_TYPE_LIST(X) \
    X(FT_TEXT)            \
    X(FT_IMAGE)           \
    X(FT_VIDEO)           \
    X(FT_AUDIO)           \
    X(FT_BINARY_GARBAGE)  \
    X(FT_EMPTY)           \
    X(FT_UNREADABLE)

KEY_ALTDEL

#define KEY_ALTDEL   0x20e

Definition at line 645 of file ui_backend.h.

KEY_ALTDOWN

#define KEY_ALTDOWN   0x214

Definition at line 650 of file ui_backend.h.

KEY_ALTEND

#define KEY_ALTEND   0x219

Definition at line 646 of file ui_backend.h.

KEY_ALTHOME

#define KEY_ALTHOME   0x21e

Definition at line 643 of file ui_backend.h.

KEY_ALTINS

#define KEY_ALTINS   0x223

Definition at line 642 of file ui_backend.h.

KEY_ALTLEFT

#define KEY_ALTLEFT   0x228

Definition at line 649 of file ui_backend.h.

KEY_ALTPGDN

#define KEY_ALTPGDN   0x22d

Definition at line 647 of file ui_backend.h.

KEY_ALTPGUP

#define KEY_ALTPGUP   0x232

Definition at line 644 of file ui_backend.h.

KEY_ALTRIGHT

#define KEY_ALTRIGHT   0x237

Definition at line 651 of file ui_backend.h.

KEY_ALTUP

#define KEY_ALTUP   0x23d

Definition at line 648 of file ui_backend.h.

LN_BG_COLOR

#define LN_BG_COLOR   7

default line number background

Definition at line 503 of file ui_backend.h.

LN_COLOR

#define LN_COLOR   4

default line number color

Definition at line 502 of file ui_backend.h.

LOG_LEVEL_LIST

#define LOG_LEVEL_LIST

(

X

)

Value:

X(FATAL)              \
X(ERROR)              \
X(WARN)               \
X(INFO)               \
X(VERBOSE)            \
X(DEBUG)              \
X(SILENT)

Definition at line 69 of file ui_backend.h.

#define LOG_LEVEL_LIST(X) \
    X(FATAL)              \
    X(ERROR)              \
    X(WARN)               \
    X(INFO)               \
    X(VERBOSE)            \
    X(DEBUG)              \
    X(SILENT)

MAX_EXT_FDS

#define MAX_EXT_FDS   8

Definition at line 131 of file ui_backend.h.

MAXLEN

#define MAXLEN   256

Definition at line 198 of file ui_backend.h.

MOUSE_ACTION

#define MOUSE_ACTION

(

X

)

Value:

X(UI_MOUSE_NONE)      \
X(UI_MOUSE_PRESS)     \
X(UI_MOUSE_RELEASE)   \
X(UI_MOUSE_DRAG)      \
X(UI_MOUSE_SCROLL_UP) \
X(UI_MOUSE_SCROLL_DOWN)

Definition at line 52 of file ui_backend.h.

#define MOUSE_ACTION(X)   \
    X(UI_MOUSE_NONE)      \
    X(UI_MOUSE_PRESS)     \
    X(UI_MOUSE_RELEASE)   \
    X(UI_MOUSE_DRAG)      \
    X(UI_MOUSE_SCROLL_UP) \
    X(UI_MOUSE_SCROLL_DOWN)

SFC_MAX

#define SFC_MAX   30

Definition at line 197 of file ui_backend.h.

SUB_SURFACE_LIST

#define SUB_SURFACE_LIST

(

X

)

Value:

X(BOX)                  \
X(WIN)                  \
X(WIN2)                 \
X(LNNO)                 \
X(CMDLN)                \
X(PAD)                  \
X(WIN3)

Definition at line 36 of file ui_backend.h.

#define SUB_SURFACE_LIST(X) \
    X(BOX)                  \
    X(WIN)                  \
    X(WIN2)                 \
    X(LNNO)                 \
    X(CMDLN)                \
    X(PAD)                  \
    X(WIN3)

UI_COLORS

#define UI_COLORS   512

Definition at line 193 of file ui_backend.h.

UI_PAIRS

#define UI_PAIRS   512

Definition at line 194 of file ui_backend.h.

UI_SFC_MAX

#define UI_SFC_MAX   30

Definition at line 196 of file ui_backend.h.

XTERM_256COLOR

#define XTERM_256COLOR   1

Definition at line 640 of file ui_backend.h.

Typedef Documentation

attr_t

typedef uint16_t attr_t

Definition at line 417 of file ui_backend.h.

BorderWide

typedef union border_wide BorderWide

NcInput

typedef struct ncinput NcInput

Definition at line 161 of file ui_backend.h.

NcPlane

typedef struct ncplane NcPlane

Definition at line 419 of file ui_backend.h.

NcPlaneOptions

typedef struct ncplane_options NcPlaneOptions

Definition at line 422 of file ui_backend.h.

NcVisual

typedef struct ncvisual NcVisual

Definition at line 162 of file ui_backend.h.

NotCurses

typedef struct notcurses NotCurses

Definition at line 420 of file ui_backend.h.

NotCursesOptions

typedef struct notcurses_options NotCursesOptions

Definition at line 421 of file ui_backend.h.

SIO

typedef struct SIO SIO

Definition at line 153 of file ui_backend.h.

UiCell

typedef nccell UiCell

Definition at line 418 of file ui_backend.h.

UiChannels

typedef union UiChannels UiChannels

Definition at line 156 of file ui_backend.h.

UiColor

typedef struct UiColor UiColor

Definition at line 424 of file ui_backend.h.

UiColorIdx

typedef uint UiColorIdx

Definition at line 160 of file ui_backend.h.

UiKey

typedef uint32_t UiKey

Definition at line 65 of file ui_backend.h.

UiMB

typedef struct UiMB UiMB

Definition at line 157 of file ui_backend.h.

UiPair

typedef struct UiPair UiPair

Definition at line 423 of file ui_backend.h.

UiPairIdx

typedef uint16_t UiPairIdx

Definition at line 159 of file ui_backend.h.

UiRuntime

typedef struct UiRuntime UiRuntime

Definition at line 152 of file ui_backend.h.

UiSplitSurface

typedef struct UiSplitSurface UiSplitSurface

Definition at line 155 of file ui_backend.h.

UiStyle

typedef uint16_t UiStyle

Definition at line 158 of file ui_backend.h.

UiSurface

typedef struct UiSurface UiSurface

Definition at line 154 of file ui_backend.h.

Enumeration Type Documentation

ColorsEnum

enum ColorsEnum

Enumerator
CLR_BLACK
CLR_RED
CLR_GREEN
CLR_YELLOW
CLR_BLUE
CLR_MAGENTA
CLR_CYAN
CLR_WHITE
CLR_BBLACK
CLR_BRED
CLR_BGREEN
CLR_BYELLOW
CLR_BBLUE
CLR_BMAGENTA
CLR_BCYAN
CLR_BWHITE
CLR_BORANGE
CLR_FG
CLR_BG
CLR_BOX_FG
CLR_BOX_BG
CLR_IND_FG
CLR_IND_BG
CLR_BRACKETS_FG
CLR_BRACKETS_BG
CLR_FILL_CHAR_FG
CLR_FILL_CHAR_BG
CLR_LN_FG
CLR_LN_BG
CLR_CMDLN_FG
CLR_CMDLN_BG
CLR_NT_FG
CLR_NT_BG
CLR_NT_REV_FG
CLR_NT_REV_BG
CLR_NT_HL_FG
CLR_NT_HL_BG
CLR_NT_HL_REV_FG
CLR_NT_HL_REV_BG
CLR_TITLE_FG
CLR_TITLE_BG
CLR_NCOLORS

Definition at line 505 of file ui_backend.h.

             {
    CLR_BLACK,
    CLR_RED,
    CLR_GREEN,
    CLR_YELLOW,
    CLR_BLUE,
    CLR_MAGENTA,
    CLR_CYAN,
    CLR_WHITE,
    CLR_BBLACK,
    CLR_BRED,
    CLR_BGREEN,
    CLR_BYELLOW,
    CLR_BBLUE,
    CLR_BMAGENTA,
    CLR_BCYAN,
    CLR_BWHITE,
    CLR_BORANGE,
    CLR_FG,
    CLR_BG,
    CLR_BOX_FG,
    CLR_BOX_BG,
    CLR_IND_FG,
    CLR_IND_BG,
    CLR_BRACKETS_FG,
    CLR_BRACKETS_BG,
    CLR_FILL_CHAR_FG,
    CLR_FILL_CHAR_BG,
    CLR_LN_FG,
    CLR_LN_BG,
    CLR_CMDLN_FG,
    CLR_CMDLN_BG,
    CLR_NT_FG,
    CLR_NT_BG,
    CLR_NT_REV_FG,
    CLR_NT_REV_BG,
    CLR_NT_HL_FG,
    CLR_NT_HL_BG,
    CLR_NT_HL_REV_FG,
    CLR_NT_HL_REV_BG,
    CLR_TITLE_FG,
    CLR_TITLE_BG,
    CLR_NCOLORS
} ColorsEnum;

FileType

enum FileType

Enumerator
FT_MAX

Definition at line 94 of file ui_backend.h.

             {
    FILE_TYPE_LIST(AS_ENUM)
        FT_MAX
} FileType;

ss_t

enum ss_t

Enumerator
SUB_SFC_MAX

Definition at line 45 of file ui_backend.h.

             {
    SUB_SURFACE_LIST(AS_ENUM)
        SUB_SFC_MAX
} ss_t;

UiBackend

enum UiBackend

Enumerator
UI_BACKEND_NCURSES	NCurses / NCursesW backend
UI_BACKEND_NOTCURSES	NotCurses backend

Definition at line 451 of file ui_backend.h.

             {
    UI_BACKEND_NCURSES = 0, 
    UI_BACKEND_NOTCURSES    
} UiBackend;

UiBorderStyle

enum UiBorderStyle

Enumerator
BORDER_MAX

Definition at line 177 of file ui_backend.h.

             {
    BORDER_STYLE(AS_ENUM)
        BORDER_MAX
} UiBorderStyle;

UiLogLevel

enum UiLogLevel

Enumerator
LOG_LEVEL_COUNT

Definition at line 78 of file ui_backend.h.

             {
    LOG_LEVEL_LIST(AS_ENUM)
        LOG_LEVEL_COUNT
} UiLogLevel;

UiMouseAction

enum UiMouseAction

Enumerator
MOUSE_ACTION_MAX

Definition at line 60 of file ui_backend.h.

             {
    MOUSE_ACTION(AS_ENUM)
        MOUSE_ACTION_MAX
} UiMouseAction;

Function Documentation

ui_bkgd()

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

Set the background of a specific window within a UiSurface.

Set the background cell for the specified window within a UI surface.

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.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
cell	Pointer to the UiCell representing the background cell.

Returns

0 on success, -1 on failure.

This function sets the background cell for the specified window within a UI surface. It updates the styles and channels of the ncplane associated with the window and stores the background cell in the metadata. If the surface is not initialized, it returns -1.

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.
cell	Pointer to the UiCell representing the background cell.

Returns

0 on success, -1 on failure.

This function sets the background cell for the specified window within a UI surface. It updates the styles and channels of the ncplane associated with the window and stores the background cell in the metadata. If the surface is not initialized, it returns -1.

Definition at line 927 of file ui_ncurses.c.

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

Referenced by init_view_boxwin(), init_view_full_screen(), ui_surface_addpad(), and ui_surface_addwin().

Here is the caller graph for this function:

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.

Set the background cell for the specified window within a UI surface without changing the base character.

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.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
cell	Pointer to the UiCell representing the background cell.

Returns

0 on success, -1 on failure.

This function sets the background cell for the specified window within a UI surface without changing the base character. It updates the styles and channels of the ncplane associated with the window and stores the background cell in the metadata. If the surface is not initialized, it returns -1.

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.
cell	Pointer to the UiCell representing the background cell.

Returns

0 on success, -1 on failure.

This function sets the background cell for the specified window within a UI surface without changing the base character. It updates the styles and channels of the ncplane associated with the window and stores the background cell in the metadata. If the surface is not initialized, it returns -1.

Definition at line 941 of file ui_ncurses.c.

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

Referenced by display_pick_page(), display_prompt(), get_cmd_arg(), init_view_boxwin(), init_view_full_screen(), menu_cmd_processor(), menu_engine(), popup_ckeys(), reverse_object(), ui_border_title(), ui_border_ysplit_text(), ui_surface_addpad(), ui_surface_addwin(), and unreverse_object().

Here is the caller graph for this function:

ui_bkgrnd()

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

Set the background of a specific window within a UiSurface.

Set the background cell for the specified window within a UI surface without changing the base character.

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.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
cell	Pointer to the UiCell representing the background cell.

Returns

0 on success, -1 on failure.

This function sets the background cell for the specified window within a UI surface without changing the base character. It updates the styles and channels of the ncplane associated with the window and stores the background cell in the metadata. If the surface is not initialized, it returns -1.

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.
cell	Pointer to the UiCell representing the background cell.

Returns

0 on success, -1 on failure.

This function sets the background cell for the specified window within a UI surface without changing the base character. It updates the styles and channels of the ncplane associated with the window and stores the background cell in the metadata. If the surface is not initialized, it returns -1.

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.

Set the background cell for the specified window within a UI surface without changing the base character.

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.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
cell	Pointer to the UiCell representing the background cell.

Returns

0 on success, -1 on failure.

This function sets the background cell for the specified window within a UI surface without changing the base character. It updates the styles and channels of the ncplane associated with the window and stores the background cell in the metadata. If the surface is not initialized, it returns -1.

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.
cell	Pointer to the UiCell representing the background cell.

Returns

0 on success, -1 on failure.

This function sets the background cell for the specified window within a UI surface without changing the base character. It updates the styles and channels of the ncplane associated with the window and stores the background cell in the metadata. If the surface is not initialized, it returns -1.

Definition at line 969 of file ui_ncurses.c.

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

ui_border_draw()

int ui_border_draw

(

UiSurface *

sfc

)

Definition at line 474 of file ui_common.c.

                                   {
    uint maxy = ui_getmaxy(sfc, BOX);
    uint maxx = ui_getmaxx(sfc, BOX);
    uint y = 0;
    uint x = 0;
    ui_mvwadd_wchnstr(sfc, BOX, y, x++, &cell_tl, 1);
    for (x = 1; x < maxx - 1; x++)
        ui_mvwadd_wchnstr(sfc, BOX, y, x, &cell_ho, 1);
    ui_mvwadd_wchnstr(sfc, BOX, y, maxx - 1, &cell_tr, 1);
    for (y = 1; y < maxy - 1; y++) {
        ui_mvwadd_wchnstr(sfc, BOX, y, 0, &cell_ve, 1);
        ui_mvwadd_wchnstr(sfc, BOX, y, maxx - 1, &cell_ve, 1);
    }
    ui_mvwadd_wchnstr(sfc, BOX, y, 0, &cell_bl, 1);
    for (x = 1; x < maxx - 1; x++)
        ui_mvwadd_wchnstr(sfc, BOX, y, x, &cell_ho, 1);
    ui_mvwadd_wchnstr(sfc, BOX, y, maxx - 1, &cell_br, 1);
    return 0;
}

References cell_bl, cell_br, cell_ho, cell_tl, cell_tr, cell_ve, ui_getmaxx(), ui_getmaxy(), and ui_mvwadd_wchnstr().

Referenced by ui_surface_box(), and ui_surface_box().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_border_title()

int ui_border_title	(	UiSurface *	sfc,
		const char *	title )

Draw a box with a title around the specified window.

border_title

Parameters

box	Pointer to the window to draw the box around
title	Title text to display at the top of the box

This function draws a box around the specified window, similar to border_draw(), but it also includes a title at the top of the box. The title is displayed in the center of the top edge of the box, and the horizontal line is drawn on either side of the title. Use this function when you want to visually label a window with a title.

Definition at line 563 of file ui_common.c.

                                                       {
    if (!title || !*title)
        return 0;
    uint y = 0;
    uint x = 0;
    uint l;
    uint maxx = ui_getmaxx(sfc, BOX);
    ui_mvwadd_wchnstr(sfc, BOX, y, x++, &cell_tl, 1);
    ui_mvwadd_wchnstr(sfc, BOX, y, x++, &cell_rt, 1);
    ui_mvwadd_wchnstr(sfc, BOX, y, x++, &cell_sp, 1);
    wchar_t *title_wc;
    title_wc = ui_mbstr_to_wcstr(title);
    l = wcswidth(title_wc, wcslen(title_wc));
    l = min(l, maxx - 7);
    ui_bkgdset(sfc, BOX, &cell_title);
    ui_mvwaddnwstr(sfc, BOX, y, x, title_wc, l);
    ui_bkgdset(sfc, BOX, &cell_box);
    x += l;
    free(title_wc);
    ui_mvwadd_wchnstr(sfc, BOX, y, x++, &cell_sp, 1);
    ui_mvwadd_wchnstr(sfc, BOX, y, x++, &cell_lt, 1);
    while (x < maxx - 1) {
        ui_mvwadd_wchnstr(sfc, BOX, y, x++, &cell_ho, 1);
    }
    return 0;
}

References cell_box, cell_ho, cell_lt, cell_rt, cell_sp, cell_title, cell_tl, ui_bkgdset(), ui_getmaxx(), ui_mbstr_to_wcstr(), ui_mvwadd_wchnstr(), and ui_mvwaddnwstr().

Referenced by new_view_file(), ui_surface_box(), ui_surface_box(), view_boxwin_resize(), and view_file().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_border_ysplit()

int ui_border_ysplit	(	UiSurface *	sfc,
		uint	y )

Draw a box with a separator line around the specified window.

ui_border-ysplit

Parameters

box	Pointer to the window to draw the box around
y	Line number where the separator line should be drawn

This function draws a box around the specified window, similar to border_draw(), but it also includes a horizontal separator line that divides the box into two sections. The separator line is drawn at a fixed position (line 00, page 00) and extends across the width of the box. Use this function when you want to visually separate two sections within a window, such as for a header and content area.

Definition at line 504 of file ui_common.c.

                                             {
    uint maxx = ui_getmaxx(sfc, BOX);
    ui_mvwadd_wchnstr(sfc, BOX, y, 0, &cell_lt, 1);
    for (uint x = 1; x < maxx - 1; x++)
        ui_mvwadd_wchnstr(sfc, BOX, y, x, &cell_ho, 1);
    ui_mvwadd_wchnstr(sfc, BOX, y, maxx - 1, &cell_rt, 1);
    return 0;
}

References cell_ho, cell_lt, cell_rt, ui_getmaxx(), and ui_mvwadd_wchnstr().

Referenced by ui_tracked_sfc_split_box().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_border_ysplit_text()

int ui_border_ysplit_text	(	UiSurface *	sfc,
		char *	text_in,
		uint	separator_line )

Draw a box with a separator line and text around the specified window.

ui_border_ysplit_text

Parameters

box	Pointer to the window to draw the box around
text	Text to display in the middle of the separator line
separator_line	Line number where the separator line should be drawn

This function draws a box around the specified window, similar to border_draw(), but it also includes a horizontal separator line that divides the box into two sections. The separator line is drawn at the specified line number and extends across the width of the box, with the provided text displayed in the middle of the line. Use this function when you want to visually separate two sections within a window and label the separator with descriptive text.

Definition at line 524 of file ui_common.c.

                                                                              {
    char text[MAXLEN];
    uint maxx = ui_getmaxx(sfc, BOX);
    uint l;
    uint y = separator_line;
    uint x = 0;
    // Draw the horizontal line with text in the middle, so we start by drawing
    // the left edge, then the text, then the right edge, and finally fill in the
    // horizontal line on either side of the text.
    ui_mvwadd_wchnstr(sfc, BOX, y, x++, &cell_lt, 1);
    ui_mvwadd_wchnstr(sfc, BOX, y, x++, &cell_ho, 1);
    ui_mvwadd_wchnstr(sfc, BOX, y, x++, &cell_rt, 1);
    ui_mvwadd_wchnstr(sfc, BOX, y, x++, &cell_sp, 1);
    strnz__cpy(text, text_in, maxx - 7);
    wchar_t *text_wc;
    text_wc = ui_mbstr_to_wcstr(text);
    l = wcswidth(text_wc, wcslen(text_wc));
    ui_bkgdset(sfc, BOX, &cell_nt_hl);
    ui_mvwaddnwstr(sfc, BOX, y, x, text_wc, l);
    x += l;
    l = min(l, maxx - 7);
    free(text_wc);
    ui_mvwadd_wchnstr(sfc, BOX, y, x++, &cell_sp, 1);
    ui_mvwadd_wchnstr(sfc, BOX, y, x++, &cell_lt, 1);
    while (x < maxx - 1)
        ui_mvwadd_wchnstr(sfc, BOX, y, x++, &cell_ho, 1);
    ui_mvwadd_wchnstr(sfc, BOX, y, x++, &cell_rt, 1);
    return 0;
}

References cell_ho, cell_lt, cell_nt_hl, cell_rt, cell_sp, strnz__cpy(), ui_bkgdset(), ui_getmaxx(), ui_mbstr_to_wcstr(), ui_mvwadd_wchnstr(), and ui_mvwaddnwstr().

Referenced by picker().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_clear()

int ui_clear

(

)

Clear the entire screen.

Clear the contents of the standard plane.

Returns

0 on success, or -1 on failure.

0 on success, -1 on failure.

This function clears the contents of the standard plane by erasing its contents. If the standard plane is not initialized, it returns -1.

Clear the entire screen.

Returns

0 on success, -1 on failure.

This function clears the contents of the standard plane by erasing its contents. If the standard plane is not initialized, it returns -1.

Definition at line 599 of file ui_ncurses.c.

               {
    clear();
    return 0;
}

ui_cm_surface_destroy()

int ui_cm_surface_destroy

(

UiSurface *

sfc

)

Destroy the most recently created surface.

ui_cm_destroy_surface

Returns

0 on success, -1 if no surfaces exist

This function destroys the most recently created surface and decrements the surface pointer. It should be called when a surface is no longer needed to free up resources. If there are no surfaces to destroy, it returns -1.

Note

The difference between this function and ui_surface_destroy() is that this function destroys the surface pointed to by the surface pointer (sfc_ptr) and decrements the surface pointer after destroying the surface.

Definition at line 466 of file ui_common.c.

                                          {
    ui_surface_destroy(sfc);
    sfc_ptr--;
    return 0;
}

References sfc_ptr, and ui_surface_destroy().

Referenced by init_form(), init_pick(), menu_engine(), ui_action_disposition(), ui_answer_yn(), ui_display_error(), ui_perror(), and ui_timeout_prompt().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_curs_set()

int ui_curs_set

(

int

visible

)

Set the visibility of the cursor.

Enable or disable the cursor visibility.

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.

Parameters

visible

True to enable the cursor, false to disable it.

Returns

0 on success, -1 on failure.

This function enables or disables the cursor visibility. If the UI is not initialized, it returns -1. When enabling the cursor, it retrieves the current cursor position and enables the cursor at that position.

Set the visibility of the cursor.

Parameters

visible

True to enable the cursor, false to disable it.

Returns

0 on success, -1 on failure.

This function enables or disables the cursor visibility. If the UI is not initialized, it returns -1. When enabling the cursor, it retrieves the current cursor position and enables the cursor at that position.

Definition at line 840 of file ui_ncurses.c.

                                {
    curs_set(visibility);
    return 0;
}

References ui.

Referenced by cf_accept(), field_editor(), fork_exec(), ui_answer_yn(), and ui_tracked_sfc_split_box().

Here is the caller graph for this function:

ui_cursor_enable()

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

Enable or disable the cursor for a UiSurface.

Enable or disable the cursor at the current position on the surface and plane specified.

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.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
visible	True to enable the cursor, false to disable it.

Returns

0 on success, -1 on failure.

This function enables or disables the cursor at the current position on the surface and plane specified. If the UI is not initialized, it returns -1.

Enable or disable the cursor for a UiSurface.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
visible	True to enable the cursor, false to disable it.

Returns

0 on success, -1 on failure.

This function enables or disables the cursor at the current position on the surface and plane specified. If the UI is not initialized, it returns -1.

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;
}

References ui.

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.

Enable or disable the cursor at a specific position on the surface and plane specified.

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.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
y	The y-coordinate for the cursor position.
x	The x-coordinate for the cursor position.
visible	True to enable the cursor, false to disable it.

Returns

0 on success, -1 on failure.

This function enables or disables the cursor at a specific position on the surface and plane specified. If the UI is not initialized, it returns -1.

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

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
y	The y-coordinate for the cursor position.
x	The x-coordinate for the cursor position.
visible	True to enable the cursor, false to disable it.

Returns

0 on success, -1 on failure.

This function enables or disables the cursor at a specific position on the surface and plane specified. If the UI is not initialized, it returns -1.

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;
}

References ui.

Referenced by field_editor(), get_cmd_arg(), get_cmd_char(), and picker().

Here is the caller graph for this function:

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.

Move the cursor to the specified position within a window of a UI surface.

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.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
y	The y-coordinate for the new cursor position.
x	The x-coordinate for the new cursor position.

Returns

0 on success, -1 on failure.

This function moves the cursor to the specified position within a window of a UI surface. If the surface or window is not initialized, it returns -1.

Move the cursor to a specified position within a UiSurface.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
y	The y-coordinate for the new cursor position.
x	The x-coordinate for the new cursor position.

Returns

0 on success, -1 on failure.

This function moves the cursor to the specified position within a window of a UI surface. If the surface or window is not initialized, it returns -1.

Definition at line 666 of file ui_ncurses.c.

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

Referenced by cf_accept(), display_line(), display_line_eod(), display_prompt(), display_split_line(), form_post(), form_process(), get_cmd_arg(), get_cmd_char(), picker(), remove_right_angle(), scroll_next(), scroll_prev(), search(), unreverse_object(), and view_display_page().

Here is the caller 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_draw_ch()

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

Draw a character in a surface window.

on specified window, at current location, 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
c	character

Returns

0 on success, -1 on error

Draw a character in a surface window.

Parameters

s	surface
w	window
c	character

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,
		char	c )

Draw a character at a specific position 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.
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.

Parameters

s	surface
w	window
y	row
x	column
c	character

Returns

0 on success, -1 on error

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

Parameters

s	surface
w	window
y	row
x	column
c	character

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;
}

Referenced by menu_cmd_processor().

Here is the caller graph for this function:

ui_draw_hline()

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

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;
}

Referenced by ui_action_disposition(), ui_answer_yn(), ui_display_error(), ui_perror(), ui_timeout_prompt(), and ui_update_timeout_prompt().

Here is the caller graph for this function:

ui_draw_text_fill()

int ui_draw_text_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 n.

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.
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.

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

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	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 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;
}

References ui_render().

Referenced by menu_cmd_processor(), and menu_engine().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_draw_text_n()

int ui_draw_text_n	(	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.

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.

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

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

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 88 of file ui_ncurses_draw.c.

                                                                                  {
    if (!s || !text)
        return -1;
    mvwaddnstr(s->mwin[w], y, x, text, (int)n);
    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.

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

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();
}

References ui_shutdown().

Referenced by exec_objects(), fork_exec(), and form_exec_receiver().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_erase()

int ui_erase

(

)

Erase the entire screen.

Clear the contents of the specified window within a UI surface.

Returns

0 on success, or -1 on failure.

Parameters

s	Pointer to the UiSurface containing the window to clear.
w	The index of the window to clear.

Returns

0 on success, -1 on failure.

This function clears the contents of the specified window within a UI surface by erasing its contents. If the surface or window is not initialized, it returns -1.

Erase the entire screen.

Parameters

s	Pointer to the UiSurface containing the window to clear.
w	The index of the window to clear.

Returns

0 on success, -1 on failure.

This function clears the contents of the specified window within a UI surface by erasing its contents. If the surface or window is not initialized, it returns -1.

Definition at line 591 of file ui_ncurses.c.

               {
    erase();
    return 0;
}

Referenced by view_full_screen_resize().

Here is the caller graph for this function:

ui_get_caps()

void ui_get_caps

(

UiCaps *

caps

)

Get the UI backend capabilities.

Get the capabilities of the current UI backend.

Parameters

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

This function populates the provided UiCaps structure with information about the capabilities of the current UI backend. It sets various fields in the structure, such as truecolor support, palette size, mouse support, Unicode support, and resize capability. If the provided pointer is NULL or if the UI runtime is not initialized, the function does nothing.

Get the UI backend capabilities.

Parameters

caps	Pointer to a UiCaps structure to be filled with the capabilities.

This function populates the provided UiCaps structure with information about the capabilities of the current UI backend. It sets various fields in the structure, such as truecolor support, palette size, mouse support, Unicode support, and resize capability. If the provided pointer is NULL or if the UI runtime is not initialized, the function does nothing.

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;
}

References UiCaps::color_pairs, UiCaps::mouse, UiCaps::palette256, UiCaps::resize, UiCaps::truecolor, ui, and UiCaps::unicode.

ui_get_event_no_mouse()

int ui_get_event_no_mouse	(	UiSurface *	target,
		ss_t	w,
		UiEvent *	ev )

Wait for an input event on target (or stdscr if NULL) without mouse support.

Wait for an input event from the NotCurses context, ignoring mouse events.

Parameters

ui	UI runtime context (unused — event comes from the window).
target	Surface to read from, or NULL for stdscr.
ev	Output UiEvent structure.

Returns

0 on success, -1 if ev is NULL.

Parameters

target	Unused for NotCurses (events are global to the context).
ev	Output UiEvent structure.

Returns

The NotCurses key code, or -1 if ui or ev is NULL.

Wait for an input event on target (or stdscr if NULL) without mouse support.

Parameters

target	Unused for NotCurses (events are global to the context).
ev	Output UiEvent structure.

Returns

The NotCurses key code, or -1 if ui or ev is NULL.

Definition at line 234 of file ui_ncurses_input.c.

                                                             {
    int ch;
    mousemask(0, NULL);
    curs_set(2);
    ui_flush_input();
    cbreak();
    do {
        curs_set(2);
        ch = wgetch(s->mwin[w]);
        curs_set(0);
        ev->key = translate_key(ch);
        if (ev->key == UIKEY_CHAR) {
            ev->ch = (uint32_t)ch;
            break;
        }
    } while (ch == ERR);
    curs_set(0);
    return ch;
}

References UiEvent::alt, UiEvent::ch, UiEvent::ctrl, UiEvent::key, UiEvent::shift, ui, and ui_flush_input().

Here is the call graph for this function:

ui_get_screen_size()

void ui_get_screen_size	(	uint *	lines,
		uint *	cols )

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

Get the current screen size in 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.
lines	Pointer to an unsigned integer to store the number of lines (rows).
cols	Pointer to an unsigned integer to store the number of columns.

This function retrieves the current screen size in lines and columns.

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

Parameters

lines	Pointer to an unsigned integer to store the number of lines (rows).
cols	Pointer to an unsigned integer to store the number of columns.

This function retrieves the current screen size in lines and columns.

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;
}

References ui.

Referenced by open_pick_win(), popup_ckeys(), ui_action_disposition(), ui_answer_yn(), ui_display_error(), ui_perror(), ui_surface_box(), ui_surface_new(), ui_timeout_prompt(), ui_tracked_sfc_box(), ui_tracked_sfc_split_box(), view_calc_boxwin_dimensions(), view_calc_full_screen_dimensions(), and view_cmd_processor().

Here is the caller graph for this function:

ui_getch()

int ui_getch

(

)

Wait for a single input character from the NotCurses context.

Returns

The NotCurses key code, or -1 if ui is NULL.

Definition at line 222 of file ui_notcurses_input.c.

               {
    if (!ui)
        return -1;
    ncinput ni;
    do {
        notcurses_get(ui->nc, NULL, &ni);
    } while (ni.evtype == NCTYPE_RELEASE ||
             ni.id == NCKEY_INVALID ||
             ni.id == NCKEY_MOTION ||
             ni.id == NCKEY_SIGNAL);
    return ni.id;
}

References ui.

ui_getmaxx()

int ui_getmaxx	(	UiSurface *	s,
		ss_t	w )

Get the maximum number of columns of a UiSurface.

Get the maximum number of columns of a window within a UI surface.

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.

Parameters

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

Returns

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

This function retrieves the maximum number of columns of a window within a UI surface. If the surface or window is not initialized, it returns -1.

Get the maximum number of columns of a UiSurface.

Parameters

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

Returns

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

This function retrieves the maximum number of columns of a window within a UI surface. If the surface or window is not initialized, it returns -1.

Definition at line 712 of file ui_ncurses.c.

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

Referenced by ui_border_draw(), ui_border_title(), ui_border_ysplit(), and ui_border_ysplit_text().

Here is the caller graph for this function:

ui_getmaxy()

int ui_getmaxy	(	UiSurface *	s,
		ss_t	w )

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

Get the maximum number of lines (rows) of a window within a UI surface.

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.

Parameters

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

Returns

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

This function retrieves the maximum number of lines (rows) of a window within a UI surface. If the surface or window is not initialized, it returns -1.

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

Parameters

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

Returns

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

This function retrieves the maximum number of lines (rows) of a window within a UI surface. If the surface or window is not initialized, it returns -1.

Definition at line 701 of file ui_ncurses.c.

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

Referenced by field_editor(), ui_assign_chyron_win(), and ui_border_draw().

Here is the caller graph for this function:

ui_getmaxyx()

void ui_getmaxyx	(	UiSurface *	s,
		ss_t	w,
		uint *	y,
		uint *	x )

Get the maximum dimensions of a UiSurface.

Get the maximum dimensions of a window within a UI surface.

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.
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 maximum number of lines (rows).
x	Pointer to an unsigned integer to store the maximum number of columns.

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

Get the maximum dimensions of a UiSurface.

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 maximum number of lines (rows).
x	Pointer to an unsigned integer to store the maximum number of columns.

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

Definition at line 690 of file ui_ncurses.c.

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

Referenced by form_post(), form_process(), and picker().

Here is the caller graph for this function:

ui_getyx()

void ui_getyx	(	UiSurface *	s,
		ss_t	w,
		uint *	y,
		uint *	x )

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);
}

Referenced by display_prompt(), and get_cmd_char().

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.

Enable or disable the keypad for the specified window within a UI surface.

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.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
enable	True to enable the keypad, false to disable the keypad.

Returns

0 on success, -1 on failure.

This function does nothing.

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

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
enable	True to enable the keypad, false to disable the keypad.

Returns

0 on success, -1 on failure.

This function does nothing.

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;
}

Referenced by init_view_boxwin(), and init_view_full_screen().

Here is the caller graph for this function:

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.

Enable or disable the use of the keypad for the specified window within a UI surface.

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.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
enable	True to enable the use of the keypad, false to disable it.

Returns

0 on success, -1 on failure.

This function does nothing.

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

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
enable	True to enable the use of the keypad, false to disable it.

Returns

0 on success, -1 on failure.

This function does nothing.

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;
}

Referenced by init_view_boxwin(), and init_view_full_screen().

Here is the caller graph for this function:

ui_init()

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

Initialize the UI runtime with the given configuration and SIO.

Initialize the UI runtime with the specified 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.

Parameters

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

Returns

Pointer to the initialized UiRuntime structure, or NULL on failure.

This function initializes the UI runtime using the NotCurses library. It sets up the terminal, creates the standard plane, and initializes various UI components based on the provided configuration. If any step fails, it cleans up and returns NULL.

Initialize the UI runtime with the given configuration and SIO.

Parameters

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

Returns

Pointer to the initialized UiRuntime structure, or NULL on failure.

This function initializes the UI runtime using the NotCurses library. It sets up the terminal, creates the standard plane, and initializes various UI components based on the provided configuration. If any step fails, it cleans up and returns NULL.

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;
}

References border_double, border_heavy, border_none, border_rounded, border_single, UiConfig::border_style, bw, f_ncurses_open, f_notcurses_open, UiConfig::log_level, sfc_ptr, stdplane, stdsfc, border_wide::str, SUB_SFC_MAX, ui, ui_color, ui_color_cnt, ui_initialize_sio(), ui_min_log_level, ui_pair, ui_pair_cnt, and ui_shutdown().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_initialize_sio()

void ui_initialize_sio

(

SIO *

sio

)

gamma correction values

These are read from ~/.minitrc

used when initializing colors

Definition at line 182 of file ui_common.c.

                                 {
    ui->sio = sio;
    RED_GAMMA = sio->red_gamma;
    GREEN_GAMMA = sio->green_gamma;
    BLUE_GAMMA = sio->blue_gamma;
    GRAY_GAMMA = sio->gray_gamma;
    ui_init_clr_palette(sio);
    //
    // Initialize Standardized color pairs
    //
    cp_default = ui_add_pair(CLR_NT_FG, CLR_NT_BG);
    cp_fill_char = ui_add_pair(CLR_FILL_CHAR_FG, CLR_FILL_CHAR_BG);
    cp_brackets = ui_add_pair(CLR_BRACKETS_FG, CLR_BRACKETS_BG);
    cp_nt = ui_add_pair(CLR_NT_FG, CLR_NT_BG);
    cp_nt_rev = ui_add_pair(CLR_NT_REV_FG, CLR_NT_REV_BG);
    cp_nt_hl_rev = ui_add_pair(CLR_NT_HL_REV_FG, CLR_NT_HL_REV_BG);
    cp_nt_hl = ui_add_pair(CLR_NT_HL_FG, CLR_NT_HL_BG);
    cp_box = ui_add_pair(CLR_BOX_FG, CLR_BOX_BG);
    cp_ind = ui_add_pair(CLR_IND_FG, CLR_IND_BG);
    cp_title = ui_add_pair(CLR_TITLE_FG, CLR_TITLE_BG);
    cp_ln = ui_add_pair(CLR_LN_FG, CLR_LN_BG);
    cp_cmdln = ui_add_pair(CLR_CMDLN_FG, CLR_CMDLN_BG);
    cp_red = ui_add_pair(CLR_FG, CLR_RED);
    cp_green = ui_add_pair(CLR_FG, CLR_GREEN);
    cp_yellow = ui_add_pair(CLR_BG, CLR_YELLOW);
    cp_blue = ui_add_pair(CLR_FG, CLR_BLUE);
    //
    // Initialize Standardized UiCells
    //
    cell_default = ui_cell_from_ucp(bw_sp, &sio->nt_fg, &sio->nt_bg);
    cell_fill_char = ui_cell_from_ucp(bw_sp, &sio->fill_char_fg, &sio->fill_char_bg);
    mbstate_t mbstate;
    memset(&mbstate, 0, sizeof(mbstate));
    wchar_t brktl = sio->brackets[0];
    cell_brktl = ui_cell_from_ucp(&brktl, &sio->brackets_fg, &sio->brackets_bg);
    wchar_t brktr = sio->brackets[1];
    cell_brktr = ui_cell_from_ucp(&brktr, &sio->brackets_fg, &sio->brackets_bg);
    cell_nt = ui_cell_from_ucp(bw_sp, &sio->nt_fg, &sio->nt_bg);
    cell_nt_rev = ui_cell_from_ucp(bw_sp, &sio->nt_rev_fg, &sio->nt_rev_bg);
    cell_nt_hl = ui_cell_from_ucp(bw_sp, &sio->nt_hl_fg, &sio->nt_hl_bg);
    cell_nt_hl_rev = ui_cell_from_ucp(bw_sp, &sio->nt_hl_rev_fg, &sio->nt_hl_rev_bg);
    cell_box = ui_cell_from_ucp(bw_sp, &sio->box_fg, &sio->box_bg);
    cell_cmdln = ui_cell_from_ucp(bw_sp, &sio->cmdln_fg, &sio->cmdln_bg);
    cell_title = ui_cell_from_ucp(bw_sp, &sio->title_fg, &sio->title_bg);
    cell_ln = ui_cell_from_ucp(bw_sp, &sio->ln_fg, &sio->ln_bg);
    cell_ind = ui_cell_from_ucp(bw_sp, &sio->ind_fg, &sio->ind_bg);
    cell_ran = ui_cell_from_ucp(bw_ran, &sio->ran_fg, &sio->ran_bg);
    cell_chk = ui_cell_from_ucp(bw_chk, &sio->box_fg, &sio->box_bg);
    cell_tl = ui_cell_from_ucp(&bw_tl, &sio->box_fg, &sio->box_bg);
    cell_tr = ui_cell_from_ucp(&bw_tr, &sio->box_fg, &sio->box_bg);
    cell_bl = ui_cell_from_ucp(&bw_bl, &sio->box_fg, &sio->box_bg);
    cell_br = ui_cell_from_ucp(&bw_br, &sio->box_fg, &sio->box_bg);
    cell_ho = ui_cell_from_ucp(&bw_ho, &sio->box_fg, &sio->box_bg);
    cell_ve = ui_cell_from_ucp(&bw_ve, &sio->box_fg, &sio->box_bg);
    cell_lt = ui_cell_from_ucp(&bw_lt, &sio->box_fg, &sio->box_bg);
    cell_rt = ui_cell_from_ucp(&bw_rt, &sio->box_fg, &sio->box_bg);
    cell_tt = ui_cell_from_ucp(&bw_tt, &sio->box_fg, &sio->box_bg);
    cell_bt = ui_cell_from_ucp(&bw_bt, &sio->box_fg, &sio->box_bg);
    cell_cr = ui_cell_from_ucp(&bw_cr, &sio->box_fg, &sio->box_bg);
    cell_sp = ui_cell_from_ucp(bw_sp, &sio->box_fg, &sio->box_bg);
}

References BLUE_GAMMA, SIO::blue_gamma, SIO::box_bg, SIO::box_fg, SIO::brackets, SIO::brackets_bg, SIO::brackets_fg, bw_chk, bw_ran, bw_sp, cell_bl, cell_box, cell_br, cell_brktl, cell_brktr, cell_bt, cell_chk, cell_cmdln, cell_cr, cell_default, cell_fill_char, cell_ho, cell_ind, cell_ln, cell_lt, cell_nt, cell_nt_hl, cell_nt_hl_rev, cell_nt_rev, cell_ran, cell_rt, cell_sp, cell_title, cell_tl, cell_tr, cell_tt, cell_ve, CLR_BG, CLR_BLUE, CLR_BOX_BG, CLR_BOX_FG, CLR_BRACKETS_BG, CLR_BRACKETS_FG, CLR_CMDLN_BG, CLR_CMDLN_FG, CLR_FG, CLR_FILL_CHAR_BG, CLR_FILL_CHAR_FG, CLR_GREEN, CLR_IND_BG, CLR_IND_FG, CLR_LN_BG, CLR_LN_FG, CLR_NT_BG, CLR_NT_FG, CLR_NT_HL_BG, CLR_NT_HL_FG, CLR_NT_HL_REV_BG, CLR_NT_HL_REV_FG, CLR_NT_REV_BG, CLR_NT_REV_FG, CLR_RED, CLR_TITLE_BG, CLR_TITLE_FG, CLR_YELLOW, SIO::cmdln_bg, SIO::cmdln_fg, cp_blue, cp_box, cp_brackets, cp_cmdln, cp_default, cp_fill_char, cp_green, cp_ind, cp_ln, cp_nt, cp_nt_hl, cp_nt_hl_rev, cp_nt_rev, cp_red, cp_title, cp_yellow, SIO::fill_char_bg, SIO::fill_char_fg, GRAY_GAMMA, SIO::gray_gamma, GREEN_GAMMA, SIO::green_gamma, SIO::ind_bg, SIO::ind_fg, SIO::ln_bg, SIO::ln_fg, SIO::nt_bg, SIO::nt_fg, SIO::nt_hl_bg, SIO::nt_hl_fg, SIO::nt_hl_rev_bg, SIO::nt_hl_rev_fg, SIO::nt_rev_bg, SIO::nt_rev_fg, SIO::ran_bg, SIO::ran_fg, RED_GAMMA, SIO::red_gamma, SIO::title_bg, SIO::title_fg, ui, ui_add_pair(), ui_cell_from_ucp(), and ui_init_clr_palette().

Referenced by read_theme(), ui_init(), and ui_init().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_keypad()

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

Enable or disable the keypad for a UiSurface.

Enable or disable the keypad for the specified window within a UI surface.

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.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
enable	True to enable the keypad, false to disable it.

Returns

0 on success, -1 on failure.

This function does nothing.

Enable or disable the keypad for a UiSurface.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
enable	True to enable the keypad, false to disable it.

Returns

0 on success, -1 on failure.

This function does nothing.

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;
}

Referenced by fork_exec(), init_view_boxwin(), init_view_full_screen(), menu_cmd_processor(), open_pick_win(), picker(), and popup_ckeys().

Here is the caller graph for this function:

ui_mice_enable()

int ui_mice_enable

(

int

mask

)

Enable or disable mouse support.

Enable or disable mouse events for the NotCurses context.

Parameters

mask	Mouse event mask (0 to disable, non-zero to enable).

Returns

0 on success, -1 if UI is not initialized.

Parameters

mask	The mouse event mask to enable. If 0, all mouse events are enabled.

Returns

0 on success, or -1 if ui is NULL.

Enable or disable mouse support.

Parameters

mask	The mouse event mask to enable. If 0, all mouse events are enabled.

Returns

0 on success, or -1 if ui is NULL.

Definition at line 274 of file ui_ncurses_input.c.

                             {
    if (!ui)
        return -1;
    if (mask)
        mousemask(mask, nullptr);
    else
        mousemask(ALL_MOUSE_EVENTS | REPORT_MOUSE_POSITION, nullptr);
    return 0;
}

References ui.

ui_mousemask()

int ui_mousemask

(

int

mask

)

Enable or disable mouse support.

Set the mouse event mask for the NotCurses context.

Parameters

mask	Mouse event mask (0 to disable, non-zero to enable).

Returns

0 on success, -1 if UI is not initialized.

Parameters

mask	The mouse event mask to set. If 0, all mouse events are enabled.

Returns

0 on success, or -1 if ui is NULL.

Enable or disable mouse support.

Parameters

mask	The mouse event mask to set. If 0, all mouse events are enabled.

Returns

0 on success, or -1 if ui is NULL.

Definition at line 261 of file ui_ncurses_input.c.

                           {
    if (!ui)
        return -1;
    if (mask)
        mousemask(mask, nullptr);
    else
        mousemask(ALL_MOUSE_EVENTS | REPORT_MOUSE_POSITION, nullptr);
    return 0;
}

References ui.

Referenced by menu_cmd_processor(), and picker().

Here is the caller 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.

Render the UI by updating panels and refreshing the display.

This function renders the UI.

Definition at line 884 of file ui_ncurses.c.

                 {
    update_panels();
    doupdate();
}

References ui.

Referenced by cf_accept(), display_form(), display_line(), display_pick_page(), field_editor(), form_display_accept_field(), form_display_field(), form_display_fields(), get_cmd_arg(), get_cmd_char(), init_pick(), main(), menu_cmd_processor(), menu_engine(), pad_refresh(), picker(), read_theme(), ui_draw_text_fill(), ui_get_event(), ui_restore_wins(), ui_surface_destroy(), ui_timeout_prompt(), ui_tracked_sfc_box(), ui_update_timeout_prompt(), view_boxwin_resize(), view_display_page(), and view_full_screen_resize().

Here is the caller graph for this function:

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();
}

References sfc_ptr, SUB_SFC_MAX, ui_render(), and ui_surface.

Referenced by enter_file_spec(), exec_objects(), fork_exec(), form_exec_receiver(), full_screen_shell(), menu_cmd_processor(), menu_engine(), view_cmd_processor(), view_init_input(), and write_view_buffer().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_resume()

int ui_resume

(

)

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

Resume the UI and enter the alternate screen.

Returns

0 on success, or -1 on failure.

This function resumes the UI and enters the alternate screen. It is typically used after a suspension of the UI, allowing the application to return to its previous state and continue rendering the UI.

Returns

0 on success, -1 on failure.

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

This function resumes the UI and enters the alternate screen. It is typically used after a suspension of the UI, allowing the application to return to its previous state and continue rendering the UI.

Returns

0 on success, -1 on failure.

Definition at line 503 of file ui_ncurses.c.

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

References ui.

Referenced by fork_exec().

Here is the caller graph for this function:

ui_scrollok()

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

Enable or disable scrolling for a UiSurface.

Enable or disable scrolling for the specified window within a UI surface.

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.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
enable	True to enable scrolling, false to disable scrolling.

Returns

0 on success, -1 on failure.

This function enables or disables scrolling for the specified window within a UI surface. If the surface or window is not initialized, it returns -1.

Enable or disable scrolling for a UiSurface.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
enable	True to enable scrolling, false to disable scrolling.

Returns

0 on success, -1 on failure.

This function enables or disables scrolling for the specified window within a UI surface. If the surface or window is not initialized, it returns -1.

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;
}

Referenced by init_view_boxwin(), init_view_full_screen(), menu_cmd_processor(), open_pick_win(), ui_surface_addpad(), and ui_surface_box().

Here is the caller graph for this function:

ui_setscrreg()

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

Set the scrolling region for a UiSurface.

Set the scrolling region for the specified window within a UI surface.

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.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
top	The top line of the scrolling region.
bottom	The bottom line of the scrolling region.

Returns

0 on success, -1 on failure.

This function does nothing.

Set the scrolling region for a UiSurface.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
top	The top line of the scrolling region.
bottom	The bottom line of the scrolling region.

Returns

0 on success, -1 on failure.

This function does nothing.

Definition at line 820 of file ui_ncurses.c.

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

Referenced by init_view_boxwin(), init_view_full_screen(), and open_pick_win().

Here is the caller graph for this function:

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.

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

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;
    }
}

References f_ncurses_open, f_notcurses_open, sfc_ptr, stdsfc, ui, ui_color, ui_pair, ui_surface, and ui_surface_destroy().

Referenced by cmenu_shutdown(), main(), ui_abend(), ui_destroy_curses(), ui_endwin(), and ui_init().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_sub_surface_str()

const char * ui_sub_surface_str

(

ss_t

w

)

Definition at line 1368 of file ui_common.c.

                                       {
    if (w < BOX || w >= SUB_SFC_MAX)
        return _("unknown");
    return subsfc_s[w];
}

References SUB_SFC_MAX, and subsfc_s.

ui_surface_addpad()

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

Add a new pad to the specified UiSurface.

Add padding to an existing UI surface.

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.

Parameters

s	Pointer to the UiSurface to which padding will be added.
w	The index of the new padded surface.
p	The index of the parent plane to attach to.
lines	The number of lines (rows) for the padded surface.
cols	The number of columns for the padded surface.
y	The y-coordinate for the padded surface's position.
x	The x-coordinate for the padded surface's position.

Returns

0 on success, -1 on failure.

This function adds padding to an existing UI surface by creating a new ncplane with the specified dimensions and position. It updates the metadata for the new padded surface and sets its background and scrolling properties. If any step fails, it cleans up and returns -1.

Add a new pad to the specified UiSurface.

Parameters

s	Pointer to the UiSurface to which padding will be added.
w	The index of the new padded surface.
p	The index of the parent plane to attach to.
lines	The number of lines (rows) for the padded surface.
cols	The number of columns for the padded surface.
y	The y-coordinate for the padded surface's position.
x	The x-coordinate for the padded surface's position.

Returns

0 on success, -1 on failure.

This function adds padding to an existing UI surface by creating a new ncplane with the specified dimensions and position. It updates the metadata for the new padded surface and sets its background and scrolling properties. If any step fails, it cleans up and returns -1.

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;
}

References cell_nt, f_notcurses_open, ui, ui_bkgd(), ui_bkgdset(), and ui_scrollok().

Referenced by init_view_boxwin(), and init_view_full_screen().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Add a new window to an existing UI surface.

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.

Parameters

s	Pointer to the UiSurface to which the window will be added.
w	The index of the new window.
p	The index of the parent plane to attach to.
lines	The number of lines (rows) for the new window.
cols	The number of columns for the new window.
y	The y-coordinate for the new window's position.
x	The x-coordinate for the new window's position.

Returns

0 on success, -1 on failure.

This function adds a new window to an existing UI surface by creating a new ncplane with the specified dimensions and position. It updates the metadata for the new window and sets its background properties. If any step fails, it cleans up and returns -1.

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 new window.
p	The index of the parent plane to attach to.
lines	The number of lines (rows) for the new window.
cols	The number of columns for the new window.
y	The y-coordinate for the new window's position.
x	The x-coordinate for the new window's position.

Returns

0 on success, -1 on failure.

This function adds a new window to an existing UI surface by creating a new ncplane with the specified dimensions and position. It updates the metadata for the new window and sets its background properties. If any step fails, it cleans up and returns -1.

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;
}

References cell_nt, f_notcurses_open, ui, ui_bkgd(), and ui_bkgdset().

Referenced by init_view_boxwin(), init_view_full_screen(), ui_display_image(), ui_tracked_sfc_box(), and ui_tracked_sfc_split_box().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Parameters

parent	Pointer to the parent UiSurface, or NULL for no parent.
p	The index of the parent plane to attach to.
lines	The number of lines (rows) for the new surface.
cols	The number of columns for the new surface.
y	The y-coordinate for the new surface's position.
x	The x-coordinate for the new surface's position.
wtitle	The title to display on the border box, or NULL for no title.

Returns

Pointer to the newly created UiSurface, or NULL on failure.

This function creates a new UI surface with a border box and an optional title. It allocates memory for the surface, sets up its metadata, and creates a new ncplane for rendering. If any step fails, it cleans up and returns NULL.

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;
}

References cell_box, em0, em1, em2, ssnprintf(), stdplane, strnz__cpy(), ui, ui_border_draw(), ui_border_title(), ui_display_error(), ui_get_screen_size(), and ui_scrollok().

Referenced by init_view_boxwin(), ui_display_image(), ui_tracked_sfc_box(), and ui_tracked_sfc_split_box().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_surface_destroy()

void ui_surface_destroy

(

UiSurface *

s

)

Destroy a UiSurface, cleaning up its windows and panels.

Destroy a UI surface and free its resources.

Parameters

s	Pointer to the UiSurface to be destroyed.
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.

Destroy a UiSurface, cleaning up its windows and panels.

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 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;
    }
}

References SUB_SFC_MAX, and ui_render().

Referenced by destroy_pick_view(), main(), ui_cm_surface_destroy(), ui_framed_surface_destroy(), ui_framed_surface_new(), ui_shutdown(), view_boxwin_resize(), view_file(), and view_full_screen_resize().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_surface_hide()

int ui_surface_hide	(	UiSurface *	s,
		ss_t	w )

Hide a UiSurface, making it invisible on the screen.

Hide the specified window within a UI surface.

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.

Parameters

s	Pointer to the UiSurface containing the window to hide.
w	The index of the window to hide.

Returns

0 on success, -1 on failure.

This function hides the specified window within a UI surface by updating its metadata and moving it far off-screen. If the surface or window is not initialized, it returns -1.

Hide a UiSurface, making it invisible on the screen.

Parameters

s	Pointer to the UiSurface containing the window to hide.
w	The index of the window to hide.

Returns

0 on success, -1 on failure.

This function hides the specified window within a UI surface by updating its metadata and moving it far off-screen. If the surface or window is not initialized, it returns -1.

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.

Move a UI surface 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.

Parameters

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

Returns

0 on success, -1 on failure.

This function moves a UI surface to a new position on the screen by updating its metadata and moving the associated ncplane. If the surface is hidden, it only updates the metadata without moving the ncplane. If any step fails, it returns -1.

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 move.
y	The new y-coordinate for the surface's position.
x	The new x-coordinate for the surface's position.

Returns

0 on success, -1 on failure.

This function moves a UI surface to a new position on the screen by updating its metadata and moving the associated ncplane. If the surface is hidden, it only updates the metadata without moving the ncplane. If any step fails, it returns -1.

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.

Parameters

w	The index of the surface to create.
parent	Pointer to the parent UiSurface, or NULL for no parent.
p	The index of the parent plane to attach to.
lines	The number of lines (rows) for the new surface.
cols	The number of columns for the new surface.
y	The y-coordinate for the new surface's position.
x	The x-coordinate for the new surface's position.

Returns

Pointer to the newly created UiSurface, or NULL on failure.

This function creates a new UI surface and initializes its properties based on the provided parameters. It allocates memory for the surface, sets up its metadata, and creates a new ncplane for rendering. If any step fails, it cleans up and returns NULL.

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;
}

References em0, em1, em2, f_notcurses_open, ssnprintf(), stdplane, SUB_SFC_MAX, ui, ui_display_error(), and ui_get_screen_size().

Referenced by init_view_full_screen(), and ui_framed_surface_new().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_surface_resize()

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

Resize a UiSurface to new dimensions.

Resize a UI surface 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.

Parameters

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

Returns

0 on success, -1 on failure.

This function resizes a UI surface to new dimensions by updating its metadata and resizing the associated ncplane. If any step fails, it returns -1.

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 resize.
lines	The new number of lines (rows) for the surface.
cols	The new number of columns for the surface.

Returns

0 on success, -1 on failure.

This function resizes a UI surface to new dimensions by updating its metadata and resizing the associated ncplane. If any step fails, it returns -1.

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.

Show the specified window within a UI surface.

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.

Parameters

s	Pointer to the UiSurface containing the window to show.
w	The index of the window to show.

Returns

0 on success, -1 on failure.

This function shows the specified window within a UI surface by updating its metadata and moving it to its designated position. If the surface or window is not initialized, it returns -1.

Show a UiSurface, making it visible on the screen.

Parameters

s	Pointer to the UiSurface containing the window to show.
w	The index of the window to show.

Returns

0 on success, -1 on failure.

This function shows the specified window within a UI surface by updating its metadata and moving it to its designated position. If the surface or window is not initialized, it returns -1.

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.

Suspend the UI and leave the alternate screen.

Returns

0 on success, or -1 on failure.

This function suspends the UI and leaves the alternate screen. It is typically used when the application needs to temporarily exit the UI mode, such as when executing a shell command or displaying a message outside of the UI context.

Returns

0 on success, -1 on failure.

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

This function suspends the UI and leaves the alternate screen. It is typically used when the application needs to temporarily exit the UI mode, such as when executing a shell command or displaying a message outside of the UI context.

Returns

0 on success, -1 on failure.

Definition at line 494 of file ui_ncurses.c.

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

References ui.

ui_top_surface()

int ui_top_surface	(	UiSurface *	s,
		ss_t	w )

Hide a UiSurface, making it invisible on the screen.

Move the specified window within a UI surface to the top of the z-order.

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.

Parameters

s	Pointer to the UiSurface containing the window to move.
w	The index of the window to move to the top.

Returns

0 on success, -1 on failure.

This function moves the specified window within a UI surface to the top of the z-order, making it the foremost window. If the surface or window is not initialized, it returns -1.

Hide a UiSurface, making it invisible on the screen.

Parameters

s	Pointer to the UiSurface containing the window to move.
w	The index of the window to move to the top.

Returns

0 on success, -1 on failure.

This function moves the specified window within a UI surface to the top of the z-order, making it the foremost window. If the surface or window is not initialized, it returns -1.

Definition at line 623 of file ui_ncurses.c.

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

Referenced by get_cmd_char(), and picker().

Here is the caller graph for this function:

ui_tracked_sfc_box()

int ui_tracked_sfc_box	(	uint	wlines,
		uint	wcols,
		uint	wbegy,
		uint	wbegx,
		const char *	wtitle )

Create a new surface with a box window.

ui_tracked_sfc_box_com

Parameters

wlines	Number of lines for the window
wcols	Number of columns for the window
wbegy	Starting Y position for the window
wbegx	Starting X position for the window
wtitle	Title for the window

Returns

0 on success, -1 on error

This function creates a new surface and adds a box window to it. It checks if the maximum number of surfaces has been exceeded and adjusts the window size based on the screen size. The new surface is stored in the global ui_surface array, and the surface pointer (sfc_ptr) is incremented. The window is then rendered on the screen.

Definition at line 387 of file ui_common.c.

                                                                                            {
    if (sfc_ptr >= SFC_MAX) {
        ui_log(ERROR, _("Maximum number of surfaces (%d) exceeded"), SFC_MAX);
        exit(EXIT_FAILURE);
    }
    uint maxy, maxx;
    ui_get_screen_size(&maxy, &maxx);
    wlines = min(wlines, maxy);
    wcols = min(wcols, maxx);
    sfc_ptr++;
    // ------------------->    UI_win_box    <-------------------
    ui_surface[sfc_ptr] = ui_surface_box(nullptr, 0, wlines + 2, wcols + 2, wbegy, wbegx, wtitle);
    UiSurface *sfc = ui_surface[sfc_ptr];
    ui_surface_addwin(sfc, WIN, BOX, wlines, wcols, 1, 1);
    ui_render();
    return 0;
}

References sfc_ptr, ui_get_screen_size(), ui_render(), ui_surface, ui_surface_addwin(), and ui_surface_box().

Referenced by display_form(), main(), menu_engine(), popup_ckeys(), ui_action_disposition(), ui_answer_yn(), ui_display_error(), ui_perror(), and ui_timeout_prompt().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_tracked_sfc_split_box()

int ui_tracked_sfc_split_box	(	uint	wlines,
		uint	wcols,
		uint	split_y,
		uint	split_x,
		uint	wbegy,
		uint	wbegx,
		const char *	wtitle )

Create a new surface with a split box window.

surface_split_box_win_new

Parameters

wlines	Number of lines for the main window
wcols	Number of columns for the main window
split_y	Y position for the split line
split_x	X position for the split line (not implemented yet)
wbegy	Starting Y position for the window
wbegx	Starting X position for the window
wtitle	Title for the window

Returns

0 on success, -1 on error

This function creates a new surface and adds a split box window to it. It checks if the maximum number of surfaces has been exceeded and adjusts the window size based on the screen size. The new surface is stored in the global ui_surface array, and the surface pointer (sfc_ptr) is incremented. The main window and the split window are then rendered on the screen, with a separator line drawn at the specified Y position.

Definition at line 425 of file ui_common.c.

                                                                                                                              {
    if (sfc_ptr >= SFC_MAX) {
        ui_log(ERROR, _("Maximum number of surfaces (%d) exceeded"), SFC_MAX);
        exit(EXIT_FAILURE);
    }
    if (wlines == 0 || wcols == 0) {
        ui_log(ERROR, _("Invalid window size: lines=%d, cols=%d"), wlines, wcols);
        return -1;
    }
    uint maxy, maxx;
    ui_get_screen_size(&maxy, &maxx);
    if (wbegy > maxy || wbegx > maxx) {
        ui_log(ERROR, _("Invalid window position: wbegy=%d, wbegx=%d, wlines=%d, wcols=%d"), wbegy, wbegx, wlines, wcols);
        return -1;
    }
    wlines = min(wlines, maxy);
    wcols = min(wcols, maxx);
    split_x = min(split_x, maxx); // not implemented yet
    uint split_wlines = min(wlines + split_y + 1, maxy);
    wcols = min(wcols, maxx);
    sfc_ptr++;
    // ------------------->    surface_new    <-------------------
    ui_surface[sfc_ptr] = ui_surface_box(nullptr, 0, split_wlines + 2, wcols + 2, wbegy, wbegx, wtitle);
    UiSurface *sfc = ui_surface[sfc_ptr];
 
    ui_surface_addwin(sfc, WIN, BOX, wlines, wcols, 1, 1);
    ui_border_ysplit(sfc, wlines + 1);
    ui_surface_addwin(sfc, WIN2, BOX, 2, wcols, wlines + 2, 1);
    ui_curs_set(0);
    return 0;
}

References sfc_ptr, ui_border_ysplit(), ui_curs_set(), ui_get_screen_size(), ui_surface, ui_surface_addwin(), and ui_surface_box().

Referenced by open_pick_win().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Update the panels in the UI.

This function updates the panels and renders the UI.

Definition at line 890 of file ui_ncurses.c.

                        {
    update_panels();
}

References ui.

ui_wclear()

int ui_wclear	(	UiSurface *	s,
		ss_t	w )

Clear the contents of a UiSurface or all surfaces.

Clear the contents of the specified window within a UI surface.

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.

Parameters

s	Pointer to the UiSurface containing the window to clear.
w	The index of the window to clear.

Returns

0 on success, -1 on failure.

This function clears the contents of the specified window within a UI surface by erasing its contents. If the surface or window is not initialized, it returns -1.

Clear the contents of a UiSurface or all surfaces.

Parameters

s	Pointer to the UiSurface containing the window to clear.
w	The index of the window to clear.

Returns

0 on success, -1 on failure.

This function clears the contents of the specified window within a UI surface by erasing its contents. If the surface or window is not initialized, it returns -1.

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;
}

References SUB_SFC_MAX.

ui_wclrtobot()

int ui_wclrtobot	(	UiSurface *	s,
		ss_t	w )

Set the style of a surface window.

clear from current cursor position to bottom of 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.

Parameters

s	surface
w	window

Returns

0 on success, -1 on error

Set the style of a surface window.

Parameters

s	surface
w	window

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;
}

Referenced by display_line_eod(), scroll_next(), scroll_prev(), and search().

Here is the caller graph for this function:

ui_wclrtoeol()

int ui_wclrtoeol	(	UiSurface *	s,
		ss_t	w )

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

clear the window from the current cursor position to the end of the window

Parameters

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

Returns

0 on success, -1 on error.

Parameters

s	surface
w	window

Returns

0 on success, -1 on error

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

Parameters

s	surface
w	window

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;
}

Referenced by cf_accept(), display_line(), display_prompt(), display_split_line(), form_post(), get_cmd_arg(), get_cmd_char(), pick_engine(), picker(), ui_display_chyron(), and ui_update_timeout_prompt().

Here is the caller graph for this function:

ui_werase()

int ui_werase	(	UiSurface *	s,
		ss_t	w )

Erase the contents of a UiSurface or all surfaces.

Clear the contents of the specified window within a UI surface.

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.

Parameters

s	Pointer to the UiSurface containing the window to clear.
w	The index of the window to clear.

Returns

0 on success, -1 on failure.

This function clears the contents of the specified window within a UI surface by erasing its contents. If the surface or window is not initialized, it returns -1.

Erase the contents of a UiSurface or all surfaces.

Parameters

s	Pointer to the UiSurface containing the window to clear.
w	The index of the window to clear.

Returns

0 on success, -1 on failure.

This function clears the contents of the specified window within a UI surface by erasing its contents. If the surface or window is not initialized, it returns -1.

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;
}

References SUB_SFC_MAX.

Referenced by exec_objects(), and full_screen_shell().

Here is the caller graph for this function:

ui_whide()

int ui_whide	(	UiSurface *	s,
		ss_t	w )

ui_wmove()

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

Move the cursor to a specified position within a UiSurface.

Move the cursor to the specified position within a window of a UI surface.

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.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
y	The y-coordinate for the new cursor position.
x	The x-coordinate for the new cursor position.

Returns

0 on success, -1 on failure.

This function moves the cursor to the specified position within a window of a UI surface. If the surface or window is not initialized, it returns -1.

Move the cursor to a specified position within a UiSurface.

Parameters

s	Pointer to the UiSurface containing the window.
w	The index of the window within the surface.
y	The y-coordinate for the new cursor position.
x	The x-coordinate for the new cursor position.

Returns

0 on success, -1 on failure.

This function moves the cursor to the specified position within a window of a UI surface. If the surface or window is not initialized, it returns -1.

Definition at line 653 of file ui_ncurses.c.

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

Referenced by full_screen_shell(), menu_cmd_processor(), ui_display_chyron(), ui_mvwadd_wchnstr(), and ui_mvwadd_wchstr().

Here is the caller graph for this function:

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.

---

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_wresize()

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

ui_wscrl()

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

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

Scroll the contents of the specified window up or down by the 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.

Parameters

s	The surface containing the window to scroll.
w	The index of the window to scroll.
r	The number of lines to scroll. Positive values scroll up, negative values scroll down.

Returns

0 on success, -1 on error.

If r is positive, the contents of the plane are moved up, leaving blank lines at the bottom. In the view application, the view scope is moved toward end of file (eof). - scope_toward_eof()

Note

ui_wscrl(-n) - If r is negative, the contents of the plane are moved down, leaving blank lines at the top. In the view application, the view scope is moved toward beginning of file (bof). - scope_toward_bof()

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

Parameters

s	The surface containing the window to scroll.
w	The index of the window to scroll.
r	The number of lines to scroll. Positive values scroll up, negative values scroll down.

Returns

0 on success, -1 on error.

If r is positive, the contents of the plane are moved up, leaving blank lines at the bottom. In the view application, the view scope is moved toward end of file (eof). - scope_toward_eof()

Note

ui_wscrl(-n) - If r is negative, the contents of the plane are moved down, leaving blank lines at the top. In the view application, the view scope is moved toward beginning of file (bof). - scope_toward_bof()

Definition at line 738 of file ui_ncurses.c.

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

Referenced by display_pick_page(), scroll_next(), and scroll_prev().

Here is the caller graph for this function:

ui_wshow()

int ui_wshow	(	UiSurface *	s,
		ss_t	w )

Variable Documentation

border_double

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

extern

Definition at line 69 of file ui_common.c.

Referenced by ui_init(), and ui_init().

border_heavy

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

extern

Definition at line 71 of file ui_common.c.

Referenced by ui_init(), and ui_init().

border_none

const wchar_t * border_none = L" "

extern

Definition at line 72 of file ui_common.c.

Referenced by ui_init(), and ui_init().

border_rounded

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

extern

Definition at line 70 of file ui_common.c.

Referenced by ui_init(), and ui_init().

border_single

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

extern

BOX WIDE UNICODE CODEPOINTS

Definition at line 68 of file ui_common.c.

Referenced by ui_init(), and ui_init().

bw

BorderWide bw

extern

Definition at line 27 of file ui_common.c.

Referenced by ui_init(), and ui_init().

bw_chk

const wchar_t * bw_chk = L"\u2611"

extern

left_angle

Definition at line 86 of file ui_common.c.

Referenced by ui_initialize_sio().

bw_da

const wchar_t * bw_da = L"\u2193"

extern

large down arrow

Definition at line 83 of file ui_common.c.

bw_h09

const wchar_t * bw_h09 = L"\u23BD"

extern

horizontal line 9

Definition at line 87 of file ui_common.c.

bw_la

const wchar_t * bw_la = L"\u2190"

extern

large left arrow

Definition at line 81 of file ui_common.c.

bw_lan

const wchar_t * bw_lan = L"\u276E"

extern

left_angle

Definition at line 85 of file ui_common.c.

bw_ra

const wchar_t * bw_ra = L"\u2192"

extern

large right arrow

Definition at line 80 of file ui_common.c.

bw_ran

const wchar_t * bw_ran = L"\u276F"

extern

right_angle

Definition at line 84 of file ui_common.c.

Referenced by ui_initialize_sio().

bw_rbl

const wchar_t * bw_rbl = L"\u2570"

extern

rounded bottom left

Definition at line 77 of file ui_common.c.

bw_rbr

const wchar_t * bw_rbr = L"\u256f"

extern

rounded bottom right

Definition at line 78 of file ui_common.c.

bw_rtl

const wchar_t * bw_rtl = L"\u256d"

extern

MISCELANEOUS UNICODE CODEPOINTS rounded top left

Definition at line 75 of file ui_common.c.

bw_rtr

const wchar_t * bw_rtr = L"\u256e"

extern

rounded top right

Definition at line 76 of file ui_common.c.

bw_sp

const wchar_t * bw_sp = L"\x20"

extern

space

Definition at line 79 of file ui_common.c.

Referenced by ui_initialize_sio().

bw_ua

const wchar_t * bw_ua = L"\u2191"

extern

large up arrow

Definition at line 82 of file ui_common.c.

cell_bl

UiCell cell_bl

extern

Definition at line 125 of file ui_common.c.

Referenced by ui_border_draw(), and ui_initialize_sio().

cell_box

UiCell cell_box

extern

Definition at line 110 of file ui_common.c.

Referenced by ui_border_title(), ui_initialize_sio(), and ui_surface_box().

cell_br

UiCell cell_br

extern

Definition at line 126 of file ui_common.c.

Referenced by ui_border_draw(), and ui_initialize_sio().

cell_brktl

UiCell cell_brktl

extern

Definition at line 104 of file ui_common.c.

Referenced by display_form(), and ui_initialize_sio().

cell_brktr

UiCell cell_brktr

extern

Definition at line 105 of file ui_common.c.

Referenced by display_form(), and ui_initialize_sio().

cell_bs

UiCell cell_bs

extern

Definition at line 120 of file ui_common.c.

cell_bt

UiCell cell_bt

extern

Definition at line 130 of file ui_common.c.

Referenced by ui_initialize_sio().

cell_chk

UiCell cell_chk

extern

Definition at line 116 of file ui_common.c.

Referenced by picker(), remove_right_angle(), reverse_object(), toggle_object(), ui_initialize_sio(), and unreverse_object().

cell_cmdln

UiCell cell_cmdln

extern

Definition at line 112 of file ui_common.c.

Referenced by ui_initialize_sio().

cell_cr

UiCell cell_cr

extern

Definition at line 131 of file ui_common.c.

Referenced by ui_initialize_sio().

cell_default

UiCell cell_default

extern

Definition at line 102 of file ui_common.c.

Referenced by ui_initialize_sio().

cell_fill_char

UiCell cell_fill_char

extern

Definition at line 103 of file ui_common.c.

Referenced by form_display_fields(), and ui_initialize_sio().

cell_ho

UiCell cell_ho

extern

Definition at line 123 of file ui_common.c.

Referenced by ui_border_draw(), ui_border_title(), ui_border_ysplit(), ui_border_ysplit_text(), and ui_initialize_sio().

cell_ind

UiCell cell_ind

extern

Definition at line 111 of file ui_common.c.

Referenced by ui_initialize_sio().

cell_ln

UiCell cell_ln

extern

Definition at line 114 of file ui_common.c.

Referenced by init_view_boxwin(), init_view_full_screen(), and ui_initialize_sio().

cell_ls

UiCell cell_ls

extern

Definition at line 117 of file ui_common.c.

cell_lt

UiCell cell_lt

extern

Definition at line 127 of file ui_common.c.

Referenced by ui_border_title(), ui_border_ysplit(), ui_border_ysplit_text(), and ui_initialize_sio().

cell_nt

UiCell cell_nt

extern

Definition at line 106 of file ui_common.c.

Referenced by display_pick_page(), display_prompt(), form_display_accept_field(), form_display_field(), form_display_fields(), get_cmd_arg(), init_view_boxwin(), init_view_full_screen(), menu_cmd_processor(), menu_engine(), popup_ckeys(), reverse_object(), ui_initialize_sio(), ui_surface_addpad(), ui_surface_addwin(), and unreverse_object().

cell_nt_hl

UiCell cell_nt_hl

extern

Definition at line 108 of file ui_common.c.

Referenced by menu_cmd_processor(), menu_engine(), ui_border_ysplit_text(), and ui_initialize_sio().

cell_nt_hl_rev

UiCell cell_nt_hl_rev

extern

Definition at line 109 of file ui_common.c.

Referenced by field_editor(), form_engine(), menu_cmd_processor(), picker(), and ui_initialize_sio().

cell_nt_rev

UiCell cell_nt_rev

extern

Definition at line 107 of file ui_common.c.

Referenced by display_prompt(), field_editor(), get_cmd_arg(), menu_cmd_processor(), picker(), popup_ckeys(), reverse_object(), ui_compile_chyron(), ui_initialize_sio(), and ui_set_chyron_key().

cell_ran

UiCell cell_ran

extern

Definition at line 115 of file ui_common.c.

Referenced by get_cmd_arg(), get_cmd_char(), picker(), and ui_initialize_sio().

cell_rs

UiCell cell_rs

extern

Definition at line 118 of file ui_common.c.

cell_rt

UiCell cell_rt

extern

Definition at line 128 of file ui_common.c.

Referenced by ui_border_title(), ui_border_ysplit(), ui_border_ysplit_text(), and ui_initialize_sio().

cell_sp

UiCell cell_sp

extern

Definition at line 132 of file ui_common.c.

Referenced by deselect_object(), get_cmd_char(), picker(), remove_right_angle(), reverse_object(), toggle_object(), ui_border_title(), ui_border_ysplit_text(), ui_initialize_sio(), unreverse_object(), and view_cmd_processor().

cell_title

UiCell cell_title

extern

Definition at line 113 of file ui_common.c.

Referenced by ui_border_title(), and ui_initialize_sio().

cell_tl

UiCell cell_tl

extern

Definition at line 121 of file ui_common.c.

Referenced by ui_border_draw(), ui_border_title(), and ui_initialize_sio().

cell_tr

UiCell cell_tr

extern

Definition at line 122 of file ui_common.c.

Referenced by ui_border_draw(), and ui_initialize_sio().

cell_ts

UiCell cell_ts

extern

Definition at line 119 of file ui_common.c.

cell_tt

UiCell cell_tt

extern

Definition at line 129 of file ui_common.c.

Referenced by ui_initialize_sio().

cell_ve

UiCell cell_ve

extern

Definition at line 124 of file ui_common.c.

Referenced by ui_border_draw(), and ui_initialize_sio().

click_x

int click_x

extern

the x coordinate of a mouse click

Definition at line 30 of file ui_common.c.

Referenced by cf_accept(), field_editor(), form_post(), and form_process().

click_y

int click_y

extern

the y coordinate of a mouse click

Definition at line 29 of file ui_common.c.

Referenced by cf_accept(), field_editor(), form_post(), and form_process().

clr_cnt

uint clr_cnt

extern

number of colors used

clr_idx

uint clr_idx

extern

current color index

clr_pair_cnt

uint clr_pair_cnt

extern

number of color pairs supported by the terminal

clr_pair_idx

uint clr_pair_idx

extern

current color pair index

colors_text

char const colors_text

extern

Initial value:

                   = {
_("black"), _("red"), _("green"), _("yellow"), _("blue"), _("magenta"), _("cyan"),
_("white"), _("orange"), _("bg"), _("abg"), _("bblack"), _("bred"), _("bgreen"),
_("byellow"), _("bblue"), _("bcyan"), _("bmagenta"), _("bwhite"), _("borange"), ""}

Color names for .minitrc overrides.

color codes for the 16 basic colors

colors_text

These names are used in .minitrc to specify color overrides The order of these names corresponds to the ColorsEnum values

Definition at line 93 of file ui_common.c.

                             {
    _("black"), _("red"), _("green"), _("yellow"), _("blue"), _("magenta"), _("cyan"),
    _("white"), _("orange"), _("bg"), _("abg"), _("bblack"), _("bred"), _("bgreen"),
    _("byellow"), _("bblue"), _("bcyan"), _("bmagenta"), _("bwhite"), _("borange"), ""};

COLS

uint COLS

Definition at line 426 of file ui_backend.h.

cp_blue

ushort cp_blue

extern

blue background color pair index

blue background - for testing

Definition at line 153 of file ui_common.c.

Referenced by ui_initialize_sio().

cp_bold

ushort cp_bold

extern

bold color pair index

cp_box

ushort cp_box

extern

box color pair index

border

Definition at line 138 of file ui_common.c.

Referenced by ui_initialize_sio().

cp_brackets

ushort cp_brackets

extern

color pair index for field brackets

field enclosure brackets

Definition at line 149 of file ui_common.c.

Referenced by ui_initialize_sio().

cp_cmdln_bg

ushort cp_cmdln_bg

extern

command line number background color pair index

cp_cmdln_fg

ushort cp_cmdln_fg

extern

command line number color pair index

cp_default

ushort cp_default

extern

default color pair index

default color pair

Definition at line 147 of file ui_common.c.

Referenced by ui_initialize_sio().

cp_fill_char

ushort cp_fill_char

extern

fill character color pair index

field fill characters

Definition at line 148 of file ui_common.c.

Referenced by ui_initialize_sio().

cp_green

ushort cp_green

extern

green background color pair index

green background - for testing

Definition at line 151 of file ui_common.c.

Referenced by ui_initialize_sio().

cp_highlight

ushort cp_highlight

extern

highlight color pair index

cp_ind

ushort cp_ind

extern

indicator color pair index

indicator character

Definition at line 139 of file ui_common.c.

Referenced by ui_initialize_sio().

cp_ln_bg

ushort cp_ln_bg

extern

line number background color pair index

cp_ln_fg

ushort cp_ln_fg

extern

line number color pair index

cp_nt

ushort cp_nt

extern

normal color pair index

normal text

Definition at line 142 of file ui_common.c.

Referenced by fmt_line(), and ui_initialize_sio().

cp_nt_hl

ushort cp_nt_hl

extern

highlight color pair index

normal text highlight

Definition at line 144 of file ui_common.c.

Referenced by ui_initialize_sio().

cp_nt_hl_rev

ushort cp_nt_hl_rev

extern

highlight reverse color pair index

normal text highlight reverse

Definition at line 145 of file ui_common.c.

Referenced by ui_initialize_sio().

cp_nt_rev

ushort cp_nt_rev

extern

reverse color pair index

normal text reverse

Definition at line 143 of file ui_common.c.

Referenced by search(), and ui_initialize_sio().

cp_red

ushort cp_red

extern

red background color pair index

red background - for testing

Definition at line 150 of file ui_common.c.

Referenced by ui_initialize_sio().

cp_title

ushort cp_title

extern

title color pair index

border title

Definition at line 141 of file ui_common.c.

Referenced by ui_initialize_sio().

cp_yellow

ushort cp_yellow

extern

yellow background color pair index

yellow background - for testing

Definition at line 152 of file ui_common.c.

Referenced by ui_initialize_sio().

em0

char em0

extern

error message string for error messages

Definition at line 46 of file ui_common.c.

Referenced by enter_file_spec(), form_desc_error(), form_parse_desc(), form_process(), form_read_data(), form_write(), handle_signal(), init_view_full_screen(), mk_dir(), new_init(), new_pick(), new_view(), pad_refresh(), parse_menu_description(), ui_action_disposition(), ui_add_pair(), ui_color_from_rgb(), ui_get_event(), ui_open_log(), ui_surface_box(), ui_surface_new(), verify_dir(), verify_file(), view_cmd_processor(), view_init_input(), write_config(), and write_view_buffer().

em1

char em1

extern

error message string for error messages

Definition at line 47 of file ui_common.c.

Referenced by enter_file_spec(), form_desc_error(), form_parse_desc(), form_process(), form_read_data(), form_write(), handle_signal(), mk_dir(), new_init(), new_pick(), new_view(), parse_menu_description(), ui_add_pair(), ui_color_from_rgb(), ui_get_event(), ui_open_log(), ui_surface_box(), ui_surface_new(), verify_dir(), verify_file(), view_cmd_processor(), view_init_input(), and write_view_buffer().

em2

char em2

extern

error message string for error messages

Definition at line 48 of file ui_common.c.

Referenced by enter_file_spec(), form_desc_error(), form_parse_desc(), form_process(), form_read_data(), form_write(), handle_signal(), mk_dir(), new_init(), new_view(), parse_menu_description(), ui_add_pair(), ui_get_event(), ui_open_log(), ui_surface_box(), ui_surface_new(), verify_dir(), verify_file(), view_cmd_processor(), view_init_input(), and write_view_buffer().

em3

char em3

extern

error message string for error messages

Definition at line 49 of file ui_common.c.

Referenced by ui_open_log(), ui_timeout_prompt(), ui_update_timeout_prompt(), verify_dir(), and verify_file().

f_ncurses_open

bool f_ncurses_open = false

extern

Definition at line 50 of file ui_common.c.

Referenced by handle_signal(), ui_action_disposition(), ui_answer_yn(), ui_destroy_curses(), ui_display_error(), ui_init(), ui_perror(), ui_shutdown(), ui_timeout_prompt(), and ui_update_timeout_prompt().

f_notcurses_open

bool f_notcurses_open = false

extern

Definition at line 51 of file ui_common.c.

Referenced by handle_signal(), ui_action_disposition(), ui_answer_yn(), ui_destroy_curses(), ui_display_error(), ui_init(), ui_perror(), ui_shutdown(), ui_surface_addpad(), ui_surface_addwin(), ui_surface_new(), ui_timeout_prompt(), and ui_update_timeout_prompt().

LINES

uint LINES

extern

Definition at line 30 of file ui_notcurses.c.

sfc_ptr

int sfc_ptr = -1

extern

Definition at line 42 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_cm_surface_destroy(), ui_display_error(), ui_init(), ui_perror(), ui_restore_wins(), ui_shutdown(), ui_timeout_prompt(), ui_tracked_sfc_box(), and ui_tracked_sfc_split_box().

stdplane

NcPlane * stdplane

extern

Definition at line 37 of file ui_notcurses.c.

Referenced by ui_init(), ui_surface_box(), and ui_surface_new().

stdsfc

UiSurface * stdsfc

extern

Definition at line 46 of file ui_ncurses.c.

Referenced by exec_objects(), fork_exec(), full_screen_shell(), ui_display_image(), ui_init(), ui_init(), and ui_shutdown().

ui_ctx

ui_context_t ui_ctx

extern

Definition at line 59 of file ui_common.c.

Referenced by ui_get_event(), ui_poll_reg_read_fd(), ui_register_read_fd(), and ui_unregister_read_fd().

win_ptr

int win_ptr

extern