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