Fix flag for the viewport. Text is supposed to be centered.
[maemo-rb.git] / apps / menu.c
blobae318b2ffc69742cb2dec5965f45acf33ecfa852
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"
55 #include "shortcuts.h"
57 #ifdef HAVE_LCD_BITMAP
58 #include "icons.h"
59 #endif
61 /* gui api */
62 #include "list.h"
63 #include "buttonbar.h"
65 #define MAX_MENUS 8
66 /* used to allow for dynamic menus */
67 #define MAX_MENU_SUBITEMS 64
68 static struct menu_item_ex *current_submenus_menu;
69 static int current_subitems[MAX_MENU_SUBITEMS];
70 static int current_subitems_count = 0;
71 static int talk_menu_item(int selected_item, void *data);
73 static void get_menu_callback(const struct menu_item_ex *m,
74 menu_callback_type *menu_callback)
76 if (m->flags&(MENU_HAS_DESC|MENU_DYNAMIC_DESC))
77 *menu_callback= m->callback_and_desc->menu_callback;
78 else
79 *menu_callback = m->menu_callback;
82 static int get_menu_selection(int selected_item, const struct menu_item_ex *menu)
84 int type = (menu->flags&MENU_TYPE_MASK);
85 if ((type == MT_MENU || type == MT_RETURN_ID)
86 && (selected_item<current_subitems_count))
87 return current_subitems[selected_item];
88 return selected_item;
90 static int find_menu_selection(int selected)
92 int i;
93 for (i=0; i< current_subitems_count; i++)
94 if (current_subitems[i] == selected)
95 return i;
96 return 0;
98 static const char* get_menu_item_name(int selected_item,
99 void * data,
100 char *buffer,
101 size_t buffer_len)
103 const struct menu_item_ex *menu = (const struct menu_item_ex *)data;
104 int type = (menu->flags&MENU_TYPE_MASK);
105 selected_item = get_menu_selection(selected_item, menu);
107 (void)buffer_len;
108 /* only MT_MENU or MT_RETURN_ID is allowed in here */
109 if (type == MT_RETURN_ID)
111 if (menu->flags&MENU_DYNAMIC_DESC)
112 return menu->menu_get_name_and_icon->list_get_name(selected_item,
113 menu->menu_get_name_and_icon->list_get_name_data, buffer);
114 return menu->strings[selected_item];
117 menu = menu->submenus[selected_item];
119 if ((menu->flags&MENU_DYNAMIC_DESC) && (type != MT_SETTING_W_TEXT))
120 return menu->menu_get_name_and_icon->list_get_name(selected_item,
121 menu->menu_get_name_and_icon->list_get_name_data, buffer);
123 type = (menu->flags&MENU_TYPE_MASK);
124 if ((type == MT_SETTING) || (type == MT_SETTING_W_TEXT))
126 const struct settings_list *v
127 = find_setting(menu->variable, NULL);
128 if (v)
129 return str(v->lang_id);
130 else return "Not Done yet!";
132 return P2STR(menu->callback_and_desc->desc);
134 #ifdef HAVE_LCD_BITMAP
135 static enum themable_icons menu_get_icon(int selected_item, void * data)
137 const struct menu_item_ex *menu = (const struct menu_item_ex *)data;
138 int menu_icon = Icon_NOICON;
139 selected_item = get_menu_selection(selected_item, menu);
141 if ((menu->flags&MENU_TYPE_MASK) == MT_RETURN_ID)
143 return Icon_Menu_functioncall;
145 menu = menu->submenus[selected_item];
146 if (menu->flags&MENU_HAS_DESC)
147 menu_icon = menu->callback_and_desc->icon_id;
148 else if (menu->flags&MENU_DYNAMIC_DESC)
149 menu_icon = menu->menu_get_name_and_icon->icon_id;
151 if (menu_icon == Icon_NOICON)
153 switch (menu->flags&MENU_TYPE_MASK)
155 case MT_SETTING:
156 case MT_SETTING_W_TEXT:
157 menu_icon = Icon_Menu_setting;
158 break;
159 case MT_MENU:
160 menu_icon = Icon_Submenu;
161 break;
162 case MT_FUNCTION_CALL:
163 case MT_RETURN_VALUE:
164 menu_icon = Icon_Menu_functioncall;
165 break;
168 return menu_icon;
170 #endif
172 static void init_menu_lists(const struct menu_item_ex *menu,
173 struct gui_synclist *lists, int selected, bool callback,
174 struct viewport parent[NB_SCREENS])
176 int i, count = MENU_GET_COUNT(menu->flags);
177 int type = (menu->flags&MENU_TYPE_MASK);
178 menu_callback_type menu_callback = NULL;
179 int icon;
180 current_subitems_count = 0;
182 if (type == MT_RETURN_ID)
183 get_menu_callback(menu, &menu_callback);
185 for (i=0; i<count; i++)
187 if (type != MT_RETURN_ID)
188 get_menu_callback(menu->submenus[i],&menu_callback);
189 if (menu_callback)
191 if (menu_callback(ACTION_REQUEST_MENUITEM,
192 type==MT_RETURN_ID ? (void*)(intptr_t)i: menu->submenus[i])
193 != ACTION_EXIT_MENUITEM)
195 current_subitems[current_subitems_count] = i;
196 current_subitems_count++;
199 else
201 current_subitems[current_subitems_count] = i;
202 current_subitems_count++;
205 current_submenus_menu = (struct menu_item_ex *)menu;
207 gui_synclist_init(lists,get_menu_item_name,(void*)menu,false,1, parent);
208 #ifdef HAVE_LCD_BITMAP
209 if (menu->callback_and_desc->icon_id == Icon_NOICON)
210 icon = Icon_Submenu_Entered;
211 else
212 icon = menu->callback_and_desc->icon_id;
213 gui_synclist_set_title(lists, P2STR(menu->callback_and_desc->desc), icon);
214 gui_synclist_set_icon_callback(lists, global_settings.show_icons?menu_get_icon:NULL);
215 #else
216 (void)icon;
217 gui_synclist_set_icon_callback(lists, NULL);
218 #endif
219 if(global_settings.talk_menu)
220 gui_synclist_set_voice_callback(lists, talk_menu_item);
221 gui_synclist_set_nb_items(lists,current_subitems_count);
222 gui_synclist_limit_scroll(lists,true);
223 gui_synclist_select_item(lists, find_menu_selection(selected));
225 get_menu_callback(menu,&menu_callback);
226 if (callback && menu_callback)
227 menu_callback(ACTION_ENTER_MENUITEM,menu);
230 static int talk_menu_item(int selected_item, void *data)
232 const struct menu_item_ex *menu = (const struct menu_item_ex *)data;
233 int id = -1;
234 int type;
235 unsigned char *str;
236 int sel = get_menu_selection(selected_item, menu);
238 if ((menu->flags&MENU_TYPE_MASK) == MT_MENU)
240 type = menu->submenus[sel]->flags&MENU_TYPE_MASK;
241 if ((type == MT_SETTING) || (type == MT_SETTING_W_TEXT))
242 talk_setting(menu->submenus[sel]->variable);
243 else
245 if (menu->submenus[sel]->flags&(MENU_DYNAMIC_DESC))
247 int (*list_speak_item)(int selected_item, void * data)
248 = menu->submenus[sel]->menu_get_name_and_icon->
249 list_speak_item;
250 if(list_speak_item)
251 list_speak_item(sel, menu->submenus[sel]->
252 menu_get_name_and_icon->
253 list_get_name_data);
254 else
256 char buffer[80];
257 str = menu->submenus[sel]->menu_get_name_and_icon->
258 list_get_name(sel, menu->submenus[sel]->
259 menu_get_name_and_icon->
260 list_get_name_data, buffer);
261 id = P2ID(str);
264 else
265 id = P2ID(menu->submenus[sel]->callback_and_desc->desc);
266 if (id != -1)
267 talk_id(id,false);
270 else if(((menu->flags&MENU_TYPE_MASK) == MT_RETURN_ID))
272 if ((menu->flags&MENU_DYNAMIC_DESC) == 0)
274 unsigned char *s = (unsigned char *)menu->strings[sel];
275 /* string list, try to talk it if ID2P was used */
276 id = P2ID(s);
277 if (id != -1)
278 talk_id(id,false);
281 return 0;
284 void do_setting_screen(const struct settings_list *setting, const char * title,
285 struct viewport parent[NB_SCREENS])
287 char padded_title[MAX_PATH];
288 /* Pad the title string by repeating it. This is needed
289 so the scroll settings title can actually be used to
290 test the setting */
291 if (setting->flags&F_PADTITLE)
293 int i = 0, len;
294 if (setting->lang_id == -1)
295 title = (char*)setting->cfg_vals;
296 else
297 title = P2STR((unsigned char*)title);
298 len = strlen(title);
299 while (i < MAX_PATH-1)
301 int padlen = MIN(len, MAX_PATH-1-i);
302 memcpy(&padded_title[i], title, padlen);
303 i += padlen;
304 if (i<MAX_PATH-1)
305 padded_title[i++] = ' ';
307 padded_title[i] = '\0';
308 title = padded_title;
311 option_screen((struct settings_list *)setting, parent,
312 setting->flags&F_TEMPVAR, (char*)title);
316 void do_setting_from_menu(const struct menu_item_ex *temp,
317 struct viewport parent[NB_SCREENS])
319 char *title;
320 int setting_id;
321 const struct settings_list *setting =
322 find_setting(temp->variable, &setting_id);
323 if (temp && ((temp->flags&MENU_TYPE_MASK) == MT_SETTING_W_TEXT))
324 title = temp->callback_and_desc->desc;
325 else
326 title = ID2P(setting->lang_id);
327 do_setting_screen(setting, title, parent);
330 /* display a menu */
331 int do_menu(const struct menu_item_ex *start_menu, int *start_selected,
332 struct viewport parent[NB_SCREENS], bool hide_theme)
334 int selected = start_selected? *start_selected : 0;
335 int action;
336 struct gui_synclist lists;
337 const struct menu_item_ex *temp, *menu = start_menu;
338 int ret = 0;
339 bool redraw_lists;
340 int old_audio_status = audio_status();
341 FOR_NB_SCREENS(i)
342 viewportmanager_theme_enable(i, !hide_theme, NULL);
344 const struct menu_item_ex *menu_stack[MAX_MENUS];
345 int menu_stack_selected_item[MAX_MENUS];
346 int stack_top = 0;
347 bool in_stringlist, done = false;
348 struct viewport *vps = NULL;
349 #ifdef HAVE_BUTTONBAR
350 struct gui_buttonbar buttonbar;
351 gui_buttonbar_init(&buttonbar);
352 gui_buttonbar_set_display(&buttonbar, &(screens[SCREEN_MAIN]) );
353 gui_buttonbar_set(&buttonbar, "<<<", "", "");
354 #endif
355 menu_callback_type menu_callback = NULL;
357 /* if hide_theme is true, assume parent has been fixed before passed into
358 * this function, e.g. with viewport_set_defaults(parent, screen) */
359 init_menu_lists(menu, &lists, selected, true, parent);
360 vps = *(lists.parent);
361 in_stringlist = ((menu->flags&MENU_TYPE_MASK) == MT_RETURN_ID);
362 /* load the callback, and only reload it if menu changes */
363 get_menu_callback(menu, &menu_callback);
365 gui_synclist_draw(&lists);
366 gui_synclist_speak_item(&lists);
367 #ifdef HAVE_BUTTONBAR
368 if (!hide_theme)
370 gui_buttonbar_set(&buttonbar, "<<<", "", "");
371 gui_buttonbar_draw(&buttonbar);
373 #endif
374 while (!done)
376 int new_audio_status;
377 redraw_lists = false;
378 if (!hide_theme)
380 #ifdef HAVE_BUTTONBAR
381 gui_buttonbar_draw(&buttonbar);
382 #endif
384 #if CONFIG_CODEC == SWCODEC
385 keyclick_set_callback(gui_synclist_keyclick_callback, &lists);
386 #endif
387 action = get_action(CONTEXT_MAINMENU,
388 list_do_action_timeout(&lists, HZ));
390 /* query audio status to see if it changed */
391 new_audio_status = audio_status();
392 if (old_audio_status != new_audio_status)
393 { /* force a redraw if anything changed the audio status
394 * from outside */
395 redraw_lists = true;
396 old_audio_status = new_audio_status;
398 /* HZ so the status bar redraws corectly */
400 if (menu_callback)
402 int old_action = action;
403 action = menu_callback(action, menu);
404 if (action == ACTION_EXIT_AFTER_THIS_MENUITEM)
406 action = old_action;
407 ret = MENU_SELECTED_EXIT; /* will exit after returning
408 from selection */
410 else if (action == ACTION_REDRAW)
412 action = old_action;
413 redraw_lists = true;
417 if (gui_synclist_do_button(&lists, &action, LIST_WRAP_UNLESS_HELD))
418 continue;
419 #ifdef HAVE_QUICKSCREEN
420 else if (action == ACTION_STD_QUICKSCREEN)
422 quick_screen_quick(action);
423 redraw_lists = true;
425 #endif
426 #ifdef HAVE_RECORDING
427 else if (action == ACTION_STD_REC)
429 ret = GO_TO_RECSCREEN;
430 done = true;
432 #endif
433 else if (action == ACTION_TREE_WPS)
435 ret = GO_TO_PREVIOUS_MUSIC;
436 done = true;
438 else if (action == ACTION_TREE_STOP)
440 redraw_lists = list_stop_handler();
442 else if (action == ACTION_STD_CONTEXT)
444 if (menu == &root_menu_)
446 ret = GO_TO_ROOTITEM_CONTEXT;
447 done = true;
449 else if (!in_stringlist)
451 int type;
452 selected = get_menu_selection(gui_synclist_get_sel_pos(&lists),menu);
453 temp = menu->submenus[selected];
454 type = (temp->flags&MENU_TYPE_MASK);
455 if ((type == MT_SETTING_W_TEXT || type == MT_SETTING))
457 #ifdef HAVE_QUICKSCREEN
458 MENUITEM_STRINGLIST(quickscreen_able_option,
459 ID2P(LANG_ONPLAY_MENU_TITLE), NULL,
460 ID2P(LANG_RESET_SETTING),
461 ID2P(LANG_TOP_QS_ITEM),
462 ID2P(LANG_LEFT_QS_ITEM),
463 ID2P(LANG_BOTTOM_QS_ITEM),
464 ID2P(LANG_RIGHT_QS_ITEM),
465 ID2P(LANG_ADD_TO_FAVES));
466 #endif
467 MENUITEM_STRINGLIST(notquickscreen_able_option,
468 ID2P(LANG_ONPLAY_MENU_TITLE), NULL,
469 ID2P(LANG_RESET_SETTING));
470 const struct menu_item_ex *menu;
471 int menu_selection = 0;
472 const struct settings_list *setting =
473 find_setting(temp->variable, NULL);
474 #ifdef HAVE_QUICKSCREEN
475 if (is_setting_quickscreenable(setting))
476 menu = &quickscreen_able_option;
477 else
478 #endif
479 menu = &notquickscreen_able_option;
480 switch (do_menu(menu, &menu_selection, NULL, false))
482 case GO_TO_PREVIOUS:
483 break;
484 case 0: /* reset setting */
485 reset_setting(setting, setting->setting);
486 break;
487 #ifdef HAVE_QUICKSCREEN
488 case 1: /* set as top QS item */
489 set_as_qs_item(setting, QUICKSCREEN_TOP);
490 break;
491 case 2: /* set as left QS item */
492 set_as_qs_item(setting, QUICKSCREEN_LEFT);
493 break;
494 case 3: /* set as bottom QS item */
495 set_as_qs_item(setting, QUICKSCREEN_BOTTOM);
496 break;
497 case 4: /* set as right QS item */
498 set_as_qs_item(setting, QUICKSCREEN_RIGHT);
499 break;
500 case 5: /* Add to faves. Same limitation on which can be
501 added to the shortcuts menu as the quickscreen */
502 shortcuts_add(SHORTCUT_SETTING, (void*)setting);
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 (!(menu->flags&MENU_EXITAFTERTHISMENU) ||
599 (temp->flags&MENU_EXITAFTERTHISMENU))
601 init_menu_lists(menu, &lists, selected, true, vps);
603 if (temp->flags&MENU_FUNC_CHECK_RETVAL)
605 if (return_value != 0)
607 done = true;
608 ret = return_value;
611 break;
613 case MT_SETTING:
614 case MT_SETTING_W_TEXT:
616 do_setting_from_menu(temp, vps);
617 send_event(GUI_EVENT_ACTIONUPDATE, (void*)1); /* force a redraw */
618 break;
620 case MT_RETURN_ID:
621 if (in_stringlist)
623 done = true;
624 ret = selected;
626 else if (stack_top < MAX_MENUS)
628 menu_stack[stack_top] = menu;
629 menu_stack_selected_item[stack_top] = selected;
630 stack_top++;
631 menu = temp;
632 init_menu_lists(menu,&lists,0,false, vps);
633 in_stringlist = true;
635 break;
636 case MT_RETURN_VALUE:
637 ret = temp->value;
638 done = true;
639 break;
641 if (type != MT_MENU)
643 if (menu_callback)
644 menu_callback(ACTION_EXIT_MENUITEM,temp);
646 if (current_submenus_menu != menu)
647 init_menu_lists(menu,&lists,selected,true,vps);
648 /* callback was changed, so reload the menu's callback */
649 get_menu_callback(menu, &menu_callback);
650 if ((menu->flags&MENU_EXITAFTERTHISMENU) &&
651 !(temp->flags&MENU_EXITAFTERTHISMENU))
653 done = true;
654 break;
656 #ifdef HAVE_BUTTONBAR
657 if (!hide_theme)
659 gui_buttonbar_set(&buttonbar, "<<<", "", "");
660 gui_buttonbar_draw(&buttonbar);
662 #endif
664 else
666 switch(default_event_handler(action))
668 case SYS_USB_CONNECTED:
669 ret = MENU_ATTACHED_USB;
670 done = true;
671 break;
672 case SYS_CALL_HUNG_UP:
673 case BUTTON_MULTIMEDIA_PLAYPAUSE:
674 /* remove splash from playlist_resume() */
675 redraw_lists = true;
676 break;
680 if (redraw_lists && !done)
682 if (menu_callback)
683 menu_callback(ACTION_REDRAW, menu);
684 gui_synclist_draw(&lists);
685 gui_synclist_speak_item(&lists);
688 if (start_selected)
690 /* make sure the start_selected variable is set to
691 the selected item from the menu do_menu() was called from */
692 if (stack_top > 0)
694 menu = menu_stack[0];
695 init_menu_lists(menu,&lists,menu_stack_selected_item[0],true, vps);
697 *start_selected = get_menu_selection(
698 gui_synclist_get_sel_pos(&lists), menu);
700 FOR_NB_SCREENS(i)
701 viewportmanager_theme_undo(i, false);
702 return ret;