ui/ncurses: unpost ncurses menu in pmenu cleanup path
[petitboot] / ui / ncurses / nc-menu.c
1 /*
2  *  Copyright (C) 2009 Sony Computer Entertainment Inc.
3  *  Copyright 2009 Sony Corp.
4  *
5  *  This program is free software; you can redistribute it and/or modify
6  *  it under the terms of the GNU General Public License as published by
7  *  the Free Software Foundation; version 2 of the License.
8  *
9  *  This program is distributed in the hope that it will be useful,
10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  *  GNU General Public License for more details.
13  *
14  *  You should have received a copy of the GNU General Public License
15  *  along with this program; if not, write to the Free Software
16  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17  */
18
19 #if defined(HAVE_CONFIG_H)
20 #include "config.h"
21 #endif
22
23 #include <assert.h>
24 #include <errno.h>
25 #include <string.h>
26
27 #include "log/log.h"
28 #include "talloc/talloc.h"
29 #include "ui/common/ui-system.h"
30 #include "nc-cui.h"
31 #include "nc-menu.h"
32
33 /**
34  * pmenu_exit_cb - Callback helper that runs run menu.on_exit().
35  */
36
37 int pmenu_exit_cb(struct pmenu_item *item)
38 {
39         assert(item->pmenu->on_exit);
40         item->pmenu->on_exit(item->pmenu);
41         return 0;
42 }
43
44 /**
45  * pmenu_find_selected - Find the selected pmenu_item.
46  */
47
48 struct pmenu_item *pmenu_find_selected(struct pmenu *menu)
49 {
50         return pmenu_item_from_arg(item_userptr(current_item(menu->ncm)));
51 }
52
53 static int pmenu_post(struct nc_scr *scr)
54 {
55         int result;
56         struct pmenu *menu = pmenu_from_scr(scr);
57
58         result = post_menu(menu->ncm);
59
60         nc_scr_frame_draw(scr);
61         redrawwin(menu->scr.main_ncw);
62         wrefresh(menu->scr.main_ncw);
63
64         return result;
65 }
66
67 static int pmenu_unpost(struct nc_scr *scr)
68 {
69         return unpost_menu(pmenu_from_scr(scr)->ncm);
70 }
71
72 static void pmenu_resize(struct nc_scr *scr)
73 {
74         /* FIXME: menus can't be resized, need to recreate here */
75         pmenu_unpost(scr);
76         pmenu_post(scr);
77 }
78
79 static int pmenu_item_destructor(void *arg)
80 {
81         struct pmenu_item *item = arg;
82         free_item(item->nci);
83         return 0;
84 }
85
86 /**
87  * pmenu_item_create - Allocate and initialize a new pmenu_item instance.
88  *
89  * Returns a pointer the the initialized struct pmenu_item instance or NULL
90  * on error. The caller is responsible for calling talloc_free() for the
91  * returned instance.
92  */
93 struct pmenu_item *pmenu_item_create(struct pmenu *menu, const char *name)
94 {
95         struct pmenu_item *item = talloc_zero(menu, struct pmenu_item);
96
97         item->i_sig = pb_item_sig;
98         item->pmenu = menu;
99         item->nci = new_item(name, NULL);
100
101         if (!item->nci) {
102                 talloc_free(item);
103                 return NULL;
104         }
105
106         talloc_set_destructor(item, pmenu_item_destructor);
107
108         set_item_userptr(item->nci, item);
109
110         return item;
111 }
112
113 void pmenu_item_insert(struct pmenu *menu, struct pmenu_item *item,
114         unsigned int index)
115 {
116         assert(item);
117         assert(index < menu->item_count);
118         assert(menu->items[index] == NULL);
119         assert(menu_items(menu->ncm) == NULL);
120
121         menu->items[index] = item->nci;
122 }
123
124 static int pmenu_item_get_index(const struct pmenu_item *item)
125 {
126         unsigned int i;
127
128         for (i = 0; i < item->pmenu->item_count; i++)
129                 if (item->pmenu->items[i] == item->nci)
130                         return i;
131
132         pb_log("%s: not found: %p %s\n", __func__, item,
133                 (item ? item->nci->name.str : "(null)"));
134         return -1;
135 }
136
137 /**
138  * pmenu_move_cursor - Move the cursor.
139  * @req: An ncurses request or char to send to menu_driver().
140  */
141
142 static void pmenu_move_cursor(struct pmenu *menu, int req)
143 {
144         menu_driver(menu->ncm, req);
145         wrefresh(menu->scr.main_ncw);
146 }
147
148 /**
149  * pmenu_process_key - Process a user keystroke.
150  */
151
152 static void pmenu_process_key(struct nc_scr *scr, int key)
153 {
154         struct pmenu *menu = pmenu_from_scr(scr);
155         struct pmenu_item *item = pmenu_find_selected(menu);
156
157         nc_scr_status_free(&menu->scr);
158
159         if (menu->hot_key)
160                 key = menu->hot_key(menu, item, key);
161
162         switch (key) {
163         case 27: /* ESC */
164         case 'x':
165                 if (menu->on_exit)
166                         menu->on_exit(menu);
167                 nc_flush_keys();
168                 return;
169
170         case KEY_PPAGE:
171                 pmenu_move_cursor(menu, REQ_SCR_UPAGE);
172                 break;
173         case KEY_NPAGE:
174                 pmenu_move_cursor(menu, REQ_SCR_DPAGE);
175                 break;
176         case KEY_HOME:
177                 pmenu_move_cursor(menu, REQ_FIRST_ITEM);
178                 break;
179         case KEY_END:
180                 pmenu_move_cursor(menu, REQ_LAST_ITEM);
181                 break;
182         case KEY_UP:
183                 pmenu_move_cursor(menu, REQ_UP_ITEM);
184                 break;
185         case KEY_BTAB:
186                 pmenu_move_cursor(menu, REQ_PREV_ITEM);
187                 break;
188         case KEY_DOWN:
189                 pmenu_move_cursor(menu, REQ_DOWN_ITEM);
190                 break;
191         case '\t':
192                 pmenu_move_cursor(menu, REQ_NEXT_ITEM);
193                 break;
194         case 'e':
195                 if (item->on_edit)
196                         item->on_edit(item);
197                 break;
198         case 'n':
199                 if (menu->on_new)
200                         menu->on_new(menu);
201                 break;
202         case ' ':
203         case '\n':
204         case '\r':
205                 if (item->on_execute)
206                         item->on_execute(item);
207                 break;
208         case 'i':
209                 cui_show_sysinfo(cui_from_arg(scr->ui_ctx));
210                 break;
211         case 'c':
212                 cui_show_config(cui_from_arg(scr->ui_ctx));
213                 break;
214         case KEY_F(1):
215         case 'h':
216                 if (menu->help_text)
217                         cui_show_help(cui_from_arg(scr->ui_ctx),
218                                         menu->help_title, menu->help_text);
219                 break;
220         default:
221                 menu_driver(menu->ncm, key);
222                 break;
223         }
224 }
225
226 /**
227  * pmenu_grow - Grow the item array.
228  * @count: The count of new items.
229  *
230  * The item array must be disconnected prior to calling pmenu_grow().
231  * Returns the insert point index.
232  */
233
234 unsigned int pmenu_grow(struct pmenu *menu, unsigned int count)
235 {
236         unsigned int tmp;
237
238         assert(item_count(menu->ncm) == 0 && "not disconnected");
239
240         pb_log("%s: %u current + %u new = %u\n", __func__, menu->item_count,
241                 count, menu->item_count + count);
242
243         /* Note that items array has a null terminator. */
244
245         menu->items = talloc_realloc(menu, menu->items, ITEM *,
246                 menu->item_count + count + 1);
247
248         memmove(menu->items + menu->insert_pt + count,
249                 menu->items + menu->insert_pt,
250                 (menu->item_count - menu->insert_pt + 1) * sizeof(ITEM *));
251
252         memset(menu->items + menu->insert_pt, 0, count * sizeof(ITEM *));
253
254         tmp = menu->insert_pt;
255         menu->insert_pt += count;
256         menu->item_count += count;
257
258         return tmp;
259 }
260
261 /**
262  * pmenu_remove - Remove an item from the item array.
263  *
264  * The item array must be disconnected prior to calling pmenu_remove()
265  */
266
267 int pmenu_remove(struct pmenu *menu, struct pmenu_item *item)
268 {
269         int index;
270
271         assert(item_count(menu->ncm) == 0 && "not disconnected");
272
273         assert(menu->item_count);
274
275         pb_log("%s: %u\n", __func__, menu->item_count);
276
277         index = pmenu_item_get_index(item);
278
279         if (index < 0)
280                 return -1;
281
282         talloc_free(item);
283
284         /* Note that items array has a null terminator. */
285
286         menu->insert_pt--;
287         menu->item_count--;
288
289         memmove(&menu->items[index], &menu->items[index + 1],
290                 (menu->item_count - index + 1) * sizeof(ITEM *));
291         menu->items = talloc_realloc(menu, menu->items, ITEM *,
292                 menu->item_count + 1);
293
294         return 0;
295 }
296
297 /**
298  * pmenu_init - Allocate and initialize a new menu instance.
299  *
300  * Returns a pointer the the initialized struct pmenu instance or NULL on error.
301  * The caller is responsible for calling talloc_free() for the returned
302  * instance.
303  */
304
305 struct pmenu *pmenu_init(void *ui_ctx, unsigned int item_count,
306         void (*on_exit)(struct pmenu *))
307 {
308         struct pmenu *menu = talloc_zero(ui_ctx, struct pmenu);
309
310         if (!menu)
311                 return NULL;
312
313         /* note items array has a null terminator */
314
315         menu->items = talloc_zero_array(menu, ITEM *, item_count + 1);
316
317         if (!menu->items) {
318                 talloc_free(menu);
319                 return NULL;
320         }
321
322         nc_scr_init(&menu->scr, pb_pmenu_sig, 0, ui_ctx, pmenu_process_key,
323                 pmenu_post, pmenu_unpost, pmenu_resize);
324
325         menu->item_count = item_count;
326         menu->insert_pt = 0; /* insert from top */
327         menu->on_exit = on_exit;
328
329         return menu;
330 }
331
332 /**
333  * pmenu_setup - Create nc menu, setup nc windows.
334  *
335  */
336
337 int pmenu_setup(struct pmenu *menu)
338 {
339         assert(!menu->ncm);
340
341         menu->ncm = new_menu(menu->items);
342
343         if (!menu->ncm) {
344                 pb_log("%s:%d: new_menu failed: %s\n", __func__, __LINE__,
345                         strerror(errno));
346                 return -1;
347         }
348
349         set_menu_win(menu->ncm, menu->scr.main_ncw);
350         set_menu_sub(menu->ncm, menu->scr.sub_ncw);
351
352         /* Makes menu scrollable. */
353         set_menu_format(menu->ncm, LINES - nc_scr_frame_lines, 1);
354
355         set_menu_grey(menu->ncm, A_NORMAL);
356
357         return 0;
358 }
359
360 /**
361  * pmenu_delete - Delete a menu instance.
362  *
363  */
364
365 void pmenu_delete(struct pmenu *menu)
366 {
367         assert(menu->scr.sig == pb_pmenu_sig);
368         menu->scr.sig = pb_removed_sig;
369
370         unpost_menu(menu->ncm);
371         free_menu(menu->ncm);
372         delwin(menu->scr.sub_ncw);
373         delwin(menu->scr.main_ncw);
374         talloc_free(menu);
375 }