]>
git.ipfire.org Git - people/ms/u-boot.git/blob - common/menu.c
64b461abb491b8584d8cfc76087c0c808e8d7ebc
2 * Copyright 2010-2011 Calxeda, Inc.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the Free
6 * Software Foundation; either version 2 of the License, or (at your option)
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program. If not, see <http://www.gnu.org/licenses/>.
21 #include <linux/list.h>
26 * Internally, each item in a menu is represented by a struct menu_item.
28 * These items will be alloc'd and initialized by menu_item_add and destroyed
29 * by menu_item_destroy, and the consumer of the interface never sees that
30 * this struct is used at all.
35 struct list_head list
;
39 * The menu is composed of a list of items along with settings and callbacks
40 * provided by the user. An incomplete definition of this struct is available
41 * in menu.h, but the full definition is here to prevent consumers from
42 * relying on its contents.
45 struct menu_item
*default_item
;
49 void (*item_data_print
)(void *);
50 char *(*item_choice
)(void *);
51 void *item_choice_data
;
52 struct list_head items
;
56 * An iterator function for menu items. callback will be called for each item
57 * in m, with m, a pointer to the item, and extra being passed to callback. If
58 * callback returns a value other than NULL, iteration stops and the value
59 * return by callback is returned from menu_items_iter. This allows it to be
60 * used for search type operations. It is also safe for callback to remove the
61 * item from the list of items.
63 static inline void *menu_items_iter(struct menu
*m
,
64 void *(*callback
)(struct menu
*, struct menu_item
*, void *),
67 struct list_head
*pos
, *n
;
68 struct menu_item
*item
;
71 list_for_each_safe(pos
, n
, &m
->items
) {
72 item
= list_entry(pos
, struct menu_item
, list
);
74 ret
= callback(m
, item
, extra
);
84 * Print a menu_item. If the consumer provided an item_data_print function
85 * when creating the menu, call it with a pointer to the item's private data.
86 * Otherwise, print the key of the item.
88 static inline void *menu_item_print(struct menu
*m
,
89 struct menu_item
*item
,
92 if (!m
->item_data_print
) {
96 m
->item_data_print(item
->data
);
103 * Free the memory used by a menu item. This includes the memory used by its
106 static inline void *menu_item_destroy(struct menu
*m
,
107 struct menu_item
*item
,
118 void __menu_display_statusline(struct menu
*m
)
122 void menu_display_statusline(struct menu
*m
)
123 __attribute__ ((weak
, alias("__menu_display_statusline")));
126 * Display a menu so the user can make a choice of an item. First display its
127 * title, if any, and then each item in the menu.
129 static inline void menu_display(struct menu
*m
)
135 menu_display_statusline(m
);
137 menu_items_iter(m
, menu_item_print
, NULL
);
141 * Check if an item's key matches a provided string, pointed to by extra. If
142 * extra is NULL, an item with a NULL key will match. Otherwise, the item's
143 * key has to match according to strcmp.
145 * This is called via menu_items_iter, so it returns a pointer to the item if
146 * the key matches, and returns NULL otherwise.
148 static inline void *menu_item_key_match(struct menu
*m
,
149 struct menu_item
*item
, void *extra
)
151 char *item_key
= extra
;
153 if (!item_key
|| !item
->key
) {
154 if (item_key
== item
->key
)
160 if (strcmp(item
->key
, item_key
) == 0)
167 * Find the first item with a key matching item_key, if any exists.
169 static inline struct menu_item
*menu_item_by_key(struct menu
*m
,
172 return menu_items_iter(m
, menu_item_key_match
, item_key
);
176 * Set *choice to point to the default item's data, if any default item was
177 * set, and returns 1. If no default item was set, returns -ENOENT.
179 int menu_default_choice(struct menu
*m
, void **choice
)
181 if (m
->default_item
) {
182 *choice
= m
->default_item
->data
;
190 * Displays the menu and asks the user to choose an item. *choice will point
191 * to the private data of the item the user chooses. The user makes a choice
192 * by inputting a string matching the key of an item. Invalid choices will
193 * cause the user to be prompted again, repeatedly, until the user makes a
194 * valid choice. The user can exit the menu without making a choice via ^c.
196 * Returns 1 if the user made a choice, or -EINTR if they bail via ^c.
198 static inline int menu_interactive_choice(struct menu
*m
, void **choice
)
200 char cbuf
[CONFIG_SYS_CBSIZE
];
201 struct menu_item
*choice_item
= NULL
;
204 while (!choice_item
) {
209 if (!m
->item_choice
) {
210 readret
= readline_into_buffer("Enter choice: ", cbuf
,
214 choice_item
= menu_item_by_key(m
, cbuf
);
216 printf("%s not found\n", cbuf
);
218 return menu_default_choice(m
, choice
);
221 char *key
= m
->item_choice(m
->item_choice_data
);
224 choice_item
= menu_item_by_key(m
, key
);
231 *choice
= choice_item
->data
;
237 * menu_default_set() - Sets the default choice for the menu. This is safe to
238 * call more than once on a menu.
240 * m - Points to a menu created by menu_create().
242 * item_key - Points to a string that, when compared using strcmp, matches the
243 * key for an existing item in the menu.
245 * Returns 1 if successful, -EINVAL if m is NULL, or -ENOENT if no item with a
246 * key matching item_key is found.
248 int menu_default_set(struct menu
*m
, char *item_key
)
250 struct menu_item
*item
;
255 item
= menu_item_by_key(m
, item_key
);
260 m
->default_item
= item
;
266 * menu_get_choice() - Returns the user's selected menu entry, or the default
267 * if the menu is set to not prompt or the timeout expires. This is safe to
268 * call more than once.
270 * m - Points to a menu created by menu_create().
272 * choice - Points to a location that will store a pointer to the selected
273 * menu item. If no item is selected or there is an error, no value will be
274 * written at the location it points to.
276 * Returns 1 if successful, -EINVAL if m or choice is NULL, -ENOENT if no
277 * default has been set and the menu is set to not prompt or the timeout
278 * expires, or -EINTR if the user exits the menu via ^c.
280 int menu_get_choice(struct menu
*m
, void **choice
)
286 return menu_default_choice(m
, choice
);
288 return menu_interactive_choice(m
, choice
);
292 * menu_item_add() - Adds or replaces a menu item. Note that this replaces the
293 * data of an item if it already exists, but doesn't change the order of the
296 * m - Points to a menu created by menu_create().
298 * item_key - Points to a string that will uniquely identify the item. The
299 * string will be copied to internal storage, and is safe to discard after
300 * passing to menu_item_add.
302 * item_data - An opaque pointer associated with an item. It is never
303 * dereferenced internally, but will be passed to the item_data_print, and
304 * will be returned from menu_get_choice if the menu item is selected.
306 * Returns 1 if successful, -EINVAL if m is NULL, or -ENOMEM if there is
307 * insufficient memory to add the menu item.
309 int menu_item_add(struct menu
*m
, char *item_key
, void *item_data
)
311 struct menu_item
*item
;
316 item
= menu_item_by_key(m
, item_key
);
319 item
->data
= item_data
;
323 item
= malloc(sizeof *item
);
327 item
->key
= strdup(item_key
);
334 item
->data
= item_data
;
336 list_add_tail(&item
->list
, &m
->items
);
342 * menu_create() - Creates a menu handle with default settings
344 * title - If not NULL, points to a string that will be displayed before the
345 * list of menu items. It will be copied to internal storage, and is safe to
346 * discard after passing to menu_create().
348 * timeout - A delay in seconds to wait for user input. If 0, timeout is
349 * disabled, and the default choice will be returned unless prompt is 1.
351 * prompt - If 0, don't ask for user input unless there is an interrupted
352 * timeout. If 1, the user will be prompted for input regardless of the value
355 * item_data_print - If not NULL, will be called for each item when the menu
356 * is displayed, with the pointer to the item's data passed as the argument.
357 * If NULL, each item's key will be printed instead. Since an item's key is
358 * what must be entered to select an item, the item_data_print function should
359 * make it obvious what the key for each entry is.
361 * item_choice - If not NULL, will be called when asking the user to choose an
362 * item. Returns a key string corresponding to the choosen item or NULL if
363 * no item has been selected.
365 * item_choice_data - Will be passed as the argument to the item_choice function
367 * Returns a pointer to the menu if successful, or NULL if there is
368 * insufficient memory available to create the menu.
370 struct menu
*menu_create(char *title
, int timeout
, int prompt
,
371 void (*item_data_print
)(void *),
372 char *(*item_choice
)(void *),
373 void *item_choice_data
)
377 m
= malloc(sizeof *m
);
382 m
->default_item
= NULL
;
384 m
->timeout
= timeout
;
385 m
->item_data_print
= item_data_print
;
386 m
->item_choice
= item_choice
;
387 m
->item_choice_data
= item_choice_data
;
390 m
->title
= strdup(title
);
399 INIT_LIST_HEAD(&m
->items
);
405 * menu_destroy() - frees the memory used by a menu and its items.
407 * m - Points to a menu created by menu_create().
409 * Returns 1 if successful, or -EINVAL if m is NULL.
411 int menu_destroy(struct menu
*m
)
416 menu_items_iter(m
, menu_item_destroy
, NULL
);