C-Menu 0.2.9
A User Interface Toolkit
Loading...
Searching...
No Matches
Menu Engine

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

Functions

unsigned int menu_engine (Init *init)
 The main loop of the menu system.
unsigned int menu_cmd_processor (Init *init)
 Processes user input for 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
initA 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.
Note
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 118 of file menu_engine.c.

118 {
119 int i, c;
120 char *d;
121 int in_key;
122 char tmp_str[MAXLEN];
123
124 Menu *menu = init->menu;
125 keypad(menu->win, TRUE);
126 mousemask(BUTTON1_CLICKED | BUTTON1_DOUBLE_CLICKED, nullptr);
127 MEVENT event;
128
129 wattron(menu->win, A_REVERSE);
130 mvwaddstr_fill(menu->win, menu->line_idx, 0,
131 menu->line[menu->line_idx]->choice_text, menu->cols);
132 wattroff(menu->win, A_REVERSE);
133
134 event.y = event.x = -1;
135 // tcflush(2, TCIFLUSH);
136 wmove(menu->win, menu->line_idx, 1);
137 in_key = xwgetch(menu->win, nullptr, -1);
138
139 mvwaddstr_fill(menu->win, menu->line_idx, 0,
140 menu->line[menu->line_idx]->choice_text, menu->cols);
141 switch (in_key) {
143 case KEY_UP:
144 i = menu->line_idx;
145 while (i > 0) {
146 i--;
147 if (menu->line[i]->type == MT_CHOICE) {
148 menu->line_idx = i;
149 break;
150 }
151 }
152 return (MA_CONTINUE);
154 case KEY_DOWN:
155 i = menu->line_idx;
156 while (i < menu->item_count - 1) {
157 i++;
158 if (menu->line[i]->type == MT_CHOICE) {
159 menu->line_idx = i;
160 break;
161 }
162 }
163 return (MA_CONTINUE);
166 case '\n':
167 case KEY_ENTER:
168 break;
170 case '?':
171 case KEY_F(1):
172 if (menu->f_help_spec && menu->help_spec[0] != '\0')
173 strnz__cpy(tmp_str, menu->help_spec, MAXLEN - 1);
174 else {
175 strnz__cpy(tmp_str, init->mapp_help, MAXLEN - 1);
176 strnz__cat(tmp_str, "/", MAXLEN - 1);
177 strnz__cat(tmp_str, MENU_HELP_FILE, MAXLEN - 1);
178 }
179 eargc = 0;
180 eargv[eargc++] = strdup("view");
181 eargv[eargc++] = strdup("-N");
182 eargv[eargc++] = strdup("f");
183 eargv[eargc++] = strdup(tmp_str);
184 eargv[eargc] = nullptr;
185 init->lines = 30;
186 init->cols = 60;
187 init->begy = menu->begy + 1;
188 init->begx = menu->begx + 1;
189 strnz__cpy(init->title, "Menu Help", MAXLEN - 1);
190 popup_view(init, eargc, eargv, init->lines, init->cols, init->begy,
191 init->begx);
192 destroy_argv(eargc, eargv);
193 return (MA_DISPLAY_MENU);
196 case KEY_F(9):
197 case KEY_BREAK:
198 return (MA_RETURN);
200 case KEY_ALTF(9):
201 d = getenv("PRTCMD");
202 if (d == nullptr || *d == '\0')
203 strnz__cpy(earg_str, PRINTCMD, MAXLEN - 1);
204 else
205 strnz__cpy(earg_str, d, MAXLEN - 1);
206 strnz__cat(earg_str, " ", MAXLEN - 1);
207 d = getenv("PRTFILE");
208 if (d == nullptr || *d == '\0') {
209 d = getenv("HOME");
210 if (d == nullptr || *d == '\0')
211 strnz__cat(earg_str, VIEW_PRT_FILE, MAXLEN - 1);
212 else {
213 strnz__cat(earg_str, d, MAXLEN - 1);
214 strnz__cat(earg_str, "/", MAXLEN - 1);
215 strnz__cat(earg_str, VIEW_PRT_FILE, MAXLEN - 1);
216 }
217 } else
218 strnz__cat(earg_str, d, MAXLEN - 1);
219 full_screen_shell(earg_str);
220 return (MA_RESET_MENU);
222 case KEY_ALTF(10):
223 restore_wins();
224 return (MA_DISPLAY_MENU);
226 case KEY_MOUSE:
227 if (click_y == -1 || click_x == -1)
228 return (MA_CONTINUE);
229 if (click_y < 0 || click_y >= menu->item_count)
230 return (MA_CONTINUE);
231 menu->line_idx = click_y;
232 break;
233 default:
236 for (i = 0; i < menu->item_count; i++) {
237 if (menu->line[i]->raw_text[0] == '_') {
238 if (menu->line[i]->choice_letter == (char)in_key) {
239 menu->line_idx = i;
240 break;
241 }
242 } else {
243 if (menu->line[i]->choice_letter == toupper((char)in_key)) {
244 menu->line_idx = i;
245 break;
246 }
247 }
248 }
249 if (i >= menu->item_count)
250 return (MA_CONTINUE);
251 break;
252 }
253 c = (int)menu->line[menu->line_idx]->command_type;
254 switch (c) {
258 case CT_EXEC:
259 char *s;
260 s = strpbrk(menu->line[menu->line_idx]->command_str, " \t\f\v");
261 strnz__cpy(earg_str, s, MAXLEN - 1);
262 trim(earg_str);
263 eargc = str_to_args(eargv, s, MAX_ARGS);
264 full_screen_fork_exec(eargv);
265 destroy_argv(eargc, eargv);
266 return (MA_RESET_MENU);
268 case CT_HELP:
269 if (menu->f_help_spec && menu->help_spec[0] != '\0')
270 strnz__cpy(tmp_str, menu->help_spec, MAXLEN - 1);
271 else {
272 strnz__cpy(tmp_str, init->mapp_help, MAXLEN - 1);
273 strnz__cat(tmp_str, "/", MAXLEN - 1);
274 strnz__cat(tmp_str, MENU_HELP_FILE, MAXLEN - 1);
275 }
276 eargc = 0;
277 eargv[eargc++] = strdup("view");
278 eargv[eargc++] = strdup("-N");
279 eargv[eargc++] = strdup("f");
280 eargv[eargc++] = strdup(tmp_str);
281 eargv[eargc] = nullptr;
282 init->lines = 66;
283 init->cols = 80;
284 init->begy = menu->begy + 1;
285 init->begx = menu->begx + 1;
286 strnz__cpy(init->title, "Menu Help", MAXLEN - 1);
287 popup_view(init, eargc, eargv, init->lines, init->cols, init->begy,
288 init->begx);
289 destroy_argv(eargc, eargv);
290 return (MA_DISPLAY_MENU);
293 case CT_MENU:
294 strnz__cpy(earg_str, menu->line[menu->line_idx]->command_str,
295 MAXLEN - 1);
296 eargc = str_to_args(eargv, earg_str, MAX_ARGS);
297 if (eargc == 0)
298 return (MA_DISPLAY_MENU);
299 zero_opt_args(init);
300 parse_opt_args(init, eargc, eargv);
301 if (init->begy == 0)
302 init->begy = menu->begy + 1;
303 if (init->begx == 0)
304 init->begx = menu->begx + 1;
305 Menu *save_menu = init->menu;
306 init->menu = nullptr;
307 init->menu = new_menu(init, eargc, eargv, init->begy, init->begx);
308 if (!init->menu)
309 abend(-1, "menu_cmd_processor: new_menu() failed");
310 // menu = init->menu;
311 parse_menu_description(init);
312 menu_engine(init);
313 destroy_argv(eargc, eargv);
314 init->menu = destroy_menu(init);
315 init->menu = save_menu;
316 menu = init->menu;
317 return (MA_RESET_MENU);
320 case CT_PICK:
321 strnz__cpy(earg_str, menu->line[menu->line_idx]->command_str,
322 MAXLEN - 1);
323 eargc = str_to_args(eargv, earg_str, MAX_ARGS);
324 popup_pick(init, eargc, eargv, menu->begy + 1, menu->begx + 1);
325 destroy_argv(eargc, eargv);
326 return (MA_DISPLAY_MENU);
329 case CT_FORM:
330 strnz__cpy(earg_str, menu->line[menu->line_idx]->command_str,
331 MAXLEN - 1);
332 eargc = str_to_args(eargv, earg_str, MAX_ARGS);
333 popup_form(init, eargc, eargv, menu->begy + 1, menu->begx + 1);
334 destroy_argv(eargc, eargv);
335 return (MA_RESET_MENU);
338 case CT_VIEW:
339 strnz__cpy(earg_str, menu->line[menu->line_idx]->command_str,
340 MAXLEN - 1);
341 eargc = str_to_args(eargv, earg_str, MAX_ARGS);
342 init->lines = 66;
343 init->cols = 80;
344 init->begy = menu->begy + 1;
345 init->begx = menu->begx + 1;
346 strnz__cpy(init->title, menu->line[menu->line_idx]->raw_text,
347 MAXLEN - 1);
348 popup_view(init, eargc, eargv, init->lines, init->cols, init->begy,
349 init->begx);
350 destroy_argv(eargc, eargv);
351 return (MA_DISPLAY_MENU);
353 case CT_CKEYS:
354 popup_ckeys();
355 return (MA_DISPLAY_MENU);
357 case CT_RETURN:
358 return (MA_RETURN);
360 case CT_WRITE_CONFIG:
361 write_config(init);
362 return (MA_CONTINUE);
363 default:
364 return (MA_CONTINUE);
365 }
366 return 0;
367}
PRINTCMD
#define PRINTCMD
Definition common.h:46
init
Init * init
Definition common.h:186
VIEW_PRT_FILE
#define VIEW_PRT_FILE
Definition common.h:40
popup_form
int popup_form(Init *, int, char **, int, int)
Definition popups.c:34
MENU_HELP_FILE
#define MENU_HELP_FILE
Definition common.h:36
popup_view
int popup_view(Init *, int, char **, int, int, int, int)
Definition popups.c:47
parse_opt_args
int parse_opt_args(Init *, int, char **)
Definition init.c:393
popup_pick
int popup_pick(Init *, int, char **, int, int)
Definition popups.c:21
eargc
int eargc
Definition futil.c:41
MAX_ARGS
#define MAX_ARGS
Definition cm.h:28
earg_str
char earg_str[MAXLEN]
Definition futil.c:40
eargv
char * eargv[MAXARGS]
Definition futil.c:42
KEY_ALTF
#define KEY_ALTF(n)
Definition cm.h:346
MT_CHOICE
@ MT_CHOICE
Definition menu.h:22
menu
Menu * menu
Definition mem.c:45
MA_RETURN
@ MA_RETURN
Definition menu.h:25
MA_DISPLAY_MENU
@ MA_DISPLAY_MENU
Definition menu.h:25
MA_RESET_MENU
@ MA_RESET_MENU
Definition menu.h:25
MA_CONTINUE
@ MA_CONTINUE
Definition menu.h:25
CT_PICK
@ CT_PICK
Definition menu.h:37
CT_FORM
@ CT_FORM
Definition menu.h:33
CT_MENU
@ CT_MENU
Definition menu.h:36
CT_RETURN
@ CT_RETURN
Definition menu.h:40
CT_HELP
@ CT_HELP
Definition menu.h:31
CT_WRITE_CONFIG
@ CT_WRITE_CONFIG
Definition menu.h:42
CT_EXEC
@ CT_EXEC
Definition menu.h:30
CT_VIEW
@ CT_VIEW
Definition menu.h:38
CT_CKEYS
@ CT_CKEYS
Definition menu.h:39
TRUE
#define TRUE
Definition iloan.c:19
popup_ckeys
int popup_ckeys()
Display Curses Keys Responds to curses keys and mouse events, displaying the key code and description...
Definition curskeys.c:23
MAXLEN
#define MAXLEN
Definition curskeys.c:15
click_x
int click_x
Definition dwin.c:45
click_y
int click_y
Definition dwin.c:44
xwgetch
int xwgetch(WINDOW *, Chyron *, int)
Wrapper for wgetch that handles signals, mouse events, checks for clicks on the chyron line,...
Definition dwin.c:1359
restore_wins
void restore_wins()
Restore all windows after a screen resize.
Definition dwin.c:938
mvwaddstr_fill
void mvwaddstr_fill(WINDOW *, int, int, char *, int)
For lines shorter than their display area, fill the rest with spaces.
Definition dwin.c:1262
abend
void abend(int, char *)
Abnormal program termination.
Definition dwin.c:1331
full_screen_fork_exec
int full_screen_fork_exec(char **)
Execute a command in full screen mode.
Definition exec.c:44
full_screen_shell
int full_screen_shell(char *)
Execute a shell command in full screen mode.
Definition exec.c:60
destroy_argv
void destroy_argv(int argc, char **argv)
Deallocates memory allocated for argument strings in argv.
Definition futil.c:221
strnz__cpy
size_t strnz__cpy(char *, const char *, size_t)
safer alternative to strncpy
Definition futil.c:269
trim
size_t trim(char *)
Trims leading and trailing spaces from string s in place.
Definition futil.c:118
strnz__cat
size_t strnz__cat(char *, const char *, size_t)
safer alternative to strncat
Definition futil.c:298
str_to_args
int str_to_args(char **, char *, int)
Converts a string into an array of argument strings.
Definition futil.c:167
write_config
int write_config(Init *)
Write the current configuration to a file specified in init->minitrc.
Definition init.c:723
zero_opt_args
void zero_opt_args(Init *)
Initialize optional arguments in the Init struct to default values.
Definition init.c:408
new_menu
Menu * new_menu(Init *, int, char **, int, int)
Create and initialize Menu structure.
Definition mem.c:148
destroy_menu
Menu * destroy_menu(Init *init)
Destroy Menu structure.
Definition mem.c:169
menu_engine
unsigned int menu_engine(Init *)
The main loop of the menu system.
Definition menu_engine.c:37
parse_menu_description
unsigned int parse_menu_description(Init *)
Parse menu description file and create Menu.
Definition parse_menu_desc.c:29
Menu
The Menu structure is the main data structure for the menu application, containing all the informatio...
Definition menu.h:81

