Headder for C-Menu Menu, Form, Pick, and View components. More...

#include "cm.h"
#include <form.h>
#include <menu.h>
#include <pick.h>
#include <view.h>
#include <stddef.h>

Include dependency graph for common.h:

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

Data Structures
struct	Init
	Gathers runtime information for C-Menu Menu, Form, Pick, and View components, used for passing common data and state during initialization and processing of these componentsi. More...

Macros
#define	_GNU_SOURCE
#define	ABOUT ".about"
#define	ACCEPT_PROMPT_CHAR '_'
#define	COLOR_LEN 8
#define	DEFAULTEDITOR "vi"
#define	destroy_cmenu()
#define	EIGHT 8
#define	FORM_HELP_FILE "form.help"
#define	MAPP_DIR "~/menuapp"
#define	MAX_FORMS 10
#define	MAX_MENUS 10
#define	MAX_PICK_OBJS 1024
#define	MAX_PICKS 10
#define	MAX_VIEWS 10
#define	MAX_WIDE_LEN 1024
#define	MAXOPTS 50
#define	MENU_HELP_FILE "menu.help"
#define	MIN_COLS 40
#define	MINITRC ".minitrc"
#define	NCURSES_WIDECHAR 1
#define	new_cmenu()
#define	P_READ 0
#define	P_WRITE 1
#define	PICK_HELP_FILE "pick.help"
#define	PICK_MAX_ARG_LEN 256
#define	PRINTCMD "lp -c -s"
#define	TRUE 1
#define	USE_PAD TRUE
#define	VIEW_HELP_FILE "view.help"
#define	VIEW_PRT_FILE "prtout"

Typedefs
typedef Form	Form
typedef Menu	Menu
typedef Pick	Pick
typedef View	View

Enumerations
enum	Caller { VIEW , FORM , PICK , MENU }
enum	OptGroup { OG_FILES , OG_DIRS , OG_SPECS , OG_MISC , OG_PARMS , OG_FLAGS , OG_COL }
	option groups More...
enum	OptType { OT_STRING , OT_INT , OT_BOOL , OT_HEX }
	option types More...

Functions
void	build_prompt (View *)
	Build Prompt String.
int	cmd_processor (Init *)
void	cmenu_abend (Init init, int ec, char s)
void	cmenu_shutdown (Init *init)
bool	derive_file_spec (char , char , char *)
	Derive full file specification from directory and file name.
Form *	destroy_form (Init *init)
	Destroy Form structure.
Init *	destroy_init (Init *init)
	Destroy Init structure.
void	destroy_line_table (View *)
	Destroy Line Table.
Menu *	destroy_menu (Init *init)
	Destroy Menu structure.
Pick *	destroy_pick (Init *init)
	Destroy Pick structure.
View *	destroy_view (Init *init)
	Destroy View structure.
void	destroy_view_win (Init *)
int	display_prompt (View , char )
	Display Command Line Prompt.
int	init_form (Init , int, char *, uint, uint)
	Initialize form data structure and parse description file.
int	init_pick (Init , int, char *, uint, uint)
	Initializes pick structure and opens pick input file or pipe.
int	init_view_boxwin (Init *)
	Initialize the C-Menu View in box window mode.
int	init_view_full_screen (Init *)
	Initialize C-Menu View in full screen mode.
void	initialize_line_table (View *)
	Initialize Line Table.
void	mapp_initialization (Init , int, char *)
	Main initialization function for MAPP - Menu Application.
unsigned int	menu_engine (Init *)
	The main loop of the menu system.
Form *	new_form (Init , int, char *, uint, uint)
	Create and initialize Form structure.
Init *	new_init (int, char **)
	Create and initialize Init structure.
Menu *	new_menu (Init , int, char *, uint, uint)
	Create and initialize Menu structure.
Pick *	new_pick (Init , int, char *, uint, uint)
	Create and initialize Pick structure.
View *	new_view (Init *)
	Create and initialize View structure.
int	open_pick_win (Init *)
int	pad_refresh (View *)
	Refresh Pad and Line Number Window.
void	page_next (View *)
	Advance to Next Page.
unsigned int	parse_menu_description (Init *)
	Parse menu description file and create Menu.
int	parse_opt_args (Init , int, char *)
	Parse command-line options and set Init struct values accordingly.
int	pick_engine (Init *)
int	popup_ckeys ()
int	popup_form (Init , int, char *, uint, uint)
	instantiate a form popup window
int	popup_menu (Init , int, char *, uint, uint)
	instantiate a menu popup window
int	popup_pick (Init , int, char *, uint, uint)
	instantiate a pick popup window
int	popup_view (Init , int, char *, uint, uint, uint, uint)
	instantiate a view popup window
int	process_config_file (char , Init )
void	view_boxwin_resize (Init *)
	Resize the current window and its box.
void	view_calc_boxwin_dimensions (Init *)
	Calculate the dimensions and position of the box window for C-Menu View.
void	view_calc_full_screen_dimensions (Init *)
	Calculate the dimensions for full screen mode.
int	view_cmd_processor (Init *)
	Main Command Processing Loop for View.
int	view_file (Init *)
	Start view.
void	view_full_screen_resize (Init *)
	Resize the full screen view and its components.
int	view_init_input (Init , char )
	Initialize the input for the C-Menu View.
void	view_stack_free (ViewStack *)
bool	view_stack_init (ViewStack *, size_t)
bool	view_stack_peek (const ViewStack , View )
bool	view_stack_pop (ViewStack , View )
bool	view_stack_push (ViewStack *, View)
int	write_config (Init *)
	Write the current configuration to a file specified in init->minitrc.
void	zero_opt_args (Init *)
	Initialize optional arguments in the Init struct to default values.

Variables
int	init_cnt
char	minitrc [MAXLEN]
ViewStack	view_stack

Detailed Description

