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