References abend(), 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, CT_CKEYS, CT_EXEC, CT_FORM, CT_HELP, CT_MENU, CT_PICK, CT_RETURN, CT_VIEW, CT_WRITE_CONFIG, destroy_argv(), destroy_menu(), earg_str, eargc, eargv, Menu::f_help_spec, full_screen_fork_exec(), full_screen_shell(), Menu::help_spec, Menu::item_count, Menu::line, Menu::line_idx, Init::lines, MA_CONTINUE, MA_DISPLAY_MENU, MA_RESET_MENU, MA_RETURN, Init::mapp_help, Init::menu, menu_engine(), MT_CHOICE, mvwaddstr_fill(), new_menu(), parse_menu_description(), parse_opt_args(), popup_ckeys(), popup_form(), 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(), xwgetch(), and zero_opt_args().

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
initA 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.
Note
displays the menu and processes user input until the user exits the menu or returns to the main menu.

Definition at line 37 of file menu_engine.c.

37 {
38 int action;
39 int i;
40 char tmp_str[MAXLEN];
41 Menu *menu = init->menu;
42 if (menu == nullptr) {
43 Perror("menu_engine: menu is nullptr");
44 return (1);
45 }
46 menu->lines = 0;
47 menu->cols = 0;
48 menu->line_idx = 0;
49 menu->item_count = 0;
50 menu->title[0] = '\0';
51 menu->choice_max_len = 0;
52 menu->text_max_len = 0;
53 parse_menu_description(init);
54 if (win_new(menu->lines, menu->cols, menu->begy, menu->begx, menu->title,
55 0)) {
56 ssnprintf(tmp_str, MAXLEN - 1, "win_new(%d, %d, %d, %d, %s, %b) failed",
57 menu->lines, menu->cols, menu->begy, menu->begx, menu->title,
58 0);
59 Perror(tmp_str);
60 return 1;
61 }
62 menu->win = win_win[win_ptr];
63 menu->box = win_box[win_ptr];
64
65 action = MA_DISPLAY_MENU;
66 while (action) {
67 switch (action) {
68 case MA_RETURN:
69 win_del();
70 if (win_ptr < 0) {
71 destroy_menu(init);
72 return 0;
73 }
74 menu->win = win_win[win_ptr];
75 menu->box = win_box[win_ptr];
76 restore_wins();
77 return 0;
78 case MA_DISPLAY_MENU:
79 for (menu->line_idx = 0; menu->line_idx < menu->item_count;
80 menu->line_idx++) {
81 mvwaddstr(menu->win, menu->line_idx, 0,
82 menu->line[menu->line_idx]->choice_text);
83 }
84 action = MA_RESET_MENU;
85 break;
86 case MA_RESET_MENU:
87 menu->line_idx = 0;
88 for (i = 0; i < menu->item_count; i++) {
89 if (menu->line[i]->type == MT_CHOICE) {
90 menu->line_idx = i;
91 break;
92 }
93 }
94 action = MA_CONTINUE;
95 break;
96 case MA_CONTINUE:
97 while ((action = menu_cmd_processor(init)) == MA_CONTINUE)
98 ;
99 break;
100 default:
101 break;
102 }
103 }
104 destroy_menu(init);
105 return 0;
106}
win_win
WINDOW * win_win[MAXWIN]
Definition dwin.c:114
win_ptr
int win_ptr
Definition dwin.c:121
win_box
WINDOW * win_box[MAXWIN]
Definition dwin.c:115
win_new
int win_new(int, int, int, int, char *, int)
Create a new window with optional box and title.
Definition dwin.c:783
win_del
WINDOW * win_del()
Delete the current window and its associated box window.
Definition dwin.c:902
Perror
int Perror(char *)
Display a simple error message window or print to stderr.
Definition dwin.c:1110
ssnprintf
size_t ssnprintf(char *, size_t, const char *,...)
ssnprintf was designed to be a safer alternative to snprintf.
Definition futil.c:147
menu_cmd_processor
unsigned int menu_cmd_processor(Init *)
Processes user input for the menu system.
Definition menu_engine.c:118

References Menu::begx, Menu::begy, Menu::box, Menu::choice_max_len, Line::choice_text, Menu::cols, destroy_menu(), Menu::item_count, 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_new(), win_ptr, and win_win.

Referenced by main(), menu_cmd_processor(), and popup_menu().

Here is the call graph for this function:
Here is the caller graph for this function: