Fix duplicate #includes
[kugel-rb.git] / apps / gui / list.c
blob732529f416abdb87dd89735a383b8d721818321a
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2005 by Kevin Ferrare
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.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
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"
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"
42 #ifdef HAVE_LCD_CHARCELLS
43 #define SCROLL_LIMIT 1
44 #else
45 #define SCROLL_LIMIT (nb_lines<3?1:2)
46 #endif
48 /* The minimum number of pending button events in queue before starting
49 * to limit list drawing interval.
51 #define FRAMEDROP_TRIGGER 6
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;
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);
64 #ifdef HAVE_LCD_BITMAP
65 static struct viewport parent[NB_SCREENS];
66 void list_init_viewports(struct gui_synclist *list)
68 int i;
69 struct viewport *vp;
70 FOR_NB_SCREENS(i)
72 vp = &parent[i];
73 if (!list || list->parent[i] == vp)
74 viewport_set_defaults(vp, i);
76 #ifdef HAVE_BUTTONBAR
77 if (list && (list->parent[0] == &parent[0]) && global_settings.buttonbar)
78 list->parent[0]->height -= BUTTONBAR_HEIGHT;
79 #endif
80 force_list_reinit = false;
82 #else
83 static struct viewport parent[NB_SCREENS] =
85 [SCREEN_MAIN] =
87 .x = 0,
88 .y = 0,
89 .width = LCD_WIDTH,
90 .height = LCD_HEIGHT
93 void list_init_viewports(struct gui_synclist *list)
95 (void)list;
96 force_list_reinit = false;
98 #endif
100 #ifdef HAVE_LCD_BITMAP
101 bool list_display_title(struct gui_synclist *list, enum screen_type screen)
103 return list->title != NULL &&
104 viewport_get_nb_lines(list->parent[screen])>2;
106 #else
107 #define list_display_title(l, i) false
108 #endif
111 * Initializes a scrolling list
112 * - gui_list : the list structure to initialize
113 * - callback_get_item_name : pointer to a function that associates a label
114 * to a given item number
115 * - data : extra data passed to the list callback
116 * - scroll_all :
117 * - selected_size :
118 * - parent : the parent viewports to use. NULL means the full screen minus
119 * statusbar if enabled. NOTE: new screens should NOT set this to NULL.
121 void gui_synclist_init(struct gui_synclist * gui_list,
122 list_get_name callback_get_item_name,
123 void * data,
124 bool scroll_all,
125 int selected_size, struct viewport list_parent[NB_SCREENS]
128 int i;
129 gui_list->callback_get_item_icon = NULL;
130 gui_list->callback_get_item_name = callback_get_item_name;
131 gui_list->callback_speak_item = NULL;
132 gui_list->nb_items = 0;
133 gui_list->selected_item = 0;
134 FOR_NB_SCREENS(i)
136 gui_list->start_item[i] = 0;
137 gui_list->last_displayed_start_item[i] = -1 ;
138 #ifdef HAVE_LCD_BITMAP
139 gui_list->offset_position[i] = 0;
140 #endif
141 if (list_parent)
142 gui_list->parent[i] = &list_parent[i];
143 else
145 gui_list->parent[i] = &parent[i];
148 list_init_viewports(gui_list);
149 gui_list->limit_scroll = false;
150 gui_list->data=data;
151 gui_list->scroll_all=scroll_all;
152 gui_list->selected_size=selected_size;
153 gui_list->title = NULL;
154 gui_list->title_width = 0;
155 gui_list->title_icon = Icon_NOICON;
157 gui_list->scheduled_talk_tick = gui_list->last_talked_tick = 0;
158 gui_list->show_selection_marker = true;
159 gui_list->last_displayed_selected_item = -1 ;
161 #ifdef HAVE_LCD_COLOR
162 gui_list->title_color = -1;
163 gui_list->callback_get_item_color = NULL;
164 #endif
165 force_list_reinit = true;
168 /* this toggles the selection bar or cursor */
169 void gui_synclist_hide_selection_marker(struct gui_synclist * lists, bool hide)
171 lists->show_selection_marker = !hide;
175 #ifdef HAVE_LCD_BITMAP
176 int gui_list_get_item_offset(struct gui_synclist * gui_list,
177 int item_width,
178 int text_pos,
179 struct screen * display,
180 struct viewport *vp)
182 int item_offset;
184 if (offset_out_of_view)
186 item_offset = gui_list->offset_position[display->screen_type];
188 else
190 /* if text is smaller then view */
191 if (item_width <= vp->width - text_pos)
193 item_offset = 0;
195 else
197 /* if text got out of view */
198 if (gui_list->offset_position[display->screen_type] >
199 item_width - (vp->width - text_pos))
200 item_offset = item_width - (vp->width - text_pos);
201 else
202 item_offset = gui_list->offset_position[display->screen_type];
206 return item_offset;
208 #endif
210 * Force a full screen update.
213 void gui_synclist_draw(struct gui_synclist *gui_list)
215 int i;
216 static struct gui_synclist *last_list = NULL;
217 static int last_count = -1;
218 #ifdef HAVE_BUTTONBAR
219 static bool last_buttonbar = false;
220 #endif
221 if (force_list_reinit ||
222 #ifdef HAVE_BUTTONBAR
223 last_buttonbar != screens[SCREEN_MAIN].has_buttonbar ||
224 #endif
225 last_list != gui_list ||
226 gui_list->nb_items != last_count)
228 list_init_viewports(gui_list);
229 gui_synclist_select_item(gui_list, gui_list->selected_item);
231 #ifdef HAVE_BUTTONBAR
232 last_buttonbar = screens[SCREEN_MAIN].has_buttonbar;
233 #endif
234 last_count = gui_list->nb_items;
235 last_list = gui_list;
236 FOR_NB_SCREENS(i)
238 list_draw(&screens[i], gui_list);
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)
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);
255 /* edge case,, selected last item */
256 if (gui_list->selected_item == gui_list->nb_items -1)
258 gui_list->start_item[screen] = MAX(0, gui_list->nb_items - nb_lines);
260 /* selected first item */
261 else if (gui_list->selected_item == 0)
263 gui_list->start_item[screen] = 0;
265 else if (difference < SCROLL_LIMIT) /* list moved up */
267 if (global_settings.scroll_paginated)
269 if (gui_list->start_item[screen] > gui_list->selected_item)
271 gui_list->start_item[screen] = (gui_list->selected_item/nb_lines)
272 *nb_lines;
274 if (gui_list->nb_items <= nb_lines)
275 gui_list->start_item[screen] = 0;
277 else
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);
284 else if (difference > nb_lines - SCROLL_LIMIT) /* list moved down */
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)
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);
295 else if (global_settings.scroll_paginated)
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);
300 else
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);
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
313 void gui_synclist_select_item(struct gui_synclist * gui_list, int item_number)
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);
323 static void gui_list_select_at_offset(struct gui_synclist * gui_list,
324 int offset)
326 int new_selection;
327 if (gui_list->selected_size > 1)
329 offset *= gui_list->selected_size;
330 /* always select the first item of multi-line lists */
331 offset -= offset%gui_list->selected_size;
333 new_selection = gui_list->selected_item + offset;
334 if (new_selection >= gui_list->nb_items)
336 gui_list->selected_item = gui_list->limit_scroll ?
337 gui_list->nb_items - gui_list->selected_size : 0;
339 else if (new_selection < 0)
341 gui_list->selected_item = gui_list->limit_scroll ?
342 0 : gui_list->nb_items - gui_list->selected_size;
344 else if (gui_list->show_selection_marker == false)
346 int i, nb_lines, screen_top;
347 FOR_NB_SCREENS(i)
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)
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];
364 else
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;
371 return;
373 else gui_list->selected_item += offset;
374 gui_synclist_select_item(gui_list, gui_list->selected_item);
378 * Adds an item to the list (the callback will be asked for one more item)
379 * - gui_list : the list structure
381 void gui_synclist_add_item(struct gui_synclist * gui_list)
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;
390 * Removes an item to the list (the callback will be asked for one less item)
391 * - gui_list : the list structure
393 void gui_synclist_del_item(struct gui_synclist * gui_list)
395 if(gui_list->nb_items > 0)
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);
404 #ifdef HAVE_LCD_BITMAP
405 void gui_list_screen_scroll_step(int ofs)
407 offset_step = ofs;
410 void gui_list_screen_scroll_out_of_view(bool enable)
412 if (enable)
413 offset_out_of_view = true;
414 else
415 offset_out_of_view = false;
417 #endif /* HAVE_LCD_BITMAP */
420 * Set the title and title icon of the list. Setting title to NULL disables
421 * both the title and icon. Use NOICON if there is no icon.
423 void gui_synclist_set_title(struct gui_synclist * gui_list,
424 char * title, enum themable_icons icon)
426 gui_list->title = title;
427 gui_list->title_icon = icon;
428 if (title) {
429 #ifdef HAVE_LCD_BITMAP
430 int i;
431 FOR_NB_SCREENS(i)
432 screens[i].getstringsize(title, &gui_list->title_width, NULL);
433 #else
434 gui_list->title_width = strlen(title);
435 #endif
436 } else {
437 gui_list->title_width = 0;
439 force_list_reinit = true;
443 void gui_synclist_set_nb_items(struct gui_synclist * lists, int nb_items)
445 #ifdef HAVE_LCD_BITMAP
446 int i;
447 #endif
448 lists->nb_items = nb_items;
449 #ifdef HAVE_LCD_BITMAP
450 FOR_NB_SCREENS(i)
452 lists->offset_position[i] = 0;
454 #endif
456 int gui_synclist_get_nb_items(struct gui_synclist * lists)
458 return lists->nb_items;
460 int gui_synclist_get_sel_pos(struct gui_synclist * lists)
462 return lists->selected_item;
464 void gui_synclist_set_icon_callback(struct gui_synclist * lists,
465 list_get_icon icon_callback)
467 lists->callback_get_item_icon = icon_callback;
470 void gui_synclist_set_voice_callback(struct gui_synclist * lists,
471 list_speak_item voice_callback)
473 lists->callback_speak_item = voice_callback;
476 #ifdef HAVE_LCD_COLOR
477 void gui_synclist_set_color_callback(struct gui_synclist * lists,
478 list_get_color color_callback)
480 lists->callback_get_item_color = color_callback;
482 #endif
484 static void gui_synclist_select_next_page(struct gui_synclist * lists,
485 enum screen_type screen)
487 int nb_lines = viewport_get_nb_lines(lists->parent[screen]);
488 gui_list_select_at_offset(lists, nb_lines);
491 static void gui_synclist_select_previous_page(struct gui_synclist * lists,
492 enum screen_type screen)
494 int nb_lines = viewport_get_nb_lines(lists->parent[screen]);
495 gui_list_select_at_offset(lists, -nb_lines);
498 void gui_synclist_limit_scroll(struct gui_synclist * lists, bool scroll)
500 lists->limit_scroll = scroll;
503 #ifdef HAVE_LCD_BITMAP
505 * Makes all the item in the list scroll by one step to the right.
506 * Should stop increasing the value when reaching the widest item value
507 * in the list.
509 static void gui_synclist_scroll_right(struct gui_synclist * lists)
511 int i;
512 FOR_NB_SCREENS(i)
514 /* FIXME: This is a fake right boundry limiter. there should be some
515 * callback function to find the longest item on the list in pixels,
516 * to stop the list from scrolling past that point */
517 lists->offset_position[i]+=offset_step;
518 if (lists->offset_position[i] > 1000)
519 lists->offset_position[i] = 1000;
524 * Makes all the item in the list scroll by one step to the left.
525 * stops at starting position.
527 static void gui_synclist_scroll_left(struct gui_synclist * lists)
529 int i;
530 FOR_NB_SCREENS(i)
532 lists->offset_position[i]-=offset_step;
533 if (lists->offset_position[i] < 0)
534 lists->offset_position[i] = 0;
537 #endif /* HAVE_LCD_BITMAP */
539 static void _gui_synclist_speak_item(struct gui_synclist *lists, bool repeating)
541 list_speak_item *cb = lists->callback_speak_item;
542 if(cb && gui_synclist_get_nb_items(lists) != 0)
544 int sel = gui_synclist_get_sel_pos(lists);
545 talk_shutup();
546 /* If we got a repeating key action, or we have just very
547 recently started talking, then we want to stay silent for a
548 while until things settle. Likewise if we already had a
549 pending scheduled announcement not yet due: we need to
550 reschedule it. */
551 if(repeating
552 || (lists->scheduled_talk_tick
553 && TIME_BEFORE(current_tick, lists->scheduled_talk_tick))
554 || (lists->last_talked_tick
555 && TIME_BEFORE(current_tick, lists->last_talked_tick +HZ/4)))
557 lists->scheduled_talk_tick = current_tick +HZ/4;
558 return;
559 } else {
560 lists->scheduled_talk_tick = 0; /* work done */
561 cb(sel, lists->data);
562 lists->last_talked_tick = current_tick;
566 void gui_synclist_speak_item(struct gui_synclist * lists)
567 /* The list user should call this to speak the first item on entering
568 the list, and whenever the list is updated. */
570 if(gui_synclist_get_nb_items(lists) == 0 && global_settings.talk_menu)
571 talk_id(VOICE_EMPTY_LIST, true);
572 else _gui_synclist_speak_item(lists, false);
575 extern intptr_t get_action_data(void);
576 #if defined(HAVE_TOUCHSCREEN)
577 /* this needs to be fixed if we ever get more than 1 touchscreen on a target */
578 unsigned gui_synclist_do_touchscreen(struct gui_synclist * gui_list);
579 #endif
581 bool gui_synclist_do_button(struct gui_synclist * lists,
582 int *actionptr, enum list_wrap wrap)
584 int action = *actionptr;
585 #ifdef HAVE_LCD_BITMAP
586 static bool scrolling_left = false;
587 #endif
589 #ifdef HAVE_WHEEL_ACCELERATION
590 int next_item_modifier = button_apply_acceleration(get_action_data());
591 #else
592 static int next_item_modifier = 1;
593 static int last_accel_tick = 0;
595 if (global_settings.list_accel_start_delay)
597 int start_delay = global_settings.list_accel_start_delay * (HZ/2);
598 int accel_wait = global_settings.list_accel_wait * HZ/2;
600 if (get_action_statuscode(NULL)&ACTION_REPEAT)
602 if (!last_accel_tick)
603 last_accel_tick = current_tick + start_delay;
604 else if (current_tick >=
605 last_accel_tick + accel_wait)
607 last_accel_tick = current_tick;
608 next_item_modifier++;
611 else if (last_accel_tick)
613 next_item_modifier = 1;
614 last_accel_tick = 0;
617 #endif
619 #if defined(HAVE_TOUCHSCREEN)
620 if (action == ACTION_TOUCHSCREEN)
621 action = *actionptr = gui_synclist_do_touchscreen(lists);
622 #endif
624 switch (wrap)
626 case LIST_WRAP_ON:
627 gui_synclist_limit_scroll(lists, false);
628 break;
629 case LIST_WRAP_OFF:
630 gui_synclist_limit_scroll(lists, true);
631 break;
632 case LIST_WRAP_UNLESS_HELD:
633 if (action == ACTION_STD_PREVREPEAT ||
634 action == ACTION_STD_NEXTREPEAT ||
635 action == ACTION_LISTTREE_PGUP ||
636 action == ACTION_LISTTREE_PGDOWN)
637 gui_synclist_limit_scroll(lists, true);
638 else gui_synclist_limit_scroll(lists, false);
639 break;
642 switch (action)
644 case ACTION_REDRAW:
645 gui_synclist_draw(lists);
646 return true;
648 #ifdef HAVE_VOLUME_IN_LIST
649 case ACTION_LIST_VOLUP:
650 global_settings.volume += 2;
651 /* up two because the falthrough brings it down one */
652 case ACTION_LIST_VOLDOWN:
653 global_settings.volume--;
654 setvol();
655 return true;
656 #endif
657 case ACTION_STD_PREV:
658 case ACTION_STD_PREVREPEAT:
659 gui_list_select_at_offset(lists, -next_item_modifier);
660 #ifndef HAVE_WHEEL_ACCELERATION
661 if (button_queue_count() < FRAMEDROP_TRIGGER)
662 #endif
663 gui_synclist_draw(lists);
664 _gui_synclist_speak_item(lists,
665 action == ACTION_STD_PREVREPEAT
666 || next_item_modifier >1);
667 yield();
668 *actionptr = ACTION_STD_PREV;
669 return true;
671 case ACTION_STD_NEXT:
672 case ACTION_STD_NEXTREPEAT:
673 gui_list_select_at_offset(lists, next_item_modifier);
674 #ifndef HAVE_WHEEL_ACCELERATION
675 if (button_queue_count() < FRAMEDROP_TRIGGER)
676 #endif
677 gui_synclist_draw(lists);
678 _gui_synclist_speak_item(lists,
679 action == ACTION_STD_NEXTREPEAT
680 || next_item_modifier >1);
681 yield();
682 *actionptr = ACTION_STD_NEXT;
683 return true;
685 #ifdef HAVE_LCD_BITMAP
686 case ACTION_TREE_PGRIGHT:
687 gui_synclist_scroll_right(lists);
688 gui_synclist_draw(lists);
689 return true;
690 case ACTION_TREE_ROOT_INIT:
691 /* After this button press ACTION_TREE_PGLEFT is allowed
692 to skip to root. ACTION_TREE_ROOT_INIT must be defined in the
693 keymaps as a repeated button press (the same as the repeated
694 ACTION_TREE_PGLEFT) with the pre condition being the non-repeated
695 button press */
696 if (lists->offset_position[0] == 0)
698 scrolling_left = false;
699 *actionptr = ACTION_STD_CANCEL;
700 return true;
702 *actionptr = ACTION_TREE_PGLEFT;
703 case ACTION_TREE_PGLEFT:
704 if(!scrolling_left && (lists->offset_position[0] == 0))
706 *actionptr = ACTION_STD_CANCEL;
707 return false;
709 gui_synclist_scroll_left(lists);
710 gui_synclist_draw(lists);
711 scrolling_left = true; /* stop ACTION_TREE_PAGE_LEFT
712 skipping to root */
713 return true;
714 #endif
715 /* for pgup / pgdown, we are obliged to have a different behaviour depending
716 * on the screen for which the user pressed the key since for example, remote
717 * and main screen doesn't have the same number of lines */
718 case ACTION_LISTTREE_PGUP:
720 int screen =
721 #ifdef HAVE_REMOTE_LCD
722 get_action_statuscode(NULL)&ACTION_REMOTE ?
723 SCREEN_REMOTE :
724 #endif
725 SCREEN_MAIN;
726 gui_synclist_select_previous_page(lists, screen);
727 gui_synclist_draw(lists);
728 _gui_synclist_speak_item(lists, false);
729 yield();
730 *actionptr = ACTION_STD_NEXT;
732 return true;
734 case ACTION_LISTTREE_PGDOWN:
736 int screen =
737 #ifdef HAVE_REMOTE_LCD
738 get_action_statuscode(NULL)&ACTION_REMOTE ?
739 SCREEN_REMOTE :
740 #endif
741 SCREEN_MAIN;
742 gui_synclist_select_next_page(lists, screen);
743 gui_synclist_draw(lists);
744 _gui_synclist_speak_item(lists, false);
745 yield();
746 *actionptr = ACTION_STD_PREV;
748 return true;
750 if(lists->scheduled_talk_tick
751 && TIME_AFTER(current_tick, lists->scheduled_talk_tick))
752 /* scheduled postponed item announcement is due */
753 _gui_synclist_speak_item(lists, false);
754 return false;
757 int list_do_action_timeout(struct gui_synclist *lists, int timeout)
758 /* Returns the lowest of timeout or the delay until a postponed
759 scheduled announcement is due (if any). */
761 if(lists->scheduled_talk_tick)
763 long delay = lists->scheduled_talk_tick -current_tick +1;
764 /* +1 because the trigger condition uses TIME_AFTER(), which
765 is implemented as strictly greater than. */
766 if(delay < 0)
767 delay = 0;
768 if(timeout > delay || timeout == TIMEOUT_BLOCK)
769 timeout = delay;
771 return timeout;
774 bool list_do_action(int context, int timeout,
775 struct gui_synclist *lists, int *action,
776 enum list_wrap wrap)
777 /* Combines the get_action() (with possibly overridden timeout) and
778 gui_synclist_do_button() calls. Returns the list action from
779 do_button, and places the action from get_action in *action. */
781 timeout = list_do_action_timeout(lists, timeout);
782 *action = get_action(context, timeout);
783 return gui_synclist_do_button(lists, action, wrap);
786 bool gui_synclist_item_is_onscreen(struct gui_synclist *lists,
787 enum screen_type screen, int item)
789 struct viewport vp = *lists->parent[screen];
790 #ifdef HAVE_LCD_BITMAP
791 if (list_display_title(lists, screen))
792 vp.height -= font_get(lists->parent[screen]->font)->height;
793 #endif
794 return item <= (lists->start_item[screen] + viewport_get_nb_lines(&vp));
797 /* Simple use list implementation */
798 static int simplelist_line_count = 0;
799 static char simplelist_text[SIMPLELIST_MAX_LINES][SIMPLELIST_MAX_LINELENGTH];
800 /* set the amount of lines shown in the list */
801 void simplelist_set_line_count(int lines)
803 if (lines < 0)
804 simplelist_line_count = 0;
805 else if (lines >= SIMPLELIST_MAX_LINES)
806 simplelist_line_count = SIMPLELIST_MAX_LINES;
807 else
808 simplelist_line_count = lines;
810 /* get the current amount of lines shown */
811 int simplelist_get_line_count(void)
813 return simplelist_line_count;
815 /* add/edit a line in the list.
816 if line_number > number of lines shown it adds the line, else it edits the line */
817 void simplelist_addline(int line_number, const char *fmt, ...)
819 va_list ap;
821 if (line_number > simplelist_line_count)
823 if (simplelist_line_count < SIMPLELIST_MAX_LINES)
824 line_number = simplelist_line_count++;
825 else
826 return;
828 va_start(ap, fmt);
829 vsnprintf(simplelist_text[line_number], SIMPLELIST_MAX_LINELENGTH, fmt, ap);
830 va_end(ap);
833 static char* simplelist_static_getname(int item,
834 void * data,
835 char *buffer,
836 size_t buffer_len)
838 (void)data; (void)buffer; (void)buffer_len;
839 return simplelist_text[item];
842 bool simplelist_show_list(struct simplelist_info *info)
844 struct gui_synclist lists;
845 int action, old_line_count = simplelist_line_count;
846 int oldbars = viewportmanager_set_statusbar(VP_SB_ALLSCREENS);
847 char* (*getname)(int item, void * data, char *buffer, size_t buffer_len);
848 int wrap = LIST_WRAP_UNLESS_HELD;
849 if (info->get_name)
850 getname = info->get_name;
851 else
852 getname = simplelist_static_getname;
853 gui_synclist_init(&lists, getname, info->callback_data,
854 info->scroll_all, info->selection_size, NULL);
856 if (info->title)
857 gui_synclist_set_title(&lists, info->title, NOICON);
858 if (info->get_icon)
859 gui_synclist_set_icon_callback(&lists, info->get_icon);
860 if (info->get_talk)
861 gui_synclist_set_voice_callback(&lists, info->get_talk);
863 if (info->hide_selection)
865 gui_synclist_hide_selection_marker(&lists, true);
866 wrap = LIST_WRAP_OFF;
869 if (info->action_callback)
870 info->action_callback(ACTION_REDRAW, &lists);
872 if (info->get_name == NULL)
873 gui_synclist_set_nb_items(&lists, simplelist_line_count*info->selection_size);
874 else
875 gui_synclist_set_nb_items(&lists, info->count*info->selection_size);
877 gui_synclist_select_item(&lists, info->selection);
879 gui_synclist_draw(&lists);
880 gui_synclist_speak_item(&lists);
882 while(1)
884 list_do_action(CONTEXT_STD, info->timeout,
885 &lists, &action, wrap);
887 /* We must yield in this case or no other thread can run */
888 if (info->timeout == TIMEOUT_NOBLOCK)
889 yield();
891 if (info->action_callback)
893 bool stdok = action==ACTION_STD_OK;
894 action = info->action_callback(action, &lists);
895 if (stdok && action == ACTION_STD_CANCEL)
897 /* callback asked us to exit */
898 info->selection = gui_synclist_get_sel_pos(&lists);
899 break;
902 if (info->get_name == NULL)
903 gui_synclist_set_nb_items(&lists,
904 simplelist_line_count*info->selection_size);
906 if (action == ACTION_STD_CANCEL)
908 info->selection = -1;
909 break;
911 else if ((action == ACTION_REDRAW) ||
912 (old_line_count != simplelist_line_count))
914 if (info->get_name == NULL)
916 gui_synclist_set_nb_items(&lists,
917 simplelist_line_count*info->selection_size);
919 gui_synclist_draw(&lists);
920 old_line_count = simplelist_line_count;
922 else if(default_event_handler(action) == SYS_USB_CONNECTED)
923 return true;
925 talk_shutup();
926 viewportmanager_set_statusbar(oldbars);
927 return false;
930 void simplelist_info_init(struct simplelist_info *info, char* title,
931 int count, void* data)
933 info->title = title;
934 info->count = count;
935 info->selection_size = 1;
936 info->hide_selection = false;
937 info->scroll_all = false;
938 info->timeout = HZ/10;
939 info->selection = 0;
940 info->action_callback = NULL;
941 info->get_icon = NULL;
942 info->get_name = NULL;
943 info->get_talk = NULL;
944 info->callback_data = data;