ui/ncurses: Don't free item in pmenu_item_setup
[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 /**
80  * pmenu_item_init - Allocate and initialize a new pmenu_item instance.
81  *
82  * Returns a pointer the the initialized struct pmenu_item instance or NULL
83  * on error. The caller is responsible for calling talloc_free() for the
84  * returned instance.
85  */
86
87 struct pmenu_item *pmenu_item_alloc(struct pmenu *menu)
88 {
89         /* Items go with the menu, not the pointer array. */
90
91         struct pmenu_item *i = talloc_zero(menu, struct pmenu_item);
92
93         return i;
94 }
95
96 struct pmenu_item *pmenu_item_setup(struct pmenu *menu, struct pmenu_item *i,
97         unsigned int index, const char *name)
98 {
99         assert(i);
100         assert(name);
101
102         if (!i)
103                 return NULL;
104
105         i->i_sig = pb_item_sig;
106         i->pmenu = menu;
107         i->nci = new_item(name, NULL);
108
109         if (!i->nci)
110                 return NULL;
111
112         set_item_userptr(i->nci, i);
113
114         menu->items[index] = i->nci;
115
116         return i;
117 }
118
119 static int pmenu_item_get_index(const struct pmenu_item *item)
120 {
121         unsigned int i;
122
123         for (i = 0; i < item->pmenu->item_count; i++)
124                 if (item->pmenu->items[i] == item->nci)
125                         return i;
126
127         pb_log("%s: not found: %p %s\n", __func__, item,
128                 (item ? item->nci->name.str : "(null)"));
129         return -1;
130 }
131
132 /**
133  * pmenu_item_replace - Replace the menu item with a new one.
134  *
135  * Use this routine to change a menu item's text.
136  */
137
138 int pmenu_item_replace(struct pmenu_item *i, const char *name)
139 {
140         struct pmenu *menu;
141         ITEM *nci;
142         int index;
143
144         assert(name);
145         assert(i->nci);
146
147         menu = i->pmenu;
148         index = pmenu_item_get_index(i);
149
150         if (index < 0) {
151                 assert(0 && "get_index failed");
152                 return -1;
153         }
154
155         nci = new_item(name, NULL);
156
157         if (!nci) {
158                 assert(0 && "new_item failed");
159                 return -1;
160         }
161
162         set_item_userptr(nci, i);
163
164         nc_scr_unpost(&menu->scr);
165         set_menu_items(menu->ncm, NULL);
166
167         // FIXME: need to assure item name is a talloc string.
168         /* talloc_free((char *)item_name(i->nci)); */
169
170         free_item(i->nci);
171         menu->items[index] = nci;
172         i->nci = nci;
173
174         set_menu_items(menu->ncm, menu->items);
175         nc_scr_post(&menu->scr);
176
177         return 0;
178 }
179
180 /**
181  * pmenu_move_cursor - Move the cursor.
182  * @req: An ncurses request or char to send to menu_driver().
183  */
184
185 static void pmenu_move_cursor(struct pmenu *menu, int req)
186 {
187         menu_driver(menu->ncm, req);
188         wrefresh(menu->scr.main_ncw);
189 }
190
191 /**
192  * pmenu_process_key - Process a user keystroke.
193  */
194
195 static void pmenu_process_key(struct nc_scr *scr, int key)
196 {
197         struct pmenu *menu = pmenu_from_scr(scr);
198         struct pmenu_item *item = pmenu_find_selected(menu);
199
200         nc_scr_status_free(&menu->scr);
201
202         if (menu->hot_key)
203                 key = menu->hot_key(menu, item, key);
204
205         switch (key) {
206         case 27: /* ESC */
207         case 'x':
208                 if (menu->on_exit)
209                         menu->on_exit(menu);
210                 nc_flush_keys();
211                 return;
212
213         case KEY_PPAGE:
214                 pmenu_move_cursor(menu, REQ_SCR_UPAGE);
215                 break;
216         case KEY_NPAGE:
217                 pmenu_move_cursor(menu, REQ_SCR_DPAGE);
218                 break;
219         case KEY_HOME:
220                 pmenu_move_cursor(menu, REQ_FIRST_ITEM);
221                 break;
222         case KEY_END:
223                 pmenu_move_cursor(menu, REQ_LAST_ITEM);
224                 break;
225         case KEY_UP:
226                 pmenu_move_cursor(menu, REQ_UP_ITEM);
227                 break;
228         case KEY_BTAB:
229                 pmenu_move_cursor(menu, REQ_PREV_ITEM);
230                 break;
231         case KEY_DOWN:
232                 pmenu_move_cursor(menu, REQ_DOWN_ITEM);
233                 break;
234         case '\t':
235                 pmenu_move_cursor(menu, REQ_NEXT_ITEM);
236                 break;
237         case 'e':
238                 if (item->on_edit)
239                         item->on_edit(item);
240                 break;
241         case 'n':
242                 if (menu->on_new)
243                         menu->on_new(menu);
244                 break;
245         case ' ':
246         case '\n':
247         case '\r':
248                 if (item->on_execute)
249                         item->on_execute(item);
250                 break;
251         case 'i':
252                 cui_show_sysinfo(cui_from_arg(scr->ui_ctx));
253                 break;
254         case 'c':
255                 cui_show_config(cui_from_arg(scr->ui_ctx));
256                 break;
257         case KEY_F(1):
258         case 'h':
259                 if (menu->help_text)
260                         cui_show_help(cui_from_arg(scr->ui_ctx),
261                                         menu->help_title, menu->help_text);
262                 break;
263         default:
264                 menu_driver(menu->ncm, key);
265                 break;
266         }
267 }
268
269 /**
270  * pmenu_grow - Grow the item array.
271  * @count: The count of new items.
272  *
273  * The item array must be disconnected prior to calling pmenu_grow().
274  * Returns the insert point index.
275  */
276
277 unsigned int pmenu_grow(struct pmenu *menu, unsigned int count)
278 {
279         unsigned int tmp;
280
281         assert(item_count(menu->ncm) == 0 && "not disconnected");
282
283         pb_log("%s: %u current + %u new = %u\n", __func__, menu->item_count,
284                 count, menu->item_count + count);
285
286         /* Note that items array has a null terminator. */
287
288         menu->items = talloc_realloc(menu, menu->items, ITEM *,
289                 menu->item_count + count + 1);
290
291         memmove(menu->items + menu->insert_pt + count,
292                 menu->items + menu->insert_pt,
293                 (menu->item_count - menu->insert_pt + 1) * sizeof(ITEM *));
294
295         memset(menu->items + menu->insert_pt, 0, count * sizeof(ITEM *));
296
297         tmp = menu->insert_pt;
298         menu->insert_pt += count;
299         menu->item_count += count;
300
301         return tmp;
302 }
303
304 /**
305  * pmenu_remove - Remove an item from the item array.
306  *
307  * The item array must be disconnected prior to calling pmenu_remove()
308  */
309
310 int pmenu_remove(struct pmenu *menu, struct pmenu_item *item)
311 {
312         int index;
313
314         assert(item_count(menu->ncm) == 0 && "not disconnected");
315
316         assert(menu->item_count);
317
318         pb_log("%s: %u\n", __func__, menu->item_count);
319
320         index = pmenu_item_get_index(item);
321
322         if (index < 0)
323                 return -1;
324
325         free_item(item->nci);
326         talloc_free(item);
327
328         /* Note that items array has a null terminator. */
329
330         menu->insert_pt--;
331         menu->item_count--;
332
333         memmove(&menu->items[index], &menu->items[index + 1],
334                 (menu->item_count - index + 1) * sizeof(ITEM *));
335         menu->items = talloc_realloc(menu, menu->items, ITEM *,
336                 menu->item_count + 1);
337
338         return 0;
339 }
340
341 /**
342  * pmenu_init - Allocate and initialize a new menu instance.
343  *
344  * Returns a pointer the the initialized struct pmenu instance or NULL on error.
345  * The caller is responsible for calling talloc_free() for the returned
346  * instance.
347  */
348
349 struct pmenu *pmenu_init(void *ui_ctx, unsigned int item_count,
350         void (*on_exit)(struct pmenu *))
351 {
352         struct pmenu *menu = talloc_zero(ui_ctx, struct pmenu);
353
354         if (!menu)
355                 return NULL;
356
357         /* note items array has a null terminator */
358
359         menu->items = talloc_zero_array(menu, ITEM *, item_count + 1);
360
361         if (!menu->items) {
362                 talloc_free(menu);
363                 return NULL;
364         }
365
366         nc_scr_init(&menu->scr, pb_pmenu_sig, 0, ui_ctx, pmenu_process_key,
367                 pmenu_post, pmenu_unpost, pmenu_resize);
368
369         menu->item_count = item_count;
370         menu->insert_pt = 0; /* insert from top */
371         menu->on_exit = on_exit;
372
373         return menu;
374 }
375
376 /**
377  * pmenu_setup - Create nc menu, setup nc windows.
378  *
379  */
380
381 int pmenu_setup(struct pmenu *menu)
382 {
383         assert(!menu->ncm);
384
385         menu->ncm = new_menu(menu->items);
386
387         if (!menu->ncm) {
388                 pb_log("%s:%d: new_menu failed: %s\n", __func__, __LINE__,
389                         strerror(errno));
390                 return -1;
391         }
392
393         set_menu_win(menu->ncm, menu->scr.main_ncw);
394         set_menu_sub(menu->ncm, menu->scr.sub_ncw);
395
396         /* Makes menu scrollable. */
397         set_menu_format(menu->ncm, LINES - nc_scr_frame_lines, 1);
398
399         set_menu_grey(menu->ncm, A_NORMAL);
400
401         return 0;
402 }
403
404 /**
405  * pmenu_delete - Delete a menu instance.
406  *
407  */
408
409 void pmenu_delete(struct pmenu *menu)
410 {
411         unsigned int i;
412
413         assert(menu->scr.sig == pb_pmenu_sig);
414         menu->scr.sig = pb_removed_sig;
415
416         for (i = item_count(menu->ncm); i; i--)
417                 free_item(menu->items[i - 1]);
418
419         free_menu(menu->ncm);
420         delwin(menu->scr.sub_ncw);
421         delwin(menu->scr.main_ncw);
422         talloc_free(menu);
423 }