Headder for C-Menu Menu, Form, Pick, and View components.

Author: Bill Waller Copyright (c) 2025 MIT License billx.nosp@m.wall.nosp@m.er@gm.nosp@m.ail..nosp@m.com

Date: 2026-02-09

Definition in file common.h.

Macro Definition Documentation

◆ _GNU_SOURCE

#define _GNU_SOURCE

Definition at line 16 of file common.h.

◆ ABOUT

#define ABOUT ".about"

Definition at line 48 of file common.h.

◆ ACCEPT_PROMPT_CHAR

#define ACCEPT_PROMPT_CHAR '_'

Definition at line 33 of file common.h.

◆ COLOR_LEN

#define COLOR_LEN 8

Definition at line 30 of file common.h.

◆ DEFAULTEDITOR

#define DEFAULTEDITOR "vi"

Definition at line 40 of file common.h.

◆ destroy_cmenu

#define destroy_cmenu ( )

Value:

destroy_init(init); \
win_del();          \
curs_set(1);        \
destroy_curses();   \
return 0;           \
}

Definition at line 70 of file common.h.

#define destroy_cmenu() \
    destroy_init(init); \
    win_del();          \
    curs_set(1);        \
    destroy_curses();   \
    return 0;           \
    }

◆ EIGHT

#define EIGHT 8

Definition at line 52 of file common.h.

◆ FORM_HELP_FILE

#define FORM_HELP_FILE "form.help"

Definition at line 36 of file common.h.

◆ MAPP_DIR

#define MAPP_DIR "~/menuapp"

Definition at line 49 of file common.h.

◆ MAX_FORMS

#define MAX_FORMS 10

Definition at line 43 of file common.h.

◆ MAX_MENUS

#define MAX_MENUS 10

Definition at line 44 of file common.h.

◆ MAX_PICK_OBJS

#define MAX_PICK_OBJS 1024

Definition at line 32 of file common.h.

◆ MAX_PICKS

#define MAX_PICKS 10

Definition at line 45 of file common.h.

◆ MAX_VIEWS

#define MAX_VIEWS 10

Definition at line 42 of file common.h.

◆ MAX_WIDE_LEN

#define MAX_WIDE_LEN 1024

Definition at line 29 of file common.h.

◆ MAXOPTS

#define MAXOPTS 50

Definition at line 51 of file common.h.

◆ MENU_HELP_FILE

#define MENU_HELP_FILE "menu.help"

Definition at line 35 of file common.h.

◆ MIN_COLS

#define MIN_COLS 40

Definition at line 27 of file common.h.

◆ MINITRC

#define MINITRC ".minitrc"

Definition at line 47 of file common.h.

◆ NCURSES_WIDECHAR

#define NCURSES_WIDECHAR 1

Definition at line 18 of file common.h.

◆ new_cmenu

#define new_cmenu ( )

Value:

__end_pgm;                             \
int main(int argc, char **argv) {      \
    __atexit;                          \
    capture_shell_tioctl();            \
    Init *init = new_init(argc, argv); \
    SIO *sio = init->sio;              \
    mapp_initialization(init);         \
    ui_init(sio);                      \
    sig_prog_mode();                   \
    capture_curses_tioctl();           \
    win_init_attrs();

Definition at line 57 of file common.h.

#define new_cmenu()                        \
    __end_pgm;                             \
    int main(int argc, char **argv) {      \
        __atexit;                          \
        capture_shell_tioctl();            \
        Init *init = new_init(argc, argv); \
        SIO *sio = init->sio;              \
        mapp_initialization(init);         \
        ui_init(sio);                      \
        sig_prog_mode();                   \
        capture_curses_tioctl();           \
        win_init_attrs();

◆ P_READ

#define P_READ 0

Definition at line 53 of file common.h.

◆ P_WRITE

#define P_WRITE 1

Definition at line 54 of file common.h.

◆ PICK_HELP_FILE

#define PICK_HELP_FILE "pick.help"

Definition at line 37 of file common.h.

◆ PICK_MAX_ARG_LEN

#define PICK_MAX_ARG_LEN 256

Definition at line 31 of file common.h.

◆ PRINTCMD

#define PRINTCMD "lp -c -s"

Definition at line 50 of file common.h.

◆ TRUE

#define TRUE 1

Definition at line 55 of file common.h.

◆ USE_PAD

#define USE_PAD TRUE

Definition at line 26 of file common.h.

◆ VIEW_HELP_FILE

#define VIEW_HELP_FILE "view.help"

Definition at line 38 of file common.h.

◆ VIEW_PRT_FILE

#define VIEW_PRT_FILE "prtout"

Definition at line 39 of file common.h.

Typedef Documentation

◆ Form

typedef Form Form

Definition at line 105 of file common.h.

◆ Menu

typedef Menu Menu

Definition at line 104 of file common.h.

◆ Pick

typedef Pick Pick

Definition at line 106 of file common.h.

◆ View

typedef View View

Definition at line 107 of file common.h.

Enumeration Type Documentation

◆ Caller

enum Caller

Enumerator
VIEW
FORM
PICK
MENU

Definition at line 78 of file common.h.

             {
    VIEW,
    FORM,
    PICK,
    MENU
} Caller;

◆ OptGroup

enum OptGroup

option groups

Enumerator
OG_FILES
OG_DIRS
OG_SPECS
OG_MISC
OG_PARMS
OG_FLAGS
OG_COL

Definition at line 94 of file common.h.

             {
    OG_FILES,
    OG_DIRS,
    OG_SPECS,
    OG_MISC,
    OG_PARMS,
    OG_FLAGS,
    OG_COL
} OptGroup;

◆ OptType

enum OptType

option types

Enumerator
OT_STRING
OT_INT
OT_BOOL
OT_HEX

Definition at line 86 of file common.h.

             {
    OT_STRING,
    OT_INT,
    OT_BOOL,
    OT_HEX,
} OptType;

Function Documentation

◆ cmd_processor()

int cmd_processor ( Init * )

extern

◆ cmenu_abend()

void cmenu_abend	(	Init *	init,
		int	ec,
		char *	s )

Definition at line 94 of file menu.c.

                                              {
    cmenu_shutdown(init);
    restore_shell_tioctl();
    sig_dfl_mode();
    fprintf(stderr, _("\n\nABEND: %s (code: %d)\n"), s, ec);
    exit(EXIT_FAILURE);
}

References cmenu_shutdown(), restore_shell_tioctl(), and sig_dfl_mode().

Referenced by view_init_input().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmenu_shutdown()

void cmenu_shutdown ( Init * init )

Definition at line 88 of file menu.c.

                                {
    destroy_view(init);
    ui_shutdown();
    destroy_init(init);
}

References destroy_init(), destroy_view(), and ui_shutdown().

Referenced by cmenu_abend().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ destroy_view_win()

void destroy_view_win ( Init * )

extern

◆ open_pick_win()

int open_pick_win ( Init * init )

extern

Definition at line 247 of file pick_engine.c.

                              {
    uint maxy, maxx;
    uint whitespace_ratio = 15;
    uint usable_lines;
    uint pick_ratio = 50;
    uint tbl_max_cols, pg_max_objs;
 
    Pick *pick = init->pick;
    ui_get_screen_size(&maxy, &maxx);
    // Screen Geometry
    // Calculate pick window size and position based on terminal size and pick
    // parameters
    //
    // Calculate line usage:
    if (pick->begy == 0)
        pick->begy = (maxy * whitespace_ratio) / 200;
    usable_lines = maxy - (maxy * whitespace_ratio) / 100;
    usable_lines -= pick->begy;
    usable_lines -= 5; // Pick overhead lines
    if (pick->p_view_files) {
        if (pick->lines == 0) {
            pick->lines = usable_lines * pick_ratio / 100;
            usable_lines -= pick->lines;
        }
        init->begy = pick->begy + 5 + pick->lines;
        init->begx = 0;
        usable_lines -= 3; // View overhead lines
        init->lines = usable_lines;
        init->cols = maxx - 2;
    } else if (pick->lines == 0)
        pick->lines = usable_lines;
 
    pick->tbl_col_width = max(pick->tbl_col_width, 4);
    pick->tbl_col_width = min(pick->tbl_col_width, (maxx - (2 + pick->begx)));
    pick->m_idx = 0; // master index
    pick->d_idx = 0; // display index
    while (pick->m_idx < pick->m_cnt)
        pick->d_object[pick->d_idx++] = pick->m_object[pick->m_idx++];
    pick->d_cnt = pick->d_idx;
    if (pick->d_cnt <= pick->lines) {
        pick->tbl_lines = pick->d_cnt;
        pick->lines = pick->d_cnt;
        pick->tbl_cols = 1;
    } else {
        tbl_max_cols = ((maxx - (2 + pick->begx)) / (pick->tbl_col_width + 1));
        pg_max_objs = pick->lines * tbl_max_cols;
        if (pick->d_cnt > pg_max_objs)
            pick->tbl_cols = tbl_max_cols;
        else
            pick->tbl_cols = pick->d_cnt / pick->lines;
        pick->tbl_lines = pick->d_cnt / tbl_max_cols;
    }
    pick->tbl_pages = (pick->tbl_lines / (pick->lines - 1)) + 1;
    // pick->lines = (pick->tbl_lines + pick->tbl_pages - 1) / pick->tbl_pages;
    pick->tbl_page = 0;
    // if (pick->begy == 0)
    //     pick->begy = (LINES - pick->lines) / 5;
    // else if (pick->begy + pick->lines > LINES - 4)
    //     pick->begy = LINES - pick->lines - 2;
    pick->width = (pick->tbl_col_width + 1) * pick->tbl_cols;
 
    pick->width = max(pick->width, 60);
    char tmp_str[MAXLEN];
 
    int ui_split_win_lines = 2;
    if (ui_tracked_sfc_split_box(pick->lines, pick->width, ui_split_win_lines, 0, pick->begy, pick->begx, pick->title)) {
        ssnprintf(tmp_str, MAXLEN - 1, "ui_tracked_sfc_split_box(%d, %d, %d, %d, %d, %d, %s) failed",
                  pick->lines, pick->width, ui_split_win_lines, 0, pick->begy, pick->begx, pick->title);
        ui_perror(tmp_str);
        return (1);
    }
    pick->surface = ui_surface[sfc_ptr];
    UiSurface *sfc = pick->surface;
    ui_setscrreg(sfc, WIN, 0, pick->lines - 1);
    ui_scrollok(sfc, WIN, true);
    ui_keypad(sfc, WIN, true);
    pick->separator_line = pick->lines + 1;
 
    pick->x = 1;
 
    pick->chyron = ui_new_chyron(pick->surface, WIN2);
    ui_set_chyron_key(pick->chyron, 1, _("F1 Help"), UIKEY_F01);
    ui_set_chyron_key(pick->chyron, 2, _("F9 Cancel"),
                      UIKEY_F09);
    ui_set_chyron_key(pick->chyron, 3, _("F10 Accept"),
                      UIKEY_F10);
    ui_set_chyron_key(pick->chyron, 4, _("F11 View"),
                      UIKEY_F11);
    ui_set_chyron_key(pick->chyron, 5, _("<q> Quit View"),
                      'q');
    ui_set_chyron_key(pick->chyron, 6, _("<Sp> Process"), ' ');
    ui_set_chyron_key(pick->chyron, 7, _("<Sp> Edit"), ' ');
    ui_set_chyron_key(pick->chyron, 9, _("<Tab> Search"),
                      '\t');
    ui_set_chyron_key(pick->chyron, 10, _("<Tab> Select"),
                      '\t');
    ui_set_chyron_key(pick->chyron, 11, "PgUp",
                      UIKEY_PPAGE);
    ui_set_chyron_key(pick->chyron, 12, "PgDn",
                      UIKEY_NPAGE);
    ui_set_chyron_key(pick->chyron, 13, "INS", UIKEY_IC);
    pick_std_chyron(pick);
    ui_compile_chyron(pick->chyron);
    return 0;
}

References Init::begx, Pick::begx, Init::begy, Pick::begy, Pick::chyron, Init::cols, Pick::d_cnt, Pick::d_idx, Pick::d_object, Init::lines, Pick::lines, Pick::m_cnt, Pick::m_idx, Pick::m_object, Pick::p_view_files, Init::pick, pick_std_chyron(), Pick::separator_line, sfc_ptr, ssnprintf(), Pick::surface, Pick::tbl_col_width, Pick::tbl_cols, Pick::tbl_lines, Pick::tbl_page, Pick::tbl_pages, Pick::title, ui_compile_chyron(), ui_get_screen_size(), ui_keypad(), ui_new_chyron(), ui_perror(), ui_scrollok(), ui_set_chyron_key(), ui_setscrreg(), ui_surface, ui_tracked_sfc_split_box(), Pick::width, and Pick::x.

Referenced by init_pick().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pick_engine()

int pick_engine ( Init * init )

extern

Enter picker loop to handle user input and interactions

< Buffer for user input in the field

Definition at line 353 of file pick_engine.c.

                            {
    int rc = 0;
    bool f_processed = false;
    Pick *pick = init->pick;
    char field[MAXLEN]; 
    field[0] = '\0';
    display_pick_page(pick);
    do {
        rc = picker(init, field);
        if (rc == UIKEY_F09)
            break;
        if (rc == -1)
            break;
        else {
            if (pick->select_cnt > 0) {
                if (pick->f_out_spec && pick->out_spec[0]) {
                    output_objects(pick);
                    f_processed = true;
                }
                if (pick->f_cmd && pick->cmd[0]) {
                    exec_objects(init);
                    f_processed = true;
                }
                if (pick->f_read_theme) {
                    read_theme(init);
                    f_processed = true;
                }
                if (f_processed) {
                    ui_mvwaddstr(pick->surface, WIN2, 0, 0, _("Selection Processed"));
                    ui_wclrtoeol(pick->surface, WIN2);
                }
            }
        }
        deselect_object(pick);
    } while (1);
    ui_destroy_chyron(pick->chyron);
    return (rc);
}

References Pick::chyron, Pick::cmd, deselect_object(), display_pick_page(), exec_objects(), Pick::f_cmd, Pick::f_out_spec, Pick::f_read_theme, Pick::out_spec, output_objects(), Init::pick, picker(), read_theme(), Pick::select_cnt, Pick::surface, ui_destroy_chyron(), ui_mvwaddstr(), and ui_wclrtoeol().

Referenced by init_pick().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ popup_ckeys()

int popup_ckeys ( )

extern

Definition at line 31 of file curskeys.c.

                  {
 
    char Title[] = _("TEST CURSES KEYS");
    unsigned lines = 10;
    unsigned cols = 55;
    char tmp[MAXLEN];
    uint maxy, maxx;
    ui_get_screen_size(&maxy, &maxx);
    uint begy = (maxy - lines) / 3;
    uint begx = (maxx - cols) / 2;
    if (ui_tracked_sfc_box(lines, cols, begy, begx, Title)) {
        strnz__cpy(tmp, _("ui_tracked_sfc_box failed: "), MAXLEN - 1);
        strnz__cat(tmp, Title, MAXLEN - 1);
        ui_perror(tmp);
        exit(EXIT_FAILURE);
    }
    UiSurface *sfc = ui_surface[sfc_ptr];
    ui_keypad(sfc, WIN, true);
    ui_bkgdset(sfc, WIN, &cell_nt_rev);
    ui_mvwaddstr(sfc, WIN, lines - 1, 0, _(" <ALT>END to exit "));
    ui_bkgdset(sfc, WIN, &cell_nt);
    ui_mvwaddstr(sfc, WIN, 1, 4, _("Press a key or activate the mouse:"));
#ifdef UAL_UI
    ncurses_input(sfc, WIN);
#else
    notcurses_input(sfc, WIN);
#endif
    return 0;
}

References cell_nt, cell_nt_rev, sfc_ptr, strnz__cat(), strnz__cpy(), ui_bkgdset(), ui_get_screen_size(), ui_keypad(), ui_mvwaddstr(), ui_perror(), ui_surface, and ui_tracked_sfc_box().

Referenced by main(), and menu_cmd_processor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ popup_form()

int popup_form	(	Init *	init,
		int	argc,
		char **	argv,
		uint	by,
		uint	bx )

extern

instantiate a form popup window

Parameters

init	the Init struct pointer
argc	the number of command line arguments
argv	the command line arguments
by	the y coordinate for the form window
bx	the x coordinate for the form window

by and bx may be set as command line option arguments, in which case, they will take precedence over arguments passed in the function arguments.

 by, and bx may be set by
    1. the calling function
       or
    2. command line arguments
 Non-zero command line arguments will override the calling function's
arguments.

Definition at line 113 of file popups.c.

                                                                    {
    int rc;
    zero_opt_args(init);
    parse_opt_args(init, argc, argv);
    Form *sav_form = init->form;
    init->form = nullptr;
    rc = init_form(init, init->argc, init->argv, by, bx);
    destroy_form(init);
    init->form = sav_form;
    return rc;
}

References Init::argc, Init::argv, destroy_form(), Init::form, init_form(), parse_opt_args(), and zero_opt_args().

Referenced by enter_file_spec(), and menu_cmd_processor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ popup_menu()

int popup_menu	(	Init *	init,
		int	argc,
		char **	argv,
		uint	by,
		uint	bx )

extern

instantiate a menu popup window

Parameters

init	the Init struct pointer
argc	the number of command line arguments
argv	the command line arguments
by	the y coordinate for the menu window
bx	the x coordinate for the menu window

by and bx may be set as command line option arguments, in which case, they will take precedence over arguments passed in the function arguments.

 by, and bx may be set by
    1. the calling function
       or
    2. command line arguments
 Non-zero command line arguments will override the calling function's
arguments.

Definition at line 53 of file popups.c.

                                                                    {
    int rc;
    zero_opt_args(init);
    parse_opt_args(init, argc, argv);
    Menu *sav_menu = init->menu;
    init->menu = nullptr;
    init->menu = new_menu(init, init->argc, init->argv, by, bx);
    rc = menu_engine(init);
    destroy_menu(init);
    init->menu = sav_menu;
    return rc;
}

References Init::argc, Init::argv, destroy_menu(), Init::menu, menu_engine(), new_menu(), parse_opt_args(), and zero_opt_args().

Referenced by menu_cmd_processor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ popup_pick()

int popup_pick	(	Init *	init,
		int	argc,
		char **	argv,
		uint	by,
		uint	bx )

extern

instantiate a pick popup window

Parameters

init	the Init struct pointer
argc	the number of command line arguments
argv	the command line arguments
by	the y coordinate for the pick window
bx	the x coordinate for the pick window

by and bx may be set as command line option arguments, in which case, they will take precedence over arguments passed in the function arguments.

 by, and bx may be set by
    1. the calling function
       or
    2. command line arguments
 Non-zero command line arguments will override the calling function's
arguments.

Definition at line 83 of file popups.c.

                                                                    {
    int rc;
    zero_opt_args(init);
    parse_opt_args(init, argc, argv);
    Pick *sav_pick = init->pick;
    init->pick = nullptr;
 
    rc = init_pick(init, init->argc, init->argv, by, bx);
    destroy_pick(init);
    init->pick = sav_pick;
    return rc;
}

References Init::argc, Init::argv, destroy_pick(), init_pick(), parse_opt_args(), Init::pick, and zero_opt_args().

Referenced by menu_cmd_processor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ popup_view()

int popup_view	(	Init *	init,
		int	argc,
		char **	argv,
		uint	ilines,
		uint	icols,
		uint	by,
		uint	bx )

extern

instantiate a view popup window

Parameters

init	the Init struct pointer
argc	the number of command line arguments
argv	the command line arguments
ilines	the number of lines for the view window
icols	the number of columns for the view window
by	the y coordinate for the view window
bx	the x coordinate for the view window

ilines, cols, by, and bx may also be set as command line option arguments, in which case, they will take precedence over arguments passed in the function arguments.

 ilines, cols, by, and bx may be set by
    1. the calling function
       or
    2. command line arguments
 Non-zero command line arguments will override the calling function's
arguments.

Definition at line 145 of file popups.c.

                        {
    int rc = 0;
    zero_opt_args(init);
    parse_opt_args(init, argc, argv);
    // view_stack_push(&view_stack, *init->view);
    View *view_sav = init->view;
    init->view = nullptr;
    View *view = nullptr;
    view = nullptr;
    view = new_view(init);
 
    if (init->lines > 0 && init->cols > 0) {
        ilines = init->lines;
        icols = init->cols;
    }
    if (init->begy > 0 || init->begx > 0) {
        by = init->begy;
        bx = init->begx;
    }
    view->begy = by;
    view->begx = bx;
    view->lines = ilines;
    view->cols = icols;
    view->f_full_screen = false;
    if (!init_view_boxwin(init))
        rc = view_file(init);
    destroy_view(init);
    init->view = view_sav;
    // view_stack_pop(&view_stack, init->view);
    return rc;
}

References Init::begx, View::begx, Init::begy, View::begy, Init::cols, View::cols, destroy_view(), View::f_full_screen, init_view_boxwin(), Init::lines, View::lines, new_view(), parse_opt_args(), Init::view, view_file(), and zero_opt_args().

Referenced by display_pick_help(), exec_objects(), form_engine(), form_exec_receiver(), menu_cmd_processor(), and view_display_help().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ process_config_file()

int process_config_file	(	char *	,
		Init *	)

extern

Definition at line 694 of file init.c.

                                                            {
    char include_file_name[MAXLEN];
    char tmp_str[MAXLEN];
    char *src_p, *dp;
    SIO *sio = init->sio;
    char hex_clr_str[8];
    char key[MAXLEN];
    char value[MAXLEN];
    FILE *config_fp = fopen(config_file_name, "r");
    char quote_char = '\0';
    if (!config_fp) {
        fprintf(stderr, "failed to read file: %s %s\n", config_file_name, strerror(errno));
        return (-1);
    }
    while (fgets(tmp_str, sizeof(tmp_str), config_fp)) {
        bool inquotes = false;
        if (tmp_str[0] == '#')
            continue;
        src_p = tmp_str;
        key[0] = '\0';
        dp = key;
        // copy delimited by "=" into value
        while (*src_p != '\0') {
            if (*src_p == '\n')
                *dp = *src_p = '\0';
            if (*src_p == '=') {
                *dp = '\0';
                src_p++;
                break;
            }
            if (*src_p == '"' && *src_p == ' ') {
                src_p++;
                continue;
            }
            *dp++ = *src_p++;
        }
        value[0] = '\0';
        dp = value;
        // copy delimited by newline or unquoted "#" into value, removing quotes, spaces, semicolons, and newlines, but respecting quotes
        while (*src_p != '\0') {
            if ((*src_p == '"' || *src_p == '\'') && (*(src_p + 1) != '\\')) {
                if (!inquotes) {
                    inquotes = true;
                    quote_char = *src_p++;
                } else if (*src_p == quote_char) {
                    inquotes = false;
                    quote_char = '\0';
                }
            }
            if (!inquotes) {
                if (*src_p == '#') {
                    if (unstr_hex_clr(hex_clr_str, src_p)) {
                        strnz__cpy(value, hex_clr_str, MAXLEN - 1);
                        dp = value + strlen(value);
                    }
                    break;
                }
            }
            if (*src_p == ' ' || *src_p == ';') {
                src_p++;
                continue;
            }
            if (*src_p == '\n') {
                *src_p = '\0';
                break;
            }
            *dp++ = *src_p++;
        }
        *dp = '\0';
        if (key[0] == '\0')
            continue;
        if (value[0] == '\0')
            continue;
        if (!strcmp(key, "include")) {
            strnz__cpy(include_file_name, value, MAXLEN - 1);
            expand_tilde(include_file_name, MAXLEN - 1);
            process_config_file(include_file_name, init);
            continue;
        }
        if (!strcmp(key, "minitrc")) {
            strnz__cpy(init->minitrc, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "lines")) {
            init->lines = atoi(value);
            continue;
        }
        if (!strcmp(key, "cols")) {
            init->cols = atoi(value);
            continue;
        }
        if (!strcmp(key, "begy")) {
            init->begy = atoi(value);
            continue;
        }
        if (!strcmp(key, "begx")) {
            init->begx = atoi(value);
            continue;
        }
        if (!strcmp(key, "f_ln")) {
            init->f_ln = str_to_bool(value);
            continue;
        }
        if (!strcmp(key, "f_at_end_remove")) {
            init->f_at_end_remove = str_to_bool(value);
            continue;
        }
        if (!strcmp(key, "f_erase_remainder")) {
            init->f_erase_remainder = str_to_bool(value);
            continue;
        }
        if (!strcmp(key, "brackets")) {
            strnz__cpy(init->brackets, value, 2);
            continue;
        }
        if (!strcmp(key, "fill_char")) {
            if (strlen(value) > 1)
                value[1] = '\0';
            if (wcwidth((int)value[0]) > 1)
                value[0] = '?';
            strnz__cpy(init->fill_char, value, 4);
            continue;
        }
        if (!strcmp(key, "f_ignore_case")) {
            init->f_ignore_case = str_to_bool(value);
            continue;
        }
        if (!strcmp(key, "p_view_files")) {
            init->p_view_files = str_to_bool(value);
            continue;
        }
        if (!strcmp(key, "f_read_theme")) {
            init->f_read_theme = str_to_bool(value);
            continue;
        }
        if (!strcmp(key, "f_squeeze")) {
            init->f_squeeze = str_to_bool(value);
            continue;
        }
        if (!strcmp(key, "f_strip_ansi")) {
            init->f_strip_ansi = str_to_bool(value);
            continue;
        }
        if (!strcmp(key, "f_multiple_cmd_args")) {
            init->f_multiple_cmd_args = str_to_bool(value);
            continue;
        }
        if (!strcmp(key, "select_max")) {
            init->select_max = atoi(value);
            continue;
        }
        if (!strcmp(key, "tab_stop")) {
            init->tab_stop = atoi(value);
            continue;
        }
        if (!strcmp(key, "timeout_secs")) {
            init->timeout_secs = atoi(value);
            continue;
        }
        if (!strcmp(key, "h_shift")) {
            init->h_shift = atoi(value);
            continue;
        }
        if (!strcmp(key, "wrap")) {
            init->wrap = str_to_bool(value);
            continue;
        }
        if (!strcmp(key, "title")) {
            strnz__cpy(init->title, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "cmd")) {
            strnz__cpy(init->cmd, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "cmd_all")) {
            strnz__cpy(init->cmd_all, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "parent_cmd")) {
            strnz__cpy(init->parent_cmd, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "provider_cmd")) {
            strnz__cpy(init->provider_cmd, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "receiver_cmd")) {
            strnz__cpy(init->receiver_cmd, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "editor")) {
            strnz__cpy(init->editor, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "border")) {
            char c = value[0];
            if (c == 'r' || c == 'R')
                sio->border = 'r';
            else if (c == 's' || c == 'S')
                sio->border = 's';
            else if (c == 'd' || c == 'D')
                sio->border = 'd';
            else if (c == 'h' || c == 'H')
                sio->border = 'h';
            else
                sio->border = 'n';
            continue;
        }
        if (!strcmp(key, "fg")) {
            sscanf(value, "#%06x", &sio->fg);
            continue;
        }
        if (!strcmp(key, "bg")) {
            sscanf(value, "#%06x", &sio->bg);
            continue;
        }
        if (!strcmp(key, "box_fg")) {
            sscanf(value, "#%06x", &sio->fg);
            continue;
        }
        if (!strcmp(key, "box_bg")) {
            sscanf(value, "#%06x", &sio->box_bg);
            continue;
        }
        if (!strcmp(key, "ind_fg")) {
            sscanf(value, "#%06x", &sio->ind_fg);
            continue;
        }
        if (!strcmp(key, "ind_bg")) {
            sscanf(value, "#%06x", &sio->ind_bg);
            continue;
        }
        if (!strcmp(key, "brackets_fg")) {
            sscanf(value, "#%06x", &sio->brackets_fg);
            continue;
        }
        if (!strcmp(key, "brackets_bg")) {
            sscanf(value, "#%06x", &sio->brackets_bg);
            continue;
        }
        if (!strcmp(key, "fill_char_fg")) {
            sscanf(value, "#%06x", &sio->fill_char_fg);
            continue;
        }
        if (!strcmp(key, "fill_char_bg")) {
            sscanf(value, "#%06x", &sio->fill_char_bg);
            continue;
        }
        if (!strcmp(key, "ln_fg")) {
            sscanf(value, "#%06x", &sio->ln_fg);
            continue;
        }
        if (!strcmp(key, "ln_bg")) {
            sscanf(value, "#%06x", &sio->ln_bg);
            continue;
        }
        if (!strcmp(key, "cmdln_fg")) {
            sscanf(value, "#%06x", &sio->cmdln_fg);
            continue;
        }
        if (!strcmp(key, "cmdln_bg")) {
            sscanf(value, "#%06x", &sio->cmdln_bg);
            continue;
        }
        if (!strcmp(key, "nt_fg")) {
            sscanf(value, "#%06x", &sio->nt_fg);
            continue;
        }
        if (!strcmp(key, "nt_bg")) {
            sscanf(value, "#%06x", &sio->nt_bg);
            continue;
        }
        if (!strcmp(key, "nt_rev_fg")) {
            sscanf(value, "#%06x", &sio->nt_rev_fg);
            continue;
        }
        if (!strcmp(key, "nt_rev_bg")) {
            sscanf(value, "#%06x", &sio->nt_rev_bg);
            continue;
        }
        if (!strcmp(key, "nt_hl_fg")) {
            sscanf(value, "#%06x", &sio->nt_hl_fg);
            continue;
        }
        if (!strcmp(key, "nt_hl_bg")) {
            sscanf(value, "#%06x", &sio->nt_hl_bg);
            continue;
        }
        if (!strcmp(key, "nt_hl_rev_fg")) {
            sscanf(value, "#%06x", &sio->nt_hl_rev_fg);
            continue;
        }
        if (!strcmp(key, "nt_hl_rev_bg")) {
            sscanf(value, "#%06x", &sio->nt_hl_rev_bg);
            continue;
        }
        if (!strcmp(key, "title_fg")) {
            sscanf(value, "#%06x", &sio->title_fg);
            continue;
        }
        if (!strcmp(key, "title_bg")) {
            sscanf(value, "#%06x", &sio->title_bg);
            continue;
        }
        if (!strcmp(key, "ran_fg")) {
            sscanf(value, "#%06x", &sio->ran_fg);
            continue;
        }
        if (!strcmp(key, "ran_bg")) {
            sscanf(value, "#%06x", &sio->ran_bg);
            continue;
        }
        if (!strcmp(key, "red_gamma")) {
            sio->red_gamma = str_to_double(value);
            continue;
        }
        if (!strcmp(key, "green_gamma")) {
            sio->green_gamma = str_to_double(value);
            continue;
        }
        if (!strcmp(key, "blue_gamma")) {
            sio->blue_gamma = str_to_double(value);
            continue;
        }
        if (!strcmp(key, "gray_gamma")) {
            sio->gray_gamma = str_to_double(value);
            continue;
        }
        if (!strcmp(key, "black")) {
            sscanf(value, "#%06x", &sio->black);
            continue;
        }
        if (!strcmp(key, "red")) {
            sscanf(value, "#%06x", &sio->red);
            continue;
        }
        if (!strcmp(key, "green")) {
            sscanf(value, "#%06x", &sio->green);
            continue;
        }
        if (!strcmp(key, "yellow")) {
            sscanf(value, "#%06x", &sio->yellow);
            continue;
        }
        if (!strcmp(key, "blue")) {
            sscanf(value, "#%06x", &sio->blue);
            continue;
        }
        if (!strcmp(key, "magenta")) {
            sscanf(value, "#%06x", &sio->magenta);
            continue;
        }
        if (!strcmp(key, "cyan")) {
            sscanf(value, "#%06x", &sio->cyan);
            continue;
        }
        if (!strcmp(key, "white")) {
            sscanf(value, "#%06x", &sio->white);
            continue;
        }
        if (!strcmp(key, "orange")) {
            sscanf(value, "#%06x", &sio->orange);
            continue;
        }
        if (!strcmp(key, "bblack")) {
            sscanf(value, "#%06x", &sio->bblack);
            continue;
        }
        if (!strcmp(key, "bred")) {
            sscanf(value, "#%06x", &sio->bred);
            continue;
        }
        if (!strcmp(key, "bgreen")) {
            sscanf(value, "#%06x", &sio->bgreen);
            continue;
        }
        if (!strcmp(key, "byellow")) {
            sscanf(value, "#%06x", &sio->byellow);
            continue;
        }
        if (!strcmp(key, "bblue")) {
            sscanf(value, "#%06x", &sio->bblue);
            continue;
        }
        if (!strcmp(key, "bmagenta")) {
            sscanf(value, "#%06x", &sio->bmagenta);
            continue;
        }
        if (!strcmp(key, "bcyan")) {
            sscanf(value, "#%06x", &sio->bcyan);
            continue;
        }
        if (!strcmp(key, "bwhite")) {
            sscanf(value, "#%06x", &sio->bwhite);
            continue;
        }
        if (!strcmp(key, "borange")) {
            sscanf(value, "#%06x", &sio->borange);
            continue;
        }
        if (!strcmp(key, "mapp_spec")) {
            strnz__cpy(init->mapp_spec, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "mapp_data")) {
            strnz__cpy(init->mapp_data, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "mapp_help")) {
            strnz__cpy(init->mapp_help, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "mapp_home")) {
            strnz__cpy(init->mapp_home, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "mapp_msrc")) {
            strnz__cpy(init->mapp_msrc, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "mapp_user")) {
            strnz__cpy(init->mapp_user, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "mapp_theme")) {
            strnz__cpy(init->mapp_theme, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "log_file_spec")) {
            strnz__cpy(init->log_file_spec, value, MAXLEN - 1);
            continue;
        }
        if (!strcmp(key, "log_level")) {
            str_to_upper(value);
            if (!strcmp(value, "SILENT"))
                init->min_log_level = SILENT;
            else if (!strcmp(value, "DEBUG"))
                init->min_log_level = DEBUG;
            else if (!strcmp(value, "INFO"))
                init->min_log_level = INFO;
            else if (!strcmp(value, "WARN"))
                init->min_log_level = WARN;
            else if (!strcmp(value, "ERROR"))
                init->min_log_level = ERROR;
            else if (!strcmp(value, "FATAL"))
                init->min_log_level = FATAL;
            else
                init->min_log_level = SILENT;
            continue;
        }
    }
    (void)fclose(config_fp);
    return 0;
}

References SIO::bblack, SIO::bblue, SIO::bcyan, Init::begx, Init::begy, SIO::bg, SIO::bgreen, SIO::black, SIO::blue, SIO::blue_gamma, SIO::bmagenta, SIO::borange, SIO::border, SIO::box_bg, Init::brackets, SIO::brackets_bg, SIO::brackets_fg, SIO::bred, SIO::bwhite, SIO::byellow, Init::cmd, Init::cmd_all, SIO::cmdln_bg, SIO::cmdln_fg, Init::cols, SIO::cyan, Init::editor, expand_tilde(), Init::f_at_end_remove, Init::f_erase_remainder, Init::f_ignore_case, Init::f_ln, Init::f_multiple_cmd_args, Init::f_read_theme, Init::f_squeeze, Init::f_strip_ansi, SIO::fg, Init::fill_char, SIO::fill_char_bg, SIO::fill_char_fg, SIO::gray_gamma, SIO::green, SIO::green_gamma, Init::h_shift, SIO::ind_bg, SIO::ind_fg, Init::lines, SIO::ln_bg, SIO::ln_fg, Init::log_file_spec, SIO::magenta, Init::mapp_data, Init::mapp_help, Init::mapp_home, Init::mapp_msrc, Init::mapp_spec, Init::mapp_theme, Init::mapp_user, Init::min_log_level, Init::minitrc, 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::orange, Init::p_view_files, Init::parent_cmd, process_config_file(), Init::provider_cmd, SIO::ran_bg, SIO::ran_fg, Init::receiver_cmd, SIO::red, SIO::red_gamma, Init::select_max, Init::sio, str_to_bool(), str_to_double(), str_to_upper(), strnz__cpy(), Init::tab_stop, Init::timeout_secs, Init::title, SIO::title_bg, SIO::title_fg, unstr_hex_clr(), SIO::white, Init::wrap, and SIO::yellow.

Referenced by process_config_file(), process_config_files(), and read_theme().

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 )

extern

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 198 of file init_view.c.

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

References init_view_boxwin(), View::sfc, View::title, ui_border_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 )

extern

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 111 of file init_view.c.

                                         {
    ui_erase();
    view_calc_full_screen_dimensions(init);
    ui_log(INFO, _("view_full_screen_resize: lines=%d, cols=%d, ln_win_lines=%d, ln_win_cols=%d, scroll_lines=%d"), init->view->lines, init->view->cols, init->view->ln_win_lines, init->view->ln_win_cols, init->view->scroll_lines);
    View *view = init->view;
    ui_surface_destroy(view->sfc);
    ui_render();
    init_view_full_screen(init);
}

References View::cols, init_view_full_screen(), View::lines, View::ln_win_cols, View::ln_win_lines, View::scroll_lines, 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:

◆ view_stack_free()

void view_stack_free ( ViewStack * )

extern

◆ view_stack_init()

bool view_stack_init	(	ViewStack *	,
		size_t	)

extern

◆ view_stack_peek()

bool view_stack_peek	(	const ViewStack *	,
		View *	)

extern

◆ view_stack_pop()

bool view_stack_pop	(	ViewStack *	,
		View *	)

extern

◆ view_stack_push()

bool view_stack_push	(	ViewStack *	,
		View	)

extern

Variable Documentation

◆ init_cnt

int init_cnt

extern

Definition at line 28 of file mem.c.

Referenced by destroy_init(), and new_init().

