apps/gui/list.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2005 by Kevin Ferrare
  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 #include "config.h"
  21 #include "lcd.h"
  22 #include "font.h"
  23 #include "button.h"
  24 #include "sprintf.h"
  25 #include "string.h"
  26 #include "settings.h"
  27 #include "kernel.h"
  28 #include "system.h"
  29
  30 #include "action.h"
  31 #include "screen_access.h"
  32 #include "list.h"
  33 #include "scrollbar.h"
  34 #include "statusbar.h"
  35 #include "lang.h"
  36 #include "sound.h"
  37 #include "misc.h"
  38 #include "talk.h"
  39 #include "viewport.h"
  40 #include "list.h"
  41
  42 #ifdef HAVE_LCD_CHARCELLS
  43 #define SCROLL_LIMIT 1
  44 #else
  45 #define SCROLL_LIMIT (nb_lines<3?1:2)
  46 #endif
  47
  48 /* The minimum number of pending button events in queue before starting
  49  * to limit list drawing interval.
  50  */
  51 #define FRAMEDROP_TRIGGER 6
  52
  53 #ifdef HAVE_LCD_BITMAP
  54 static int offset_step = 16; /* pixels per screen scroll step */
  55 /* should lines scroll out of the screen */
  56 static bool offset_out_of_view = false;
  57 #endif
  58 static int force_list_reinit = false;
  59
  60 static void gui_list_select_at_offset(struct gui_synclist * gui_list,
  61                                       int offset);
  62 void list_draw(struct screen *display, struct viewport *parent, struct gui_synclist *list);
  63
  64 #ifdef HAVE_LCD_BITMAP
  65 static struct viewport parent[NB_SCREENS];
  66 void list_init_viewports(struct gui_synclist *list)
  67 {
  68     int i;
  69     struct viewport *vp;
  70     FOR_NB_SCREENS(i)
  71     {
  72         vp = &parent[i];
  73         if (!list)
  74             viewport_set_defaults(vp, i);
  75         else if (list->parent[i] == vp)
  76         {
  77             viewport_set_defaults(vp, i);
  78             list->parent[i]->y = gui_statusbar_height();
  79             list->parent[i]->height = screens[i].height - list->parent[i]->y;
  80         }
  81     }
  82 #ifdef HAVE_BUTTONBAR
  83     if (list && (list->parent[0] == &parent[0]) && global_settings.buttonbar)
  84         list->parent[0]->height -= BUTTONBAR_HEIGHT;
  85 #endif
  86     force_list_reinit = false;
  87 }
  88 #else
  89 static struct viewport parent[NB_SCREENS] =
  90 {
  91     [SCREEN_MAIN] =
  92     {
  93         .x        = 0,
  94         .y        = 0,
  95         .width    = LCD_WIDTH,
  96         .height   = LCD_HEIGHT
  97     },
  98 };
  99 void list_init_viewports(struct gui_synclist *list)
 100 {
 101     (void)list;
 102 }
 103 #endif
 104
 105 #ifdef HAVE_LCD_BITMAP
 106 bool list_display_title(struct gui_synclist *list, struct viewport *vp)
 107 {
 108     return list->title != NULL && viewport_get_nb_lines(vp)>2;
 109 }
 110 #else
 111 #define list_display_title(l,v) false
 112 #endif
 113
 114 /*
 115  * Initializes a scrolling list
 116  *  - gui_list : the list structure to initialize
 117  *  - callback_get_item_name : pointer to a function that associates a label
 118  *    to a given item number
 119  *  - data : extra data passed to the list callback
 120  *  - scroll_all :
 121  *  - selected_size :
 122  *  - parent : the parent viewports to use. NULL means the full screen minus
 123  *             statusbar if enabled. NOTE: new screens should NOT set this to NULL.
 124  */
 125 void gui_synclist_init(struct gui_synclist * gui_list,
 126     list_get_name callback_get_item_name,
 127     void * data,
 128     bool scroll_all,
 129     int selected_size, struct viewport list_parent[NB_SCREENS]
 130     )
 131 {
 132     int i;
 133     gui_list->callback_get_item_icon = NULL;
 134     gui_list->callback_get_item_name = callback_get_item_name;
 135     gui_list->callback_speak_item = NULL;
 136     gui_list->nb_items = 0;
 137     gui_list->selected_item = 0;
 138     FOR_NB_SCREENS(i)
 139     {
 140         gui_list->start_item[i] = 0;
 141         gui_list->last_displayed_start_item[i] = -1 ;
 142 #ifdef HAVE_LCD_BITMAP
 143         gui_list->offset_position[i] = 0;
 144 #endif
 145         if (list_parent)
 146             gui_list->parent[i] = &list_parent[i];
 147         else
 148         {
 149             gui_list->parent[i] = &parent[i];
 150         }
 151     }
 152     list_init_viewports(gui_list);
 153     gui_list->limit_scroll = false;
 154     gui_list->data=data;
 155     gui_list->scroll_all=scroll_all;
 156     gui_list->selected_size=selected_size;
 157     gui_list->title = NULL;
 158     gui_list->title_width = 0;
 159     gui_list->title_icon = Icon_NOICON;
 160
 161     gui_list->scheduled_talk_tick = gui_list->last_talked_tick = 0;
 162     gui_list->show_selection_marker = true;
 163     gui_list->last_displayed_selected_item = -1 ;
 164
 165 #ifdef HAVE_LCD_COLOR
 166     gui_list->title_color = -1;
 167     gui_list->callback_get_item_color = NULL;
 168 #endif
 169     force_list_reinit = true;
 170 }
 171
 172 /* this toggles the selection bar or cursor */
 173 void gui_synclist_hide_selection_marker(struct gui_synclist * lists, bool hide)
 174 {
 175     lists->show_selection_marker = !hide;
 176 }
 177
 178
 179 #ifdef HAVE_LCD_BITMAP
 180 int list_title_height(struct gui_synclist *list, struct viewport *vp);
 181
 182 int gui_list_get_item_offset(struct gui_synclist * gui_list, int item_width,
 183                              int text_pos, struct screen * display, struct viewport *vp)
 184 {
 185     int item_offset;
 186
 187     if (offset_out_of_view)
 188     {
 189         item_offset = gui_list->offset_position[display->screen_type];
 190     }
 191     else
 192     {
 193         /* if text is smaller then view */
 194         if (item_width <= vp->width - text_pos)
 195         {
 196             item_offset = 0;
 197         }
 198         else
 199         {
 200             /* if text got out of view  */
 201             if (gui_list->offset_position[display->screen_type] >
 202                     item_width - (vp->width - text_pos))
 203                 item_offset = item_width - (vp->width - text_pos);
 204             else
 205                 item_offset = gui_list->offset_position[display->screen_type];
 206         }
 207     }
 208
 209     return item_offset;
 210 }
 211 #endif
 212 /*
 213  * Force a full screen update.
 214  */
 215
 216 void gui_synclist_draw(struct gui_synclist *gui_list)
 217 {
 218     int i;
 219     static struct gui_synclist *last_list = NULL;
 220     static int last_count = -1;
 221 #ifdef HAVE_BUTTONBAR
 222     static bool last_buttonbar = false;
 223 #endif
 224     if (force_list_reinit ||
 225 #ifdef HAVE_BUTTONBAR
 226         last_buttonbar != screens[SCREEN_MAIN].has_buttonbar ||
 227 #endif
 228         last_list != gui_list ||
 229         gui_list->nb_items != last_count)
 230     {
 231         list_init_viewports(gui_list);
 232         force_list_reinit = false;
 233     }
 234 #ifdef HAVE_BUTTONBAR
 235     last_buttonbar = screens[SCREEN_MAIN].has_buttonbar;
 236 #endif
 237     last_count = gui_list->nb_items;
 238     last_list = gui_list;
 239     FOR_NB_SCREENS(i)
 240     {
 241         list_draw(&screens[i], gui_list->parent[i], gui_list);
 242     }
 243 }
 244
 245 /* sets up the list so the selection is shown correctly on the screen */
 246 static void gui_list_put_selection_on_screen(struct gui_synclist * gui_list,
 247                                              enum screen_type screen)
 248 {
 249     int nb_lines;
 250     int difference = gui_list->selected_item - gui_list->start_item[screen];
 251     struct viewport vp = *gui_list->parent[screen];
 252 #ifdef HAVE_LCD_BITMAP
 253     if (list_display_title(gui_list, gui_list->parent[screen]))
 254         vp.height -= list_title_height(gui_list,gui_list->parent[screen]);
 255 #endif
 256     nb_lines = viewport_get_nb_lines(&vp);
 257
 258     /* edge case,, selected last item */
 259     if (gui_list->selected_item == gui_list->nb_items -1)
 260     {
 261         gui_list->start_item[screen] = MAX(0, gui_list->nb_items - nb_lines);
 262     }
 263     /* selected first item */
 264     else if (gui_list->selected_item == 0)
 265     {
 266         gui_list->start_item[screen] = 0;
 267     }
 268     else if (difference < SCROLL_LIMIT) /* list moved up */
 269     {
 270         if (global_settings.scroll_paginated)
 271         {
 272             if (gui_list->start_item[screen] > gui_list->selected_item)
 273                 gui_list->start_item[screen] = (gui_list->selected_item/nb_lines)*nb_lines;
 274         }
 275         else
 276         {
 277             int top_of_screen = gui_list->selected_item - SCROLL_LIMIT + 1;
 278             int temp = MIN(top_of_screen, gui_list->nb_items - nb_lines);
 279             gui_list->start_item[screen] = MAX(0, temp);
 280         }
 281     }
 282     else if (difference > nb_lines - SCROLL_LIMIT) /* list moved down */
 283     {
 284         int bottom = gui_list->nb_items - nb_lines;
 285         /* always move the screen if selection isnt "visible" */
 286         if (gui_list->show_selection_marker == false)
 287         {
 288             if (bottom < 0)
 289                 bottom = 0;
 290             gui_list->start_item[screen] = MIN(bottom, gui_list->start_item[screen] +
 291                                                        2*gui_list->selected_size);
 292         }
 293         else if (global_settings.scroll_paginated)
 294         {
 295             if (gui_list->start_item[screen] + nb_lines <= gui_list->selected_item)
 296                 gui_list->start_item[screen] = MIN(bottom, gui_list->selected_item);
 297         }
 298         else
 299         {
 300             int top_of_screen = gui_list->selected_item + SCROLL_LIMIT - nb_lines;
 301             int temp = MAX(0, top_of_screen);
 302             gui_list->start_item[screen] = MIN(bottom, temp);
 303         }
 304     }
 305 }
 306 /*
 307  * Selects an item in the list
 308  *  - gui_list : the list structure
 309  *  - item_number : the number of the item which will be selected
 310  */
 311 void gui_synclist_select_item(struct gui_synclist * gui_list, int item_number)
 312 {
 313     int i;
 314     if( item_number > gui_list->nb_items-1 || item_number < 0 )
 315         return;
 316     gui_list->selected_item = item_number;
 317     FOR_NB_SCREENS(i)
 318         gui_list_put_selection_on_screen(gui_list, i);
 319 }
 320
 321 static void gui_list_select_at_offset(struct gui_synclist * gui_list,
 322                                       int offset)
 323 {
 324     int new_selection;
 325     if (gui_list->selected_size > 1)
 326     {
 327         offset *= gui_list->selected_size;
 328         /* always select the first item of multi-line lists */
 329         offset -= offset%gui_list->selected_size;
 330     }
 331     new_selection = gui_list->selected_item + offset;
 332     if (new_selection >= gui_list->nb_items)
 333     {
 334         gui_list->selected_item = gui_list->limit_scroll ?
 335           gui_list->nb_items - gui_list->selected_size : 0;
 336     }
 337     else if (new_selection < 0)
 338     {
 339         gui_list->selected_item = gui_list->limit_scroll ?
 340           0 : gui_list->nb_items - gui_list->selected_size;
 341     }
 342     else if (gui_list->show_selection_marker == false)
 343     {
 344         /* NOTE: this part doesnt work as well as it used to, the problem is
 345                  we want to scroll the lists seperatly but we only have one
 346                  selected item now, I dont think this is such a big deal though  */
 347         int i, nb_lines, screen_top;
 348         FOR_NB_SCREENS(i)
 349         {
 350             struct viewport vp = *gui_list->parent[i];
 351 #ifdef HAVE_LCD_BITMAP
 352             if (list_display_title(gui_list, gui_list->parent[i]))
 353                 vp.height -= list_title_height(gui_list,gui_list->parent[i]);
 354 #endif
 355             nb_lines = viewport_get_nb_lines(&vp);
 356             if (offset > 0)
 357             {
 358                 screen_top = gui_list->nb_items-nb_lines;
 359                 if (screen_top < 0)
 360                     screen_top = 0;
 361                 gui_list->start_item[i] = MIN(screen_top, gui_list->start_item[i] +
 362                                                           gui_list->selected_size);
 363             }
 364             else
 365             {
 366                 gui_list->start_item[i] = MAX(0, gui_list->start_item[i] -
 367                                                  gui_list->selected_size);
 368             }
 369         }
 370         return;
 371     }
 372     else gui_list->selected_item += offset;
 373     gui_synclist_select_item(gui_list, gui_list->selected_item);
 374 }
 375
 376 /*
 377  * Adds an item to the list (the callback will be asked for one more item)
 378  * - gui_list : the list structure
 379  */
 380 void gui_synclist_add_item(struct gui_synclist * gui_list)
 381 {
 382     gui_list->nb_items++;
 383     /* if only one item in the list, select it */
 384     if(gui_list->nb_items == 1)
 385         gui_list->selected_item = 0;
 386 }
 387
 388 /*
 389  * Removes an item to the list (the callback will be asked for one less item)
 390  * - gui_list : the list structure
 391  */
 392 void gui_synclist_del_item(struct gui_synclist * gui_list)
 393 {
 394     if(gui_list->nb_items > 0)
 395     {
 396         if (gui_list->selected_item == gui_list->nb_items-1)
 397             gui_list->selected_item--;
 398         gui_list->nb_items--;
 399         gui_synclist_select_item(gui_list, gui_list->selected_item);
 400     }
 401 }
 402
 403 #ifdef HAVE_LCD_BITMAP
 404 void gui_list_screen_scroll_step(int ofs)
 405 {
 406      offset_step = ofs;
 407 }
 408
 409 void gui_list_screen_scroll_out_of_view(bool enable)
 410 {
 411     if (enable)
 412         offset_out_of_view = true;
 413     else
 414         offset_out_of_view = false;
 415 }
 416 #endif /* HAVE_LCD_BITMAP */
 417
 418 /*
 419  * Set the title and title icon of the list. Setting title to NULL disables
 420  * both the title and icon. Use NOICON if there is no icon.
 421  */
 422 void gui_synclist_set_title(struct gui_synclist * gui_list,
 423                                char * title, enum themable_icons icon)
 424 {
 425     gui_list->title = title;
 426     gui_list->title_icon = icon;
 427     if (title) {
 428 #ifdef HAVE_LCD_BITMAP
 429         int i;
 430         FOR_NB_SCREENS(i)
 431             screens[i].getstringsize(title, &gui_list->title_width, NULL);
 432 #else
 433         gui_list->title_width = strlen(title);
 434 #endif
 435     } else {
 436         gui_list->title_width = 0;
 437     }
 438     force_list_reinit = true;
 439 }
 440
 441
 442 void gui_synclist_set_nb_items(struct gui_synclist * lists, int nb_items)
 443 {
 444 #ifdef HAVE_LCD_BITMAP
 445     int i;
 446 #endif
 447     lists->nb_items = nb_items;
 448 #ifdef HAVE_LCD_BITMAP
 449     FOR_NB_SCREENS(i)
 450     {
 451         lists->offset_position[i] = 0;
 452     }
 453 #endif
 454 }
 455 int gui_synclist_get_nb_items(struct gui_synclist * lists)
 456 {
 457     return lists->nb_items;
 458 }
 459 int  gui_synclist_get_sel_pos(struct gui_synclist * lists)
 460 {
 461     return lists->selected_item;
 462 }
 463 void gui_synclist_set_icon_callback(struct gui_synclist * lists,
 464                                     list_get_icon icon_callback)
 465 {
 466     lists->callback_get_item_icon = icon_callback;
 467 }
 468
 469 void gui_synclist_set_voice_callback(struct gui_synclist * lists,
 470                                     list_speak_item voice_callback)
 471 {
 472     lists->callback_speak_item = voice_callback;
 473 }
 474
 475 #ifdef HAVE_LCD_COLOR
 476 void gui_synclist_set_color_callback(struct gui_synclist * lists,
 477                                     list_get_color color_callback)
 478 {
 479     lists->callback_get_item_color = color_callback;
 480 }
 481 #endif
 482
 483 static void gui_synclist_select_next_page(struct gui_synclist * lists,
 484                                    enum screen_type screen)
 485 {
 486     int nb_lines = viewport_get_nb_lines(lists->parent[screen]);
 487     gui_list_select_at_offset(lists, nb_lines);
 488 }
 489
 490 static void gui_synclist_select_previous_page(struct gui_synclist * lists,
 491                                        enum screen_type screen)
 492 {
 493     int nb_lines = viewport_get_nb_lines(lists->parent[screen]);
 494     gui_list_select_at_offset(lists, -nb_lines);
 495 }
 496
 497 void gui_synclist_limit_scroll(struct gui_synclist * lists, bool scroll)
 498 {
 499     lists->limit_scroll = scroll;
 500 }
 501
 502 #ifdef HAVE_LCD_BITMAP
 503 /*
 504  * Makes all the item in the list scroll by one step to the right.
 505  * Should stop increasing the value when reaching the widest item value
 506  * in the list.
 507  */
 508 static void gui_synclist_scroll_right(struct gui_synclist * lists)
 509 {
 510     int i;
 511     FOR_NB_SCREENS(i)
 512     {
 513         /* FIXME: This is a fake right boundry limiter. there should be some
 514         * callback function to find the longest item on the list in pixels,
 515         * to stop the list from scrolling past that point */
 516         lists->offset_position[i]+=offset_step;
 517         if (lists->offset_position[i] > 1000)
 518             lists->offset_position[i] = 1000;
 519     }
 520 }
 521
 522 /*
 523  * Makes all the item in the list scroll by one step to the left.
 524  * stops at starting position.
 525  */
 526 static void gui_synclist_scroll_left(struct gui_synclist * lists)
 527 {
 528     int i;
 529     FOR_NB_SCREENS(i)
 530     {
 531         lists->offset_position[i]-=offset_step;
 532         if (lists->offset_position[i] < 0)
 533             lists->offset_position[i] = 0;
 534     }
 535 }
 536 #endif /* HAVE_LCD_BITMAP */
 537
 538 static void _gui_synclist_speak_item(struct gui_synclist *lists, bool repeating)
 539 {
 540     list_speak_item *cb = lists->callback_speak_item;
 541     if(cb && gui_synclist_get_nb_items(lists) != 0)
 542     {
 543         int sel = gui_synclist_get_sel_pos(lists);
 544         talk_shutup();
 545         /* If we got a repeating key action, or we have just very
 546            recently started talking, then we want to stay silent for a
 547            while until things settle. Likewise if we already had a
 548            pending scheduled announcement not yet due: we need to
 549            reschedule it. */
 550         if(repeating
 551            || (lists->scheduled_talk_tick
 552                && TIME_BEFORE(current_tick, lists->scheduled_talk_tick))
 553            || (lists->last_talked_tick
 554                && TIME_BEFORE(current_tick, lists->last_talked_tick +HZ/4)))
 555         {
 556             lists->scheduled_talk_tick = current_tick +HZ/4;
 557             return;
 558         } else {
 559             lists->scheduled_talk_tick = 0; /* work done */
 560             cb(sel, lists->data);
 561             lists->last_talked_tick = current_tick;
 562         }
 563     }
 564 }
 565 void gui_synclist_speak_item(struct gui_synclist * lists)
 566 /* The list user should call this to speak the first item on entering
 567    the list, and whenever the list is updated. */
 568 {
 569     if(gui_synclist_get_nb_items(lists) == 0 && global_settings.talk_menu)
 570         talk_id(VOICE_EMPTY_LIST, true);
 571     else _gui_synclist_speak_item(lists, false);
 572 }
 573
 574 extern intptr_t get_action_data(void);
 575 #if  defined(HAVE_TOUCHPAD)
 576 /* this needs to be fixed if we ever get more than 1 touchscreen on a target */
 577 unsigned gui_synclist_do_touchpad(struct gui_synclist * gui_list, struct viewport *parent);
 578 #endif
 579
 580 bool gui_synclist_do_button(struct gui_synclist * lists,
 581                             unsigned *actionptr, enum list_wrap wrap)
 582 {
 583     int action = *actionptr;
 584 #ifdef HAVE_LCD_BITMAP
 585     static bool scrolling_left = false;
 586 #endif
 587
 588 #ifdef HAVE_SCROLLWHEEL
 589     int next_item_modifier = button_apply_acceleration(get_action_data());
 590 #else
 591     static int next_item_modifier = 1;
 592     static int last_accel_tick = 0;
 593
 594     if (global_settings.list_accel_start_delay)
 595     {
 596         int start_delay = global_settings.list_accel_start_delay * (HZ/2);
 597         int accel_wait = global_settings.list_accel_wait * HZ/2;
 598
 599         if (get_action_statuscode(NULL)&ACTION_REPEAT)
 600         {
 601             if (!last_accel_tick)
 602                 last_accel_tick = current_tick + start_delay;
 603             else if (current_tick >=
 604                         last_accel_tick + accel_wait)
 605             {
 606                 last_accel_tick = current_tick;
 607                 next_item_modifier++;
 608             }
 609         }
 610         else if (last_accel_tick)
 611         {
 612             next_item_modifier = 1;
 613             last_accel_tick = 0;
 614         }
 615     }
 616 #endif
 617
 618 #if defined(HAVE_TOUCHPAD)
 619     if (action == ACTION_TOUCHPAD)
 620         action = *actionptr = gui_synclist_do_touchpad(lists, &parent[SCREEN_MAIN]);
 621 #endif
 622
 623     switch (wrap)
 624     {
 625         case LIST_WRAP_ON:
 626             gui_synclist_limit_scroll(lists, false);
 627         break;
 628         case LIST_WRAP_OFF:
 629             gui_synclist_limit_scroll(lists, true);
 630         break;
 631         case LIST_WRAP_UNLESS_HELD:
 632             if (action == ACTION_STD_PREVREPEAT ||
 633                 action == ACTION_STD_NEXTREPEAT ||
 634                 action == ACTION_LISTTREE_PGUP  ||
 635                 action == ACTION_LISTTREE_PGDOWN)
 636                 gui_synclist_limit_scroll(lists, true);
 637             else gui_synclist_limit_scroll(lists, false);
 638         break;
 639     };
 640
 641     switch (action)
 642     {
 643         case ACTION_REDRAW:
 644             gui_synclist_draw(lists);
 645             return true;
 646
 647 #ifdef HAVE_VOLUME_IN_LIST
 648         case ACTION_LIST_VOLUP:
 649             global_settings.volume += 2;
 650             /* up two because the falthrough brings it down one */
 651         case ACTION_LIST_VOLDOWN:
 652             global_settings.volume--;
 653             setvol();
 654             return true;
 655 #endif
 656         case ACTION_STD_PREV:
 657         case ACTION_STD_PREVREPEAT:
 658                 gui_list_select_at_offset(lists, -next_item_modifier);
 659 #ifndef HAVE_SCROLLWHEEL
 660             if (button_queue_count() < FRAMEDROP_TRIGGER)
 661 #endif
 662                 gui_synclist_draw(lists);
 663             _gui_synclist_speak_item(lists,
 664                                      action == ACTION_STD_PREVREPEAT
 665                                      || next_item_modifier >1);
 666             yield();
 667             *actionptr = ACTION_STD_PREV;
 668             return true;
 669
 670         case ACTION_STD_NEXT:
 671         case ACTION_STD_NEXTREPEAT:
 672                 gui_list_select_at_offset(lists, next_item_modifier);
 673 #ifndef HAVE_SCROLLWHEEL
 674             if (button_queue_count() < FRAMEDROP_TRIGGER)
 675 #endif
 676                 gui_synclist_draw(lists);
 677             _gui_synclist_speak_item(lists,
 678                                      action == ACTION_STD_NEXTREPEAT
 679                                      || next_item_modifier >1);
 680             yield();
 681             *actionptr = ACTION_STD_NEXT;
 682             return true;
 683
 684 #ifdef HAVE_LCD_BITMAP
 685         case ACTION_TREE_PGRIGHT:
 686             gui_synclist_scroll_right(lists);
 687             gui_synclist_draw(lists);
 688             return true;
 689         case ACTION_TREE_ROOT_INIT:
 690          /* After this button press ACTION_TREE_PGLEFT is allowed
 691             to skip to root. ACTION_TREE_ROOT_INIT must be defined in the
 692             keymaps as a repeated button press (the same as the repeated
 693             ACTION_TREE_PGLEFT) with the pre condition being the non-repeated
 694             button press */
 695             if (lists->offset_position[0] == 0)
 696             {
 697                 scrolling_left = false;
 698                 *actionptr = ACTION_STD_CANCEL;
 699                 return true;
 700             }
 701             *actionptr = ACTION_TREE_PGLEFT;
 702         case ACTION_TREE_PGLEFT:
 703             if(!scrolling_left && (lists->offset_position[0] == 0))
 704             {
 705                 *actionptr = ACTION_STD_CANCEL;
 706                 return false;
 707             }
 708             gui_synclist_scroll_left(lists);
 709             gui_synclist_draw(lists);
 710             scrolling_left = true; /* stop ACTION_TREE_PAGE_LEFT
 711                                       skipping to root */
 712             return true;
 713 #endif
 714 /* for pgup / pgdown, we are obliged to have a different behaviour depending
 715  * on the screen for which the user pressed the key since for example, remote
 716  * and main screen doesn't have the same number of lines */
 717         case ACTION_LISTTREE_PGUP:
 718         {
 719             int screen =
 720 #ifdef HAVE_REMOTE_LCD
 721                 get_action_statuscode(NULL)&ACTION_REMOTE ?
 722                          SCREEN_REMOTE :
 723 #endif
 724                                           SCREEN_MAIN;
 725             gui_synclist_select_previous_page(lists, screen);
 726             gui_synclist_draw(lists);
 727             _gui_synclist_speak_item(lists, false);
 728             yield();
 729             *actionptr = ACTION_STD_NEXT;
 730         }
 731         return true;
 732
 733         case ACTION_LISTTREE_PGDOWN:
 734         {
 735             int screen =
 736 #ifdef HAVE_REMOTE_LCD
 737                 get_action_statuscode(NULL)&ACTION_REMOTE ?
 738                          SCREEN_REMOTE :
 739 #endif
 740                                           SCREEN_MAIN;
 741             gui_synclist_select_next_page(lists, screen);
 742             gui_synclist_draw(lists);
 743             _gui_synclist_speak_item(lists, false);
 744             yield();
 745             *actionptr = ACTION_STD_PREV;
 746         }
 747         return true;
 748     }
 749     if(lists->scheduled_talk_tick
 750        && TIME_AFTER(current_tick, lists->scheduled_talk_tick))
 751         /* scheduled postponed item announcement is due */
 752         _gui_synclist_speak_item(lists, false);
 753     return false;
 754 }
 755
 756 int list_do_action_timeout(struct gui_synclist *lists, int timeout)
 757 /* Returns the lowest of timeout or the delay until a postponed
 758    scheduled announcement is due (if any). */
 759 {
 760     if(lists->scheduled_talk_tick)
 761     {
 762         long delay = lists->scheduled_talk_tick -current_tick +1;
 763         /* +1 because the trigger condition uses TIME_AFTER(), which
 764            is implemented as strictly greater than. */
 765         if(delay < 0)
 766             delay = 0;
 767         if(timeout > delay || timeout == TIMEOUT_BLOCK)
 768             timeout = delay;
 769     }
 770     return timeout;
 771 }
 772
 773 bool list_do_action(int context, int timeout,
 774                     struct gui_synclist *lists, int *action,
 775                     enum list_wrap wrap)
 776 /* Combines the get_action() (with possibly overridden timeout) and
 777    gui_synclist_do_button() calls. Returns the list action from
 778    do_button, and places the action from get_action in *action. */
 779 {
 780     timeout = list_do_action_timeout(lists, timeout);
 781     *action = get_action(context, timeout);
 782     return gui_synclist_do_button(lists, action, wrap);
 783 }
 784
 785 /* Simple use list implementation */
 786 static int simplelist_line_count = 0;
 787 static char simplelist_text[SIMPLELIST_MAX_LINES][SIMPLELIST_MAX_LINELENGTH];
 788 /* set the amount of lines shown in the list */
 789 void simplelist_set_line_count(int lines)
 790 {
 791     if (lines < 0)
 792         simplelist_line_count = 0;
 793     else if (lines >= SIMPLELIST_MAX_LINES)
 794         simplelist_line_count = SIMPLELIST_MAX_LINES;
 795     else
 796         simplelist_line_count = lines;
 797 }
 798 /* get the current amount of lines shown */
 799 int simplelist_get_line_count(void)
 800 {
 801     return simplelist_line_count;
 802 }
 803 /* add/edit a line in the list.
 804    if line_number > number of lines shown it adds the line, else it edits the line */
 805 void simplelist_addline(int line_number, const char *fmt, ...)
 806 {
 807     va_list ap;
 808
 809     if (line_number > simplelist_line_count)
 810     {
 811         if (simplelist_line_count < SIMPLELIST_MAX_LINES)
 812             line_number = simplelist_line_count++;
 813         else
 814              return;
 815     }
 816     va_start(ap, fmt);
 817     vsnprintf(simplelist_text[line_number], SIMPLELIST_MAX_LINELENGTH, fmt, ap);
 818     va_end(ap);
 819 }
 820
 821 static char* simplelist_static_getname(int item,
 822                                        void * data,
 823                                        char *buffer,
 824                                        size_t buffer_len)
 825 {
 826     (void)data; (void)buffer; (void)buffer_len;
 827     return simplelist_text[item];
 828 }
 829
 830 bool simplelist_show_list(struct simplelist_info *info)
 831 {
 832     struct gui_synclist lists;
 833     struct viewport vp[NB_SCREENS];
 834     int action, old_line_count = simplelist_line_count,i;
 835     char* (*getname)(int item, void * data, char *buffer, size_t buffer_len);
 836     if (info->get_name)
 837         getname = info->get_name;
 838     else
 839         getname = simplelist_static_getname;
 840     FOR_NB_SCREENS(i)
 841     {
 842         viewport_set_defaults(&vp[i], i);
 843     }
 844     gui_synclist_init(&lists, getname,  info->callback_data,
 845                       info->scroll_all, info->selection_size, vp);
 846
 847     if (info->title)
 848         gui_synclist_set_title(&lists, info->title, NOICON);
 849     if (info->get_icon)
 850         gui_synclist_set_icon_callback(&lists, info->get_icon);
 851     if (info->get_talk)
 852         gui_synclist_set_voice_callback(&lists, info->get_talk);
 853
 854     gui_synclist_hide_selection_marker(&lists, info->hide_selection);
 855
 856     if (info->action_callback)
 857         info->action_callback(ACTION_REDRAW, &lists);
 858
 859     if (info->get_name == NULL)
 860         gui_synclist_set_nb_items(&lists, simplelist_line_count*info->selection_size);
 861     else
 862         gui_synclist_set_nb_items(&lists, info->count*info->selection_size);
 863
 864     gui_synclist_select_item(&lists, info->start_selection);
 865
 866     gui_synclist_draw(&lists);
 867     gui_synclist_speak_item(&lists);
 868
 869     while(1)
 870     {
 871         gui_syncstatusbar_draw(&statusbars, true);
 872         list_do_action(CONTEXT_STD, info->timeout,
 873                        &lists, &action, LIST_WRAP_UNLESS_HELD);
 874
 875         /* We must yield in this case or no other thread can run */
 876         if (info->timeout == TIMEOUT_NOBLOCK)
 877             yield();
 878
 879         if (info->action_callback)
 880         {
 881             action = info->action_callback(action, &lists);
 882             if (info->get_name == NULL)
 883                 gui_synclist_set_nb_items(&lists, simplelist_line_count*info->selection_size);
 884         }
 885         if (action == ACTION_STD_CANCEL)
 886             break;
 887         else if ((action == ACTION_REDRAW) ||
 888                  (old_line_count != simplelist_line_count))
 889         {
 890             if (info->get_name == NULL)
 891                 gui_synclist_set_nb_items(&lists, simplelist_line_count*info->selection_size);
 892             gui_synclist_draw(&lists);
 893             if (action != ACTION_NONE)
 894                 gui_synclist_speak_item(&lists);
 895             old_line_count = simplelist_line_count;
 896         }
 897         else if(default_event_handler(action) == SYS_USB_CONNECTED)
 898             return true;
 899     }
 900     talk_shutup();
 901     return false;
 902 }
 903
 904 void simplelist_info_init(struct simplelist_info *info, char* title,
 905                           int count, void* data)
 906 {
 907     info->title = title;
 908     info->count = count;
 909     info->selection_size = 1;
 910     info->hide_selection = false;
 911     info->scroll_all = false;
 912     info->timeout = HZ/10;
 913     info->start_selection = 0;
 914     info->action_callback = NULL;
 915     info->get_icon = NULL;
 916     info->get_name = NULL;
 917     info->get_talk = NULL;
 918     info->callback_data = data;
 919 }
 920
 921
 922
 923
 924
 925
 926