apps/menu.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 Robert E. Hak
  11  *
  12  * All files in this archive are subject to the GNU General Public License.
  13  * See the file COPYING in the source tree root for full license agreement.
  14  *
  15  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  16  * KIND, either express or implied.
  17  *
  18  ****************************************************************************/
  19 /*
  20 2005 Kevin Ferrare :
  21  - Multi screen support
  22  - Rewrote/removed a lot of code now useless with the new gui API
  23 */
  24 #include <stdbool.h>
  25 #include <stdlib.h>
  26 #include "config.h"
  27
  28 #include "lcd.h"
  29 #include "font.h"
  30 #include "backlight.h"
  31 #include "menu.h"
  32 #include "button.h"
  33 #include "kernel.h"
  34 #include "debug.h"
  35 #include "usb.h"
  36 #include "panic.h"
  37 #include "settings.h"
  38 #include "settings_list.h"
  39 #include "option_select.h"
  40 #include "status.h"
  41 #include "screens.h"
  42 #include "talk.h"
  43 #include "lang.h"
  44 #include "misc.h"
  45 #include "action.h"
  46 #include "menus/exported_menus.h"
  47 #include "string.h"
  48 #include "root_menu.h"
  49 #include "bookmark.h"
  50 #include "gwps-common.h" /* for fade() */
  51 #include "audio.h"
  52
  53 #ifdef HAVE_LCD_BITMAP
  54 #include "icons.h"
  55 #endif
  56
  57 /* gui api */
  58 #include "list.h"
  59 #include "statusbar.h"
  60 #include "buttonbar.h"
  61
  62 #define MAX_MENUS 8
  63 /* used to allow for dynamic menus */
  64 #define MAX_MENU_SUBITEMS 64
  65 static struct menu_item_ex *current_submenus_menu;
  66 static int current_subitems[MAX_MENU_SUBITEMS];
  67 static int current_subitems_count = 0;
  68
  69 static void get_menu_callback(const struct menu_item_ex *m,
  70                         menu_callback_type *menu_callback)
  71 {
  72     if (m->flags&(MENU_HAS_DESC|MENU_DYNAMIC_DESC))
  73         *menu_callback= m->callback_and_desc->menu_callback;
  74     else
  75         *menu_callback = m->menu_callback;
  76 }
  77
  78 static int get_menu_selection(int selected_item, const struct menu_item_ex *menu)
  79 {
  80     int type = (menu->flags&MENU_TYPE_MASK);
  81     if (type == MT_MENU && (selected_item<current_subitems_count))
  82         return current_subitems[selected_item];
  83     return selected_item;
  84 }
  85 static int find_menu_selection(int selected)
  86 {
  87     int i;
  88     for (i=0; i< current_subitems_count; i++)
  89         if (current_subitems[i] == selected)
  90             return i;
  91     return 0;
  92 }
  93 static char * get_menu_item_name(int selected_item,void * data, char *buffer)
  94 {
  95     const struct menu_item_ex *menu = (const struct menu_item_ex *)data;
  96     int type = (menu->flags&MENU_TYPE_MASK);
  97     selected_item = get_menu_selection(selected_item, menu);
  98
  99     (void)buffer;
 100     /* only MT_MENU or MT_RETURN_ID is allowed in here */
 101     if (type == MT_RETURN_ID)
 102     {
 103         if (menu->flags&MENU_DYNAMIC_DESC)
 104             return menu->menu_get_name_and_icon->list_get_name(selected_item,
 105                     menu->menu_get_name_and_icon->list_get_name_data, buffer);
 106         return (char*)menu->strings[selected_item];
 107     }
 108
 109     menu = menu->submenus[selected_item];
 110
 111     if ((menu->flags&MENU_DYNAMIC_DESC) && (type != MT_SETTING_W_TEXT))
 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
 115     type = (menu->flags&MENU_TYPE_MASK);
 116     if ((type == MT_SETTING) || (type == MT_SETTING_W_TEXT))
 117     {
 118         const struct settings_list *v
 119                 = find_setting(menu->variable, NULL);
 120         if (v)
 121             return str(v->lang_id);
 122         else return "Not Done yet!";
 123     }
 124     return P2STR(menu->callback_and_desc->desc);
 125 }
 126 #ifdef HAVE_LCD_BITMAP
 127 static int menu_get_icon(int selected_item, void * data)
 128 {
 129     const struct menu_item_ex *menu = (const struct menu_item_ex *)data;
 130     int menu_icon = Icon_NOICON;
 131     selected_item = get_menu_selection(selected_item, menu);
 132
 133     if ((menu->flags&MENU_TYPE_MASK) == MT_RETURN_ID)
 134     {
 135         return Icon_Menu_functioncall;
 136     }
 137     menu = menu->submenus[selected_item];
 138     if (menu->flags&MENU_HAS_DESC)
 139         menu_icon = menu->callback_and_desc->icon_id;
 140     else if (menu->flags&MENU_DYNAMIC_DESC)
 141         menu_icon = menu->menu_get_name_and_icon->icon_id;
 142
 143     if (menu_icon == Icon_NOICON)
 144     {
 145         switch (menu->flags&MENU_TYPE_MASK)
 146         {
 147             case MT_SETTING:
 148             case MT_SETTING_W_TEXT:
 149                 menu_icon = Icon_Menu_setting;
 150                 break;
 151             case MT_MENU:
 152                     menu_icon = Icon_Submenu;
 153                 break;
 154             case MT_FUNCTION_CALL:
 155             case MT_RETURN_VALUE:
 156                 menu_icon = Icon_Menu_functioncall;
 157                 break;
 158         }
 159     }
 160     return menu_icon;
 161 }
 162 #endif
 163
 164 static void init_menu_lists(const struct menu_item_ex *menu,
 165                      struct gui_synclist *lists, int selected, bool callback)
 166 {
 167     int i, count = MENU_GET_COUNT(menu->flags);
 168     int type = (menu->flags&MENU_TYPE_MASK);
 169     menu_callback_type menu_callback = NULL;
 170     int icon;
 171     current_subitems_count = 0;
 172
 173     if (type == MT_RETURN_ID)
 174         get_menu_callback(menu, &menu_callback);
 175
 176     for (i=0; i<count; i++)
 177     {
 178         if (type != MT_RETURN_ID)
 179             get_menu_callback(menu->submenus[i],&menu_callback);
 180         if (menu_callback)
 181         {
 182             if (menu_callback(ACTION_REQUEST_MENUITEM,
 183                     type==MT_RETURN_ID ? (void*)(intptr_t)i: menu->submenus[i])
 184                     != ACTION_EXIT_MENUITEM)
 185             {
 186                 current_subitems[current_subitems_count] = i;
 187                 current_subitems_count++;
 188             }
 189         }
 190         else
 191         {
 192             current_subitems[current_subitems_count] = i;
 193             current_subitems_count++;
 194         }
 195     }
 196     current_submenus_menu = (struct menu_item_ex *)menu;
 197
 198     gui_synclist_init(lists,get_menu_item_name,(void*)menu,false,1);
 199 #ifdef HAVE_LCD_BITMAP
 200     if (menu->callback_and_desc->icon_id == Icon_NOICON)
 201         icon = Icon_Submenu_Entered;
 202     else
 203         icon = menu->callback_and_desc->icon_id;
 204     gui_synclist_set_title(lists, P2STR(menu->callback_and_desc->desc), icon);
 205     gui_synclist_set_icon_callback(lists, menu_get_icon);
 206 #else
 207     (void)icon;
 208     gui_synclist_set_icon_callback(lists, NULL);
 209 #endif
 210     gui_synclist_set_nb_items(lists,current_subitems_count);
 211     gui_synclist_limit_scroll(lists,true);
 212     gui_synclist_select_item(lists, find_menu_selection(selected));
 213
 214     get_menu_callback(menu,&menu_callback);
 215     if (callback && menu_callback)
 216         menu_callback(ACTION_ENTER_MENUITEM,menu);
 217     gui_synclist_draw(lists);
 218 }
 219
 220 static void talk_menu_item(const struct menu_item_ex *menu,
 221                     struct gui_synclist *lists)
 222 {
 223     int id = -1;
 224     int type;
 225     unsigned char *str;
 226     int sel;
 227
 228     if (talk_menus_enabled())
 229     {
 230         sel = get_menu_selection(gui_synclist_get_sel_pos(lists),menu);
 231         if ((menu->flags&MENU_TYPE_MASK) == MT_MENU)
 232         {
 233             type = menu->submenus[sel]->flags&MENU_TYPE_MASK;
 234             if ((type == MT_SETTING) || (type == MT_SETTING_W_TEXT))
 235                 talk_setting(menu->submenus[sel]->variable);
 236             else
 237             {
 238                 if (menu->submenus[sel]->flags&(MENU_DYNAMIC_DESC))
 239                 {
 240                     char buffer[80];
 241                     str = menu->submenus[sel]->menu_get_name_and_icon->
 242                         list_get_name(sel, menu->submenus[sel]->
 243                                       menu_get_name_and_icon->
 244                                       list_get_name_data, buffer);
 245                     id = P2ID(str);
 246                 }
 247                 else
 248                     id = P2ID(menu->submenus[sel]->callback_and_desc->desc);
 249                 if (id != -1)
 250                    talk_id(id,false);
 251             }
 252         }
 253         else if(((menu->flags&MENU_TYPE_MASK) == MT_RETURN_ID))
 254         {
 255             if ((menu->flags&MENU_DYNAMIC_DESC) == 0)
 256             {
 257                 unsigned char *s = (unsigned char *)menu->strings[sel];
 258                 /* string list, try to talk it if ID2P was used */
 259                 id = P2ID(s);
 260                 if (id != -1)
 261                     talk_id(id,false);
 262             }
 263         }
 264     }
 265 }
 266 #define MAX_OPTIONS 32
 267 bool do_setting_from_menu(const struct menu_item_ex *temp)
 268 {
 269     int setting_id;
 270     const struct settings_list *setting = find_setting(
 271                                                temp->variable,
 272                                                &setting_id);
 273     char *title;
 274     if ((temp->flags&MENU_TYPE_MASK) == MT_SETTING_W_TEXT)
 275         title = temp->callback_and_desc->desc;
 276     else
 277         title = ID2P(setting->lang_id);
 278     option_screen((struct settings_list *)setting,
 279                   setting->flags&F_TEMPVAR, title);
 280     return false;
 281 }
 282
 283 int do_menu(const struct menu_item_ex *start_menu, int *start_selected)
 284 {
 285     int selected = start_selected? *start_selected : 0;
 286     int action;
 287     struct gui_synclist lists;
 288     const struct menu_item_ex *temp, *menu;
 289     int ret = 0;
 290     bool redraw_lists;
 291 #ifdef HAS_BUTTONBAR
 292     struct gui_buttonbar buttonbar;
 293 #endif
 294
 295     const struct menu_item_ex *menu_stack[MAX_MENUS];
 296     int menu_stack_selected_item[MAX_MENUS];
 297     int stack_top = 0;
 298     bool in_stringlist, done = false;
 299     menu_callback_type menu_callback = NULL;
 300     bool talk_item = false;
 301     if (start_menu == NULL)
 302         menu = &main_menu_;
 303     else menu = start_menu;
 304 #ifdef HAS_BUTTONBAR
 305     gui_buttonbar_init(&buttonbar);
 306     gui_buttonbar_set_display(&buttonbar, &(screens[SCREEN_MAIN]) );
 307     gui_buttonbar_set(&buttonbar, "<<<", "", "");
 308     gui_buttonbar_draw(&buttonbar);
 309 #endif
 310     init_menu_lists(menu,&lists,selected,true);
 311     in_stringlist = ((menu->flags&MENU_TYPE_MASK) == MT_RETURN_ID);
 312
 313     talk_menu_item(menu, &lists);
 314
 315     /* load the callback, and only reload it if menu changes */
 316     get_menu_callback(menu, &menu_callback);
 317     gui_synclist_draw(&lists);
 318
 319     while (!done)
 320     {
 321         talk_item = false;
 322         redraw_lists = false;
 323         gui_syncstatusbar_draw(&statusbars, true);
 324         action = get_action(CONTEXT_MAINMENU,HZ);
 325         /* HZ so the status bar redraws corectly */
 326         if (action == ACTION_NONE)
 327         {
 328             continue;
 329         }
 330
 331         if (menu_callback)
 332         {
 333             int old_action = action;
 334             action = menu_callback(action, menu);
 335             if (action == ACTION_EXIT_AFTER_THIS_MENUITEM)
 336             {
 337                 action = old_action;
 338                 ret = MENU_SELECTED_EXIT; /* will exit after returning
 339                                              from selection */
 340             }
 341             else if (action == ACTION_REDRAW)
 342             {
 343                 action = old_action;
 344                 redraw_lists = true;
 345             }
 346         }
 347
 348         if (gui_synclist_do_button(&lists, &action, LIST_WRAP_UNLESS_HELD))
 349         {
 350             talk_menu_item(menu, &lists);
 351             continue;
 352         }
 353
 354 #ifdef HAVE_RECORDING
 355         if (action == ACTION_STD_REC)
 356         {
 357             ret = GO_TO_RECSCREEN;
 358             done = true;
 359         }
 360         else
 361 #endif
 362         if (action == ACTION_TREE_WPS)
 363         {
 364             ret = GO_TO_PREVIOUS_MUSIC;
 365             done = true;
 366         }
 367         else if (action == ACTION_TREE_STOP)
 368         {
 369             redraw_lists = list_stop_handler();
 370         }
 371         else if (action == ACTION_STD_CONTEXT &&
 372                  menu == &root_menu_)
 373         {
 374             ret = GO_TO_ROOTITEM_CONTEXT;
 375             done = true;
 376         }
 377         else if (action == ACTION_STD_MENU)
 378         {
 379             if (menu != &root_menu_)
 380                 ret = GO_TO_ROOT;
 381             else
 382                 ret = GO_TO_PREVIOUS;
 383             done = true;
 384         }
 385         else if (action == ACTION_STD_CANCEL)
 386         {
 387             in_stringlist = false;
 388             if (menu_callback)
 389                 menu_callback(ACTION_EXIT_MENUITEM, menu);
 390
 391             if (menu->flags&MENU_EXITAFTERTHISMENU)
 392                 done = true;
 393             if (stack_top > 0)
 394             {
 395                 stack_top--;
 396                 menu = menu_stack[stack_top];
 397                 if (menu->flags&MENU_EXITAFTERTHISMENU)
 398                     done = true;
 399                 else
 400                     init_menu_lists(menu, &lists,
 401                                  menu_stack_selected_item[stack_top], false);
 402                 /* new menu, so reload the callback */
 403                 get_menu_callback(menu, &menu_callback);
 404                 talk_item = true;
 405             }
 406             else if (menu != &root_menu_)
 407             {
 408                 ret = GO_TO_PREVIOUS;
 409                 done = true;
 410             }
 411         }
 412         else if (action == ACTION_STD_OK)
 413         {
 414             int type;
 415 #ifdef HAS_BUTTONBAR
 416             gui_buttonbar_unset(&buttonbar);
 417             gui_buttonbar_draw(&buttonbar);
 418 #endif
 419             selected = get_menu_selection(gui_synclist_get_sel_pos(&lists), menu);
 420             temp = menu->submenus[selected];
 421             redraw_lists = true;
 422             if (in_stringlist)
 423                 type = (menu->flags&MENU_TYPE_MASK);
 424             else
 425             {
 426                 type = (temp->flags&MENU_TYPE_MASK);
 427                 get_menu_callback(temp, &menu_callback);
 428                 if (menu_callback)
 429                 {
 430                     action = menu_callback(ACTION_ENTER_MENUITEM,temp);
 431                     if (action == ACTION_EXIT_MENUITEM)
 432                         break;
 433                 }
 434             }
 435             switch (type)
 436             {
 437                 case MT_MENU:
 438                     if (stack_top < MAX_MENUS)
 439                     {
 440                         menu_stack[stack_top] = menu;
 441                         menu_stack_selected_item[stack_top] = selected;
 442                         stack_top++;
 443                         init_menu_lists(temp, &lists, 0, true);
 444                         redraw_lists = false; /* above does the redraw */
 445                         menu = temp;
 446                         talk_item = true;
 447                     }
 448                     break;
 449                 case MT_FUNCTION_CALL:
 450                 {
 451                     int return_value;
 452                     talk_item = true;
 453                     if (temp->flags&MENU_FUNC_USEPARAM)
 454                         return_value = temp->function->function_w_param(
 455                                     temp->function->param);
 456                     else
 457                         return_value = temp->function->function();
 458                     if (temp->flags&MENU_FUNC_CHECK_RETVAL)
 459                     {
 460                         if (return_value == 1)
 461                         {
 462                             done = true;
 463                             ret =  return_value;
 464                         }
 465                     }
 466                     break;
 467                 }
 468                 case MT_SETTING:
 469                 case MT_SETTING_W_TEXT:
 470                 {
 471                     if (do_setting_from_menu(temp))
 472                     {
 473                         init_menu_lists(menu, &lists, selected, true);
 474                         redraw_lists = false; /* above does the redraw */
 475                     }
 476                     talk_item = true;
 477                     break;
 478                 }
 479                 case MT_RETURN_ID:
 480                     if (in_stringlist)
 481                     {
 482                         done = true;
 483                         ret =  selected;
 484                     }
 485                     else if (stack_top < MAX_MENUS)
 486                     {
 487                         menu_stack[stack_top] = menu;
 488                         menu_stack_selected_item[stack_top] = selected;
 489                         stack_top++;
 490                         menu = temp;
 491                         init_menu_lists(menu,&lists,0,false);
 492                         redraw_lists = false; /* above does the redraw */
 493                         talk_item = true;
 494                         in_stringlist = true;
 495                     }
 496                     break;
 497                 case MT_RETURN_VALUE:
 498                     ret = temp->value;
 499                     done = true;
 500                     break;
 501             }
 502             if (type != MT_MENU)
 503             {
 504                 if (menu_callback)
 505                     menu_callback(ACTION_EXIT_MENUITEM,temp);
 506             }
 507             if (current_submenus_menu != menu)
 508                 init_menu_lists(menu,&lists,selected,true);
 509             /* callback was changed, so reload the menu's callback */
 510             get_menu_callback(menu, &menu_callback);
 511             if ((menu->flags&MENU_EXITAFTERTHISMENU) &&
 512                 !(temp->flags&MENU_EXITAFTERTHISMENU))
 513             {
 514                 done = true;
 515                 break;
 516             }
 517 #ifdef HAS_BUTTONBAR
 518             gui_buttonbar_set(&buttonbar, "<<<", "", "");
 519             gui_buttonbar_draw(&buttonbar);
 520 #endif
 521         }
 522         else if(default_event_handler(action) == SYS_USB_CONNECTED)
 523         {
 524             ret = MENU_ATTACHED_USB;
 525             done = true;
 526         }
 527         if (talk_item && !done)
 528             talk_menu_item(menu, &lists);
 529
 530         if (redraw_lists)
 531             gui_synclist_draw(&lists);
 532     }
 533     if (start_selected)
 534     {
 535         /* make sure the start_selected variable is set to
 536            the selected item from the menu do_menu() was called from */
 537         if (stack_top > 0)
 538         {
 539             menu = menu_stack[0];
 540             init_menu_lists(menu,&lists,menu_stack_selected_item[0],true);
 541         }
 542         *start_selected = get_menu_selection(
 543                             gui_synclist_get_sel_pos(&lists), menu);
 544     }
 545     return ret;
 546 }
 547