git.ozlabs.org Git - petitboot/blob - 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         const char *description)
  96 {
  97         assert(i);
  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, description);
 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 /**
 119  * pmenu_move_cursor - Move the cursor.
 120  * @req: An ncurses request or char to send to menu_driver().
 121  */
 122
 123 static void pmenu_move_cursor(struct pmenu *menu, int req)
 124 {
 125         menu_driver(menu->ncm, req);
 126         wrefresh(menu->scr.main_ncw);
 127 }
 128
 129 /**
 130  * pmenu_process_key - Process a user keystroke.
 131  */
 132
 133 static void pmenu_process_key(struct nc_scr *scr)
 134 {
 135         struct pmenu *menu = pmenu_from_scr(scr);
 136         struct pmenu_item *item = pmenu_find_selected(menu);
 137
 138         nc_scr_status_free(&menu->scr);
 139
 140         while (1) {
 141                 int c = getch();
 142
 143                 if (c == ERR)
 144                         return;
 145
 146                 /* DBGS("%d (%o)\n", c, c); */
 147
 148                 if (menu->hot_key)
 149                         c = menu->hot_key(menu, item, c);
 150
 151                 switch (c) {
 152                 case 27: /* ESC */
 153                         if (menu->on_exit)
 154                                 menu->on_exit(menu);
 155                         nc_flush_keys();
 156                         return;
 157
 158                 case KEY_PPAGE:
 159                         pmenu_move_cursor(menu, REQ_SCR_UPAGE);
 160                         break;
 161                 case KEY_NPAGE:
 162                         pmenu_move_cursor(menu, REQ_SCR_DPAGE);
 163                         break;
 164                 case KEY_HOME:
 165                         pmenu_move_cursor(menu, REQ_FIRST_ITEM);
 166                         break;
 167                 case KEY_END:
 168                         pmenu_move_cursor(menu, REQ_LAST_ITEM);
 169                         break;
 170                 case KEY_UP:
 171                         pmenu_move_cursor(menu, REQ_UP_ITEM);
 172                         break;
 173                 case KEY_DOWN:
 174                 case '\t':
 175                         pmenu_move_cursor(menu, REQ_DOWN_ITEM);
 176                         break;
 177
 178                 case KEY_LEFT:
 179                 case 'E':
 180                 case 'e':
 181                         if (item->on_edit)
 182                                 item->on_edit(item);
 183                         break;
 184                 case '\n':
 185                 case '\r':
 186                         if (item->on_execute)
 187                                 item->on_execute(item);
 188                         break;
 189                 default:
 190                         menu_driver(menu->ncm, c);
 191                         break;
 192                 }
 193         }
 194 }
 195
 196 /**
 197  * pmenu_grow - Grow the item array.
 198  * @count: The count of new items.
 199  *
 200  * The item array must be disconnected prior to calling pmenu_grow().
 201  * Returns the insert point index.
 202  */
 203
 204 unsigned int pmenu_grow(struct pmenu *menu, unsigned int count)
 205 {
 206         unsigned int tmp;
 207
 208         assert(item_count(menu->ncm) == 0 && "not disconnected");
 209
 210         pb_log("%s: %u current + %u new = %u\n", __func__, menu->item_count,
 211                 count, menu->item_count + count);
 212
 213         /* Note that items array has a null terminator. */
 214
 215         menu->items = talloc_realloc(menu, menu->items, ITEM *,
 216                 menu->item_count + count + 1);
 217
 218         memmove(menu->items + menu->insert_pt + count,
 219                 menu->items + menu->insert_pt,
 220                 (menu->item_count - menu->insert_pt + 1) * sizeof(ITEM *));
 221
 222         memset(menu->items + menu->insert_pt, 0, count * sizeof(ITEM *));
 223
 224         tmp = menu->insert_pt;
 225         menu->insert_pt += count;
 226         menu->item_count += count;
 227
 228         return tmp;
 229 }
 230
 231 static int pmenu_item_get_index(const struct pmenu_item *item)
 232 {
 233         unsigned int i;
 234
 235         for (i = 0; i < item->pmenu->item_count; i++)
 236                 if (item->pmenu->items[i] == item->nci)
 237                         return i;
 238
 239         pb_log("%s: not found: %p %s\n", __func__, item,
 240                 (item ? item->nci->name.str : "(null)"));
 241         return -1;
 242 }
 243
 244 /**
 245  * pmenu_remove - Remove an item from the item array.
 246  *
 247  * The item array must be disconnected prior to calling pmenu_remove()
 248  */
 249
 250 int pmenu_remove(struct pmenu *menu, struct pmenu_item *item)
 251 {
 252         int index;
 253
 254         assert(item_count(menu->ncm) == 0 && "not disconnected");
 255
 256         assert(menu->item_count);
 257
 258         pb_log("%s: %u\n", __func__, menu->item_count);
 259
 260         index = pmenu_item_get_index(item);
 261
 262         if (index < 0)
 263                 return -1;
 264
 265         /* Note that items array has a null terminator. */
 266
 267         menu->insert_pt--;
 268         menu->item_count--;
 269
 270         memmove(&menu->items[index], &menu->items[index + 1],
 271                 (menu->item_count - index + 1) * sizeof(ITEM *));
 272         menu->items = talloc_realloc(menu, menu->items, ITEM *,
 273                 menu->item_count + 1);
 274
 275         return 0;
 276 }
 277
 278 /**
 279  * pmenu_init - Allocate and initialize a new menu instance.
 280  *
 281  * Returns a pointer the the initialized struct pmenu instance or NULL on error.
 282  * The caller is responsible for calling talloc_free() for the returned
 283  * instance.
 284  */
 285
 286 struct pmenu *pmenu_init(void *ui_ctx, unsigned int item_count,
 287         void (*on_exit)(struct pmenu *))
 288 {
 289         struct pmenu *menu = talloc_zero(ui_ctx, struct pmenu);
 290
 291         if (!menu)
 292                 return NULL;
 293
 294         /* note items array has a null terminator */
 295
 296         menu->items = talloc_zero_array(menu, ITEM *, item_count + 1);
 297
 298         if (!menu->items) {
 299                 talloc_free(menu);
 300                 return NULL;
 301         }
 302
 303         nc_scr_init(&menu->scr, pb_pmenu_sig, 0, ui_ctx, pmenu_process_key,
 304                 pmenu_post, pmenu_unpost, pmenu_resize);
 305
 306         menu->item_count = item_count;
 307         menu->insert_pt = 0; /* insert from top */
 308         menu->on_exit = on_exit;
 309
 310         return menu;
 311 }
 312
 313 /**
 314  * pmenu_setup - Create nc menu, setup nc windows.
 315  *
 316  */
 317
 318 int pmenu_setup(struct pmenu *menu)
 319 {
 320         assert(!menu->ncm);
 321
 322         menu->ncm = new_menu(menu->items);
 323
 324         if (!menu->ncm) {
 325                 pb_log("%s:%d: new_menu failed: %s\n", __func__, __LINE__,
 326                         strerror(errno));
 327                 return -1;
 328         }
 329
 330         set_menu_win(menu->ncm, menu->scr.main_ncw);
 331         set_menu_sub(menu->ncm, menu->scr.sub_ncw);
 332
 333         /* Makes menu scrollable. */
 334         set_menu_format(menu->ncm, LINES - nc_scr_frame_lines, 1);
 335
 336         return 0;
 337 }
 338
 339 /**
 340  * pmenu_delete - Delete a menu instance.
 341  *
 342  */
 343
 344 void pmenu_delete(struct pmenu *menu)
 345 {
 346         unsigned int i;
 347
 348         assert(menu->scr.sig == pb_pmenu_sig);
 349         menu->scr.sig = pb_removed_sig;
 350
 351         for (i = item_count(menu->ncm); i; i--)
 352                 free_item(menu->items[i]);
 353
 354         free_menu(menu->ncm);
 355         delwin(menu->scr.sub_ncw);
 356         delwin(menu->scr.main_ncw);
 357         talloc_free(menu);
 358 }