ui/ncurses: Allow multiple hot key handlers per pmenu
[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 int pmenu_item_update(struct pmenu_item *item, const char *name);
57 struct pmenu_item *pmenu_item_create(struct pmenu *menu, const char *name);
58 struct pmenu_item *pmenu_find_device(struct pmenu *menu, struct device *dev,
59         struct boot_option *opt);
60 void pmenu_item_insert(struct pmenu *menu, struct pmenu_item *item,
61         unsigned int index);
62 void pmenu_item_add(struct pmenu *menu, struct pmenu_item *item,
63         unsigned int insert_pt);
64 void pmenu_item_delete(struct pmenu_item *item);
65
66 static inline struct pmenu_item *pmenu_item_from_arg(void *arg)
67 {
68         struct pmenu_item *item = (struct pmenu_item *)arg;
69
70         assert(item->i_sig == pb_item_sig);
71         return item;
72 }
73
74 static inline struct cui_opt_data *cod_from_item(struct pmenu_item *item)
75 {
76         return item->data;
77 }
78
79 typedef int (*hot_key_fn)(struct pmenu *menu, struct pmenu_item *item, int c);
80
81 int pmenu_main_hot_keys(struct pmenu *menu, struct pmenu_item *item, int c);
82
83 /**
84  * struct pmenu - Data structure defining complete menu.
85  * @insert_pt: Index in nc item array.
86  * @ncm: The ncurses menu instance for this menu.
87  */
88
89 struct pmenu {
90         struct nc_scr scr;
91         MENU *ncm;
92         ITEM **items;
93         unsigned int item_count;
94         unsigned int insert_pt;
95         const char *help_title;
96         const struct help_text *help_text;
97         hot_key_fn *hot_keys;
98         unsigned int n_hot_keys;
99         void (*on_exit)(struct pmenu *menu);
100         void (*on_new)(struct pmenu *menu);
101 };
102
103 struct pmenu *pmenu_init(void *ui_ctx, unsigned int item_count,
104         void (*on_exit)(struct pmenu *));
105 int pmenu_setup(struct pmenu *menu);
106 unsigned int pmenu_grow(struct pmenu *menu, unsigned int count);
107 int pmenu_remove(struct pmenu *menu, struct pmenu_item *item);
108 struct pmenu_item *pmenu_find_selected(struct pmenu *menu);
109
110 /* convenience routines */
111
112 int pmenu_exit_cb(struct pmenu_item *item);
113
114 static inline struct pmenu *pmenu_from_scr(struct nc_scr *scr)
115 {
116         struct pmenu *pmenu;
117
118         assert(scr->sig == pb_pmenu_sig);
119         pmenu = (struct pmenu *)((char *)scr
120                 - (size_t)&((struct pmenu *)0)->scr);
121         assert(pmenu->scr.sig == pb_pmenu_sig);
122
123         return pmenu;
124 }
125
126 /* debug routines */
127
128 static inline void pmenu_dump_item(const ITEM *item)
129 {
130         pb_debug("%p %s\n", item, (item ? item->name.str : "(null)"));
131 }
132
133 static inline void pmenu_dump_items(ITEM *const *items, unsigned int count)
134 {
135         unsigned int i;
136
137         for (i = 0; i < count; i++)
138                 pb_debug("%u: %p %s\n", i, items[i],
139                         (items[i] ? items[i]->name.str : "(null)"));
140 }
141
142 #endif