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     }
 254 }
 255 #define MAX_OPTIONS 32
 256 bool do_setting_from_menu(const struct menu_item_ex *temp)
 257 {
 258     int setting_id;
 259     const struct settings_list *setting = find_setting(
 260                                                temp->variable,
 261                                                &setting_id);
 262     char *title;
 263     if ((temp->flags&MENU_TYPE_MASK) == MT_SETTING_W_TEXT)
 264         title = temp->callback_and_desc->desc;
 265     else
 266         title = ID2P(setting->lang_id);
 267     option_screen((struct settings_list *)setting,
 268                   setting->flags&F_TEMPVAR, title);
 269     return false;
 270 }
 271
 272 int do_menu(const struct menu_item_ex *start_menu, int *start_selected)
 273 {
 274     int selected = start_selected? *start_selected : 0;
 275     int action;
 276     struct gui_synclist lists;
 277     const struct menu_item_ex *temp, *menu;
 278     int ret = 0;
 279     bool redraw_lists;
 280 #ifdef HAS_BUTTONBAR
 281     struct gui_buttonbar buttonbar;
 282 #endif
 283
 284     const struct menu_item_ex *menu_stack[MAX_MENUS];
 285     int menu_stack_selected_item[MAX_MENUS];
 286     int stack_top = 0;
 287     bool in_stringlist, done = false;
 288     menu_callback_type menu_callback = NULL;
 289     bool talk_item = false;
 290     if (start_menu == NULL)
 291         menu = &main_menu_;
 292     else menu = start_menu;
 293 #ifdef HAS_BUTTONBAR
 294     gui_buttonbar_init(&buttonbar);
 295     gui_buttonbar_set_display(&buttonbar, &(screens[SCREEN_MAIN]) );
 296     gui_buttonbar_set(&buttonbar, "<<<", "", "");
 297     gui_buttonbar_draw(&buttonbar);
 298 #endif
 299     init_menu_lists(menu,&lists,selected,true);
 300     in_stringlist = ((menu->flags&MENU_TYPE_MASK) == MT_RETURN_ID);
 301
 302     talk_menu_item(menu, &lists);
 303
 304     /* load the callback, and only reload it if menu changes */
 305     get_menu_callback(menu, &menu_callback);
 306     gui_synclist_draw(&lists);
 307
 308     while (!done)
 309     {
 310         talk_item = false;
 311         redraw_lists = false;
 312         gui_syncstatusbar_draw(&statusbars, true);
 313         action = get_action(CONTEXT_MAINMENU,HZ);
 314         /* HZ so the status bar redraws corectly */
 315         if (action == ACTION_NONE)
 316         {
 317             continue;
 318         }
 319
 320         if (menu_callback)
 321         {
 322             int old_action = action;
 323             action = menu_callback(action, menu);
 324             if (action == ACTION_EXIT_AFTER_THIS_MENUITEM)
 325             {
 326                 action = old_action;
 327                 ret = MENU_SELECTED_EXIT; /* will exit after returning
 328                                              from selection */
 329             }
 330             else if (action == ACTION_REDRAW)
 331             {
 332                 action = old_action;
 333                 redraw_lists = true;
 334             }
 335         }
 336
 337         if (gui_synclist_do_button(&lists,action,LIST_WRAP_UNLESS_HELD))
 338         {
 339             talk_menu_item(menu, &lists);
 340             continue;
 341         }
 342
 343         if (action == ACTION_TREE_WPS)
 344         {
 345             ret = GO_TO_PREVIOUS_MUSIC;
 346             done = true;
 347         }
 348         else if (action == ACTION_TREE_STOP)
 349         {
 350             list_stop_handler();
 351         }
 352         else if (action == ACTION_STD_CONTEXT &&
 353                  menu == &root_menu_)
 354         {
 355             ret = GO_TO_ROOTITEM_CONTEXT;
 356             done = true;
 357         }
 358         else if (action == ACTION_STD_MENU)
 359         {
 360             if (menu != &root_menu_)
 361                 ret = GO_TO_ROOT;
 362             else
 363                 ret = GO_TO_PREVIOUS;
 364             done = true;
 365         }
 366         else if (action == ACTION_STD_CANCEL)
 367         {
 368             in_stringlist = false;
 369             if (menu_callback)
 370                 menu_callback(ACTION_EXIT_MENUITEM, menu);
 371
 372             if (menu->flags&MENU_EXITAFTERTHISMENU)
 373                 done = true;
 374             if (stack_top > 0)
 375             {
 376                 stack_top--;
 377                 menu = menu_stack[stack_top];
 378                 if (menu->flags&MENU_EXITAFTERTHISMENU)
 379                     done = true;
 380                 init_menu_lists(menu, &lists,
 381                                  menu_stack_selected_item[stack_top], false);
 382                 /* new menu, so reload the callback */
 383                 get_menu_callback(menu, &menu_callback);
 384                 talk_item = true;
 385             }
 386             else if (menu != &root_menu_)
 387             {
 388                 ret = GO_TO_PREVIOUS;
 389                 done = true;
 390             }
 391         }
 392         else if (action == ACTION_STD_OK)
 393         {
 394             int type;
 395 #ifdef HAS_BUTTONBAR
 396             gui_buttonbar_unset(&buttonbar);
 397             gui_buttonbar_draw(&buttonbar);
 398 #endif
 399             selected = get_menu_selection(gui_synclist_get_sel_pos(&lists), menu);
 400             temp = menu->submenus[selected];
 401             redraw_lists = true;
 402             if (in_stringlist)
 403                 type = (menu->flags&MENU_TYPE_MASK);
 404             else
 405             {
 406                 type = (temp->flags&MENU_TYPE_MASK);
 407                 get_menu_callback(temp, &menu_callback);
 408                 if (menu_callback)
 409                 {
 410                     action = menu_callback(ACTION_ENTER_MENUITEM,temp);
 411                     if (action == ACTION_EXIT_MENUITEM)
 412                         break;
 413                 }
 414             }
 415             switch (type)
 416             {
 417                 case MT_MENU:
 418                     if (stack_top < MAX_MENUS)
 419                     {
 420                         menu_stack[stack_top] = menu;
 421                         menu_stack_selected_item[stack_top] = selected;
 422                         stack_top++;
 423                         init_menu_lists(temp, &lists, 0, true);
 424                         redraw_lists = false; /* above does the redraw */
 425                         menu = temp;
 426                         talk_item = true;
 427                     }
 428                     break;
 429                 case MT_FUNCTION_CALL:
 430                 {
 431                     int return_value;
 432                     talk_item = true;
 433                     if (temp->flags&MENU_FUNC_USEPARAM)
 434                         return_value = temp->function->function_w_param(
 435                                     temp->function->param);
 436                     else
 437                         return_value = temp->function->function();
 438                     if (temp->flags&MENU_FUNC_CHECK_RETVAL)
 439                     {
 440                         if (return_value == 1)
 441                         {
 442                             done = true;
 443                             ret =  return_value;
 444                         }
 445                     }
 446                     break;
 447                 }
 448                 case MT_SETTING:
 449                 case MT_SETTING_W_TEXT:
 450                 {
 451                     if (do_setting_from_menu(temp))
 452                     {
 453                         init_menu_lists(menu, &lists, selected, true);
 454                         redraw_lists = false; /* above does the redraw */
 455                     }
 456                     talk_item = true;
 457                     break;
 458                 }
 459                 case MT_RETURN_ID:
 460                     if (in_stringlist)
 461                     {
 462                         done = true;
 463                         ret =  selected;
 464                     }
 465                     else if (stack_top < MAX_MENUS)
 466                     {
 467                         menu_stack[stack_top] = menu;
 468                         menu_stack_selected_item[stack_top] = selected;
 469                         stack_top++;
 470                         menu = temp;
 471                         init_menu_lists(menu,&lists,0,false);
 472                         redraw_lists = false; /* above does the redraw */
 473                         talk_item = true;
 474                         in_stringlist = true;
 475                     }
 476                     break;
 477                 case MT_RETURN_VALUE:
 478                     ret = temp->value;
 479                     done = true;
 480                     break;
 481             }
 482             if (type != MT_MENU)
 483             {
 484                 if (menu_callback)
 485                     menu_callback(ACTION_EXIT_MENUITEM,temp);
 486             }
 487             if (current_submenus_menu != menu)
 488                 init_menu_lists(menu,&lists,selected,true);
 489             /* callback was changed, so reload the menu's callback */
 490             get_menu_callback(menu, &menu_callback);
 491             if ((menu->flags&MENU_EXITAFTERTHISMENU) &&
 492                 !(temp->flags&MENU_EXITAFTERTHISMENU))
 493             {
 494                 done = true;
 495                 break;
 496             }
 497 #ifdef HAS_BUTTONBAR
 498             gui_buttonbar_set(&buttonbar, "<<<", "", "");
 499             gui_buttonbar_draw(&buttonbar);
 500 #endif
 501         }
 502         else if(default_event_handler(action) == SYS_USB_CONNECTED)
 503         {
 504             ret = MENU_ATTACHED_USB;
 505             done = true;
 506         }
 507         if (talk_item && !done)
 508             talk_menu_item(menu, &lists);
 509
 510         if (redraw_lists)
 511             gui_synclist_draw(&lists);
 512     }
 513     if (start_selected)
 514     {
 515         /* make sure the start_selected variable is set to
 516            the selected item from the menu do_menu() was called from */
 517         if (stack_top > 0)
 518         {
 519             menu = menu_stack[0];
 520             init_menu_lists(menu,&lists,menu_stack_selected_item[0],true);
 521         }
 522         *start_selected = get_menu_selection(
 523                             gui_synclist_get_sel_pos(&lists), menu);
 524     }
 525     return ret;
 526 }
 527