ui/ncurses: Use pmenu_item destrutor to free ncurses ITEMs
[petitboot] / ui / ncurses / nc-menu.h
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(_PB_NC_MENU_H)
20 #define _PB_NC_MENU_H
21
22 #include <assert.h>
23
24 #include <linux/input.h> /* This must be included before ncurses.h */
25 #if defined HAVE_NCURSESW_MENU_H
26 #  include <ncursesw/menu.h>
27 #elif defined HAVE_NCURSES_MENU_H
28 #  include <ncurses/menu.h>
29 #elif defined HAVE_MENU_H
30 #  include <menu.h>
31 #else
32 #  error "Curses menu.h not found."
33 #endif
34
35 #include "log/log.h"
36 #include "types/types.h"
37 #include "nc-scr.h"
38
39 struct pmenu;
40
41 /**
42  * struct pmenu_item - Hold the state of a single menu item.
43  * @i_sig: Signature for callback type checking, should be pmenu_item_sig.
44  * @nci: The ncurses menu item instance for this item.
45  */
46
47 struct pmenu_item {
48         enum pb_nc_sig i_sig;
49         ITEM *nci;
50         struct pmenu *pmenu;
51         void *data;
52         void (*on_edit)(struct pmenu_item *item);
53         int (*on_execute)(struct pmenu_item *item);
54 };
55
56 struct pmenu_item *pmenu_item_create(struct pmenu *menu, const char *name);
57 void pmenu_item_insert(struct pmenu *menu, struct pmenu_item *item,
58         unsigned int index);
59 void pmenu_item_delete(struct pmenu_item *item);
60
61 static inline struct pmenu_item *pmenu_item_from_arg(void *arg)
62 {
63         struct pmenu_item *item = (struct pmenu_item *)arg;
64
65         assert(item->i_sig == pb_item_sig);
66         return item;
67 }
68
69 static inline struct cui_opt_data *cod_from_item(struct pmenu_item *item)
70 {
71         return item->data;
72 }
73
74 /**
75  * struct pmenu - Data structure defining complete menu.
76  * @insert_pt: Index in nc item array.
77  * @ncm: The ncurses menu instance for this menu.
78  */
79
80 struct pmenu {
81         struct nc_scr scr;
82         MENU *ncm;
83         ITEM **items;
84         unsigned int item_count;
85         unsigned int insert_pt;
86         const char *help_title;
87         const char *help_text;
88         int (*hot_key)(struct pmenu *menu, struct pmenu_item *item, int c);
89         void (*on_exit)(struct pmenu *menu);
90         void (*on_new)(struct pmenu *menu);
91 };
92
93 struct pmenu *pmenu_init(void *ui_ctx, unsigned int item_count,
94         void (*on_exit)(struct pmenu *));
95 int pmenu_setup(struct pmenu *menu);
96 void pmenu_delete(struct pmenu *menu);
97 unsigned int pmenu_grow(struct pmenu *menu, unsigned int count);
98 int pmenu_remove(struct pmenu *menu, struct pmenu_item *item);
99 struct pmenu_item *pmenu_find_selected(struct pmenu *menu);
100
101 /* convenience routines */
102
103 int pmenu_exit_cb(struct pmenu_item *item);
104
105 static inline struct pmenu *pmenu_from_scr(struct nc_scr *scr)
106 {
107         struct pmenu *pmenu;
108
109         assert(scr->sig == pb_pmenu_sig);
110         pmenu = (struct pmenu *)((char *)scr
111                 - (size_t)&((struct pmenu *)0)->scr);
112         assert(pmenu->scr.sig == pb_pmenu_sig);
113
114         return pmenu;
115 }
116
117 /* debug routines */
118
119 static inline void pmenu_dump_item(const ITEM *item)
120 {
121         pb_debug("%p %s\n", item, (item ? item->name.str : "(null)"));
122 }
123
124 static inline void pmenu_dump_items(ITEM *const *items, unsigned int count)
125 {
126         unsigned int i;
127
128         for (i = 0; i < count; i++)
129                 pb_debug("%u: %p %s\n", i, items[i],
130                         (items[i] ? items[i]->name.str : "(null)"));
131 }
132
133 #endif