Window Support

Manage NCurses windows and color settings. More...

Functions
int	border_title (UiSurface *sfc, char *title)
	Draw a box with a title around the specified window.
int	border_ysplit (UiSurface *sfc, uint y)
	Draw a box with a separator line around the specified window.
int	border_ysplit_text (UiSurface *sfc, char *text, uint separator_line)
	Draw a box with a separator line and text around the specified window.
int	cm_surface_destroy (UiSurface *sfc)
	Destroy the most recently created surface.
void	destroy_curses ()
	Gracefully shut down NCurses and restore terminal settings.
void	view_boxwin_resize (Init *init)
	Resize the current window and its box.
void	view_full_screen_resize (Init *init)
	Resize the full screen view and its components.

Detailed Description

Manage NCurses windows and color settings.

Function Documentation

border_title()

int border_title	(	UiSurface *	sfc,
		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 676 of file dwin.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 = 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);
    ui_render();
    return 0;
}

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

border_ysplit()

int border_ysplit	(	UiSurface *	sfc,
		uint	y )

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

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 617 of file dwin.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 BOX, cell_ho, cell_lt, cell_rt, ui_getmaxx(), and ui_mvwadd_wchnstr().

Referenced by surface_split_box_win_new().

Here is the call graph for this function:

Here is the caller graph for this function:

border_ysplit_text()

int border_ysplit_text	(	UiSurface *	sfc,
		char *	text,
		uint	separator_line )

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

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 637 of file dwin.c.

                                                                        {
    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(text, maxx - 7);
    wchar_t *text_wc;
    text_wc = 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 BOX, cell_ho, cell_lt, cell_nt_hl, cell_rt, cell_sp, mbstr_to_wcstr(), strnz(), ui_bkgdset(), ui_getmaxx(), 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:

cm_surface_destroy()

int cm_surface_destroy

(

UiSurface *

sfc

)

Destroy the most recently created surface.

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 576 of file dwin.c.

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

References sfc_ptr, and ui_surface_destroy().

Referenced by action_disposition(), answer_yn(), display_error(), init_form(), init_pick(), menu_engine(), and Perror().

Here is the call graph for this function:

Here is the caller graph for this function:

destroy_curses()

void destroy_curses

(

)

Gracefully shut down NCurses and restore terminal settings.

destroy_curses

This function should be called before exiting the program to ensure that the terminal is left in a usable state. It checks if NCurses was initialized and, if so, it erases the screen, and ends the NCurses session. It also restores the original terminal settings using restore_shell_tioctl and resets signal handlers to their default state with sig_dfl_mode.

Definition at line 384 of file dwin.c.

                      {
    if (!f_curses_open)
        return;
    ui_shutdown();
    f_curses_open = false;
    restore_shell_tioctl();
    sig_dfl_mode();
    return;
}

References f_curses_open, restore_shell_tioctl(), sig_dfl_mode(), and ui_shutdown().

Referenced by abend(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

view_boxwin_resize()

void view_boxwin_resize

(

Init *

init

)

Resize the current window and its box.

Parameters

init	Pointer to the Init structure containing view settings.

This function resizes the current window and its associated box window to the specified number of lines and columns.

Definition at line 178 of file init_view.c.

                                    {
    View *view = init->view;
    ui_surface_destroy(view->sfc);
    ui_render();
    init_view_boxwin(init);
    border_title(init->view->sfc, init->view->title);
    // initialize_line_table(init->view);
}

References border_title(), init_view_boxwin(), View::sfc, View::title, ui_render(), ui_surface_destroy(), and Init::view.

Referenced by view_cmd_processor().

Here is the call graph for this function:

Here is the caller graph for this function:

view_full_screen_resize()

void view_full_screen_resize

(

Init *

init

)

Resize the full screen view and its components.

Parameters

init	Pointer to the Init structure containing view settings.

This function resizes the full screen view and its components, including the command line window, line number window, and main content pad. It also recalculates the dimensions for the full screen mode and updates the scroll regions accordingly.

Definition at line 97 of file init_view.c.

                                         {
    ui_erase();
    view_calc_full_screen_dimensions(init);
    View *view = init->view;
    ui_surface_destroy(view->sfc);
    ui_render();
    init_view_full_screen(init);
}

References init_view_full_screen(), View::sfc, ui_erase(), ui_render(), ui_surface_destroy(), Init::view, and view_calc_full_screen_dimensions().

Referenced by view_cmd_processor().

Here is the call graph for this function:

Here is the caller graph for this function: