summaryrefslogtreecommitdiffstats
path: root/ui/ncurses/nc-menu.c
blob: 531ea2d9e90bd69855305ec6bbedaf2be00c61b4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
/*
 *  Copyright (C) 2009 Sony Computer Entertainment Inc.
 *  Copyright 2009 Sony Corp.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; version 2 of the License.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#if defined(HAVE_CONFIG_H)
#include "config.h"
#endif

#include <assert.h>
#include <errno.h>
#include <string.h>
#include <stdlib.h>
#include <wctype.h>
#include <util/util.h>

#include "log/log.h"
#include "talloc/talloc.h"
#include "i18n/i18n.h"
#include "ui/common/ui-system.h"
#include "nc-cui.h"
#include "nc-menu.h"

/**
 * pmenu_exit_cb - Callback helper that runs run menu.on_exit().
 */

int pmenu_exit_cb(struct pmenu_item *item)
{
	assert(item->pmenu->on_exit);
	item->pmenu->on_exit(item->pmenu);
	return 0;
}

/**
 * pmenu_find_selected - Find the selected pmenu_item.
 */

struct pmenu_item *pmenu_find_selected(struct pmenu *menu)
{
	return pmenu_item_from_arg(item_userptr(current_item(menu->ncm)));
}

static int pmenu_post(struct nc_scr *scr)
{
	int result;
	struct pmenu *menu = pmenu_from_scr(scr);

	result = post_menu(menu->ncm);

	nc_scr_frame_draw(scr);
	redrawwin(menu->scr.main_ncw);
	wrefresh(menu->scr.main_ncw);

	return result;
}

static int pmenu_unpost(struct nc_scr *scr)
{
	return unpost_menu(pmenu_from_scr(scr)->ncm);
}

static void pmenu_resize(struct nc_scr *scr)
{
	/* FIXME: menus can't be resized, need to recreate here */
	pmenu_unpost(scr);
	pmenu_post(scr);
}

static int pmenu_item_destructor(void *arg)
{
	struct pmenu_item *item = arg;
	free_item(item->nci);
	return 0;
}

static const char *pmenu_item_label(struct pmenu_item *item, const char *name)
{
	static int invalid_idx;
	unsigned int i;
	wchar_t *tmp;
	char *label;
	size_t len;

	len = mbstowcs(NULL, name, 0);

	/* if we have an invalid multibyte sequence, create an entirely
	 * new name, indicating that we had invalid input */
	if (len == SIZE_MAX) {
		name = talloc_asprintf(item, _("!Invalid option %d"),
				++invalid_idx);
		return name;
	}

	tmp = talloc_array(item, wchar_t, len + 1);
	mbstowcs(tmp, name, len + 1);

	/* replace anything unprintable with U+FFFD REPLACEMENT CHARACTER */
	for (i = 0; i < len; i++) {
		if (!iswprint(tmp[i]))
			tmp[i] = 0xfffd;
	}

	len = wcstombs(NULL, tmp, 0);
	label = talloc_array(item, char, len + 1);
	wcstombs(label, tmp, len + 1);

	pb_log("%s: %s\n", __func__, label);

	talloc_free(tmp);
	return label;
}

/**
 * pmenu_item_create - Allocate and initialize a new pmenu_item instance.
 *
 * Returns a pointer the the initialized struct pmenu_item instance or NULL
 * on error. The caller is responsible for calling talloc_free() for the
 * returned instance.
 */
struct pmenu_item *pmenu_item_create(struct pmenu *menu, const char *name)
{
	struct pmenu_item *item = talloc_zero(menu, struct pmenu_item);
	const char *label;

	label = pmenu_item_label(item, name);

	item->i_sig = pb_item_sig;
	item->pmenu = menu;
	item->nci = new_item(label, NULL);

	if (!item->nci) {
		talloc_free(item);
		return NULL;
	}

	talloc_set_destructor(item, pmenu_item_destructor);

	set_item_userptr(item->nci, item);

	return item;
}

