Correct flawed search&replace.
[kugel-rb.git] / apps / menu.c
blob5b8b121b1a45daa0050aa0300d367d70323c7008
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 "appevents.h"
32 #include "lcd.h"
33 #include "font.h"
34 #include "file.h"
35 #include "menu.h"
36 #include "button.h"
37 #include "kernel.h"
38 #include "debug.h"
39 #include "usb.h"
40 #include "panic.h"
41 #include "settings.h"
42 #include "settings_list.h"
43 #include "option_select.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 "audio.h"
53 #include "viewport.h"
54 #include "quickscreen.h"
56 #ifdef HAVE_LCD_BITMAP
57 #include "icons.h"
58 #endif
60 /* gui api */
61 #include "list.h"
62 #include "buttonbar.h"
64 #define MAX_MENUS 8
65 /* used to allow for dynamic menus */
66 #define MAX_MENU_SUBITEMS 64
67 static struct menu_item_ex *current_submenus_menu;
68 static int current_subitems[MAX_MENU_SUBITEMS];
69 static int current_subitems_count = 0;
70 static int talk_menu_item(int selected_item, void *data);
72 static void get_menu_callback(const struct menu_item_ex *m,
73 menu_callback_type *menu_callback)
75 if (m->flags&(MENU_HAS_DESC|MENU_DYNAMIC_DESC))
76 *menu_callback= m->callback_and_desc->menu_callback;
77 else
78 *menu_callback = m->menu_callback;
81 static int get_menu_selection(int selected_item, const struct menu_item_ex *menu)
83 int type = (menu->flags&MENU_TYPE_MASK);
84 if ((type == MT_MENU || type == MT_RETURN_ID)
85 && (selected_item<current_subitems_count))
86 return current_subitems[selected_item];
87 return selected_item;
89 static int find_menu_selection(int selected)
91 int i;
92 for (i=0; i< current_subitems_count; i++)
93 if (current_subitems[i] == selected)
94 return i;
95 return 0;
97 static const char* get_menu_item_name(int selected_item,
98 void * data,
99 char *buffer,
100 size_t buffer_len)
102 const struct menu_item_ex *menu = (const struct menu_item_ex *)data;
103 int type = (menu->flags&MENU_TYPE_MASK);
104 selected_item = get_menu_selection(selected_item, menu);
106 (void)buffer_len;
107 /* only MT_MENU or MT_RETURN_ID is allowed in here */
108 if (type == MT_RETURN_ID)
110 if (menu->flags&MENU_DYNAMIC_DESC)
111 return menu->menu_get_name_and_icon->list_get_name(selected_item,
112 menu->menu_get_name_and_icon->list_get_name_data, buffer);
113 return menu->strings[selected_item];
116 menu = menu->submenus[selected_item];
118 if ((menu->flags&MENU_DYNAMIC_DESC) && (type != MT_SETTING_W_TEXT))
119 return menu->menu_get_name_and_icon->list_get_name(selected_item,
120 menu->menu_get_name_and_icon->list_get_name_data, buffer);
122 type = (menu->flags&MENU_TYPE_MASK);
123 if ((type == MT_SETTING) || (type == MT_SETTING_W_TEXT))
125 const struct settings_list *v
126 = find_setting(menu->variable, NULL);
127 if (v)
128 return str(v->lang_id);
129 else return "Not Done yet!";
131 return P2STR(menu->callback_and_desc->desc);
133 #ifdef HAVE_LCD_BITMAP
134 static enum themable_icons menu_get_icon(int selected_item, void * data)
136 const struct menu_item_ex *menu = (const struct menu_item_ex *)data;
137 int menu_icon = Icon_NOICON;
138 selected_item = get_menu_selection(selected_item, menu);
140 if ((menu->flags&MENU_TYPE_MASK) == MT_RETURN_ID)
142 return Icon_Menu_functioncall;
144 menu = menu->submenus[selected_item];
145 if (menu->flags&MENU_HAS_DESC)
146 menu_icon = menu->callback_and_desc->icon_id;
147 else if (menu->flags&MENU_DYNAMIC_DESC)
148 menu_icon = menu->menu_get_name_and_icon->icon_id;
150 if (menu_icon == Icon_NOICON)
152 switch (menu->flags&MENU_TYPE_MASK)
154 case MT_SETTING:
155 case MT_SETTING_W_TEXT:
156 menu_icon = Icon_Menu_setting;
157 break;
158 case MT_MENU:
159 menu_icon = Icon_Submenu;
160 break;
161 case MT_FUNCTION_CALL:
162 case MT_RETURN_VALUE:
163 menu_icon = Icon_Menu_functioncall;
164 break;
167 return menu_icon;
169 #endif
171 static void init_menu_lists(const struct menu_item_ex *menu,
172 struct gui_synclist *lists, int selected, bool callback,
173 struct viewport parent[NB_SCREENS])
175 int i, count = MENU_GET_COUNT(menu->flags);
176 int type = (menu->flags&MENU_TYPE_MASK);
177 menu_callback_type menu_callback = NULL;
178 int icon;
179 current_subitems_count = 0;
181 if (type == MT_RETURN_ID)
182 get_menu_callback(menu, &menu_callback);
184 for (i=0; i<count; i++)
186 if (type != MT_RETURN_ID)
187 get_menu_callback(menu->submenus[i],&menu_callback);
188 if (menu_callback)
190 if (menu_callback(ACTION_REQUEST_MENUITEM,
191 type==MT_RETURN_ID ? (void*)(intptr_t)i: menu->submenus[i])
192 != ACTION_EXIT_MENUITEM)
194 current_subitems[current_subitems_count] = i;
195 current_subitems_count++;
198 else
200 current_subitems[current_subitems_count] = i;
201 current_subitems_count++;
204 current_submenus_menu = (struct menu_item_ex *)menu;
206 gui_synclist_init(lists,get_menu_item_name,(void*)menu,false,1, parent);
207 #ifdef HAVE_LCD_BITMAP
208 if (menu->callback_and_desc->icon_id == Icon_NOICON)
209 icon = Icon_Submenu_Entered;
210 else
211 icon = menu->callback_and_desc->icon_id;
212 gui_synclist_set_title(lists, P2STR(menu->callback_and_desc->desc), icon);
213 gui_synclist_set_icon_callback(lists, global_settings.show_icons?menu_get_icon:NULL);
214 #else
215 (void)icon;
216 gui_synclist_set_icon_callback(lists, NULL);
217 #endif
218 if(global_settings.talk_menu)
219 gui_synclist_set_voice_callback(lists, talk_menu_item);
220 gui_synclist_set_nb_items(lists,current_subitems_count);
221 gui_synclist_limit_scroll(lists,true);
222 gui_synclist_select_item(lists, find_menu_selection(selected));
224 get_menu_callback(menu,&menu_callback);
225 if (callback && menu_callback)
226 menu_callback(ACTION_ENTER_MENUITEM,menu);
229 static int talk_menu_item(int selected_item, void *data)
231 const struct menu_item_ex *menu = (const struct menu_item_ex *)data;
232 int id = -1;
233 int type;
234 unsigned char *str;
235 int sel = get_menu_selection(selected_item, menu);
237 if ((menu->flags&MENU_TYPE_MASK) == MT_MENU)
239 type = menu->submenus[sel]->flags&MENU_TYPE_MASK;
240 if ((type == MT_SETTING) || (type == MT_SETTING_W_TEXT))
241 talk_setting(menu->submenus[sel]->variable);
242 else
244 if (menu->submenus[sel]->flags&(MENU_DYNAMIC_DESC))
246 int (*list_speak_item)(int selected_item, void * data)
247 = menu->submenus[sel]->menu_get_name_and_icon->
248 list_speak_item;
249 if(list_speak_item)
250 list_speak_item(sel, menu->submenus[sel]->
251 menu_get_name_and_icon->
252 list_get_name_data);
253 else
255 char buffer[80];
256 str = menu->submenus[sel]->menu_get_name_and_icon->
257 list_get_name(sel, menu->submenus[sel]->
258 menu_get_name_and_icon->
259 list_get_name_data, buffer);
260 id = P2ID(str);
263 else
264 id = P2ID(menu->submenus[sel]->callback_and_desc->desc);
265 if (id != -1)
266 talk_id(id,false);
269 else if(((menu->flags&MENU_TYPE_MASK) == MT_RETURN_ID))
271 if ((menu->flags&MENU_DYNAMIC_DESC) == 0)
273 unsigned char *s = (unsigned char *)menu->strings[sel];
274 /* string list, try to talk it if ID2P was used */
275 id = P2ID(s);
276 if (id != -1)
277 talk_id(id,false);
280 return 0;
283 void do_setting_from_menu(const struct menu_item_ex *temp,
284 struct viewport parent[NB_SCREENS])
286 int setting_id, oldval;
287 const struct settings_list *setting =
288 find_setting(temp->variable, &setting_id);
289 char *title;
290 char padded_title[MAX_PATH];
291 int var_type = setting->flags&F_T_MASK;
292 if (var_type == F_T_INT || var_type == F_T_UINT)
294 oldval = *(int*)setting->setting;
296 else if (var_type == F_T_BOOL)
298 oldval = *(bool*)setting->setting;
300 else
301 oldval = 0;
302 if ((temp->flags&MENU_TYPE_MASK) == MT_SETTING_W_TEXT)
303 title = temp->callback_and_desc->desc;
304 else
305 title = ID2P(setting->lang_id);
307 /* Pad the title string by repeating it. This is needed
308 so the scroll settings title can actually be used to
309 test the setting */
310 if (setting->flags&F_PADTITLE)
312 int i = 0, len;
313 if (setting->lang_id == -1)
314 title = (char*)setting->cfg_vals;
315 else
316 title = P2STR((unsigned char*)title);
317 len = strlen(title);
318 while (i < MAX_PATH-1)
320 int padlen = MIN(len, MAX_PATH-1-i);
321 memcpy(&padded_title[i], title, padlen);
322 i += padlen;
323 if (i<MAX_PATH-1)
324 padded_title[i++] = ' ';
326 padded_title[i] = '\0';
327 title = padded_title;
330 option_screen((struct settings_list *)setting, parent,
331 setting->flags&F_TEMPVAR, title);
334 /* display a menu */
335 int do_menu(const struct menu_item_ex *start_menu, int *start_selected,
336 struct viewport parent[NB_SCREENS], bool hide_theme)
338 int selected = start_selected? *start_selected : 0;
339 int action;
340 struct gui_synclist lists;
341 const struct menu_item_ex *temp, *menu;
342 int ret = 0, i;
343 bool redraw_lists;
344 int old_audio_status = audio_status();
345 FOR_NB_SCREENS(i)
346 viewportmanager_theme_enable(i, !hide_theme, NULL);
348 const struct menu_item_ex *menu_stack[MAX_MENUS];
349 int menu_stack_selected_item[MAX_MENUS];
350 int stack_top = 0;
351 bool in_stringlist, done = false;
352 struct viewport *vps = NULL;
353 #ifdef HAVE_BUTTONBAR
354 struct gui_buttonbar buttonbar;
355 gui_buttonbar_init(&buttonbar);
356 gui_buttonbar_set_display(&buttonbar, &(screens[SCREEN_MAIN]) );
357 gui_buttonbar_set(&buttonbar, "<<<", "", "");
358 #endif
360 menu_callback_type menu_callback = NULL;
361 if (start_menu == NULL)
362 menu = &main_menu_;
363 else menu = start_menu;
365 /* if hide_theme is true, assume parent has been fixed before passed into
366 * this function, e.g. with viewport_set_defaults(parent, screen) */
367 init_menu_lists(menu, &lists, selected, true, parent);
368 vps = *(lists.parent);
369 in_stringlist = ((menu->flags&MENU_TYPE_MASK) == MT_RETURN_ID);
370 /* load the callback, and only reload it if menu changes */
371 get_menu_callback(menu, &menu_callback);
373 gui_synclist_draw(&lists);
374 gui_synclist_speak_item(&lists);
375 #ifdef HAVE_BUTTONBAR
376 if (!hide_theme)
378 gui_buttonbar_set(&buttonbar, "<<<", "", "");
379 gui_buttonbar_draw(&buttonbar);
381 #endif
382 while (!done)
384 int new_audio_status;
385 redraw_lists = false;
386 if (!hide_theme)
388 #ifdef HAVE_BUTTONBAR
389 gui_buttonbar_draw(&buttonbar);
390 #endif
392 action = get_action(CONTEXT_MAINMENU,
393 list_do_action_timeout(&lists, HZ));
395 /* query audio status to see if it changed */
396 new_audio_status = audio_status();
397 if (old_audio_status != new_audio_status)
398 { /* force a redraw if anything changed the audio status
399 * from outside */
400 redraw_lists = true;
401 old_audio_status = new_audio_status;
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 #ifdef HAVE_QUICKSCREEN
425 else if (action == ACTION_STD_QUICKSCREEN)
427 quick_screen_quick(action);
428 redraw_lists = true;
430 #endif
431 #ifdef HAVE_RECORDING
432 else if (action == ACTION_STD_REC)
434 ret = GO_TO_RECSCREEN;
435 done = true;
437 #endif
438 else if (action == ACTION_TREE_WPS)
440 ret = GO_TO_PREVIOUS_MUSIC;
441 done = true;
443 else if (action == ACTION_TREE_STOP)
445 redraw_lists = list_stop_handler();
447 else if (action == ACTION_STD_CONTEXT)
449 if (menu == &root_menu_)
451 ret = GO_TO_ROOTITEM_CONTEXT;
452 done = true;
454 else if (!in_stringlist)
456 int type;
457 selected = get_menu_selection(gui_synclist_get_sel_pos(&lists),menu);
458 temp = menu->submenus[selected];
459 type = (temp->flags&MENU_TYPE_MASK);
460 if ((type == MT_SETTING_W_TEXT || type == MT_SETTING))
462 #ifdef HAVE_QUICKSCREEN
463 MENUITEM_STRINGLIST(quickscreen_able_option,
464 ID2P(LANG_ONPLAY_MENU_TITLE), NULL,
465 ID2P(LANG_RESET_SETTING),
466 ID2P(LANG_TOP_QS_ITEM),
467 ID2P(LANG_LEFT_QS_ITEM),
468 ID2P(LANG_BOTTOM_QS_ITEM),
469 ID2P(LANG_RIGHT_QS_ITEM));
470 #endif
471 MENUITEM_STRINGLIST(notquickscreen_able_option,
472 ID2P(LANG_ONPLAY_MENU_TITLE), NULL,
473 ID2P(LANG_RESET_SETTING));
474 const struct menu_item_ex *menu;
475 int menu_selection = 0;
476 const struct settings_list *setting =
477 find_setting(temp->variable, NULL);
478 #ifdef HAVE_QUICKSCREEN
479 if (is_setting_quickscreenable(setting))
480 menu = &quickscreen_able_option;
481 else
482 #endif
483 menu = &notquickscreen_able_option;
484 switch (do_menu(menu, &menu_selection, NULL, false))
486 case GO_TO_PREVIOUS:
487 break;
488 case 0: /* reset setting */
489 reset_setting(setting, setting->setting);
490 break;
491 #ifdef HAVE_QUICKSCREEN
492 case 1: /* set as top QS item */
493 set_as_qs_item(setting, QUICKSCREEN_TOP);
494 break;
495 case 2: /* set as left QS item */
496 set_as_qs_item(setting, QUICKSCREEN_LEFT);
497 break;
498 case 3: /* set as bottom QS item */
499 set_as_qs_item(setting, QUICKSCREEN_BOTTOM);
500 break;
501 case 4: /* set as right QS item */
502 set_as_qs_item(setting, QUICKSCREEN_RIGHT);
503 break;
504 #endif
505 } /* swicth(do_menu()) */
506 redraw_lists = true;
508 } /* else if (!in_stringlist) */
510 else if (action == ACTION_STD_MENU)
512 if (menu != &root_menu_)
513 ret = GO_TO_ROOT;
514 else
515 ret = GO_TO_PREVIOUS;
516 done = true;
518 else if (action == ACTION_STD_CANCEL)
520 bool exiting_menu = false;
521 in_stringlist = false;
522 /* might be leaving list, so stop scrolling */
523 gui_synclist_scroll_stop(&lists);
524 if (menu_callback)
525 menu_callback(ACTION_EXIT_MENUITEM, menu);
527 if (menu->flags&MENU_EXITAFTERTHISMENU)
528 done = true;
529 else if ((menu->flags&MENU_TYPE_MASK) == MT_MENU)
530 exiting_menu = true;
531 if (stack_top > 0)
533 stack_top--;
534 menu = menu_stack[stack_top];
535 if (!exiting_menu && (menu->flags&MENU_EXITAFTERTHISMENU))
536 done = true;
537 else
538 init_menu_lists(menu, &lists,
539 menu_stack_selected_item[stack_top], false, vps);
540 redraw_lists = true;
541 /* new menu, so reload the callback */
542 get_menu_callback(menu, &menu_callback);
544 else if (menu != &root_menu_)
546 ret = GO_TO_PREVIOUS;
547 done = true;
550 else if (action == ACTION_STD_OK)
552 int type;
553 /* entering an item that may not be a list, so stop scrolling */
554 gui_synclist_scroll_stop(&lists);
555 #ifdef HAVE_BUTTONBAR
556 if (!hide_theme)
558 gui_buttonbar_unset(&buttonbar);
559 gui_buttonbar_draw(&buttonbar);
561 #endif
562 selected = get_menu_selection(gui_synclist_get_sel_pos(&lists), menu);
563 temp = menu->submenus[selected];
564 redraw_lists = true;
565 if (in_stringlist)
566 type = (menu->flags&MENU_TYPE_MASK);
567 else
569 type = (temp->flags&MENU_TYPE_MASK);
570 get_menu_callback(temp, &menu_callback);
571 if (menu_callback)
573 action = menu_callback(ACTION_ENTER_MENUITEM,temp);
574 if (action == ACTION_EXIT_MENUITEM)
575 break;
578 switch (type)
580 case MT_MENU:
581 if (stack_top < MAX_MENUS)
583 menu_stack[stack_top] = menu;
584 menu_stack_selected_item[stack_top] = selected;
585 stack_top++;
586 menu = temp;
587 init_menu_lists(menu, &lists, 0, true, vps);
589 break;
590 case MT_FUNCTION_CALL:
592 int return_value;
593 if (temp->flags&MENU_FUNC_USEPARAM)
594 return_value = temp->function->function_w_param(
595 temp->function->param);
596 else
597 return_value = temp->function->function();
598 if (temp->flags&MENU_FUNC_CHECK_RETVAL)
600 if (return_value != 0)
602 done = true;
603 ret = return_value;
606 break;
608 case MT_SETTING:
609 case MT_SETTING_W_TEXT:
611 do_setting_from_menu(temp, vps);
612 send_event(GUI_EVENT_ACTIONUPDATE, (void*)1); /* force a redraw */
613 break;
615 case MT_RETURN_ID:
616 if (in_stringlist)
618 done = true;
619 ret = selected;
621 else if (stack_top < MAX_MENUS)
623 menu_stack[stack_top] = menu;
624 menu_stack_selected_item[stack_top] = selected;
625 stack_top++;
626 menu = temp;
627 init_menu_lists(menu,&lists,0,false, vps);
628 in_stringlist = true;
630 break;
631 case MT_RETURN_VALUE:
632 ret = temp->value;
633 done = true;
634 break;
636 if (type != MT_MENU)
638 if (menu_callback)
639 menu_callback(ACTION_EXIT_MENUITEM,temp);
641 if (current_submenus_menu != menu)
642 init_menu_lists(menu,&lists,selected,true,vps);
643 /* callback was changed, so reload the menu's callback */
644 get_menu_callback(menu, &menu_callback);
645 if ((menu->flags&MENU_EXITAFTERTHISMENU) &&
646 !(temp->flags&MENU_EXITAFTERTHISMENU))
648 done = true;
649 break;
651 #ifdef HAVE_BUTTONBAR
652 if (!hide_theme)
654 gui_buttonbar_set(&buttonbar, "<<<", "", "");
655 gui_buttonbar_draw(&buttonbar);
657 #endif
659 else if(default_event_handler(action) == SYS_USB_CONNECTED)
661 ret = MENU_ATTACHED_USB;
662 done = true;
665 if (redraw_lists && !done)
667 if (menu_callback)
668 menu_callback(ACTION_REDRAW, menu);
669 gui_synclist_draw(&lists);
670 gui_synclist_speak_item(&lists);
673 if (start_selected)
675 /* make sure the start_selected variable is set to
676 the selected item from the menu do_menu() was called from */
677 if (stack_top > 0)
679 menu = menu_stack[0];
680 init_menu_lists(menu,&lists,menu_stack_selected_item[0],true, vps);
682 *start_selected = get_menu_selection(
683 gui_synclist_get_sel_pos(&lists), menu);
685 FOR_NB_SCREENS(i)
686 viewportmanager_theme_undo(i, false);
687 return ret;