woops... fix the header and bump the plugin API
[kugel-rb.git] / apps / menu.c
blobb5309a047e9e831bc051c5bc8ffbaf622d6ce5d9
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2002 Robert E. Hak
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
22 2005 Kevin Ferrare :
23 - Multi screen support
24 - Rewrote/removed a lot of code now useless with the new gui API
26 #include <stdbool.h>
27 #include <stdlib.h>
28 #include "config.h"
29 #include "system.h"
31 #include "lcd.h"
32 #include "font.h"
33 #include "backlight.h"
34 #include "menu.h"
35 #include "button.h"
36 #include "kernel.h"
37 #include "debug.h"
38 #include "usb.h"
39 #include "panic.h"
40 #include "settings.h"
41 #include "settings_list.h"
42 #include "option_select.h"
43 #include "status.h"
44 #include "screens.h"
45 #include "talk.h"
46 #include "lang.h"
47 #include "misc.h"
48 #include "action.h"
49 #include "menus/exported_menus.h"
50 #include "string.h"
51 #include "root_menu.h"
52 #include "bookmark.h"
53 #include "gwps-common.h" /* for fade() */
54 #include "audio.h"
55 #include "viewport.h"
56 #include "quickscreen.h"
58 #ifdef HAVE_LCD_BITMAP
59 #include "icons.h"
60 #endif
62 /* gui api */
63 #include "list.h"
64 #include "statusbar.h"
65 #include "buttonbar.h"
67 #define MAX_MENUS 8
68 /* used to allow for dynamic menus */
69 #define MAX_MENU_SUBITEMS 64
70 static struct menu_item_ex *current_submenus_menu;
71 static int current_subitems[MAX_MENU_SUBITEMS];
72 static int current_subitems_count = 0;
73 static int talk_menu_item(int selected_item, void *data);
75 static void get_menu_callback(const struct menu_item_ex *m,
76 menu_callback_type *menu_callback)
78 if (m->flags&(MENU_HAS_DESC|MENU_DYNAMIC_DESC))
79 *menu_callback= m->callback_and_desc->menu_callback;
80 else
81 *menu_callback = m->menu_callback;
84 static int get_menu_selection(int selected_item, const struct menu_item_ex *menu)
86 int type = (menu->flags&MENU_TYPE_MASK);
87 if (type == MT_MENU && (selected_item<current_subitems_count))
88 return current_subitems[selected_item];
89 return selected_item;
91 static int find_menu_selection(int selected)
93 int i;
94 for (i=0; i< current_subitems_count; i++)
95 if (current_subitems[i] == selected)
96 return i;
97 return 0;
99 static char * get_menu_item_name(int selected_item,
100 void * data,
101 char *buffer,
102 size_t buffer_len)
104 const struct menu_item_ex *menu = (const struct menu_item_ex *)data;
105 int type = (menu->flags&MENU_TYPE_MASK);
106 selected_item = get_menu_selection(selected_item, menu);
108 (void)buffer_len;
109 /* only MT_MENU or MT_RETURN_ID is allowed in here */
110 if (type == MT_RETURN_ID)
112 if (menu->flags&MENU_DYNAMIC_DESC)
113 return menu->menu_get_name_and_icon->list_get_name(selected_item,
114 menu->menu_get_name_and_icon->list_get_name_data, buffer);
115 return (char*)menu->strings[selected_item];
118 menu = menu->submenus[selected_item];
120 if ((menu->flags&MENU_DYNAMIC_DESC) && (type != MT_SETTING_W_TEXT))
121 return menu->menu_get_name_and_icon->list_get_name(selected_item,
122 menu->menu_get_name_and_icon->list_get_name_data, buffer);
124 type = (menu->flags&MENU_TYPE_MASK);
125 if ((type == MT_SETTING) || (type == MT_SETTING_W_TEXT))
127 const struct settings_list *v
128 = find_setting(menu->variable, NULL);
129 if (v)
130 return str(v->lang_id);
131 else return "Not Done yet!";
133 return P2STR(menu->callback_and_desc->desc);
135 #ifdef HAVE_LCD_BITMAP
136 static int menu_get_icon(int selected_item, void * data)
138 const struct menu_item_ex *menu = (const struct menu_item_ex *)data;
139 int menu_icon = Icon_NOICON;
140 selected_item = get_menu_selection(selected_item, menu);
142 if ((menu->flags&MENU_TYPE_MASK) == MT_RETURN_ID)
144 return Icon_Menu_functioncall;
146 menu = menu->submenus[selected_item];
147 if (menu->flags&MENU_HAS_DESC)
148 menu_icon = menu->callback_and_desc->icon_id;
149 else if (menu->flags&MENU_DYNAMIC_DESC)
150 menu_icon = menu->menu_get_name_and_icon->icon_id;
152 if (menu_icon == Icon_NOICON)
154 switch (menu->flags&MENU_TYPE_MASK)
156 case MT_SETTING:
157 case MT_SETTING_W_TEXT:
158 menu_icon = Icon_Menu_setting;
159 break;
160 case MT_MENU:
161 menu_icon = Icon_Submenu;
162 break;
163 case MT_FUNCTION_CALL:
164 case MT_RETURN_VALUE:
165 menu_icon = Icon_Menu_functioncall;
166 break;
169 return menu_icon;
171 #endif
173 static void init_menu_lists(const struct menu_item_ex *menu,
174 struct gui_synclist *lists, int selected, bool callback,
175 struct viewport parent[NB_SCREENS])
177 int i, count = MENU_GET_COUNT(menu->flags);
178 int type = (menu->flags&MENU_TYPE_MASK);
179 menu_callback_type menu_callback = NULL;
180 int icon;
181 current_subitems_count = 0;
183 if (type == MT_RETURN_ID)
184 get_menu_callback(menu, &menu_callback);
186 for (i=0; i<count; i++)
188 if (type != MT_RETURN_ID)
189 get_menu_callback(menu->submenus[i],&menu_callback);
190 if (menu_callback)
192 if (menu_callback(ACTION_REQUEST_MENUITEM,
193 type==MT_RETURN_ID ? (void*)(intptr_t)i: menu->submenus[i])
194 != ACTION_EXIT_MENUITEM)
196 current_subitems[current_subitems_count] = i;
197 current_subitems_count++;
200 else
202 current_subitems[current_subitems_count] = i;
203 current_subitems_count++;
206 current_submenus_menu = (struct menu_item_ex *)menu;
208 gui_synclist_init(lists,get_menu_item_name,(void*)menu,false,1, parent);
209 #ifdef HAVE_LCD_BITMAP
210 if (menu->callback_and_desc->icon_id == Icon_NOICON)
211 icon = Icon_Submenu_Entered;
212 else
213 icon = menu->callback_and_desc->icon_id;
214 gui_synclist_set_title(lists, P2STR(menu->callback_and_desc->desc), icon);
215 gui_synclist_set_icon_callback(lists, menu_get_icon);
216 #else
217 (void)icon;
218 gui_synclist_set_icon_callback(lists, NULL);
219 #endif
220 if(global_settings.talk_menu)
221 gui_synclist_set_voice_callback(lists, talk_menu_item);
222 gui_synclist_set_nb_items(lists,current_subitems_count);
223 gui_synclist_limit_scroll(lists,true);
224 gui_synclist_select_item(lists, find_menu_selection(selected));
226 get_menu_callback(menu,&menu_callback);
227 if (callback && menu_callback)
228 menu_callback(ACTION_ENTER_MENUITEM,menu);
229 gui_synclist_draw(lists);
230 gui_synclist_speak_item(lists);
233 static int talk_menu_item(int selected_item, void *data)
235 const struct menu_item_ex *menu = (const struct menu_item_ex *)data;
236 int id = -1;
237 int type;
238 unsigned char *str;
239 int sel = get_menu_selection(selected_item, menu);
241 if ((menu->flags&MENU_TYPE_MASK) == MT_MENU)
243 type = menu->submenus[sel]->flags&MENU_TYPE_MASK;
244 if ((type == MT_SETTING) || (type == MT_SETTING_W_TEXT))
245 talk_setting(menu->submenus[sel]->variable);
246 else
248 if (menu->submenus[sel]->flags&(MENU_DYNAMIC_DESC))
250 int (*list_speak_item)(int selected_item, void * data)
251 = menu->submenus[sel]->menu_get_name_and_icon->
252 list_speak_item;
253 if(list_speak_item)
254 list_speak_item(sel, menu->submenus[sel]->
255 menu_get_name_and_icon->
256 list_get_name_data);
257 else
259 char buffer[80];
260 str = menu->submenus[sel]->menu_get_name_and_icon->
261 list_get_name(sel, menu->submenus[sel]->
262 menu_get_name_and_icon->
263 list_get_name_data, buffer);
264 id = P2ID(str);
267 else
268 id = P2ID(menu->submenus[sel]->callback_and_desc->desc);
269 if (id != -1)
270 talk_id(id,false);
273 else if(((menu->flags&MENU_TYPE_MASK) == MT_RETURN_ID))
275 if ((menu->flags&MENU_DYNAMIC_DESC) == 0)
277 unsigned char *s = (unsigned char *)menu->strings[sel];
278 /* string list, try to talk it if ID2P was used */
279 id = P2ID(s);
280 if (id != -1)
281 talk_id(id,false);
284 return 0;
287 bool do_setting_from_menu(const struct menu_item_ex *temp,
288 struct viewport parent[NB_SCREENS])
290 int setting_id, oldval;
291 const struct settings_list *setting = find_setting(
292 temp->variable,
293 &setting_id);
294 char *title;
295 char padded_title[MAX_PATH];
296 int var_type = setting->flags&F_T_MASK;
297 if (var_type == F_T_INT || var_type == F_T_UINT)
299 oldval = *(int*)setting->setting;
301 else if (var_type == F_T_BOOL)
303 oldval = *(bool*)setting->setting;
305 else
306 oldval = 0;
307 if ((temp->flags&MENU_TYPE_MASK) == MT_SETTING_W_TEXT)
308 title = temp->callback_and_desc->desc;
309 else
310 title = ID2P(setting->lang_id);
312 /* Pad the title string by repeating it. This is needed
313 so the scroll settings title can actually be used to
314 test the setting */
315 if (setting->flags&F_PADTITLE)
317 int i = 0, len;
318 if (setting->lang_id == -1)
319 title = (char*)setting->cfg_vals;
320 else
321 title = P2STR((unsigned char*)title);
322 len = strlen(title);
323 while (i < MAX_PATH-1)
325 int padlen = MIN(len, MAX_PATH-1-i);
326 strncpy(&padded_title[i], title, padlen);
327 i += padlen;
328 if (i<MAX_PATH-1)
329 padded_title[i++] = ' ';
331 padded_title[i] = '\0';
332 title = padded_title;
335 option_screen((struct settings_list *)setting, parent,
336 setting->flags&F_TEMPVAR, title);
337 if (var_type == F_T_INT || var_type == F_T_UINT)
339 return oldval != *(int*)setting->setting;
341 else if (var_type == F_T_BOOL)
343 return oldval != *(bool*)setting->setting;
345 return false;
348 /* display a menu */
349 int do_menu(const struct menu_item_ex *start_menu, int *start_selected,
350 struct viewport parent[NB_SCREENS], bool hide_bars)
352 int selected = start_selected? *start_selected : 0;
353 int action;
354 struct gui_synclist lists;
355 const struct menu_item_ex *temp, *menu;
356 int ret = 0, i;
357 bool redraw_lists;
359 const struct menu_item_ex *menu_stack[MAX_MENUS];
360 int menu_stack_selected_item[MAX_MENUS];
361 int stack_top = 0;
362 bool in_stringlist, done = false;
363 struct viewport *vps = NULL;
364 #ifdef HAVE_BUTTONBAR
365 struct gui_buttonbar buttonbar;
366 gui_buttonbar_init(&buttonbar);
367 gui_buttonbar_set_display(&buttonbar, &(screens[SCREEN_MAIN]) );
368 gui_buttonbar_set(&buttonbar, "<<<", "", "");
369 #endif
371 menu_callback_type menu_callback = NULL;
372 if (start_menu == NULL)
373 menu = &main_menu_;
374 else menu = start_menu;
376 /* if hide_bars is true, assume parent has been fixed before passed into
377 * this function, e.g. with viewport_set_defaults(parent, screen, true) */
378 init_menu_lists(menu, &lists, selected, true, parent);
379 vps = *(lists.parent);
380 in_stringlist = ((menu->flags&MENU_TYPE_MASK) == MT_RETURN_ID);
381 /* load the callback, and only reload it if menu changes */
382 get_menu_callback(menu, &menu_callback);
385 #ifdef HAVE_BUTTONBAR
386 if (!hide_bars)
388 gui_buttonbar_set(&buttonbar, "<<<", "", "");
389 gui_buttonbar_draw(&buttonbar);
391 #endif
392 while (!done)
394 redraw_lists = false;
395 if (!hide_bars)
397 #ifdef HAVE_BUTTONBAR
398 gui_buttonbar_draw(&buttonbar);
399 #endif
401 action = get_action(CONTEXT_MAINMENU,
402 list_do_action_timeout(&lists, HZ));
403 /* HZ so the status bar redraws corectly */
405 if (menu_callback)
407 int old_action = action;
408 action = menu_callback(action, menu);
409 if (action == ACTION_EXIT_AFTER_THIS_MENUITEM)
411 action = old_action;
412 ret = MENU_SELECTED_EXIT; /* will exit after returning
413 from selection */
415 else if (action == ACTION_REDRAW)
417 action = old_action;
418 redraw_lists = true;
422 if (gui_synclist_do_button(&lists, &action, LIST_WRAP_UNLESS_HELD))
423 continue;
424 if (action == ACTION_NONE)
425 continue;
426 #ifdef HAVE_QUICKSCREEN
427 else if (action == ACTION_STD_QUICKSCREEN)
429 quick_screen_quick(action);
430 redraw_lists = true;
432 #endif
433 #ifdef HAVE_RECORDING
434 else if (action == ACTION_STD_REC)
436 ret = GO_TO_RECSCREEN;
437 done = true;
439 #endif
440 else if (action == ACTION_TREE_WPS)
442 ret = GO_TO_PREVIOUS_MUSIC;
443 done = true;
445 else if (action == ACTION_TREE_STOP)
447 redraw_lists = list_stop_handler();
449 else if (action == ACTION_STD_CONTEXT)
451 if (menu == &root_menu_)
453 ret = GO_TO_ROOTITEM_CONTEXT;
454 done = true;
456 else if (!in_stringlist)
458 int type;
459 selected = get_menu_selection(gui_synclist_get_sel_pos(&lists),menu);
460 temp = menu->submenus[selected];
461 type = (temp->flags&MENU_TYPE_MASK);
462 if ((type == MT_SETTING_W_TEXT || type == MT_SETTING))
464 #ifdef HAVE_QUICKSCREEN
465 MENUITEM_STRINGLIST(quickscreen_able_option,
466 ID2P(LANG_ONPLAY_MENU_TITLE), NULL,
467 ID2P(LANG_RESET_SETTING),
468 ID2P(LANG_LEFT_QS_ITEM),
469 ID2P(LANG_BOTTOM_QS_ITEM),
470 ID2P(LANG_RIGHT_QS_ITEM));
471 #endif
472 MENUITEM_STRINGLIST(notquickscreen_able_option,
473 ID2P(LANG_ONPLAY_MENU_TITLE), NULL,
474 ID2P(LANG_RESET_SETTING));
475 const struct menu_item_ex *menu;
476 int menu_selection = 0;
477 const struct settings_list *setting =
478 find_setting(temp->variable, NULL);
479 #ifdef HAVE_QUICKSCREEN
480 if (is_setting_quickscreenable(setting))
481 menu = &quickscreen_able_option;
482 else
483 #endif
484 menu = &notquickscreen_able_option;
485 switch (do_menu(menu, &menu_selection, NULL, false))
487 case GO_TO_PREVIOUS:
488 break;
489 case 0: /* reset setting */
490 reset_setting(setting, setting->setting);
491 break;
492 #ifdef HAVE_QUICKSCREEN
493 break;
494 case 1: /* set as left QS item */
495 set_as_qs_item(setting, QUICKSCREEN_LEFT);
496 break;
497 case 2: /* set as bottom QS item */
498 set_as_qs_item(setting, QUICKSCREEN_BOTTOM);
499 break;
500 case 3: /* set as right QS item */
501 set_as_qs_item(setting, QUICKSCREEN_RIGHT);
502 break;
503 #endif
504 } /* swicth(do_menu()) */
505 redraw_lists = true;
507 } /* else if (!in_stringlist) */
509 else if (action == ACTION_STD_MENU)
511 if (menu != &root_menu_)
512 ret = GO_TO_ROOT;
513 else
514 ret = GO_TO_PREVIOUS;
515 done = true;
517 else if (action == ACTION_STD_CANCEL)
519 bool exiting_menu = false;
520 in_stringlist = false;
521 /* might be leaving list, so stop scrolling */
522 FOR_NB_SCREENS(i)
524 screens[i].stop_scroll();
526 if (menu_callback)
527 menu_callback(ACTION_EXIT_MENUITEM, menu);
529 if (menu->flags&MENU_EXITAFTERTHISMENU)
530 done = true;
531 else if ((menu->flags&MENU_TYPE_MASK) == MT_MENU)
532 exiting_menu = true;
533 if (stack_top > 0)
535 stack_top--;
536 menu = menu_stack[stack_top];
537 if (!exiting_menu && (menu->flags&MENU_EXITAFTERTHISMENU))
538 done = true;
539 else
540 init_menu_lists(menu, &lists,
541 menu_stack_selected_item[stack_top], false, vps);
542 /* new menu, so reload the callback */
543 get_menu_callback(menu, &menu_callback);
545 else if (menu != &root_menu_)
547 ret = GO_TO_PREVIOUS;
548 done = true;
551 else if (action == ACTION_STD_OK)
553 int type;
554 /* entering an item that may not be a list, so stop scrolling */
555 FOR_NB_SCREENS(i)
557 screens[i].stop_scroll();
559 #ifdef HAVE_BUTTONBAR
560 if (!hide_bars)
562 gui_buttonbar_unset(&buttonbar);
563 gui_buttonbar_draw(&buttonbar);
565 #endif
566 selected = get_menu_selection(gui_synclist_get_sel_pos(&lists), menu);
567 temp = menu->submenus[selected];
568 redraw_lists = true;
569 if (in_stringlist)
570 type = (menu->flags&MENU_TYPE_MASK);
571 else
573 type = (temp->flags&MENU_TYPE_MASK);
574 get_menu_callback(temp, &menu_callback);
575 if (menu_callback)
577 action = menu_callback(ACTION_ENTER_MENUITEM,temp);
578 if (action == ACTION_EXIT_MENUITEM)
579 break;
582 switch (type)
584 case MT_MENU:
585 if (stack_top < MAX_MENUS)
587 menu_stack[stack_top] = menu;
588 menu_stack_selected_item[stack_top] = selected;
589 stack_top++;
590 init_menu_lists(temp, &lists, 0, true, vps);
591 redraw_lists = false; /* above does the redraw */
592 menu = temp;
594 break;
595 case MT_FUNCTION_CALL:
597 int return_value;
598 if (temp->flags&MENU_FUNC_USEPARAM)
599 return_value = temp->function->function_w_param(
600 temp->function->param);
601 else
602 return_value = temp->function->function();
603 if (!(menu->flags&MENU_EXITAFTERTHISMENU) ||
604 (temp->flags&MENU_EXITAFTERTHISMENU))
606 init_menu_lists(menu, &lists, selected, true, vps);
608 if (temp->flags&MENU_FUNC_CHECK_RETVAL)
610 if (return_value != 0)
612 done = true;
613 ret = return_value;
616 break;
618 case MT_SETTING:
619 case MT_SETTING_W_TEXT:
621 if (do_setting_from_menu(temp, vps))
623 init_menu_lists(menu, &lists, selected, true,vps);
624 redraw_lists = false; /* above does the redraw */
626 break;
628 case MT_RETURN_ID:
629 if (in_stringlist)
631 done = true;
632 ret = selected;
634 else if (stack_top < MAX_MENUS)
636 menu_stack[stack_top] = menu;
637 menu_stack_selected_item[stack_top] = selected;
638 stack_top++;
639 menu = temp;
640 init_menu_lists(menu,&lists,0,false, vps);
641 redraw_lists = false; /* above does the redraw */
642 in_stringlist = true;
644 break;
645 case MT_RETURN_VALUE:
646 ret = temp->value;
647 done = true;
648 break;
650 if (type != MT_MENU)
652 if (menu_callback)
653 menu_callback(ACTION_EXIT_MENUITEM,temp);
655 if (current_submenus_menu != menu)
656 init_menu_lists(menu,&lists,selected,true,vps);
657 /* callback was changed, so reload the menu's callback */
658 get_menu_callback(menu, &menu_callback);
659 if ((menu->flags&MENU_EXITAFTERTHISMENU) &&
660 !(temp->flags&MENU_EXITAFTERTHISMENU))
662 done = true;
663 break;
665 #ifdef HAVE_BUTTONBAR
666 if (!hide_bars)
668 gui_buttonbar_set(&buttonbar, "<<<", "", "");
669 gui_buttonbar_draw(&buttonbar);
671 #endif
673 else if(default_event_handler(action) == SYS_USB_CONNECTED)
675 ret = MENU_ATTACHED_USB;
676 done = true;
679 if (redraw_lists && !done)
681 if (menu_callback)
682 menu_callback(ACTION_REDRAW, menu);
683 gui_synclist_draw(&lists);
684 gui_synclist_speak_item(&lists);
687 if (start_selected)
689 /* make sure the start_selected variable is set to
690 the selected item from the menu do_menu() was called from */
691 if (stack_top > 0)
693 menu = menu_stack[0];
694 init_menu_lists(menu,&lists,menu_stack_selected_item[0],true, vps);
696 *start_selected = get_menu_selection(
697 gui_synclist_get_sel_pos(&lists), menu);
699 return ret;