◆ minitrc

char minitrc[MAXLEN]

extern

number of Init data structures allocated

◆ view_stack

ViewStack view_stack

extern

Definition at line 32 of file init_view.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ _GNU_SOURCE

◆ ABOUT

◆ ACCEPT_PROMPT_CHAR

◆ COLOR_LEN

◆ DEFAULTEDITOR

◆ destroy_cmenu

◆ EIGHT

◆ FORM_HELP_FILE

◆ MAPP_DIR

◆ MAX_FORMS

◆ MAX_MENUS

◆ MAX_PICK_OBJS

◆ MAX_PICKS

◆ MAX_VIEWS

◆ MAX_WIDE_LEN

◆ MAXOPTS

◆ MENU_HELP_FILE

◆ MIN_COLS

◆ MINITRC

◆ NCURSES_WIDECHAR

◆ new_cmenu

◆ P_READ

◆ P_WRITE

◆ PICK_HELP_FILE

◆ PICK_MAX_ARG_LEN

◆ PRINTCMD

◆ TRUE

◆ USE_PAD

◆ VIEW_HELP_FILE

◆ VIEW_PRT_FILE

Typedef Documentation

◆ Form

◆ Menu

◆ Pick

◆ View

Enumeration Type Documentation

◆ Caller

◆ OptGroup

◆ OptType

Function Documentation

◆ cmd_processor()

◆ cmenu_abend()

◆ cmenu_shutdown()

◆ destroy_view_win()

◆ open_pick_win()

◆ pick_engine()

◆ popup_ckeys()

◆ popup_form()

◆ popup_menu()

◆ popup_pick()

◆ popup_view()

◆ process_config_file()

◆ view_boxwin_resize()

◆ view_full_screen_resize()

◆ view_stack_free()

◆ view_stack_init()

◆ view_stack_peek()

◆ view_stack_pop()

◆ view_stack_push()

Variable Documentation

◆ init_cnt

◆ minitrc

◆ view_stack