Menu Engine

Main loop and command processor for the C-Menu menu system. More...

Functions
unsigned int	menu_cmd_processor (Init *init)
	Processes user input for the menu system.
unsigned int	menu_engine (Init *init)
	The main loop of the menu system.

Detailed Description

Main loop and command processor for the C-Menu menu system.

This module contains the core functionality for displaying menus, processing user input, and executing commands associated with menu choices. It handles navigation through menu options, responding to special keys, and managing the display of submenus, pick lists, forms, and views.

Function Documentation

menu_cmd_processor()

unsigned int menu_cmd_processor

(

Init *

init

)

Processes user input for the menu system.

Parameters

init	A pointer to an Init structure containing initialization data for the menu system.

Returns

an integer indicating the action taken by the user, such as returning to the main menu, displaying a submenu, or executing a command associated with a menu choice.

handles navigation through the menu options, executing commands associated with menu choices, and responding to special keys such as function keys and mouse clicks.

Move up to the previous menu choice

Move down to the next menu choice

Select the current menu choice and execute its associated command

Display help information for the menu system

Exit the menu and return to the previous menu or exit if at top

send default printer output file to printer

open the default editor

process mouse event

If the user presses a key that corresponds to a menu choice's letter, select that menu choice

Execute the command associated with the selected menu choice

Display help information for the menu system

Display a submenu or perform an action associated with the selected menu choice

Display a pick list or form associated with the selected menu choice

Display a form associated with the selected menu choice

Display a view associated with the selected menu choice

open ckeys (test curses keys)

return to calling program

write the current menu configuration to a file

