ui/ncurses: Add device hierarchy
[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 #include <stdlib.h>
27 #include <wctype.h>
28 #include <util/util.h>
29
30 #include "log/log.h"
31 #include "talloc/talloc.h"
32 #include "ui/common/ui-system.h"
33 #include "nc-cui.h"
34 #include "nc-menu.h"
35
36 /**
37  * pmenu_exit_cb - Callback helper that runs run menu.on_exit().
38  */
39
40 int pmenu_exit_cb(struct pmenu_item *item)
41 {
42         assert(item->pmenu->on_exit);
43         item->pmenu->on_exit(item->pmenu);
44         return 0;
45 }
46
47 /**
48  * pmenu_find_selected - Find the selected pmenu_item.
49  */
50
51 struct pmenu_item *pmenu_find_selected(struct pmenu *menu)
52 {
53         return pmenu_item_from_arg(item_userptr(current_item(menu->ncm)));
54 }
55
56 static int pmenu_post(struct nc_scr *scr)
57 {
58         int result;
59         struct pmenu *menu = pmenu_from_scr(scr);
60
61         result = post_menu(menu->ncm);
62
63         nc_scr_frame_draw(scr);
64         redrawwin(menu->scr.main_ncw);
65         wrefresh(menu->scr.main_ncw);
66
67         return result;
68 }
69
70 static int pmenu_unpost(struct nc_scr *scr)
71 {
72         return unpost_menu(pmenu_from_scr(scr)->ncm);
73 }
74
75 static void pmenu_resize(struct nc_scr *scr)
76 {
77         /* FIXME: menus can't be resized, need to recreate here */
78         pmenu_unpost(scr);
79         pmenu_post(scr);
80 }
81
82 static int pmenu_item_destructor(void *arg)
83 {
84         struct pmenu_item *item = arg;
85         free_item(item->nci);
86         return 0;
87 }
88
89 static const char *pmenu_item_label(struct pmenu_item *item, const char *name)
90 {
91         static int invalid_idx;
92         unsigned int i;
93         wchar_t *tmp;
94         char *label;
95         size_t len;
96
97         len = mbstowcs(NULL, name, 0);
98
99         /* if we have an invalid multibyte sequence, create an entirely
100          * new name, indicating that we had invalid input */
101         if (len == SIZE_MAX) {
102                 name = talloc_asprintf(item, "!Invalid option %d\n",
103                                 ++invalid_idx);
104                 return name;
105         }
106
107         tmp = talloc_array(item, wchar_t, len + 1);
108         mbstowcs(tmp, name, len + 1);
109
110         /* replace anything unprintable with U+FFFD REPLACEMENT CHARACTER */
111         for (i = 0; i < len; i++) {
112                 if (!iswprint(tmp[i]))
113                         tmp[i] = 0xfffd;
114         }
115
116         len = wcstombs(NULL, tmp, 0);
117         label = talloc_array(item, char, len + 1);
118         wcstombs(label, tmp, len + 1);
119
120         pb_log("%s: %s\n", __func__, label);
121
122         talloc_free(tmp);
123         return label;
124 }
125
126 /**
127  * pmenu_item_create - Allocate and initialize a new pmenu_item instance.
128  *
129  * Returns a pointer the the initialized struct pmenu_item instance or NULL
130  * on error. The caller is responsible for calling talloc_free() for the
131  * returned instance.
132  */
133 struct pmenu_item *pmenu_item_create(struct pmenu *menu, const char *name)
134 {
135         struct pmenu_item *item = talloc_zero(menu, struct pmenu_item);
136         const char *label;
137
138         label = pmenu_item_label(item, name);
139
140         item->i_sig = pb_item_sig;
141         item->pmenu = menu;
142         item->nci = new_item(label, NULL);
143
144         if (!item->nci) {
145                 talloc_free(item);
146                 return NULL;
147         }
148
149         talloc_set_destructor(item, pmenu_item_destructor);
150
151         set_item_userptr(item->nci, item);
152
153         return item;
154 }
155
156 void pmenu_item_insert(struct pmenu *menu, struct pmenu_item *item,
157         unsigned int index)
158 {
159         assert(item);
160         assert(index < menu->item_count);
161         assert(menu->items[index] == NULL);
162         assert(menu_items(menu->ncm) == NULL);
163
164         menu->items[index] = item->nci;
165 }
166
167 /**
168  * pmenu_item_add - Insert item into appropriate position
169  *
170  * Inserts boot entry under matching, predefined device header entry,
171  * moving items in the list if necessary
172  */
173
174 void pmenu_item_add(struct pmenu *menu, struct pmenu_item *item,
175         unsigned int insert_pt)
176 {
177         struct cui_opt_data *cod = item->data;
178         bool found = false;
179         unsigned int dev;
180
181         /* Items array should already be disconnected */
182
183         for (dev = 0; dev < menu->item_count; dev++) {
184                 if (!menu->items[dev])
185                         continue;
186
187                 struct pmenu_item *i = item_userptr(menu->items[dev]);
188                 struct cui_opt_data *d = i->data;
189                 /* Device header will have opt == NULL */
190                 if (d && !d->opt) {
191                         if (cod->dev == d->dev) {
192                                 found = true;
193                                 break;
194                         }
195                 }
196         }
197
198         if (found) {
199                 assert(dev < insert_pt);
200                 /* Shift down entries between header and insert_pt */
201                 memmove(menu->items + dev + 2, menu->items + dev + 1,
202                         ((menu->items + insert_pt) - (menu->items + dev + 1))
203                         * sizeof(menu->items[0]));
204                 memset(menu->items + dev + 1, 0, sizeof(menu->items[0]));
205                 insert_pt = dev + 1;
206         }
207         /* If for some reason we didn't find the matching device,
208          * at least add it to a valid position */
209         pmenu_item_insert(menu, item, insert_pt);
210 }
211
212 /**
213  * pmenu_find_device - Determine if a boot option is new, and if
214  * so return a new pmenu_item to represent its parent device
215  */
216
217 struct pmenu_item *pmenu_find_device(struct pmenu *menu, struct device *dev,
218         struct boot_option *opt)
219 {
220         struct pmenu_item *item, *dev_hdr = NULL;
221         struct cui *cui = cui_from_pmenu(menu);
222         bool newdev = true, matched = false;
223         struct interface_info *intf;
224         struct blockdev_info *bd;
225         struct cui_opt_data *cod;
226         struct system_info *sys;
227         char hwaddr[32];
228         unsigned int i;
229         char buf[256];
230
231         for (i = 0; i < menu->item_count; i++) {
232                 item = item_userptr(menu->items[i]);
233                 cod = item->data;
234                 /* boot entries will have opt defined */
235                 if (!cod || cod->opt)
236                         continue;
237                 if (cod->dev == dev) {
238                         pb_debug("%s: opt %s fits under %s\n",__func__,
239                                  opt->name, opt->device_id);
240                         newdev = false;
241                         break;
242                 }
243         }
244
245         if (!newdev) {
246                 pb_debug("%s: No new device\n",__func__);
247                 return NULL;
248         }
249
250         /* Create a dummy pmenu_item to represent the dev */
251         pb_debug("%s: Building new item\n",__func__);
252         sys = cui->sysinfo;
253         switch (dev->type) {
254         case DEVICE_TYPE_OPTICAL:
255         case DEVICE_TYPE_DISK:
256                 /* Find block info */
257                 for (i = 0; sys && i < sys->n_blockdevs; i++) {
258                         bd = sys->blockdevs[i];
259                         if (!strcmp(opt->device_id, bd->name)) {
260                                 matched = true;
261                                 break;
262                         }
263                 }
264                 if (matched) {
265                         snprintf(buf,sizeof(buf),"[%s: %s / %s]",
266                                 dev->type == DEVICE_TYPE_DISK ?
267                                 "Disk" : "CD/DVD",
268                                 bd->name, bd->uuid);
269                 }
270                 break;
271
272         case DEVICE_TYPE_NETWORK:
273                 /* Find interface info */
274                 for (i = 0; sys && i < sys->n_interfaces; i++) {
275                         intf = sys->interfaces[i];
276                         if (!strcmp(opt->device_id, intf->name)) {
277                                 matched = true;
278                                 break;
279                         }
280                 }
281                 if (matched) {
282                         mac_str(intf->hwaddr, intf->hwaddr_size,
283                                 hwaddr, sizeof(hwaddr));
284                         snprintf(buf,sizeof(buf),"[Interface %s / %s]",
285                                 intf->name, hwaddr);
286                 }
287                 break;
288
289         default:
290                 /* Assume the device may be able to boot */
291                 break;
292         }
293         if (!matched) {
294                 pb_debug("%s: No matching device found for %s (%s)\n",
295                         __func__,opt->device_id, dev->id);
296                 snprintf(buf,sizeof(buf),"[Unknown Device: %s]",
297                         dev->id);
298         }
299
300         dev_hdr = pmenu_item_create(menu, buf);
301         if (!dev_hdr) {
302                 pb_log("%s: Failed to create item\n",__func__);
303                 return NULL;
304         }
305
306         dev_hdr->on_execute = NULL;
307         item_opts_off(dev_hdr->nci, O_SELECTABLE);
308
309         /* We identify dev_hdr items as having a valid c->name,
310          * but a NULL c->opt */
311         cod = talloc(dev_hdr, struct cui_opt_data);
312         cod->name = talloc_strdup(dev_hdr, opt->device_id);
313         cod->dev = dev;
314         cod->opt = NULL;
315         dev_hdr->data = cod;
316
317         pb_debug("%s: returning %s\n",__func__,cod->name);
318         return dev_hdr;
319 }
320
321 static int pmenu_item_get_index(const struct pmenu_item *item)
322 {
323         unsigned int i;
324
325         for (i = 0; i < item->pmenu->item_count; i++)
326                 if (item->pmenu->items[i] == item->nci)
327                         return i;
328
329         pb_log("%s: not found: %p %s\n", __func__, item,
330                 (item ? item->nci->name.str : "(null)"));
331         return -1;
332 }
333
334 /**
335  * pmenu_move_cursor - Move the cursor.
336  * @req: An ncurses request or char to send to menu_driver().
337  */
338
339 static void pmenu_move_cursor(struct pmenu *menu, int req)
340 {
341         menu_driver(menu->ncm, req);
342         wrefresh(menu->scr.main_ncw);
343 }
344
345 /**
346  * pmenu_process_key - Process a user keystroke.
347  */
348
349 static void pmenu_process_key(struct nc_scr *scr, int key)
350 {
351         struct pmenu *menu = pmenu_from_scr(scr);
352         struct pmenu_item *item = pmenu_find_selected(menu);
353
354         nc_scr_status_free(&menu->scr);
355
356         if (menu->hot_key)
357                 key = menu->hot_key(menu, item, key);
358
359         switch (key) {
360         case 27: /* ESC */
361         case 'x':
362                 if (menu->on_exit)
363                         menu->on_exit(menu);
364                 nc_flush_keys();
365                 return;
366
367         case KEY_PPAGE:
368                 pmenu_move_cursor(menu, REQ_SCR_UPAGE);
369                 break;
370         case KEY_NPAGE:
371                 pmenu_move_cursor(menu, REQ_SCR_DPAGE);
372                 break;
373         case KEY_HOME:
374                 pmenu_move_cursor(menu, REQ_FIRST_ITEM);
375                 break;
376         case KEY_END:
377                 pmenu_move_cursor(menu, REQ_LAST_ITEM);
378                 break;
379         case KEY_UP:
380                 pmenu_move_cursor(menu, REQ_UP_ITEM);
381                 break;
382         case KEY_BTAB:
383                 pmenu_move_cursor(menu, REQ_PREV_ITEM);
384                 break;
385         case KEY_DOWN:
386                 pmenu_move_cursor(menu, REQ_DOWN_ITEM);
387                 break;
388         case '\t':
389                 pmenu_move_cursor(menu, REQ_NEXT_ITEM);
390                 break;
391         case 'e':
392                 if (item->on_edit)
393                         item->on_edit(item);
394                 break;
395         case 'n':
396                 if (menu->on_new)
397                         menu->on_new(menu);
398                 break;
399         case ' ':
400         case '\n':
401         case '\r':
402                 if (item->on_execute)
403                         item->on_execute(item);
404                 break;
405         case 'i':
406                 cui_show_sysinfo(cui_from_arg(scr->ui_ctx));
407                 break;
408         case 'c':
409                 cui_show_config(cui_from_arg(scr->ui_ctx));
410                 break;
411         case KEY_F(1):
412         case 'h':
413                 if (menu->help_text)
414                         cui_show_help(cui_from_arg(scr->ui_ctx),
415                                         menu->help_title, menu->help_text);
416                 break;
417         default:
418                 menu_driver(menu->ncm, key);
419                 break;
420         }
421 }
422
423 /**
424  * pmenu_grow - Grow the item array.
425  * @count: The count of new items.
426  *
427  * The item array must be disconnected prior to calling pmenu_grow().
428  * Returns the insert point index.
429  */
430
431 unsigned int pmenu_grow(struct pmenu *menu, unsigned int count)
432 {
433         unsigned int tmp;
434
435         assert(item_count(menu->ncm) == 0 && "not disconnected");
436
437         pb_log("%s: %u current + %u new = %u\n", __func__, menu->item_count,
438                 count, menu->item_count + count);
439
440         /* Note that items array has a null terminator. */
441
442         menu->items = talloc_realloc(menu, menu->items, ITEM *,
443                 menu->item_count + count + 1);
444
445         memmove(menu->items + menu->insert_pt + count,
446                 menu->items + menu->insert_pt,
447                 (menu->item_count - menu->insert_pt + 1) * sizeof(ITEM *));
448
449         memset(menu->items + menu->insert_pt, 0, count * sizeof(ITEM *));
450
451         tmp = menu->insert_pt;
452         menu->insert_pt += count;
453         menu->item_count += count;
454
455         return tmp;
456 }
457
458 /**
459  * pmenu_remove - Remove an item from the item array.
460  *
461  * The item array must be disconnected prior to calling pmenu_remove()
462  */
463
464 int pmenu_remove(struct pmenu *menu, struct pmenu_item *item)
465 {
466         int index;
467
468         assert(item_count(menu->ncm) == 0 && "not disconnected");
469
470         assert(menu->item_count);
471
472         pb_log("%s: %u\n", __func__, menu->item_count);
473
474         index = pmenu_item_get_index(item);
475
476         if (index < 0)
477                 return -1;
478
479         talloc_free(item);
480
481         /* Note that items array has a null terminator. */
482
483         menu->insert_pt--;
484         menu->item_count--;
485
486         memmove(&menu->items[index], &menu->items[index + 1],
487                 (menu->item_count - index + 1) * sizeof(ITEM *));
488         menu->items = talloc_realloc(menu, menu->items, ITEM *,
489                 menu->item_count + 1);
490
491         return 0;
492 }
493
494 /**
495  * pmenu_init - Allocate and initialize a new menu instance.
496  *
497  * Returns a pointer the the initialized struct pmenu instance or NULL on error.
498  * The caller is responsible for calling talloc_free() for the returned
499  * instance.
500  */
501
502 struct pmenu *pmenu_init(void *ui_ctx, unsigned int item_count,
503         void (*on_exit)(struct pmenu *))
504 {
505         struct pmenu *menu = talloc_zero(ui_ctx, struct pmenu);
506
507         if (!menu)
508                 return NULL;
509
510         /* note items array has a null terminator */
511
512         menu->items = talloc_zero_array(menu, ITEM *, item_count + 1);
513
514         if (!menu->items) {
515                 talloc_free(menu);
516                 return NULL;
517         }
518
519         nc_scr_init(&menu->scr, pb_pmenu_sig, 0, ui_ctx, pmenu_process_key,
520                 pmenu_post, pmenu_unpost, pmenu_resize);
521
522         menu->item_count = item_count;
523         menu->insert_pt = 0; /* insert from top */
524         menu->on_exit = on_exit;
525
526         return menu;
527 }
528
529 /**
530  * pmenu_setup - Create nc menu, setup nc windows.
531  *
532  */
533
534 int pmenu_setup(struct pmenu *menu)
535 {
536         assert(!menu->ncm);
537
538         menu->ncm = new_menu(menu->items);
539
540         if (!menu->ncm) {
541                 pb_log("%s:%d: new_menu failed: %s\n", __func__, __LINE__,
542                         strerror(errno));
543                 return -1;
544         }
545
546         set_menu_win(menu->ncm, menu->scr.main_ncw);
547         set_menu_sub(menu->ncm, menu->scr.sub_ncw);
548
549         /* Makes menu scrollable. */
550         set_menu_format(menu->ncm, LINES - nc_scr_frame_lines, 1);
551
552         set_menu_grey(menu->ncm, A_NORMAL);
553
554         return 0;
555 }
556
557 /**
558  * pmenu_delete - Delete a menu instance.
559  *
560  */
561
562 void pmenu_delete(struct pmenu *menu)
563 {
564         assert(menu->scr.sig == pb_pmenu_sig);
565         menu->scr.sig = pb_removed_sig;
566
567         unpost_menu(menu->ncm);
568         free_menu(menu->ncm);
569         delwin(menu->scr.sub_ncw);
570         delwin(menu->scr.main_ncw);
571         talloc_free(menu);
572 }