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