Definition at line 133 of file menu_engine.c.

                                            {
    int i, c;
    int len;
    char *d;
    int in_key;
    char tmp_str[MAXLEN];
    char earg_str[MAXLEN];
    char *eargv[MAXARGS];
    int eargc;
    mbstate_t mbstate;
    memset(&mbstate, 0, sizeof(mbstate));
    cchar_t cc = {0};
    Menu *menu = init->menu;
    keypad(menu->win, TRUE);
    immedok(menu->win, TRUE);
    mousemask(BUTTON1_CLICKED | BUTTON1_DOUBLE_CLICKED, nullptr);
    MEVENT event;
    scrollok(menu->win, FALSE);
 
    // Highlight the currently selected menu choice
 
    while (1) {
        wattron(menu->win, A_REVERSE);
        mvwaddstr_fill(menu->win, menu->line_idx, 0,
                       menu->line[menu->line_idx]->choice_text, menu->cols);
        wattroff(menu->win, A_REVERSE);
        // Highlight the letter of the currently selected menu choice
        wchar_t wstr[2] = {L'\0', L'\0'};
        len = mbrtowc(wstr, &menu->line[menu->line_idx]->choice_letter,
                      MB_CUR_MAX, &mbstate);
        if (len < 0) {
            wstr[0] = L'?';
            wstr[1] = L'\0';
        }
        setcchar(&cc, wstr, WA_BOLD, cp_nt_hl_rev, nullptr);
        mvwadd_wch(menu->win, menu->line_idx,
                   menu->line[menu->line_idx]->letter_pos, &cc);
        wrefresh(menu->win);
 
        // Wait for user input and process it
        event.y = event.x = -1;
        wmove(menu->win, menu->line_idx, 1);
        in_key = xwgetch(menu->win, nullptr, -1);
 
        // Remove the highlight from the currently selected menu choice
        mvwaddstr_fill(menu->win, menu->line_idx, 0,
                       menu->line[menu->line_idx]->choice_text, menu->cols);
        len = mbrtowc(wstr, &menu->line[menu->line_idx]->choice_letter,
                      MB_CUR_MAX, &mbstate);
        if (len < 0) {
            wstr[0] = L'?';
            wstr[1] = L'\0';
        }
        setcchar(&cc, wstr, WA_NORMAL, cp_nt_hl, nullptr);
        mvwadd_wch(menu->win, menu->line_idx,
                   menu->line[menu->line_idx]->letter_pos, &cc);
        // Initialize the mouse event coordinates to -1 to indicate no mouse
        // event
        event.y = event.x = -1;
        switch (in_key) {
        case KEY_UP:
            i = menu->line_idx;
            while (i > 0) {
                i--;
                if (menu->line[i]->type == MT_CHOICE) {
                    menu->line_idx = i;
                    break;
                }
            }
            return (MA_CONTINUE);
        case KEY_DOWN:
            i = menu->line_idx;
            while (i < menu->item_count - 1) {
                i++;
                if (menu->line[i]->type == MT_CHOICE) {
                    menu->line_idx = i;
                    break;
                }
            }
            return (MA_CONTINUE);
        case '\n':
        case KEY_ENTER:
            break;
        case '?':
        case KEY_F(1):
            if (menu->f_help_spec && menu->help_spec[0] != '\0')
                strnz__cpy(tmp_str, menu->help_spec, MAXLEN - 1);
            else {
                strnz__cpy(tmp_str, init->mapp_help, MAXLEN - 1);
                strnz__cat(tmp_str, "/", MAXLEN - 1);
                strnz__cat(tmp_str, MENU_HELP_FILE, MAXLEN - 1);
            }
            eargc = 0;
            eargv[eargc++] = strdup("view");
            eargv[eargc++] = strdup("-Nf");
            eargv[eargc++] = strdup(tmp_str);
            eargv[eargc] = nullptr;
            init->lines = 51;
            init->cols = 86;
            init->begy = menu->begy + 1;
            init->begx = menu->begx + 1;
            strnz__cpy(init->title, "Menu Help", MAXLEN - 1);
            popup_view(init, eargc, eargv, init->lines, init->cols, init->begy,
                       init->begx);
            destroy_argv(eargc, eargv);
            return (MA_DISPLAY_MENU);
        case KEY_F(9):
        case KEY_BREAK:
            return (MA_RETURN);
        case KEY_ALTF(9):
            d = getenv("PRTCMD");
            if (d == nullptr || *d == '\0')
                strnz__cpy(earg_str, PRINTCMD, MAXLEN - 1);
            else
                strnz__cpy(earg_str, d, MAXLEN - 1);
            strnz__cat(earg_str, " ", MAXLEN - 1);
            d = getenv("PRTFILE");
            if (d == nullptr || *d == '\0') {
                d = getenv("HOME");
                if (d == nullptr || *d == '\0')
                    strnz__cat(earg_str, VIEW_PRT_FILE, MAXLEN - 1);
                else {
                    strnz__cat(earg_str, d, MAXLEN - 1);
                    strnz__cat(earg_str, "/", MAXLEN - 1);
                    strnz__cat(earg_str, VIEW_PRT_FILE, MAXLEN - 1);
                }
            } else
                strnz__cat(earg_str, d, MAXLEN - 1);
            full_screen_shell(earg_str);
            return (MA_RESET_MENU);
        case KEY_ALTF(10):
            restore_wins();
            return (MA_DISPLAY_MENU);
        case KEY_MOUSE:
            if (click_y == -1 || click_x == -1)
                return (MA_CONTINUE);
            if (click_y < 0 || click_y >= menu->item_count)
                return (MA_CONTINUE);
            menu->line_idx = click_y;
            break;
        default:
            if (in_key == 'q')
                return (MA_RETURN);
            for (i = 0; i < menu->item_count; i++) {
                if (menu->line[i]->raw_text[0] == '_') {
                    if (menu->line[i]->choice_letter == (char)in_key) {
                        menu->line_idx = i;
                        break;
                    }
                } else {
                    if (menu->line[i]->choice_letter == (char)in_key) {
                        menu->line_idx = i;
                        break;
                    }
                }
            }
            if (i >= menu->item_count)
                return (MA_CONTINUE);
            break;
        }
        char *s;
        c = (int)menu->line[menu->line_idx]->command_type;
        switch (c) {
        case CT_DMON:
            s = strpbrk(menu->line[menu->line_idx]->command_str, " \t\f\v");
            strnz__cpy(earg_str, s, MAXLEN - 1);
            trim(earg_str);
            eargc = str_to_args(eargv, s, MAX_ARGS);
            dmon(eargv);
            destroy_argv(eargc, eargv);
            return (MA_RESET_MENU);
        case CT_EXEC:
            s = strpbrk(menu->line[menu->line_idx]->command_str, " \t\f\v");
            strnz__cpy(earg_str, s, MAXLEN - 1);
            trim(earg_str);
            eargc = str_to_args(eargv, s, MAX_ARGS);
            full_screen_fork_exec(eargv);
            destroy_argv(eargc, eargv);
            return (MA_RESET_MENU);
        case CT_HELP:
            if (menu->f_help_spec && menu->help_spec[0] != '\0')
                strnz__cpy(tmp_str, menu->help_spec, MAXLEN - 1);
            else {
                strnz__cpy(tmp_str, init->mapp_help, MAXLEN - 1);
                strnz__cat(tmp_str, "/", MAXLEN - 1);
                strnz__cat(tmp_str, MENU_HELP_FILE, MAXLEN - 1);
            }
            eargc = 0;
            eargv[eargc++] = strdup("view");
            eargv[eargc++] = strdup("-N");
            eargv[eargc++] = strdup("f");
            eargv[eargc++] = strdup(tmp_str);
            eargv[eargc] = nullptr;
            init->lines = 40;
            init->cols = 60;
            init->begy = menu->begy + 1;
            init->begx = menu->begx + 1;
            strnz__cpy(init->title, "Menu Help", MAXLEN - 1);
            popup_view(init, eargc, eargv, init->lines, init->cols, init->begy,
                       init->begx);
            destroy_argv(eargc, eargv);
            return (MA_DISPLAY_MENU);
        case CT_MENU:
            strnz__cpy(earg_str, menu->line[menu->line_idx]->command_str,
                       MAXLEN - 1);
            eargc = str_to_args(eargv, earg_str, MAX_ARGS);
            if (eargc == 0)
                return (MA_DISPLAY_MENU);
            popup_menu(init, eargc, eargv, menu->begy + 1, menu->begx + 1);
            destroy_argv(eargc, eargv);
            return (MA_RESET_MENU);
        case CT_PICK:
            strnz__cpy(earg_str, menu->line[menu->line_idx]->command_str,
                       MAXLEN - 1);
            eargc = str_to_args(eargv, earg_str, MAX_ARGS);
            popup_pick(init, eargc, eargv, menu->begy + 1, menu->begx + 1);
            destroy_argv(eargc, eargv);
            return (MA_DISPLAY_MENU);
        case CT_FORM:
            strnz__cpy(earg_str, menu->line[menu->line_idx]->command_str,
                       MAXLEN - 1);
            eargc = str_to_args(eargv, earg_str, MAX_ARGS);
            popup_form(init, eargc, eargv, menu->begy + 1, menu->begx + 1);
            destroy_argv(eargc, eargv);
            return (MA_RESET_MENU);
        case CT_VIEW:
            strnz__cpy(earg_str, menu->line[menu->line_idx]->command_str,
                       MAXLEN - 1);
            eargc = str_to_args(eargv, earg_str, MAX_ARGS);
            init->lines = 66;
            init->cols = 80;
            init->begy = menu->begy + 1;
            init->begx = menu->begx + 1;
            strnz__cpy(init->title, menu->line[menu->line_idx]->raw_text,
                       MAXLEN - 1);
            popup_view(init, eargc, eargv, init->lines, init->cols, init->begy,
                       init->begx);
            destroy_argv(eargc, eargv);
            return (MA_DISPLAY_MENU);
        case CT_CKEYS:
            popup_ckeys();
            return (MA_DISPLAY_MENU);
        case CT_RETURN:
            return (MA_RETURN);
        case CT_WRITE_CONFIG:
            write_config(init);
            return (MA_CONTINUE);
        default:
            return (MA_CONTINUE);
        }
    }
    return 0;
}

