GSoC/Buflib: Enable compaction in buflib.
[kugel-rb.git] / apps / menu.c
blob6a28b1de26ecc6d057da5962f3098e01f82bd90e
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;
287 const struct settings_list *setting =
288 find_setting(temp->variable, &setting_id);
289 char *title;
290 char padded_title[MAX_PATH];
291 if ((temp->flags&MENU_TYPE_MASK) == MT_SETTING_W_TEXT)
292 title = temp->callback_and_desc->desc;
293 else
294 title = ID2P(setting->lang_id);
296 /* Pad the title string by repeating it. This is needed
297 so the scroll settings title can actually be used to
298 test the setting */
299 if (setting->flags&F_PADTITLE)
301 int i = 0, len;
302 if (setting->lang_id == -1)
303 title = (char*)setting->cfg_vals;
304 else
305 title = P2STR((unsigned char*)title);
306 len = strlen(title);
307 while (i < MAX_PATH-1)
309 int padlen = MIN(len, MAX_PATH-1-i);
310 memcpy(&padded_title[i], title, padlen);
311 i += padlen;
312 if (i<MAX_PATH-1)
313 padded_title[i++] = ' ';
315 padded_title[i] = '\0';
316 title = padded_title;
319 option_screen((struct settings_list *)setting, parent,
320 setting->flags&F_TEMPVAR, title);
323 /* display a menu */
324 int do_menu(const struct menu_item_ex *start_menu, int *start_selected,
325 struct viewport parent[NB_SCREENS], bool hide_theme)
327 int selected = start_selected? *start_selected : 0;
328 int action;
329 struct gui_synclist lists;
330 const struct menu_item_ex *temp, *menu = start_menu;
331 int ret = 0, i;
332 bool redraw_lists;
333 int old_audio_status = audio_status();
334 FOR_NB_SCREENS(i)
335 viewportmanager_theme_enable(i, !hide_theme, NULL);
337 const struct menu_item_ex *menu_stack[MAX_MENUS];
338 int menu_stack_selected_item[MAX_MENUS];
339 int stack_top = 0;
340 bool in_stringlist, done = false;
341 struct viewport *vps = NULL;
342 #ifdef HAVE_BUTTONBAR
343 struct gui_buttonbar buttonbar;
344 gui_buttonbar_init(&buttonbar);
345 gui_buttonbar_set_display(&buttonbar, &(screens[SCREEN_MAIN]) );
346 gui_buttonbar_set(&buttonbar, "<<<", "", "");
347 #endif
348 menu_callback_type menu_callback = NULL;
350 /* if hide_theme is true, assume parent has been fixed before passed into
351 * this function, e.g. with viewport_set_defaults(parent, screen) */
352 init_menu_lists(menu, &lists, selected, true, parent);
353 vps = *(lists.parent);
354 in_stringlist = ((menu->flags&MENU_TYPE_MASK) == MT_RETURN_ID);
355 /* load the callback, and only reload it if menu changes */
356 get_menu_callback(menu, &menu_callback);
358 gui_synclist_draw(&lists);
359 gui_synclist_speak_item(&lists);
360 #ifdef HAVE_BUTTONBAR
361 if (!hide_theme)
363 gui_buttonbar_set(&buttonbar, "<<<", "", "");
364 gui_buttonbar_draw(&buttonbar);
366 #endif
367 while (!done)
369 int new_audio_status;
370 redraw_lists = false;
371 if (!hide_theme)
373 #ifdef HAVE_BUTTONBAR
374 gui_buttonbar_draw(&buttonbar);
375 #endif
377 action = get_action(CONTEXT_MAINMENU,
378 list_do_action_timeout(&lists, HZ));
380 /* query audio status to see if it changed */
381 new_audio_status = audio_status();
382 if (old_audio_status != new_audio_status)
383 { /* force a redraw if anything changed the audio status
384 * from outside */
385 redraw_lists = true;
386 old_audio_status = new_audio_status;
388 /* HZ so the status bar redraws corectly */
390 if (menu_callback)
392 int old_action = action;
393 action = menu_callback(action, menu);
394 if (action == ACTION_EXIT_AFTER_THIS_MENUITEM)
396 action = old_action;
397 ret = MENU_SELECTED_EXIT; /* will exit after returning
398 from selection */
400 else if (action == ACTION_REDRAW)
402 action = old_action;
403 redraw_lists = true;
407 if (gui_synclist_do_button(&lists, &action, LIST_WRAP_UNLESS_HELD))
408 continue;
409 #ifdef HAVE_QUICKSCREEN
410 else if (action == ACTION_STD_QUICKSCREEN)
412 quick_screen_quick(action);
413 redraw_lists = true;
415 #endif
416 #ifdef HAVE_RECORDING
417 else if (action == ACTION_STD_REC)
419 ret = GO_TO_RECSCREEN;
420 done = true;
422 #endif
423 else if (action == ACTION_TREE_WPS)
425 ret = GO_TO_PREVIOUS_MUSIC;
426 done = true;
428 else if (action == ACTION_TREE_STOP)
430 redraw_lists = list_stop_handler();
432 else if (action == ACTION_STD_CONTEXT)
434 if (menu == &root_menu_)
436 ret = GO_TO_ROOTITEM_CONTEXT;
437 done = true;
439 else if (!in_stringlist)
441 int type;
442 selected = get_menu_selection(gui_synclist_get_sel_pos(&lists),menu);
443 temp = menu->submenus[selected];
444 type = (temp->flags&MENU_TYPE_MASK);
445 if ((type == MT_SETTING_W_TEXT || type == MT_SETTING))
447 #ifdef HAVE_QUICKSCREEN
448 MENUITEM_STRINGLIST(quickscreen_able_option,
449 ID2P(LANG_ONPLAY_MENU_TITLE), NULL,
450 ID2P(LANG_RESET_SETTING),
451 ID2P(LANG_TOP_QS_ITEM),
452 ID2P(LANG_LEFT_QS_ITEM),
453 ID2P(LANG_BOTTOM_QS_ITEM),
454 ID2P(LANG_RIGHT_QS_ITEM));
455 #endif
456 MENUITEM_STRINGLIST(notquickscreen_able_option,
457 ID2P(LANG_ONPLAY_MENU_TITLE), NULL,
458 ID2P(LANG_RESET_SETTING));
459 const struct menu_item_ex *menu;
460 int menu_selection = 0;
461 const struct settings_list *setting =
462 find_setting(temp->variable, NULL);
463 #ifdef HAVE_QUICKSCREEN
464 if (is_setting_quickscreenable(setting))
465 menu = &quickscreen_able_option;
466 else
467 #endif
468 menu = &notquickscreen_able_option;
469 switch (do_menu(menu, &menu_selection, NULL, false))
471 case GO_TO_PREVIOUS:
472 break;
473 case 0: /* reset setting */
474 reset_setting(setting, setting->setting);
475 break;
476 #ifdef HAVE_QUICKSCREEN
477 case 1: /* set as top QS item */
478 set_as_qs_item(setting, QUICKSCREEN_TOP);
479 break;
480 case 2: /* set as left QS item */
481 set_as_qs_item(setting, QUICKSCREEN_LEFT);
482 break;
483 case 3: /* set as bottom QS item */
484 set_as_qs_item(setting, QUICKSCREEN_BOTTOM);
485 break;
486 case 4: /* set as right QS item */
487 set_as_qs_item(setting, QUICKSCREEN_RIGHT);
488 break;
489 #endif
490 } /* swicth(do_menu()) */
491 redraw_lists = true;
493 } /* else if (!in_stringlist) */
495 else if (action == ACTION_STD_MENU)
497 if (menu != &root_menu_)
498 ret = GO_TO_ROOT;
499 else
500 ret = GO_TO_PREVIOUS;
501 done = true;
503 else if (action == ACTION_STD_CANCEL)
505 bool exiting_menu = false;
506 in_stringlist = false;
507 /* might be leaving list, so stop scrolling */
508 gui_synclist_scroll_stop(&lists);
509 if (menu_callback)
510 menu_callback(ACTION_EXIT_MENUITEM, menu);
512 if (menu->flags&MENU_EXITAFTERTHISMENU)
513 done = true;
514 else if ((menu->flags&MENU_TYPE_MASK) == MT_MENU)
515 exiting_menu = true;
516 if (stack_top > 0)
518 stack_top--;
519 menu = menu_stack[stack_top];
520 if (!exiting_menu && (menu->flags&MENU_EXITAFTERTHISMENU))
521 done = true;
522 else
523 init_menu_lists(menu, &lists,
524 menu_stack_selected_item[stack_top], false, vps);
525 redraw_lists = true;
526 /* new menu, so reload the callback */
527 get_menu_callback(menu, &menu_callback);
529 else if (menu != &root_menu_)
531 ret = GO_TO_PREVIOUS;
532 done = true;
535 else if (action == ACTION_STD_OK)
537 int type;
538 /* entering an item that may not be a list, so stop scrolling */
539 gui_synclist_scroll_stop(&lists);
540 #ifdef HAVE_BUTTONBAR
541 if (!hide_theme)
543 gui_buttonbar_unset(&buttonbar);
544 gui_buttonbar_draw(&buttonbar);
546 #endif
547 selected = get_menu_selection(gui_synclist_get_sel_pos(&lists), menu);
548 temp = menu->submenus[selected];
549 redraw_lists = true;
550 if (in_stringlist)
551 type = (menu->flags&MENU_TYPE_MASK);
552 else
554 type = (temp->flags&MENU_TYPE_MASK);
555 get_menu_callback(temp, &menu_callback);
556 if (menu_callback)
558 action = menu_callback(ACTION_ENTER_MENUITEM,temp);
559 if (action == ACTION_EXIT_MENUITEM)
560 break;
563 switch (type)
565 case MT_MENU:
566 if (stack_top < MAX_MENUS)
568 menu_stack[stack_top] = menu;
569 menu_stack_selected_item[stack_top] = selected;
570 stack_top++;
571 menu = temp;
572 init_menu_lists(menu, &lists, 0, true, vps);
574 break;
575 case MT_FUNCTION_CALL:
577 int return_value;
578 if (temp->flags&MENU_FUNC_USEPARAM)
579 return_value = temp->function->function_w_param(
580 temp->function->param);
581 else
582 return_value = temp->function->function();
583 if (!(menu->flags&MENU_EXITAFTERTHISMENU) ||
584 (temp->flags&MENU_EXITAFTERTHISMENU))
586 init_menu_lists(menu, &lists, selected, true, vps);
588 if (temp->flags&MENU_FUNC_CHECK_RETVAL)
590 if (return_value != 0)
592 done = true;
593 ret = return_value;
596 break;
598 case MT_SETTING:
599 case MT_SETTING_W_TEXT:
601 do_setting_from_menu(temp, vps);
602 send_event(GUI_EVENT_ACTIONUPDATE, (void*)1); /* force a redraw */
603 break;
605 case MT_RETURN_ID:
606 if (in_stringlist)
608 done = true;
609 ret = selected;
611 else if (stack_top < MAX_MENUS)
613 menu_stack[stack_top] = menu;
614 menu_stack_selected_item[stack_top] = selected;
615 stack_top++;
616 menu = temp;
617 init_menu_lists(menu,&lists,0,false, vps);
618 in_stringlist = true;
620 break;
621 case MT_RETURN_VALUE:
622 ret = temp->value;
623 done = true;
624 break;
626 if (type != MT_MENU)
628 if (menu_callback)
629 menu_callback(ACTION_EXIT_MENUITEM,temp);
631 if (current_submenus_menu != menu)
632 init_menu_lists(menu,&lists,selected,true,vps);
633 /* callback was changed, so reload the menu's callback */
634 get_menu_callback(menu, &menu_callback);
635 if ((menu->flags&MENU_EXITAFTERTHISMENU) &&
636 !(temp->flags&MENU_EXITAFTERTHISMENU))
638 done = true;
639 break;
641 #ifdef HAVE_BUTTONBAR
642 if (!hide_theme)
644 gui_buttonbar_set(&buttonbar, "<<<", "", "");
645 gui_buttonbar_draw(&buttonbar);
647 #endif
649 else
651 switch(default_event_handler(action))
653 case SYS_USB_CONNECTED:
654 ret = MENU_ATTACHED_USB;
655 done = true;
656 break;
657 case SYS_CALL_HUNG_UP:
658 case BUTTON_MULTIMEDIA_PLAYPAUSE:
659 /* remove splash from playlist_resume() */
660 redraw_lists = true;
661 break;
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;