Don't objcopy simulator plugins.
[kugel-rb.git] / apps / menu.c
blob8edec585870b96aaa3e1d3656634bc5910d70464
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;
286 /* this is used to reload the default menu viewports when the
287 theme changes. nothing happens if the menu is using a supplied parent vp */
288 static void init_default_menu_viewports(struct viewport parent[NB_SCREENS], bool hide_bars)
290 int i;
291 FOR_NB_SCREENS(i)
293 viewport_set_defaults(&parent[i], i);
294 /* viewport_set_defaults() fixes the vp for the bars, so resize */
295 if (hide_bars)
297 if (global_settings.statusbar)
299 parent[i].y -= STATUSBAR_HEIGHT;
300 parent[i].height += STATUSBAR_HEIGHT;
304 #ifdef HAVE_BUTTONBAR
305 if (!hide_bars && global_settings.buttonbar)
306 parent[0].height -= BUTTONBAR_HEIGHT;
307 #endif
310 bool do_setting_from_menu(const struct menu_item_ex *temp,
311 struct viewport parent[NB_SCREENS])
313 int setting_id, oldval;
314 const struct settings_list *setting = find_setting(
315 temp->variable,
316 &setting_id);
317 char *title;
318 char padded_title[MAX_PATH];
319 int var_type = setting->flags&F_T_MASK;
320 if (var_type == F_T_INT || var_type == F_T_UINT)
322 oldval = *(int*)setting->setting;
324 else if (var_type == F_T_BOOL)
326 oldval = *(bool*)setting->setting;
328 else
329 oldval = 0;
330 if ((temp->flags&MENU_TYPE_MASK) == MT_SETTING_W_TEXT)
331 title = temp->callback_and_desc->desc;
332 else
333 title = ID2P(setting->lang_id);
335 /* Pad the title string by repeating it. This is needed
336 so the scroll settings title can actually be used to
337 test the setting */
338 if (setting->flags&F_PADTITLE)
340 int i = 0, len;
341 if (setting->lang_id == -1)
342 title = (char*)setting->cfg_vals;
343 else
344 title = P2STR((unsigned char*)title);
345 len = strlen(title);
346 while (i < MAX_PATH-1)
348 int padlen = MIN(len, MAX_PATH-1-i);
349 strncpy(&padded_title[i], title, padlen);
350 i += padlen;
351 if (i<MAX_PATH-1)
352 padded_title[i++] = ' ';
354 padded_title[i] = '\0';
355 title = padded_title;
358 option_screen((struct settings_list *)setting, parent,
359 setting->flags&F_TEMPVAR, title);
360 if (var_type == F_T_INT || var_type == F_T_UINT)
362 return oldval != *(int*)setting->setting;
364 else if (var_type == F_T_BOOL)
366 return oldval != *(bool*)setting->setting;
368 return false;
371 /* display a menu */
372 int do_menu(const struct menu_item_ex *start_menu, int *start_selected,
373 struct viewport parent[NB_SCREENS], bool hide_bars)
375 int selected = start_selected? *start_selected : 0;
376 int action;
377 struct gui_synclist lists;
378 const struct menu_item_ex *temp, *menu;
379 int ret = 0, i;
380 bool redraw_lists;
382 const struct menu_item_ex *menu_stack[MAX_MENUS];
383 int menu_stack_selected_item[MAX_MENUS];
384 int stack_top = 0;
385 bool in_stringlist, done = false;
387 struct viewport *vps, menu_vp[NB_SCREENS]; /* menu_vp will hopefully be phased out */
388 #ifdef HAVE_BUTTONBAR
389 struct gui_buttonbar buttonbar;
390 gui_buttonbar_init(&buttonbar);
391 gui_buttonbar_set_display(&buttonbar, &(screens[SCREEN_MAIN]) );
392 gui_buttonbar_set(&buttonbar, "<<<", "", "");
393 #endif
395 menu_callback_type menu_callback = NULL;
396 if (start_menu == NULL)
397 menu = &main_menu_;
398 else menu = start_menu;
400 init_default_menu_viewports(menu_vp, hide_bars);
402 if (parent)
404 vps = parent;
405 /* if hide_bars == true we assume the viewport is correctly sized */
407 else
409 vps = menu_vp;
411 FOR_NB_SCREENS(i)
413 screens[i].set_viewport(&vps[i]);
414 screens[i].clear_viewport();
415 screens[i].set_viewport(NULL);
417 init_menu_lists(menu, &lists, selected, true, vps);
418 in_stringlist = ((menu->flags&MENU_TYPE_MASK) == MT_RETURN_ID);
420 /* load the callback, and only reload it if menu changes */
421 get_menu_callback(menu, &menu_callback);
424 #ifdef HAVE_BUTTONBAR
425 if (!hide_bars)
427 gui_buttonbar_set(&buttonbar, "<<<", "", "");
428 gui_buttonbar_draw(&buttonbar);
430 #endif
431 while (!done)
433 redraw_lists = false;
434 if (!hide_bars)
436 gui_syncstatusbar_draw(&statusbars, true);
438 action = get_action(CONTEXT_MAINMENU,
439 list_do_action_timeout(&lists, HZ));
440 /* HZ so the status bar redraws corectly */
442 if (menu_callback)
444 int old_action = action;
445 action = menu_callback(action, menu);
446 if (action == ACTION_EXIT_AFTER_THIS_MENUITEM)
448 action = old_action;
449 ret = MENU_SELECTED_EXIT; /* will exit after returning
450 from selection */
452 else if (action == ACTION_REDRAW)
454 action = old_action;
455 redraw_lists = true;
459 if (gui_synclist_do_button(&lists, &action, LIST_WRAP_UNLESS_HELD))
460 continue;
461 if (action == ACTION_NONE)
462 continue;
463 #ifdef HAVE_QUICKSCREEN
464 else if (action == ACTION_STD_QUICKSCREEN)
466 quick_screen_quick(action);
467 redraw_lists = true;
469 #endif
470 #ifdef HAVE_RECORDING
471 else if (action == ACTION_STD_REC)
473 ret = GO_TO_RECSCREEN;
474 done = true;
476 #endif
477 else if (action == ACTION_TREE_WPS)
479 ret = GO_TO_PREVIOUS_MUSIC;
480 done = true;
482 else if (action == ACTION_TREE_STOP)
484 redraw_lists = list_stop_handler();
486 else if (action == ACTION_STD_CONTEXT)
488 if (menu == &root_menu_)
490 ret = GO_TO_ROOTITEM_CONTEXT;
491 done = true;
493 else if (!in_stringlist)
495 int type;
496 selected = get_menu_selection(gui_synclist_get_sel_pos(&lists), menu);
497 temp = menu->submenus[selected];
498 type = (temp->flags&MENU_TYPE_MASK);
499 if ((type == MT_SETTING_W_TEXT || type == MT_SETTING))
501 #ifdef HAVE_QUICKSCREEN
502 MENUITEM_STRINGLIST(quickscreen_able_option,
503 ID2P(LANG_ONPLAY_MENU_TITLE), NULL,
504 ID2P(LANG_RESET_SETTING),
505 ID2P(LANG_LEFT_QS_ITEM),
506 ID2P(LANG_BOTTOM_QS_ITEM),
507 ID2P(LANG_RIGHT_QS_ITEM));
508 #endif
509 MENUITEM_STRINGLIST(notquickscreen_able_option,
510 ID2P(LANG_ONPLAY_MENU_TITLE), NULL,
511 ID2P(LANG_RESET_SETTING));
512 const struct menu_item_ex *menu;
513 int menu_selection = 0;
514 const struct settings_list *setting =
515 find_setting(temp->variable, NULL);
516 #ifdef HAVE_QUICKSCREEN
517 if (is_setting_quickscreenable(setting))
518 menu = &quickscreen_able_option;
519 else
520 #endif
521 menu = &notquickscreen_able_option;
522 switch (do_menu(menu, &menu_selection, NULL, false))
524 case GO_TO_PREVIOUS:
525 break;
526 case 0: /* reset setting */
527 reset_setting(setting, setting->setting);
528 break;
529 #ifdef HAVE_QUICKSCREEN
530 break;
531 case 1: /* set as left QS item */
532 set_as_qs_item(setting, QUICKSCREEN_LEFT);
533 break;
534 case 2: /* set as bottom QS item */
535 set_as_qs_item(setting, QUICKSCREEN_BOTTOM);
536 break;
537 case 3: /* set as right QS item */
538 set_as_qs_item(setting, QUICKSCREEN_RIGHT);
539 break;
540 #endif
541 } /* swicth(do_menu()) */
542 redraw_lists = true;
544 } /* else if (!in_stringlist) */
546 else if (action == ACTION_STD_MENU)
548 if (menu != &root_menu_)
549 ret = GO_TO_ROOT;
550 else
551 ret = GO_TO_PREVIOUS;
552 done = true;
554 else if (action == ACTION_STD_CANCEL)
556 bool exiting_menu = false;
557 in_stringlist = false;
558 /* might be leaving list, so stop scrolling */
559 FOR_NB_SCREENS(i)
561 screens[i].stop_scroll();
563 if (menu_callback)
564 menu_callback(ACTION_EXIT_MENUITEM, menu);
566 if (menu->flags&MENU_EXITAFTERTHISMENU)
567 done = true;
568 else if ((menu->flags&MENU_TYPE_MASK) == MT_MENU)
569 exiting_menu = true;
570 if (stack_top > 0)
572 stack_top--;
573 menu = menu_stack[stack_top];
574 if (!exiting_menu && (menu->flags&MENU_EXITAFTERTHISMENU))
575 done = true;
576 else
577 init_menu_lists(menu, &lists,
578 menu_stack_selected_item[stack_top], false, vps);
579 /* new menu, so reload the callback */
580 get_menu_callback(menu, &menu_callback);
582 else if (menu != &root_menu_)
584 ret = GO_TO_PREVIOUS;
585 done = true;
588 else if (action == ACTION_STD_OK)
590 int type;
591 /* entering an item that may not be a list, so stop scrolling */
592 FOR_NB_SCREENS(i)
594 screens[i].stop_scroll();
596 #ifdef HAVE_BUTTONBAR
597 if (!hide_bars)
599 gui_buttonbar_unset(&buttonbar);
600 gui_buttonbar_draw(&buttonbar);
602 #endif
603 selected = get_menu_selection(gui_synclist_get_sel_pos(&lists), menu);
604 temp = menu->submenus[selected];
605 redraw_lists = true;
606 if (in_stringlist)
607 type = (menu->flags&MENU_TYPE_MASK);
608 else
610 type = (temp->flags&MENU_TYPE_MASK);
611 get_menu_callback(temp, &menu_callback);
612 if (menu_callback)
614 action = menu_callback(ACTION_ENTER_MENUITEM,temp);
615 if (action == ACTION_EXIT_MENUITEM)
616 break;
619 switch (type)
621 case MT_MENU:
622 if (stack_top < MAX_MENUS)
624 menu_stack[stack_top] = menu;
625 menu_stack_selected_item[stack_top] = selected;
626 stack_top++;
627 init_menu_lists(temp, &lists, 0, true, vps);
628 redraw_lists = false; /* above does the redraw */
629 menu = temp;
631 break;
632 case MT_FUNCTION_CALL:
634 int return_value;
635 if (temp->flags&MENU_FUNC_USEPARAM)
636 return_value = temp->function->function_w_param(
637 temp->function->param);
638 else
639 return_value = temp->function->function();
640 if (!(menu->flags&MENU_EXITAFTERTHISMENU) || (temp->flags&MENU_EXITAFTERTHISMENU))
642 init_menu_lists(menu, &lists, selected, true, vps);
644 if (temp->flags&MENU_FUNC_CHECK_RETVAL)
646 if (return_value != 0)
648 done = true;
649 ret = return_value;
652 break;
654 case MT_SETTING:
655 case MT_SETTING_W_TEXT:
657 if (do_setting_from_menu(temp, menu_vp))
659 init_menu_lists(menu, &lists, selected, true,vps);
660 redraw_lists = false; /* above does the redraw */
662 break;
664 case MT_RETURN_ID:
665 if (in_stringlist)
667 done = true;
668 ret = selected;
670 else if (stack_top < MAX_MENUS)
672 menu_stack[stack_top] = menu;
673 menu_stack_selected_item[stack_top] = selected;
674 stack_top++;
675 menu = temp;
676 init_menu_lists(menu,&lists,0,false, vps);
677 redraw_lists = false; /* above does the redraw */
678 in_stringlist = true;
680 break;
681 case MT_RETURN_VALUE:
682 ret = temp->value;
683 done = true;
684 break;
686 if (type != MT_MENU)
688 if (menu_callback)
689 menu_callback(ACTION_EXIT_MENUITEM,temp);
691 if (current_submenus_menu != menu)
692 init_menu_lists(menu,&lists,selected,true,vps);
693 /* callback was changed, so reload the menu's callback */
694 get_menu_callback(menu, &menu_callback);
695 if ((menu->flags&MENU_EXITAFTERTHISMENU) &&
696 !(temp->flags&MENU_EXITAFTERTHISMENU))
698 done = true;
699 break;
701 #ifdef HAVE_BUTTONBAR
702 if (!hide_bars)
704 gui_buttonbar_set(&buttonbar, "<<<", "", "");
705 gui_buttonbar_draw(&buttonbar);
707 #endif
709 else if(default_event_handler(action) == SYS_USB_CONNECTED)
711 ret = MENU_ATTACHED_USB;
712 done = true;
715 if (redraw_lists && !done)
717 if (menu_callback)
718 menu_callback(ACTION_REDRAW, menu);
719 gui_synclist_draw(&lists);
720 gui_synclist_speak_item(&lists);
723 if (start_selected)
725 /* make sure the start_selected variable is set to
726 the selected item from the menu do_menu() was called from */
727 if (stack_top > 0)
729 menu = menu_stack[0];
730 init_menu_lists(menu,&lists,menu_stack_selected_item[0],true, vps);
732 *start_selected = get_menu_selection(
733 gui_synclist_get_sel_pos(&lists), menu);
735 return ret;