References Init::begx, Menu::begx, Init::begy, Menu::begy, Line::choice_letter, Line::choice_text, click_x, click_y, Init::cols, Menu::cols, Line::command_str, Line::command_type, cp_nt_hl, cp_nt_hl_rev, CT_CKEYS, CT_DMON, CT_EXEC, CT_FORM, CT_HELP, CT_MENU, CT_PICK, CT_RETURN, CT_VIEW, CT_WRITE_CONFIG, destroy_argv(), dmon(), Menu::f_help_spec, full_screen_fork_exec(), full_screen_shell(), Menu::help_spec, Menu::item_count, Line::letter_pos, Menu::line, Menu::line_idx, Init::lines, MA_CONTINUE, MA_DISPLAY_MENU, MA_RESET_MENU, MA_RETURN, Init::mapp_help, Init::menu, MT_CHOICE, mvwaddstr_fill(), popup_ckeys(), popup_form(), popup_menu(), popup_pick(), popup_view(), Line::raw_text, restore_wins(), str_to_args(), strnz__cat(), strnz__cpy(), Init::title, trim(), Line::type, Menu::win, write_config(), and xwgetch().

Referenced by menu_engine().

Here is the call graph for this function:

Here is the caller graph for this function:

menu_engine()

unsigned int menu_engine