void pmenu_item_insert(struct pmenu *menu, struct pmenu_item *item,
	unsigned int index)
{
	assert(item);
	assert(index < menu->item_count);
	assert(menu->items[index] == NULL);
	assert(menu_items(menu->ncm) == NULL);

	menu->items[index] = item->nci;
}

/**
 * pmenu_item_add - Insert item into appropriate position
 *
 * Inserts boot entry under matching, predefined device header entry,
 * moving items in the list if necessary
 */

void pmenu_item_add(struct pmenu *menu, struct pmenu_item *item,
	unsigned int insert_pt)
{
	struct cui_opt_data *cod = item->data;
	bool found = false;
	unsigned int dev;

	/* Items array should already be disconnected */

	for (dev = 0; dev < menu->item_count; dev++) {
		if (!menu->items[dev])
			continue;

		struct pmenu_item *i = item_userptr(menu->items[dev]);
		struct cui_opt_data *d = i->data;
		/* Device header will have opt == NULL */
		if (d && !d->opt) {
			if (cod->dev == d->dev) {
				found = true;
				break;
			}
		}
	}

	if (found) {
		assert(dev < insert_pt);
		/* Shift down entries between header and insert_pt */
		memmove(menu->items + dev + 2, menu->items + dev + 1,
			((menu->items + insert_pt) - (menu->items + dev + 1))
			* sizeof(menu->items[0]));
		memset(menu->items + dev + 1, 0, sizeof(menu->items[0]));
		insert_pt = dev + 1;
	}
	/* If for some reason we didn't find the matching device,
	 * at least add it to a valid position */
	pmenu_item_insert(menu, item, insert_pt);
}

/**
 * pmenu_find_device - Determine if a boot option is new, and if
 * so return a new pmenu_item to represent its parent device
 */

struct pmenu_item *pmenu_find_device(struct pmenu *menu, struct device *dev,
	struct boot_option *opt)
{
	struct pmenu_item *item, *dev_hdr = NULL;
	struct cui *cui = cui_from_pmenu(menu);
	bool newdev = true, matched = false;
	struct interface_info *intf;
	struct blockdev_info *bd;
	struct cui_opt_data *cod;
	struct system_info *sys;
	char hwaddr[32];
	unsigned int i;
	char buf[256];

	for (i = 0; i < menu->item_count; i++) {
		item = item_userptr(menu->items[i]);
		cod = item->data;
		/* boot entries will have opt defined */
		if (!cod || cod->opt)
			continue;
		if (cod->dev == dev) {
			pb_debug("%s: opt %s fits under %s\n",__func__,
				 opt->name, opt->device_id);
			newdev = false;
			break;
		}
	}

	if (!newdev) {
		pb_debug("%s: No new device\n",__func__);
		return NULL;
	}

	/* Create a dummy pmenu_item to represent the dev */
	pb_debug("%s: Building new item\n",__func__);
	sys = cui->sysinfo;
	switch (dev->type) {
	case DEVICE_TYPE_OPTICAL:
	case DEVICE_TYPE_DISK:
		/* Find block info */
		for (i = 0; sys && i < sys->n_blockdevs; i++) {
			bd = sys->blockdevs[i];
			if (!strcmp(opt->device_id, bd->name)) {
				matched = true;
				break;
			}
		}
		if (matched) {
			snprintf(buf,sizeof(buf),"[%s: %s / %s]",
				dev->type == DEVICE_TYPE_DISK ?
				"Disk" : "CD/DVD",
				bd->name, bd->uuid);
		}
		break;

	case DEVICE_TYPE_NETWORK:
		/* Find interface info */
		for (i = 0; sys && i < sys->n_interfaces; i++) {
			intf = sys->interfaces[i];
			if (!strcmp(opt->device_id, intf->name)) {
				matched = true;
				break;
			}
		}
		if (matched) {
			mac_str(intf->hwaddr, intf->hwaddr_size,
				hwaddr, sizeof(hwaddr));
			snprintf(buf,sizeof(buf),"[Interface %s / %s]",
				intf->name, hwaddr);
		}
		break;

	default:
		/* Assume the device may be able to boot */
		break;
	}
	if (!matched) {
		pb_debug("%s: No matching device found for %s (%s)\n",
			__func__,opt->device_id, dev->id);
		snprintf(buf,sizeof(buf),"[Unknown Device: %s]",
			dev->id);
	}

	dev_hdr = pmenu_item_create(menu, buf);
	if (!dev_hdr) {
		pb_log("%s: Failed to create item\n",__func__);
		return NULL;
	}

	dev_hdr->on_execute = NULL;
	item_opts_off(dev_hdr->nci, O_SELECTABLE);

	/* We identify dev_hdr items as having a valid c->name,
	 * but a NULL c->opt */
	cod = talloc(dev_hdr, struct cui_opt_data);
	cod->name = talloc_strdup(dev_hdr, opt->device_id);
	cod->dev = dev;
	cod->opt = NULL;
	dev_hdr->data = cod;

	pb_debug("%s: returning %s\n",__func__,cod->name);
	return dev_hdr;
}

static int pmenu_item_get_index(const struct pmenu_item *item)
{
	unsigned int i;

	for (i = 0; i < item->pmenu->item_count; i++)
		if (item->pmenu->items[i] == item->nci)
			return i;

	pb_log("%s: not found: %p %s\n", __func__, item,
		(item ? item->nci->name.str : "(null)"));
	return -1;
}

/**
 * pmenu_move_cursor - Move the cursor.
 * @req: An ncurses request or char to send to menu_driver().
 */

static void pmenu_move_cursor(struct pmenu *menu, int req)
{
	menu_driver(menu->ncm, req);
	wrefresh(menu->scr.main_ncw);
}

/**
 * pmenu_process_key - Process a user keystroke.
 */

static void pmenu_process_key(struct nc_scr *scr, int key)
{
	struct pmenu *menu = pmenu_from_scr(scr);
	struct pmenu_item *item = pmenu_find_selected(menu);

	nc_scr_status_free(&menu->scr);

	if (menu->hot_key)
		key = menu->hot_key(menu, item, key);

	switch (key) {
	case 27: /* ESC */
	case 'x':
		if (menu->on_exit)
			menu->on_exit(menu);
		nc_flush_keys();
		return;

	case KEY_PPAGE:
		pmenu_move_cursor(menu, REQ_SCR_UPAGE);
		break;
	case KEY_NPAGE:
		pmenu_move_cursor(menu, REQ_SCR_DPAGE);
		break;
	case KEY_HOME:
		pmenu_move_cursor(menu, REQ_FIRST_ITEM);
		break;
	case KEY_END:
		pmenu_move_cursor(menu, REQ_LAST_ITEM);
		break;
	case KEY_UP:
		pmenu_move_cursor(menu, REQ_UP_ITEM);
		break;
	case KEY_BTAB:
		pmenu_move_cursor(menu, REQ_PREV_ITEM);
		break;
	case KEY_DOWN:
		pmenu_move_cursor(menu, REQ_DOWN_ITEM);
		break;
	case '\t':
		pmenu_move_cursor(menu, REQ_NEXT_ITEM);
		break;
	case 'e':
		if (item->on_edit)
			item->on_edit(item);
		break;
	case 'n':
		if (menu->on_new)
			menu->on_new(menu);
		break;
	case ' ':
	case '\n':
	case '\r':
		if (item->on_execute)
			item->on_execute(item);
		break;
	case 'i':
		cui_show_sysinfo(cui_from_arg(scr->ui_ctx));
		break;
	case 'c':
		cui_show_config(cui_from_arg(scr->ui_ctx));
		break;
	case KEY_F(1):
	case 'h':
		if (menu->help_text)
			cui_show_help(cui_from_arg(scr->ui_ctx),
					menu->help_title, menu->help_text);
		break;
	default:
		menu_driver(menu->ncm, key);
		break;
	}
}

/**
 * pmenu_grow - Grow the item array.
 * @count: The count of new items.
 *
 * The item array must be disconnected prior to calling pmenu_grow().
 * Returns the insert point index.
 */

unsigned int pmenu_grow(struct pmenu *menu, unsigned int count)
{
	unsigned int tmp;

	assert(item_count(menu->ncm) == 0 && "not disconnected");

	pb_log("%s: %u current + %u new = %u\n", __func__, menu->item_count,
		count, menu->item_count + count);

	/* Note that items array has a null terminator. */

	menu->items = talloc_realloc(menu, menu->items, ITEM *,
		menu->item_count + count + 1);

	memmove(menu->items + menu->insert_pt + count,
		menu->items + menu->insert_pt,
		(menu->item_count - menu->insert_pt + 1) * sizeof(ITEM *));

	memset(menu->items + menu->insert_pt, 0, count * sizeof(ITEM *));

	tmp = menu->insert_pt;
	menu->insert_pt += count;
	menu->item_count += count;

	return tmp;
}

/**
 * pmenu_remove - Remove an item from the item array.
 *
 * The item array must be disconnected prior to calling pmenu_remove()
 */

int pmenu_remove(struct pmenu *menu, struct pmenu_item *item)
{
	int index;

	assert(item_count(menu->ncm) == 0 && "not disconnected");

	assert(menu->item_count);

	pb_log("%s: %u\n", __func__, menu->item_count);

	index = pmenu_item_get_index(item);

	if (index < 0)
		return -1;

	talloc_free(item);

	/* Note that items array has a null terminator. */

	menu->insert_pt--;
	menu->item_count--;

	memmove(&menu->items[index], &menu->items[index + 1],
		(menu->item_count - index + 1) * sizeof(ITEM *));
	menu->items = talloc_realloc(menu, menu->items, ITEM *,
		menu->item_count + 1);

	return 0;
}

/**
 * pmenu_init - Allocate and initialize a new menu instance.
 *
 * Returns a pointer the the initialized struct pmenu instance or NULL on error.
 * The caller is responsible for calling talloc_free() for the returned
 * instance.
 */

struct pmenu *pmenu_init(void *ui_ctx, unsigned int item_count,
	void (*on_exit)(struct pmenu *))
{
	struct pmenu *menu = talloc_zero(ui_ctx, struct pmenu);

	if (!menu)
		return NULL;

	/* note items array has a null terminator */

	menu->items = talloc_zero_array(menu, ITEM *, item_count + 1);

	if (!menu->items) {
		talloc_free(menu);
		return NULL;
	}

	nc_scr_init(&menu->scr, pb_pmenu_sig, 0, ui_ctx, pmenu_process_key,
		pmenu_post, pmenu_unpost, pmenu_resize);

	menu->item_count = item_count;
	menu->insert_pt = 0; /* insert from top */
	menu->on_exit = on_exit;

	return menu;
}

/**
 * pmenu_setup - Create nc menu, setup nc windows.
 *
 */

int pmenu_setup(struct pmenu *menu)
{
	assert(!menu->ncm);

	menu->ncm = new_menu(menu->items);

	if (!menu->ncm) {
		pb_log("%s:%d: new_menu failed: %s\n", __func__, __LINE__,
			strerror(errno));
		return -1;
	}

	set_menu_win(menu->ncm, menu->scr.main_ncw);
	set_menu_sub(menu->ncm, menu->scr.sub_ncw);

	/* Makes menu scrollable. */
	set_menu_format(menu->ncm, LINES - nc_scr_frame_lines, 1);

	set_menu_grey(menu->ncm, A_NORMAL);

	return 0;
}

/**
 * pmenu_delete - Delete a menu instance.
 *
 */

void pmenu_delete(struct pmenu *menu)
{
	assert(menu->scr.sig == pb_pmenu_sig);
	menu->scr.sig = pb_removed_sig;

	unpost_menu(menu->ncm);
	free_menu(menu->ncm);
	delwin(menu->scr.sub_ncw);
	delwin(menu->scr.main_ncw);
	talloc_free(menu);
}
OpenPOWER on IntegriCloud