2 * Copyright (C) 2009 Sony Computer Entertainment Inc.
3 * Copyright 2009 Sony Corp.
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.
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.
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
19 #if defined(HAVE_CONFIG_H)
28 #include <util/util.h>
31 #include "talloc/talloc.h"
32 #include "i18n/i18n.h"
33 #include "ui/common/ui-system.h"
38 * pmenu_exit_cb - Callback helper that runs run menu.on_exit().
41 int pmenu_exit_cb(struct pmenu_item *item)
43 assert(item->pmenu->on_exit);
44 item->pmenu->on_exit(item->pmenu);
49 * pmenu_find_selected - Find the selected pmenu_item.
52 struct pmenu_item *pmenu_find_selected(struct pmenu *menu)
54 return pmenu_item_from_arg(item_userptr(current_item(menu->ncm)));
57 static int pmenu_post(struct nc_scr *scr)
60 struct pmenu *menu = pmenu_from_scr(scr);
62 result = post_menu(menu->ncm);
64 nc_scr_frame_draw(scr);
65 wrefresh(menu->scr.main_ncw);
70 static int pmenu_unpost(struct nc_scr *scr)
72 return unpost_menu(pmenu_from_scr(scr)->ncm);
75 static void pmenu_resize(struct nc_scr *scr)
77 /* FIXME: menus can't be resized, need to recreate here */
82 static int pmenu_item_destructor(void *arg)
84 struct pmenu_item *item = arg;
89 static const char *pmenu_item_label(struct pmenu_item *item, const char *name)
91 static int invalid_idx;
97 len = mbstowcs(NULL, name, 0);
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"),
107 tmp = talloc_array(item, wchar_t, len + 1);
108 mbstowcs(tmp, name, len + 1);
110 /* replace anything unprintable with U+FFFD REPLACEMENT CHARACTER */
111 for (i = 0; i < len; i++) {
112 if (!iswprint(tmp[i]))
116 len = wcstombs(NULL, tmp, 0);
117 label = talloc_array(item, char, len + 1);
118 wcstombs(label, tmp, len + 1);
120 pb_log("%s: %s\n", __func__, label);
127 * pmenu_item_update - Update the label of an existing pmenu_item.
129 * The item array must be disconnected prior to calling.
131 int pmenu_item_update(struct pmenu_item *item, const char *name)
136 if (!item || !item->nci)
139 label = pmenu_item_label(item, name);
146 i->name.length = strncols(label);
152 * pmenu_item_create - Allocate and initialize a new pmenu_item instance.
154 * Returns a pointer the the initialized struct pmenu_item instance or NULL
155 * on error. The caller is responsible for calling talloc_free() for the
158 struct pmenu_item *pmenu_item_create(struct pmenu *menu, const char *name)
160 struct pmenu_item *item = talloc_zero(menu, struct pmenu_item);
163 label = pmenu_item_label(item, name);
165 item->i_sig = pb_item_sig;
167 item->nci = new_item(label, NULL);
174 talloc_set_destructor(item, pmenu_item_destructor);
176 set_item_userptr(item->nci, item);
181 void pmenu_item_insert(struct pmenu *menu, struct pmenu_item *item,
185 assert(index < menu->item_count);
186 assert(menu->items[index] == NULL);
187 assert(menu_items(menu->ncm) == NULL);
189 menu->items[index] = item->nci;
193 * pmenu_item_add - Insert item into appropriate position
195 * Inserts boot entry under matching, predefined device header entry,
196 * moving items in the list if necessary
199 void pmenu_item_add(struct pmenu *menu, struct pmenu_item *item,
200 unsigned int insert_pt)
202 struct cui_opt_data *cod = item->data;
206 /* Items array should already be disconnected */
208 for (dev = 0; dev < menu->item_count; dev++) {
209 if (!menu->items[dev])
212 struct pmenu_item *i = item_userptr(menu->items[dev]);
213 struct cui_opt_data *d = i->data;
214 /* Device header will have opt == NULL */
216 if (cod->dev == d->dev) {
224 assert(dev < insert_pt);
225 /* Shift down entries between header and insert_pt */
226 memmove(menu->items + dev + 2, menu->items + dev + 1,
227 ((menu->items + insert_pt) - (menu->items + dev + 1))
228 * sizeof(menu->items[0]));
229 memset(menu->items + dev + 1, 0, sizeof(menu->items[0]));
232 /* If for some reason we didn't find the matching device,
233 * at least add it to a valid position */
234 pmenu_item_insert(menu, item, insert_pt);
238 * pmenu_find_device - Determine if a boot option is new, and if
239 * so return a new pmenu_item to represent its parent device
242 struct pmenu_item *pmenu_find_device(struct pmenu *menu, struct device *dev,
243 struct boot_option *opt)
245 struct pmenu_item *item, *dev_hdr = NULL;
246 struct cui *cui = cui_from_pmenu(menu);
247 bool newdev = true, matched = false;
248 struct interface_info *intf;
249 struct blockdev_info *bd;
250 struct cui_opt_data *cod;
251 struct system_info *sys;
256 for (i = 0; i < menu->item_count; i++) {
257 item = item_userptr(menu->items[i]);
258 cod = cod_from_item(item);
259 /* boot entries will have opt defined */
260 if (!cod || cod->opt)
262 if (cod->dev == dev) {
263 pb_debug("%s: opt %s fits under %s\n",__func__,
264 opt->name, opt->device_id);
271 pb_debug("%s: No new device\n",__func__);
275 /* Create a dummy pmenu_item to represent the dev */
276 pb_debug("%s: Building new item\n",__func__);
279 case DEVICE_TYPE_OPTICAL:
280 case DEVICE_TYPE_DISK:
281 case DEVICE_TYPE_USB:
282 /* Find block info */
283 for (i = 0; sys && i < sys->n_blockdevs; i++) {
284 bd = sys->blockdevs[i];
285 if (!strcmp(opt->device_id, bd->name)) {
291 snprintf(buf,sizeof(buf),"[%s: %s / %s]",
292 device_type_display_name(dev->type),
297 case DEVICE_TYPE_NETWORK:
298 /* Find interface info */
299 for (i = 0; sys && i < sys->n_interfaces; i++) {
300 intf = sys->interfaces[i];
301 if (!strcmp(opt->device_id, intf->name)) {
307 mac_str(intf->hwaddr, intf->hwaddr_size,
308 hwaddr, sizeof(hwaddr));
309 snprintf(buf,sizeof(buf),"[%s: %s / %s]",
310 _("Network"), intf->name, hwaddr);
313 case DEVICE_TYPE_ANY:
314 /* This is an option found from a file:// url, not associated
316 snprintf(buf, sizeof(buf), "[Custom Local Options]");
321 /* Assume the device may be able to boot */
325 pb_debug("%s: No matching device found for %s (%s)\n",
326 __func__,opt->device_id, dev->id);
327 snprintf(buf, sizeof(buf), "[%s: %s]",
328 _("Unknown Device"), dev->id);
331 dev_hdr = pmenu_item_create(menu, buf);
333 pb_log("%s: Failed to create item\n",__func__);
337 dev_hdr->on_execute = NULL;
338 item_opts_off(dev_hdr->nci, O_SELECTABLE);
340 /* We identify dev_hdr items as having a valid c->name,
341 * but a NULL c->opt */
342 cod = talloc_zero(dev_hdr, struct cui_opt_data);
343 cod->name = talloc_strdup(dev_hdr, opt->device_id);
347 pb_debug("%s: returning %s\n",__func__,cod->name);
351 static int pmenu_item_get_index(const struct pmenu_item *item)
356 for (i = 0; i < item->pmenu->item_count; i++)
357 if (item->pmenu->items[i] == item->nci)
360 pb_log("%s: not found: %p %s\n", __func__, item,
361 (item ? item->nci->name.str : "(null)"));
366 * pmenu_move_cursor - Move the cursor.
367 * @req: An ncurses request or char to send to menu_driver().
370 static void pmenu_move_cursor(struct pmenu *menu, int req)
372 menu_driver(menu->ncm, req);
373 wrefresh(menu->scr.main_ncw);
377 * pmenu_process_key - Process a user keystroke.
380 static void pmenu_process_key(struct nc_scr *scr, int key)
382 struct pmenu *menu = pmenu_from_scr(scr);
383 struct pmenu_item *item = pmenu_find_selected(menu);
385 nc_scr_status_free(&menu->scr);
388 key = menu->hot_key(menu, item, key);
399 pmenu_move_cursor(menu, REQ_SCR_UPAGE);
402 pmenu_move_cursor(menu, REQ_SCR_DPAGE);
405 pmenu_move_cursor(menu, REQ_FIRST_ITEM);
408 pmenu_move_cursor(menu, REQ_LAST_ITEM);
411 pmenu_move_cursor(menu, REQ_UP_ITEM);
414 pmenu_move_cursor(menu, REQ_PREV_ITEM);
417 pmenu_move_cursor(menu, REQ_DOWN_ITEM);
420 pmenu_move_cursor(menu, REQ_NEXT_ITEM);
433 if (item->on_execute)
434 item->on_execute(item);
437 cui_show_sysinfo(cui_from_arg(scr->ui_ctx));
440 cui_show_config(cui_from_arg(scr->ui_ctx));
443 cui_show_lang(cui_from_arg(scr->ui_ctx));
446 cui_show_statuslog(cui_from_arg(scr->ui_ctx));
451 cui_show_help(cui_from_arg(scr->ui_ctx),
452 menu->help_title, menu->help_text);
455 menu_driver(menu->ncm, key);
461 * pmenu_grow - Grow the item array.
462 * @count: The count of new items.
464 * The item array must be disconnected prior to calling pmenu_grow().
465 * Returns the insert point index.
468 unsigned int pmenu_grow(struct pmenu *menu, unsigned int count)
472 assert(item_count(menu->ncm) == 0 && "not disconnected");
474 pb_log("%s: %u current + %u new = %u\n", __func__, menu->item_count,
475 count, menu->item_count + count);
477 /* Note that items array has a null terminator. */
479 menu->items = talloc_realloc(menu, menu->items, ITEM *,
480 menu->item_count + count + 1);
482 memmove(menu->items + menu->insert_pt + count,
483 menu->items + menu->insert_pt,
484 (menu->item_count - menu->insert_pt + 1) * sizeof(ITEM *));
486 memset(menu->items + menu->insert_pt, 0, count * sizeof(ITEM *));
488 tmp = menu->insert_pt;
489 menu->insert_pt += count;
490 menu->item_count += count;
496 * pmenu_remove - Remove an item from the item array.
498 * The item array must be disconnected prior to calling pmenu_remove()
501 int pmenu_remove(struct pmenu *menu, struct pmenu_item *item)
505 assert(item_count(menu->ncm) == 0 && "not disconnected");
507 assert(menu->item_count);
509 pb_log("%s: %u\n", __func__, menu->item_count);
511 index = pmenu_item_get_index(item);
518 /* Note that items array has a null terminator. */
523 memmove(&menu->items[index], &menu->items[index + 1],
524 (menu->item_count - index + 1) * sizeof(ITEM *));
525 menu->items = talloc_realloc(menu, menu->items, ITEM *,
526 menu->item_count + 1);
531 static int pmenu_destructor(void *ptr)
533 struct pmenu *menu = ptr;
534 assert(menu->scr.sig == pb_pmenu_sig);
535 menu->scr.sig = pb_removed_sig;
537 unpost_menu(menu->ncm);
538 free_menu(menu->ncm);
539 delwin(menu->scr.sub_ncw);
540 delwin(menu->scr.main_ncw);
545 * pmenu_init - Allocate and initialize a new menu instance.
547 * Returns a pointer the the initialized struct pmenu instance or NULL on error.
548 * The caller is responsible for calling talloc_free() for the returned
552 struct pmenu *pmenu_init(void *ui_ctx, unsigned int item_count,
553 void (*on_exit)(struct pmenu *))
555 struct pmenu *menu = talloc_zero(ui_ctx, struct pmenu);
559 talloc_set_destructor(menu, pmenu_destructor);
561 /* note items array has a null terminator */
562 menu->items = talloc_zero_array(menu, ITEM *, item_count + 1);
568 nc_scr_init(&menu->scr, pb_pmenu_sig, 0, ui_ctx, pmenu_process_key,
569 pmenu_post, pmenu_unpost, pmenu_resize);
571 menu->item_count = item_count;
572 menu->insert_pt = 0; /* insert from top */
573 menu->on_exit = on_exit;
579 * pmenu_setup - Create nc menu, setup nc windows.
583 int pmenu_setup(struct pmenu *menu)
587 menu->ncm = new_menu(menu->items);
590 pb_log("%s:%d: new_menu failed: %s\n", __func__, __LINE__,
595 set_menu_win(menu->ncm, menu->scr.main_ncw);
596 set_menu_sub(menu->ncm, menu->scr.sub_ncw);
598 /* Makes menu scrollable. */
599 set_menu_format(menu->ncm, LINES - nc_scr_frame_lines, 1);
601 set_menu_grey(menu->ncm, A_NORMAL);