(

Init *

init

)

The main loop of the menu system.

Parameters

init	A pointer to an Init structure containing initialization data for the menu system.

Returns

an integer indicating the action taken by the user, such as returning to the main menu or exiting the menu system.

displays the menu and processes user input until the user exits the menu or returns to the main menu.

Definition at line 38 of file menu_engine.c.

                                     {
    int action;
    int i;
    char tmp_str[MAXLEN];
    Menu *menu = init->menu;
    if (menu == nullptr) {
        Perror("menu_engine: menu is nullptr");
        return (1);
    }
    menu->lines = 0;
    menu->cols = 0;
    menu->line_idx = 0;
    menu->item_count = 0;
    menu->title[0] = '\0';
    menu->choice_max_len = 0;
    menu->text_max_len = 0;
    parse_menu_description(init);
    if (box_new(menu->lines, menu->cols, menu->begy, menu->begx, menu->title,
                true)) {
        ssnprintf(tmp_str, MAXLEN - 1, "box_new(%d, %d, %d, %d, %s) failed",
                  menu->lines, menu->cols, menu->begy, menu->begx, menu->title);
        Perror(tmp_str);
        return 1;
    }
    menu->win = win_win[win_ptr];
    menu->box = win_box[win_ptr];
 
    int len;
    mbstate_t mbstate;
    memset(&mbstate, 0, sizeof(mbstate));
    cchar_t cc = {0};
 
    action = MA_DISPLAY_MENU;
    while (action) {
        switch (action) {
        case MA_RETURN:
            win_del();
            if (win_ptr < 0) {
                destroy_menu(init);
                return 0;
            }
            menu->win = win_win[win_ptr];
            menu->box = win_box[win_ptr];
            restore_wins();
            return 0;
        case MA_DISPLAY_MENU:
            for (menu->line_idx = 0; menu->line_idx < menu->item_count;
                 menu->line_idx++) {
                mvwaddstr(menu->win, menu->line_idx, 0,
                          menu->line[menu->line_idx]->choice_text);
                // Highlight the letter of the menu choice
                wchar_t wstr[2] = {L'\0', L'\0'};
                len = mbrtowc(wstr, &menu->line[menu->line_idx]->choice_letter,
                              MB_CUR_MAX, &mbstate);
                if (len < 0) {
                    wstr[0] = L'?';
                    wstr[1] = L'\0';
                }
                setcchar(&cc, wstr, WA_NORMAL, cp_nt_hl, nullptr);
                mvwadd_wch(menu->win, menu->line_idx,
                           menu->line[menu->line_idx]->letter_pos, &cc);
            }
            action = MA_RESET_MENU;
            break;
        case MA_RESET_MENU:
            menu->line_idx = 0;
            for (i = 0; i < menu->item_count; i++) {
                if (menu->line[i]->type == MT_CHOICE) {
                    menu->line_idx = i;
                    break;
                }
            }
            action = MA_CONTINUE;
            break;
        case MA_CONTINUE:
            action = menu_cmd_processor(init);
            break;
        default:
            break;
        }
    }
    destroy_menu(init);
    return 0;
}

References Menu::begx, Menu::begy, Menu::box, box_new(), Line::choice_letter, Menu::choice_max_len, Line::choice_text, Menu::cols, cp_nt_hl, destroy_menu(), Menu::item_count, Line::letter_pos, Menu::line, Menu::line_idx, Menu::lines, MA_CONTINUE, MA_DISPLAY_MENU, MA_RESET_MENU, MA_RETURN, Init::menu, menu_cmd_processor(), MT_CHOICE, parse_menu_description(), Perror(), restore_wins(), ssnprintf(), Menu::text_max_len, Menu::title, Line::type, Menu::win, win_box, win_del(), win_ptr, and win_win.

Referenced by main(), and popup_menu().

Here is the call graph for this function:

Here is the caller graph for this function: