d8bedc2024bdd8b0a7348f794cee3d471eba032f
[asterisk/asterisk.git] / build_tools / menuselect_curses.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2005 - 2006, Russell Bryant
5  *
6  * Russell Bryant <russell@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*
20  * \file
21  *
22  * \author Russell Bryant <russell@digium.com>
23  * 
24  * \brief curses frontend for Asterisk module selection
25  */
26
27 #include "autoconfig.h"
28
29 #include <stdlib.h>
30 #include <stdio.h>
31 #include <string.h>
32 #include <signal.h>
33 #include <curses.h>
34
35 #include "menuselect.h"
36
37 #define MENU_TITLE1     "*************************************"
38 #define MENU_TITLE2     "*     Asterisk Module Selection     *"
39 #define MENU_TITLE3     "*************************************"
40 #define MENU_HELP       "Press 'h' for help."
41
42 #define TITLE_HEIGHT    7
43
44 #define MIN_X           80
45 #define MIN_Y           20
46
47 #define PAGE_OFFSET     10
48
49
50 /*! Maximum number of characters horizontally */
51 int max_x = 0;
52 /*! Maximum number of characters vertically */
53 int max_y = 0;
54
55 const char * const help_info[] = {
56         "scroll        => up/down arrows",
57         "(de)select    => Enter",
58         "select all    => F8",
59         "deselect all  => F7",
60         "back          => left arrow",
61         "quit          => q",
62         "save and quit => x",
63         "",
64         "XXX means dependencies have not been met"
65 };
66
67 void winch_handler(int sig);
68 void show_help(WINDOW *win);
69 void draw_main_menu(WINDOW *menu, int curopt);
70 void draw_category_menu(WINDOW *menu, struct category *cat, int start, int end, int curopt);
71 int run_category_menu(WINDOW *menu, int cat_num);
72 int run_category_menu(WINDOW *menu, int cat_num);
73 void draw_title_window(WINDOW *title);
74
75 /*! \brief Handle a window resize in xterm */
76 void winch_handler(int sig)
77 {
78         getmaxyx(stdscr, max_y, max_x);
79
80         if (max_x < MIN_X - 1 || max_y < MIN_Y - 1) {
81                 fprintf(stderr, "Terminal must be at least 80 x 25.\n");
82                 max_x = MIN_X - 1;
83                 max_y = MIN_Y - 1;
84         }
85 }
86
87 /*! \brief Display help information */
88 void show_help(WINDOW *win)
89 {
90         int i;
91
92         wclear(win);
93         for (i = 0; i < (sizeof(help_info) / sizeof(help_info[0])); i++) {
94                 wmove(win, i, max_x / 2 - 15);
95                 waddstr(win, help_info[i]);
96         }
97         wrefresh(win);
98         getch(); /* display the help until the user hits a key */
99 }
100
101 void draw_main_menu(WINDOW *menu, int curopt)
102 {
103         struct category *cat;
104         char buf[64];
105         int i = 0;
106
107         wclear(menu);
108
109         AST_LIST_TRAVERSE(&categories, cat, list) {
110                 wmove(menu, i++, max_x / 2 - 10);
111                 if (!strlen_zero(cat->displayname))
112                         snprintf(buf, sizeof(buf), "%d.%s %s", i, i < 10 ? " " : "", cat->displayname);
113                 else
114                         snprintf(buf, sizeof(buf), "%d.%s %s", i, i < 10 ? " " : "", cat->name);
115                 waddstr(menu, buf);
116         }
117
118         wmove(menu, curopt, (max_x / 2) - 15);
119         waddstr(menu, "--->");
120         wmove(menu, 0, 0);
121
122         wrefresh(menu);
123 }
124
125 void draw_category_menu(WINDOW *menu, struct category *cat, int start, int end, int curopt)
126 {
127         int i = 0;
128         int j = 0;
129         struct member *mem;
130         char buf[64];
131         const char *desc = NULL;
132
133         wclear(menu);
134
135         AST_LIST_TRAVERSE(&cat->members, mem, list) {
136                 if (i < start) {
137                         i++;
138                         continue;
139                 }
140                 wmove(menu, j++, max_x / 2 - 10);
141                 i++;
142                 if (mem->depsfailed)
143                         snprintf(buf, sizeof(buf), "XXX %d.%s %s", i, i < 10 ? " " : "", mem->name);
144                 else
145                         snprintf(buf, sizeof(buf), "[%s] %d.%s %s", mem->enabled ? "*" : " ", i, i < 10 ? " " : "", mem->name);
146                 if (curopt + 1== i)
147                         desc = mem->displayname;
148                 waddstr(menu, buf);
149                 if (i == end)
150                         break;
151         }
152
153         if (desc) {
154                 wmove(menu, end - start + 2, max_x / 2 - 16);
155                 waddstr(menu, desc);
156         }
157         wmove(menu, curopt - start, max_x / 2 - 9);
158
159         wrefresh(menu);
160 }
161
162 int run_category_menu(WINDOW *menu, int cat_num)
163 {
164         struct category *cat;
165         int i = 0;
166         int start = 0;
167         int end = max_y - TITLE_HEIGHT - 6;
168         int c;
169         int curopt = 0;
170         int maxopt;
171
172         AST_LIST_TRAVERSE(&categories, cat, list) {
173                 if (i++ == cat_num)
174                         break;
175         }
176         if (!cat)
177                 return -1;
178
179         maxopt = count_members(cat) - 1;
180
181         draw_category_menu(menu, cat, start, end, curopt);
182
183         while ((c = getch())) {
184                 switch (c) {
185                 case KEY_UP:
186                         if (curopt > 0) {
187                                 curopt--;
188                                 if (curopt < start) {
189                                         start--;
190                                         end--;
191                                 }
192                         }
193                         break;
194                 case KEY_DOWN:
195                         if (curopt < maxopt) {
196                                 curopt++;
197                                 if (curopt > end - 1) {
198                                         start++;
199                                         end++;
200                                 }
201                         }
202                         break;
203                 case KEY_NPAGE:
204                         /* XXX Move down the list by PAGE_OFFSET */
205                         break;
206                 case KEY_PPAGE:
207                         /* XXX Move up the list by PAGE_OFFSET */
208                         break;
209                 case KEY_LEFT:
210                 case 27:        /* Esc key */
211                         return 0;
212                 case KEY_RIGHT:
213                 case KEY_ENTER:
214                 case '\n':
215                 case ' ':
216                         toggle_enabled(cat, curopt);
217                         break;
218                 case 'h':
219                 case 'H':
220                         show_help(menu);
221                         break;
222                 case KEY_F(7):
223                         set_all(cat, 0);
224                         break;
225                 case KEY_F(8):
226                         set_all(cat, 1);
227                 default:
228                         break;  
229                 }
230                 if (c == 'x' || c == 'q')
231                         break;  
232                 draw_category_menu(menu, cat, start, end, curopt);
233         }
234
235         wrefresh(menu);
236
237         return c;
238 }
239
240 void draw_title_window(WINDOW *title)
241 {
242         wmove(title, 1, (max_x / 2) - (strlen(MENU_TITLE1) / 2));
243         waddstr(title, MENU_TITLE1);
244         wmove(title, 2, (max_x / 2) - (strlen(MENU_TITLE2) / 2));
245         waddstr(title, MENU_TITLE2);
246         wmove(title, 3, (max_x / 2) - (strlen(MENU_TITLE3) / 2));
247         waddstr(title, MENU_TITLE3);
248         wmove(title, 5, (max_x / 2) - (strlen(MENU_HELP) / 2));
249         waddstr(title, MENU_HELP);
250         wrefresh(title);
251 }
252
253
254
255 int run_menu(void)
256 {
257         WINDOW *title;
258         WINDOW *menu;
259         int maxopt;
260         int curopt = 0;
261         int c;
262         int res = 0;
263
264         initscr();
265         getmaxyx(stdscr, max_y, max_x);
266         signal(SIGWINCH, winch_handler); /* handle window resizing in xterm */
267
268         if (max_x < MIN_X - 1 || max_y < MIN_Y - 1) {
269                 fprintf(stderr, "Terminal must be at least %d x %d.\n", MIN_X, MIN_Y);
270                 endwin();
271                 return -1;
272         }
273
274         cbreak(); /* don't buffer input until the enter key is pressed */
275         noecho(); /* don't echo user input to the screen */
276         keypad(stdscr, TRUE); /* allow the use of arrow keys */
277         clear();
278         refresh();
279
280         maxopt = count_categories() - 1;
281         
282         /* We have two windows - the title window at the top, and the menu window gets the rest */
283         title = newwin(TITLE_HEIGHT, max_x, 0, 0);
284         menu = newwin(max_y - TITLE_HEIGHT, max_x, TITLE_HEIGHT, 0);
285         draw_title_window(title);       
286         draw_main_menu(menu, curopt);
287         
288         while ((c = getch())) {
289                 switch (c) {
290                 case KEY_UP:
291                         if (curopt > 0)
292                                 curopt--;
293                         break;
294                 case KEY_DOWN:
295                         if (curopt < maxopt)
296                                 curopt++;
297                         break;
298                 case KEY_RIGHT:
299                 case KEY_ENTER:
300                 case '\n':
301                 case ' ':
302                         c = run_category_menu(menu, curopt);
303                         break;
304                 case 'h':
305                 case 'H':
306                         show_help(menu);
307                 default:
308                         break;  
309                 }
310                 if (c == 'q' || c == 'Q' || c == 27) {
311                         res = -1;
312                         break;
313                 }
314                 if (c == 'x' || c == 'X' || c == 's' || c == 'S')
315                         break;  
316                 draw_main_menu(menu, curopt);
317         }
318
319         endwin();
320
321         return res;
322 }