ui/ncurses: move getch() out of process_key callbacks
[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 #define _GNU_SOURCE
20
21 #include <assert.h>
22 #include <errno.h>
23 #include <string.h>
24
25 #include "log/log.h"
26 #include "talloc/talloc.h"
27 #include "ui/common/ui-system.h"
28 #include "nc-menu.h"
29
30 /**
31  * pmenu_exit_cb - Callback helper that runs run menu.on_exit().
32  */
33
34 int pmenu_exit_cb(struct pmenu_item *item)
35 {
36         assert(item->pmenu->on_exit);
37         item->pmenu->on_exit(item->pmenu);
38         return 0;
39 }
40
41 /**
42  * pmenu_find_selected - Find the selected pmenu_item.
43  */
44
45 struct pmenu_item *pmenu_find_selected(struct pmenu *menu)
46 {
47         return pmenu_item_from_arg(item_userptr(current_item(menu->ncm)));
48 }
49
50 static int pmenu_post(struct nc_scr *scr)
51 {
52         int result;
53         struct pmenu *menu = pmenu_from_scr(scr);
54
55         result = post_menu(menu->ncm);
56
57         nc_scr_frame_draw(scr);
58         redrawwin(menu->scr.main_ncw);
59         wrefresh(menu->scr.main_ncw);
60
61         return result;
62 }
63
64 static int pmenu_unpost(struct nc_scr *scr)
65 {
66         return unpost_menu(pmenu_from_scr(scr)->ncm);
67 }
68
69 static void pmenu_resize(struct nc_scr *scr)
70 {
71         /* FIXME: menus can't be resized, need to recreate here */
72         pmenu_unpost(scr);
73         pmenu_post(scr);
74 }
75
76 /**
77  * pmenu_item_init - Allocate and initialize a new pmenu_item instance.
78  *
79  * Returns a pointer the the initialized struct pmenu_item instance or NULL
80  * on error. The caller is responsible for calling talloc_free() for the
81  * returned instance.
82  */
83
84 struct pmenu_item *pmenu_item_alloc(struct pmenu *menu)
85 {
86         /* Items go with the menu, not the pointer array. */
87
88         struct pmenu_item *i = talloc_zero(menu, struct pmenu_item);
89
90         return i;
91 }
92
93 struct pmenu_item *pmenu_item_setup(struct pmenu *menu, struct pmenu_item *i,
94         unsigned int index, const char *name)
95 {
96         assert(i);
97         assert(name);
98
99         if (!i)
100                 return NULL;
101
102         i->i_sig = pb_item_sig;
103         i->pmenu = menu;
104         i->nci = new_item(name, NULL);
105
106         if (!i->nci) {
107                 talloc_free(i);
108                 return NULL;
109         }
110
111         set_item_userptr(i->nci, i);
112
113         menu->items[index] = i->nci;
114
115         return i;
116 }
117
118 static int pmenu_item_get_index(const struct pmenu_item *item)
119 {
120         unsigned int i;
121
122         for (i = 0; i < item->pmenu->item_count; i++)
123                 if (item->pmenu->items[i] == item->nci)
124                         return i;
125
126         pb_log("%s: not found: %p %s\n", __func__, item,
127                 (item ? item->nci->name.str : "(null)"));
128         return -1;
129 }
130
131 /**
132  * pmenu_item_replace - Replace the menu item with a new one.
133  *
134  * Use this routine to change a menu item's text.
135  */
136
137 int pmenu_item_replace(struct pmenu_item *i, const char *name)
138 {
139         struct pmenu *menu;
140         ITEM *nci;
141         int index;
142
143         assert(name);
144         assert(i->nci);
145
146         menu = i->pmenu;
147         index = pmenu_item_get_index(i);
148
149         if (index < 0) {
150                 assert(0 && "get_index failed");
151                 return -1;
152         }
153
154         nci = new_item(name, NULL);
155
156         if (!nci) {
157                 assert(0 && "new_item failed");
158                 return -1;
159         }
160
161         set_item_userptr(nci, i);
162
163         menu->scr.unpost(&menu->scr);
164         set_menu_items(menu->ncm, NULL);
165
166         // FIXME: need to assure item name is a talloc string.
167         /* talloc_free((char *)item_name(i->nci)); */
168
169         free_item(i->nci);
170         menu->items[index] = nci;
171         i->nci = nci;
172
173         set_menu_items(menu->ncm, menu->items);
174         menu->scr.post(&menu->scr);
175
176         return 0;
177 }
178
179 /**
180  * pmenu_move_cursor - Move the cursor.
181  * @req: An ncurses request or char to send to menu_driver().
182  */
183
184 static void pmenu_move_cursor(struct pmenu *menu, int req)
185 {
186         menu_driver(menu->ncm, req);
187         wrefresh(menu->scr.main_ncw);
188 }
189
190 /**
191  * pmenu_process_key - Process a user keystroke.
192  */
193
194 static void pmenu_process_key(struct nc_scr *scr, int key)
195 {
196         struct pmenu *menu = pmenu_from_scr(scr);
197         struct pmenu_item *item = pmenu_find_selected(menu);
198
199         nc_scr_status_free(&menu->scr);
200
201         if (menu->hot_key)
202                 key = menu->hot_key(menu, item, key);
203
204         switch (key) {
205         case 27: /* ESC */
206                 if (menu->on_exit)
207                         menu->on_exit(menu);
208                 nc_flush_keys();
209                 return;
210
211         case KEY_PPAGE:
212                 pmenu_move_cursor(menu, REQ_SCR_UPAGE);
213                 break;
214         case KEY_NPAGE:
215                 pmenu_move_cursor(menu, REQ_SCR_DPAGE);
216                 break;
217         case KEY_HOME:
218                 pmenu_move_cursor(menu, REQ_FIRST_ITEM);
219                 break;
220         case KEY_END:
221                 pmenu_move_cursor(menu, REQ_LAST_ITEM);
222                 break;
223         case KEY_UP:
224                 pmenu_move_cursor(menu, REQ_UP_ITEM);
225                 break;
226         case KEY_DOWN:
227                 pmenu_move_cursor(menu, REQ_DOWN_ITEM);
228                 break;
229         case 'e':
230                 if (item->on_edit)
231                         item->on_edit(item);
232                 break;
233         case 'o':
234                 DBGS("on_open: %p\n", menu->on_open);
235                 if (menu->on_open)
236                         menu->on_open(menu);
237                 break;
238         case '\n':
239         case '\r':
240                 if (item->on_execute)
241                         item->on_execute(item);
242                 break;
243         default:
244                 menu_driver(menu->ncm, key);
245                 break;
246         }
247 }
248
249 /**
250  * pmenu_grow - Grow the item array.
251  * @count: The count of new items.
252  *
253  * The item array must be disconnected prior to calling pmenu_grow().
254  * Returns the insert point index.
255  */
256
257 unsigned int pmenu_grow(struct pmenu *menu, unsigned int count)
258 {
259         unsigned int tmp;
260
261         assert(item_count(menu->ncm) == 0 && "not disconnected");
262
263         pb_log("%s: %u current + %u new = %u\n", __func__, menu->item_count,
264                 count, menu->item_count + count);
265
266         /* Note that items array has a null terminator. */
267
268         menu->items = talloc_realloc(menu, menu->items, ITEM *,
269                 menu->item_count + count + 1);
270
271         memmove(menu->items + menu->insert_pt + count,
272                 menu->items + menu->insert_pt,
273                 (menu->item_count - menu->insert_pt + 1) * sizeof(ITEM *));
274
275         memset(menu->items + menu->insert_pt, 0, count * sizeof(ITEM *));
276
277         tmp = menu->insert_pt;
278         menu->insert_pt += count;
279         menu->item_count += count;
280
281         return tmp;
282 }
283
284 /**
285  * pmenu_remove - Remove an item from the item array.
286  *
287  * The item array must be disconnected prior to calling pmenu_remove()
288  */
289
290 int pmenu_remove(struct pmenu *menu, struct pmenu_item *item)
291 {
292         int index;
293
294         assert(item_count(menu->ncm) == 0 && "not disconnected");
295
296         assert(menu->item_count);
297
298         pb_log("%s: %u\n", __func__, menu->item_count);
299
300         index = pmenu_item_get_index(item);
301
302         if (index < 0)
303                 return -1;
304
305         free_item(item->nci);
306         talloc_free(item);
307
308         /* Note that items array has a null terminator. */
309
310         menu->insert_pt--;
311         menu->item_count--;
312
313         memmove(&menu->items[index], &menu->items[index + 1],
314                 (menu->item_count - index + 1) * sizeof(ITEM *));
315         menu->items = talloc_realloc(menu, menu->items, ITEM *,
316                 menu->item_count + 1);
317
318         return 0;
319 }
320
321 /**
322  * pmenu_init - Allocate and initialize a new menu instance.
323  *
324  * Returns a pointer the the initialized struct pmenu instance or NULL on error.
325  * The caller is responsible for calling talloc_free() for the returned
326  * instance.
327  */
328
329 struct pmenu *pmenu_init(void *ui_ctx, unsigned int item_count,
330         void (*on_exit)(struct pmenu *))
331 {
332         struct pmenu *menu = talloc_zero(ui_ctx, struct pmenu);
333
334         if (!menu)
335                 return NULL;
336
337         /* note items array has a null terminator */
338
339         menu->items = talloc_zero_array(menu, ITEM *, item_count + 1);
340
341         if (!menu->items) {
342                 talloc_free(menu);
343                 return NULL;
344         }
345
346         nc_scr_init(&menu->scr, pb_pmenu_sig, 0, ui_ctx, pmenu_process_key,
347                 pmenu_post, pmenu_unpost, pmenu_resize);
348
349         menu->item_count = item_count;
350         menu->insert_pt = 0; /* insert from top */
351         menu->on_exit = on_exit;
352
353         return menu;
354 }
355
356 /**
357  * pmenu_setup - Create nc menu, setup nc windows.
358  *
359  */
360
361 int pmenu_setup(struct pmenu *menu)
362 {
363         assert(!menu->ncm);
364
365         menu->ncm = new_menu(menu->items);
366
367         if (!menu->ncm) {
368                 pb_log("%s:%d: new_menu failed: %s\n", __func__, __LINE__,
369                         strerror(errno));
370                 return -1;
371         }
372
373         set_menu_win(menu->ncm, menu->scr.main_ncw);
374         set_menu_sub(menu->ncm, menu->scr.sub_ncw);
375
376         /* Makes menu scrollable. */
377         set_menu_format(menu->ncm, LINES - nc_scr_frame_lines, 1);
378
379         return 0;
380 }
381
382 /**
383  * pmenu_delete - Delete a menu instance.
384  *
385  */
386
387 void pmenu_delete(struct pmenu *menu)
388 {
389         unsigned int i;
390
391         assert(menu->scr.sig == pb_pmenu_sig);
392         menu->scr.sig = pb_removed_sig;
393
394         for (i = item_count(menu->ncm); i; i--)
395                 free_item(menu->items[i - 1]);
396
397         free_menu(menu->ncm);
398         delwin(menu->scr.sub_ncw);
399         delwin(menu->scr.main_ncw);
400         talloc_free(menu);
401 }