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