blob: bf2b471ff8767cd6f58ceee2961d594c60ac9623 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Jason Hobbsb69bf522011-08-23 11:06:49 +00002/*
3 * Copyright 2010-2011 Calxeda, Inc.
Jason Hobbsb69bf522011-08-23 11:06:49 +00004 */
5
6#include <common.h>
Simon Glass18d66532014-04-10 20:01:25 -06007#include <cli.h>
Jason Hobbsb69bf522011-08-23 11:06:49 +00008#include <malloc.h>
9#include <errno.h>
10#include <linux/list.h>
11
12#include "menu.h"
13
14/*
15 * Internally, each item in a menu is represented by a struct menu_item.
16 *
17 * These items will be alloc'd and initialized by menu_item_add and destroyed
18 * by menu_item_destroy, and the consumer of the interface never sees that
19 * this struct is used at all.
20 */
21struct menu_item {
22 char *key;
23 void *data;
24 struct list_head list;
25};
26
27/*
28 * The menu is composed of a list of items along with settings and callbacks
29 * provided by the user. An incomplete definition of this struct is available
30 * in menu.h, but the full definition is here to prevent consumers from
31 * relying on its contents.
32 */
33struct menu {
34 struct menu_item *default_item;
Jason Hobbsb41bc5a2011-08-23 11:06:50 +000035 int timeout;
Jason Hobbsb69bf522011-08-23 11:06:49 +000036 char *title;
37 int prompt;
38 void (*item_data_print)(void *);
Pali Rohárfc9d64f2013-03-23 14:50:40 +000039 char *(*item_choice)(void *);
40 void *item_choice_data;
Jason Hobbsb69bf522011-08-23 11:06:49 +000041 struct list_head items;
42};
43
44/*
45 * An iterator function for menu items. callback will be called for each item
46 * in m, with m, a pointer to the item, and extra being passed to callback. If
47 * callback returns a value other than NULL, iteration stops and the value
48 * return by callback is returned from menu_items_iter. This allows it to be
49 * used for search type operations. It is also safe for callback to remove the
50 * item from the list of items.
51 */
52static inline void *menu_items_iter(struct menu *m,
53 void *(*callback)(struct menu *, struct menu_item *, void *),
54 void *extra)
55{
56 struct list_head *pos, *n;
57 struct menu_item *item;
58 void *ret;
59
60 list_for_each_safe(pos, n, &m->items) {
61 item = list_entry(pos, struct menu_item, list);
62
63 ret = callback(m, item, extra);
64
65 if (ret)
66 return ret;
67 }
68
69 return NULL;
70}
71
72/*
73 * Print a menu_item. If the consumer provided an item_data_print function
74 * when creating the menu, call it with a pointer to the item's private data.
75 * Otherwise, print the key of the item.
76 */
77static inline void *menu_item_print(struct menu *m,
78 struct menu_item *item,
79 void *extra)
80{
Wolfgang Denkd887ad52011-11-28 20:19:41 +010081 if (!m->item_data_print) {
Anatolij Gustschin21574972011-12-03 06:46:07 +000082 puts(item->key);
Wolfgang Denkd887ad52011-11-28 20:19:41 +010083 putc('\n');
84 } else {
Jason Hobbsb69bf522011-08-23 11:06:49 +000085 m->item_data_print(item->data);
Wolfgang Denkd887ad52011-11-28 20:19:41 +010086 }
Jason Hobbsb69bf522011-08-23 11:06:49 +000087
88 return NULL;
89}
90
91/*
92 * Free the memory used by a menu item. This includes the memory used by its
93 * key.
94 */
95static inline void *menu_item_destroy(struct menu *m,
96 struct menu_item *item,
97 void *extra)
98{
99 if (item->key)
100 free(item->key);
101
102 free(item);
103
104 return NULL;
105}
106
Jeroen Hofstee002ad7b2014-10-08 22:57:25 +0200107__weak void menu_display_statusline(struct menu *m)
Heiko Schochere0611dd2012-01-16 21:13:20 +0000108{
Heiko Schochere0611dd2012-01-16 21:13:20 +0000109}
Heiko Schochere0611dd2012-01-16 21:13:20 +0000110
Jason Hobbsb69bf522011-08-23 11:06:49 +0000111/*
112 * Display a menu so the user can make a choice of an item. First display its
113 * title, if any, and then each item in the menu.
114 */
115static inline void menu_display(struct menu *m)
116{
Wolfgang Denkd887ad52011-11-28 20:19:41 +0100117 if (m->title) {
118 puts(m->title);
119 putc('\n');
120 }
Heiko Schochere0611dd2012-01-16 21:13:20 +0000121 menu_display_statusline(m);
Jason Hobbsb69bf522011-08-23 11:06:49 +0000122
123 menu_items_iter(m, menu_item_print, NULL);
124}
125
126/*
127 * Check if an item's key matches a provided string, pointed to by extra. If
128 * extra is NULL, an item with a NULL key will match. Otherwise, the item's
129 * key has to match according to strcmp.
130 *
131 * This is called via menu_items_iter, so it returns a pointer to the item if
132 * the key matches, and returns NULL otherwise.
133 */
134static inline void *menu_item_key_match(struct menu *m,
135 struct menu_item *item, void *extra)
136{
137 char *item_key = extra;
138
139 if (!item_key || !item->key) {
140 if (item_key == item->key)
141 return item;
142
143 return NULL;
144 }
145
146 if (strcmp(item->key, item_key) == 0)
147 return item;
148
149 return NULL;
150}
151
152/*
153 * Find the first item with a key matching item_key, if any exists.
154 */
155static inline struct menu_item *menu_item_by_key(struct menu *m,
156 char *item_key)
157{
158 return menu_items_iter(m, menu_item_key_match, item_key);
159}
160
161/*
Jason Hobbsb69bf522011-08-23 11:06:49 +0000162 * Set *choice to point to the default item's data, if any default item was
163 * set, and returns 1. If no default item was set, returns -ENOENT.
164 */
Anatolij Gustschin6a3439f2013-03-23 14:52:04 +0000165int menu_default_choice(struct menu *m, void **choice)
Jason Hobbsb69bf522011-08-23 11:06:49 +0000166{
167 if (m->default_item) {
168 *choice = m->default_item->data;
169 return 1;
170 }
171
172 return -ENOENT;
173}
174
175/*
176 * Displays the menu and asks the user to choose an item. *choice will point
177 * to the private data of the item the user chooses. The user makes a choice
178 * by inputting a string matching the key of an item. Invalid choices will
179 * cause the user to be prompted again, repeatedly, until the user makes a
180 * valid choice. The user can exit the menu without making a choice via ^c.
181 *
182 * Returns 1 if the user made a choice, or -EINTR if they bail via ^c.
183 */
184static inline int menu_interactive_choice(struct menu *m, void **choice)
185{
186 char cbuf[CONFIG_SYS_CBSIZE];
187 struct menu_item *choice_item = NULL;
188 int readret;
189
190 while (!choice_item) {
191 cbuf[0] = '\0';
192
193 menu_display(m);
194
Pali Rohárfc9d64f2013-03-23 14:50:40 +0000195 if (!m->item_choice) {
Simon Glasse1bf8242014-04-10 20:01:27 -0600196 readret = cli_readline_into_buffer("Enter choice: ",
197 cbuf,
198 m->timeout / 10);
Jason Hobbsb69bf522011-08-23 11:06:49 +0000199
Pali Rohárfc9d64f2013-03-23 14:50:40 +0000200 if (readret >= 0) {
201 choice_item = menu_item_by_key(m, cbuf);
202 if (!choice_item)
203 printf("%s not found\n", cbuf);
Tuomas Tynkkynen9b081d82015-05-07 21:29:19 +0300204 } else if (readret == -1) {
205 printf("<INTERRUPT>\n");
206 return -EINTR;
Pali Rohárfc9d64f2013-03-23 14:50:40 +0000207 } else {
208 return menu_default_choice(m, choice);
Heiko Schocherfc4fa6a2012-01-16 22:24:29 +0000209 }
Pali Rohárfc9d64f2013-03-23 14:50:40 +0000210 } else {
211 char *key = m->item_choice(m->item_choice_data);
212
213 if (key)
214 choice_item = menu_item_by_key(m, key);
215 }
216
217 if (!choice_item)
218 m->timeout = 0;
Jason Hobbsb69bf522011-08-23 11:06:49 +0000219 }
220
221 *choice = choice_item->data;
222
223 return 1;
224}
225
226/*
227 * menu_default_set() - Sets the default choice for the menu. This is safe to
228 * call more than once on a menu.
229 *
230 * m - Points to a menu created by menu_create().
231 *
232 * item_key - Points to a string that, when compared using strcmp, matches the
233 * key for an existing item in the menu.
234 *
235 * Returns 1 if successful, -EINVAL if m is NULL, or -ENOENT if no item with a
236 * key matching item_key is found.
237 */
238int menu_default_set(struct menu *m, char *item_key)
239{
240 struct menu_item *item;
241
242 if (!m)
243 return -EINVAL;
244
245 item = menu_item_by_key(m, item_key);
246
247 if (!item)
248 return -ENOENT;
249
250 m->default_item = item;
251
252 return 1;
253}
254
255/*
256 * menu_get_choice() - Returns the user's selected menu entry, or the default
Jason Hobbsb41bc5a2011-08-23 11:06:50 +0000257 * if the menu is set to not prompt or the timeout expires. This is safe to
258 * call more than once.
Jason Hobbsb69bf522011-08-23 11:06:49 +0000259 *
260 * m - Points to a menu created by menu_create().
261 *
262 * choice - Points to a location that will store a pointer to the selected
263 * menu item. If no item is selected or there is an error, no value will be
264 * written at the location it points to.
265 *
266 * Returns 1 if successful, -EINVAL if m or choice is NULL, -ENOENT if no
Jason Hobbsb41bc5a2011-08-23 11:06:50 +0000267 * default has been set and the menu is set to not prompt or the timeout
268 * expires, or -EINTR if the user exits the menu via ^c.
Jason Hobbsb69bf522011-08-23 11:06:49 +0000269 */
270int menu_get_choice(struct menu *m, void **choice)
271{
272 if (!m || !choice)
273 return -EINVAL;
274
Rob Herring85947532012-03-28 05:51:32 +0000275 if (!m->prompt)
Jason Hobbsb69bf522011-08-23 11:06:49 +0000276 return menu_default_choice(m, choice);
277
278 return menu_interactive_choice(m, choice);
279}
280
281/*
282 * menu_item_add() - Adds or replaces a menu item. Note that this replaces the
283 * data of an item if it already exists, but doesn't change the order of the
284 * item.
285 *
286 * m - Points to a menu created by menu_create().
287 *
288 * item_key - Points to a string that will uniquely identify the item. The
289 * string will be copied to internal storage, and is safe to discard after
290 * passing to menu_item_add.
291 *
292 * item_data - An opaque pointer associated with an item. It is never
293 * dereferenced internally, but will be passed to the item_data_print, and
294 * will be returned from menu_get_choice if the menu item is selected.
295 *
296 * Returns 1 if successful, -EINVAL if m is NULL, or -ENOMEM if there is
297 * insufficient memory to add the menu item.
298 */
299int menu_item_add(struct menu *m, char *item_key, void *item_data)
300{
301 struct menu_item *item;
302
303 if (!m)
304 return -EINVAL;
305
306 item = menu_item_by_key(m, item_key);
307
308 if (item) {
309 item->data = item_data;
310 return 1;
311 }
312
313 item = malloc(sizeof *item);
314 if (!item)
315 return -ENOMEM;
316
317 item->key = strdup(item_key);
318
319 if (!item->key) {
320 free(item);
321 return -ENOMEM;
322 }
323
324 item->data = item_data;
325
326 list_add_tail(&item->list, &m->items);
327
328 return 1;
329}
330
331/*
332 * menu_create() - Creates a menu handle with default settings
333 *
334 * title - If not NULL, points to a string that will be displayed before the
335 * list of menu items. It will be copied to internal storage, and is safe to
336 * discard after passing to menu_create().
337 *
Jason Hobbsb41bc5a2011-08-23 11:06:50 +0000338 * timeout - A delay in seconds to wait for user input. If 0, timeout is
339 * disabled, and the default choice will be returned unless prompt is 1.
340 *
341 * prompt - If 0, don't ask for user input unless there is an interrupted
342 * timeout. If 1, the user will be prompted for input regardless of the value
343 * of timeout.
Jason Hobbsb69bf522011-08-23 11:06:49 +0000344 *
345 * item_data_print - If not NULL, will be called for each item when the menu
346 * is displayed, with the pointer to the item's data passed as the argument.
347 * If NULL, each item's key will be printed instead. Since an item's key is
348 * what must be entered to select an item, the item_data_print function should
349 * make it obvious what the key for each entry is.
350 *
Pali Rohárfc9d64f2013-03-23 14:50:40 +0000351 * item_choice - If not NULL, will be called when asking the user to choose an
Alexander Merkledd8d8da2016-03-17 15:44:47 +0100352 * item. Returns a key string corresponding to the chosen item or NULL if
Pali Rohárfc9d64f2013-03-23 14:50:40 +0000353 * no item has been selected.
354 *
355 * item_choice_data - Will be passed as the argument to the item_choice function
356 *
Jason Hobbsb69bf522011-08-23 11:06:49 +0000357 * Returns a pointer to the menu if successful, or NULL if there is
358 * insufficient memory available to create the menu.
359 */
Jason Hobbsb41bc5a2011-08-23 11:06:50 +0000360struct menu *menu_create(char *title, int timeout, int prompt,
Pali Rohárfc9d64f2013-03-23 14:50:40 +0000361 void (*item_data_print)(void *),
362 char *(*item_choice)(void *),
363 void *item_choice_data)
Jason Hobbsb69bf522011-08-23 11:06:49 +0000364{
365 struct menu *m;
366
367 m = malloc(sizeof *m);
368
369 if (!m)
370 return NULL;
371
372 m->default_item = NULL;
373 m->prompt = prompt;
Jason Hobbsb41bc5a2011-08-23 11:06:50 +0000374 m->timeout = timeout;
Jason Hobbsb69bf522011-08-23 11:06:49 +0000375 m->item_data_print = item_data_print;
Pali Rohárfc9d64f2013-03-23 14:50:40 +0000376 m->item_choice = item_choice;
377 m->item_choice_data = item_choice_data;
Jason Hobbsb69bf522011-08-23 11:06:49 +0000378
379 if (title) {
380 m->title = strdup(title);
381 if (!m->title) {
382 free(m);
383 return NULL;
384 }
385 } else
386 m->title = NULL;
387
388
389 INIT_LIST_HEAD(&m->items);
390
391 return m;
392}
393
394/*
395 * menu_destroy() - frees the memory used by a menu and its items.
396 *
397 * m - Points to a menu created by menu_create().
398 *
399 * Returns 1 if successful, or -EINVAL if m is NULL.
400 */
401int menu_destroy(struct menu *m)
402{
403 if (!m)
404 return -EINVAL;
405
406 menu_items_iter(m, menu_item_destroy, NULL);
407
408 if (m->title)
409 free(m->title);
410
411 free(m);
412
413 return 1;
414}