Nyaaori/rockbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
rockbox/apps/gui/list.c
Christian Soffke fbf83dc4ce Add setting for disabling wrap-around lists 
Allows user to decide whether scrolling lists will wrap around
to the opposite end after the first or last item has been reached.

Change-Id: I22156812cf4c857ddc4b6c48c1cef013b1985260
2021-11-11 17:31:10 -05:00

1045 lines
33 KiB
C
Raw Blame History

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2005 by Kevin Ferrare
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
****************************************************************************/
#include <stdarg.h>
#include <stdio.h>
#include "config.h"
#include "lcd.h"
#include "font.h"
#include "button.h"
#include "string.h"
#include "settings.h"
#include "kernel.h"
#include "system.h"
#include "action.h"
#include "screen_access.h"
#include "list.h"
#include "scrollbar.h"
#include "lang.h"
#include "sound.h"
#include "misc.h"
#include "talk.h"
#include "viewport.h"
#include "appevents.h"
#include "statusbar-skinned.h"
/* The minimum number of pending button events in queue before starting
* to limit list drawing interval.
*/
#define FRAMEDROP_TRIGGER 6
static int offset_step = 16; /* pixels per screen scroll step */
/* should lines scroll out of the screen */
static bool offset_out_of_view = false;
static void gui_list_select_at_offset(struct gui_synclist * gui_list,
int offset);
void list_draw(struct screen *display, struct gui_synclist *list);
static long last_dirty_tick;
static struct viewport parent[NB_SCREENS];
static bool list_is_dirty(struct gui_synclist *list)
{
return TIME_BEFORE(list->dirty_tick, last_dirty_tick);
}
static void list_force_reinit(unsigned short id, void *param, void *last_dirty_tick)
{
(void)id;
(void)param;
*(int *)last_dirty_tick = current_tick;
}
void list_init(void)
{
last_dirty_tick = current_tick;
add_event_ex(GUI_EVENT_THEME_CHANGED, false, list_force_reinit, &last_dirty_tick);
}
static void list_init_viewports(struct gui_synclist *list)
{
bool parent_used = (*list->parent == &parent[SCREEN_MAIN]);
if (parent_used)
{
FOR_NB_SCREENS(i)
{
gui_synclist_set_viewport_defaults(list->parent[i], i);
}
}
list->dirty_tick = current_tick;
}
static int list_nb_lines(struct gui_synclist *list, enum screen_type screen)
{
struct viewport *vp = list->parent[screen];
return vp->height / list->line_height[screen];
}
bool list_display_title(struct gui_synclist *list, enum screen_type screen)
{
return list->title != NULL &&
!sb_set_title_text(list->title, list->title_icon, screen) &&
list_nb_lines(list, screen) > 2;
}
int list_get_nb_lines(struct gui_synclist *list, enum screen_type screen)
{
int lines = skinlist_get_line_count(screen, list);
if (lines < 0)
{
lines = list_nb_lines(list, screen);
if (list_display_title(list, screen))
lines -= 1;
}
return lines;
}
void list_init_item_height(struct gui_synclist *list, enum screen_type screen)
{
struct viewport *vp = list->parent[screen];
#ifdef HAVE_TOUCHSCREEN
/* the 4/12 factor is designed for reasonable item size on a 160dpi screen */
if (global_settings.list_line_padding == -1)
list->line_height[screen] = MAX(lcd_get_dpi()*4/12, (int)font_get(vp->font)->height);
else
list->line_height[screen] = font_get(vp->font)->height + global_settings.list_line_padding;
#else
list->line_height[screen] = font_get(vp->font)->height;
#endif
}
/*
* Initializes a scrolling list
* - gui_list : the list structure to initialize
* - callback_get_item_name : pointer to a function that associates a label
* to a given item number
* - data : extra data passed to the list callback
* - scroll_all :
* - selected_size :
* - parent : the parent viewports to use. NULL means the full screen minus
* statusbar if enabled. NOTE: new screens should NOT set this to NULL.
*/
void gui_synclist_init(struct gui_synclist * gui_list,
list_get_name callback_get_item_name,
void * data,
bool scroll_all,
int selected_size, struct viewport list_parent[NB_SCREENS]
)
{
gui_list->callback_get_item_icon = NULL;
gui_list->callback_get_item_name = callback_get_item_name;
gui_list->callback_speak_item = NULL;
gui_list->nb_items = 0;
gui_list->selected_item = 0;
#ifdef HAVE_TOUCHSCREEN
gui_list->y_pos = 0;
#endif
FOR_NB_SCREENS(i)
{
gui_list->start_item[i] = 0;
gui_list->offset_position[i] = 0;
if (list_parent)
gui_list->parent[i] = &list_parent[i];
else
gui_list->parent[i] = &parent[i];
}
list_init_viewports(gui_list);
FOR_NB_SCREENS(i)
list_init_item_height(gui_list, i);
gui_list->limit_scroll = false;
gui_list->data = data;
gui_list->scroll_all = scroll_all;
gui_list->selected_size = selected_size;
gui_list->title = NULL;
gui_list->title_icon = Icon_NOICON;
gui_list->scheduled_talk_tick = gui_list->last_talked_tick = 0;
gui_list->dirty_tick = current_tick;
gui_list->show_selection_marker = true;
#ifdef HAVE_LCD_COLOR
gui_list->title_color = -1;
gui_list->callback_get_item_color = NULL;
gui_list->selection_color = NULL;
#endif
}
/* this toggles the selection bar or cursor */
void gui_synclist_hide_selection_marker(struct gui_synclist * lists, bool hide)
{
lists->show_selection_marker = !hide;
}
int gui_list_get_item_offset(struct gui_synclist * gui_list,
int item_width,
int text_pos,
struct screen * display,
struct viewport *vp)
{
int item_offset;
if (offset_out_of_view)
{
item_offset = gui_list->offset_position[display->screen_type];
}
else
{
/* if text is smaller than view */
if (item_width <= vp->width - text_pos)
{
item_offset = 0;
}
/* if text got out of view */
else if (gui_list->offset_position[display->screen_type] >
item_width - (vp->width - text_pos))
{
item_offset = item_width - (vp->width - text_pos);
}
else
item_offset = gui_list->offset_position[display->screen_type];
}
return item_offset;
}
/*
* Force a full screen update.
*/
void gui_synclist_draw(struct gui_synclist *gui_list)
{
if (list_is_dirty(gui_list))
{
list_init_viewports(gui_list);
FOR_NB_SCREENS(i)
list_init_item_height(gui_list, i);
gui_synclist_select_item(gui_list, gui_list->selected_item);
}
FOR_NB_SCREENS(i)
{
if (!skinlist_draw(&screens[i], gui_list))
list_draw(&screens[i], gui_list);
}
}
/* sets up the list so the selection is shown correctly on the screen */
static void gui_list_put_selection_on_screen(struct gui_synclist * gui_list,
enum screen_type screen)
{
int nb_lines = list_get_nb_lines(gui_list, screen);
int bottom = MAX(0, gui_list->nb_items - nb_lines);
int new_start_item = gui_list->start_item[screen];
int difference = gui_list->selected_item - gui_list->start_item[screen];
const int scroll_limit_up = (nb_lines < gui_list->selected_size+2 ? 0:1);
const int scroll_limit_down = (scroll_limit_up+gui_list->selected_size);
if (gui_list->show_selection_marker == false)
{
new_start_item = gui_list->selected_item;
}
else if (gui_list->selected_size >= nb_lines)
{
new_start_item = gui_list->selected_item;
}
else if (global_settings.scroll_paginated)
{
nb_lines -= nb_lines%gui_list->selected_size;
if (difference < 0 || difference >= nb_lines)
{
new_start_item = gui_list->selected_item -
(gui_list->selected_item%nb_lines);
}
}
else if (difference <= scroll_limit_up) /* list moved up */
{
new_start_item = gui_list->selected_item - scroll_limit_up;
}
else if (difference > nb_lines - scroll_limit_down) /* list moved down */
{
new_start_item = gui_list->selected_item + scroll_limit_down - nb_lines;
}
if (new_start_item < 0)
gui_list->start_item[screen] = 0;
else if (new_start_item > bottom)
gui_list->start_item[screen] = bottom;
else
gui_list->start_item[screen] = new_start_item;
#ifdef HAVE_TOUCHSCREEN
gui_list->y_pos = gui_list->start_item[SCREEN_MAIN] * gui_list->line_height[SCREEN_MAIN];
#endif
}
static void edge_beep(struct gui_synclist * gui_list, bool wrap)
{
if (global_settings.keyclick)
{
list_speak_item *cb = gui_list->callback_speak_item;
if (!wrap) /* a bounce */
{
static long last_bounce_tick = 0;
if(TIME_BEFORE(current_tick, last_bounce_tick+HZ/4))
return;
last_bounce_tick = current_tick;
}
/* Next thing the list code will do is go speak the item, doing
a talk_shutup() first. Shutup now so the beep is clearer, and
make sure the subsequent shutup is skipped because otherwise
it'd kill the pcm buffer. */
if (cb) {
talk_shutup();
talk_force_enqueue_next();
}
system_sound_play(wrap ? SOUND_LIST_EDGE_BEEP_WRAP : SOUND_LIST_EDGE_BEEP_NOWRAP);
if (cb) {
/* On at least x5: if, instead of the above shutup, I insert a
sleep just after the beep_play() call, to delay the subsequent
shutup and talk, then in some cases the beep is not played: if
the end of a previous utterance is still playing from the pcm buf,
the beep fails, even if there would seem to remain enough time
to the utterance to mix in the beep. */
/* Somehow, the following voice utterance is suppressed on e200,
but not on x5. Work around... */
sleep((40*HZ +999)/1000); // FIXME: Is this really needed?
talk_force_shutup();
}
}
}
static void _gui_synclist_speak_item(struct gui_synclist *lists)
{
list_speak_item *cb = lists->callback_speak_item;
if (cb && lists->nb_items != 0)
{
talk_shutup();
/* If we have just very recently started talking, then we want
to stay silent for a while until things settle. Likewise if
we already had a pending scheduled announcement not yet due
we need to reschedule it. */
if ((lists->scheduled_talk_tick &&
TIME_BEFORE(current_tick, lists->scheduled_talk_tick)) ||
(lists->last_talked_tick &&
TIME_BEFORE(current_tick, lists->last_talked_tick + HZ/5)))
{
lists->scheduled_talk_tick = current_tick + HZ/5;
}
else
{
lists->scheduled_talk_tick = 0; /* work done */
cb(lists->selected_item, lists->data);
lists->last_talked_tick = current_tick;
}
}
}
void gui_synclist_speak_item(struct gui_synclist *lists)
{
if (global_settings.talk_menu)
{
if (lists->nb_items == 0)
talk_id(VOICE_EMPTY_LIST, true);
else
_gui_synclist_speak_item(lists);
}
}
/*
* Selects an item in the list
* - gui_list : the list structure
* - item_number : the number of the item which will be selected
*/
void gui_synclist_select_item(struct gui_synclist * gui_list, int item_number)
{
if (item_number >= gui_list->nb_items || item_number < 0)
return;
if (item_number != gui_list->selected_item)
{
gui_list->selected_item = item_number;
_gui_synclist_speak_item(gui_list);
}
FOR_NB_SCREENS(i)
gui_list_put_selection_on_screen(gui_list, i);
}
static void gui_list_select_at_offset(struct gui_synclist * gui_list,
int offset)
{
int new_selection;
if (gui_list->selected_size > 1)
{
offset *= gui_list->selected_size;
}
new_selection = gui_list->selected_item + offset;
if (new_selection >= gui_list->nb_items)
{
new_selection = gui_list->limit_scroll ?
gui_list->nb_items - gui_list->selected_size : 0;
edge_beep(gui_list, !gui_list->limit_scroll);
}
else if (new_selection < 0)
{
new_selection = gui_list->limit_scroll ?
0 : gui_list->nb_items - gui_list->selected_size;
edge_beep(gui_list, !gui_list->limit_scroll);
}
else if (gui_list->show_selection_marker == false)
{
FOR_NB_SCREENS(i)
{
int nb_lines = list_get_nb_lines(gui_list, i);
if (offset > 0)
{
int screen_top = MAX(0, gui_list->nb_items - nb_lines);
gui_list->start_item[i] = MIN(screen_top, gui_list->start_item[i] +
gui_list->selected_size);
gui_list->selected_item = gui_list->start_item[i];
}
else
{
gui_list->start_item[i] = MAX(0, gui_list->start_item[i] -
gui_list->selected_size);
gui_list->selected_item = gui_list->start_item[i] + nb_lines;
}
#ifdef HAVE_TOUCHSCREEN
gui_list->y_pos = gui_list->start_item[SCREEN_MAIN] * gui_list->line_height[SCREEN_MAIN];
#endif
}
return;
}
gui_synclist_select_item(gui_list, new_selection);
}
/*
* Adds an item to the list (the callback will be asked for one more item)
* - gui_list : the list structure
*/
void gui_synclist_add_item(struct gui_synclist * gui_list)
{
gui_list->nb_items++;
/* if only one item in the list, select it */
if (gui_list->nb_items == 1)
gui_list->selected_item = 0;
}
/*
* Removes an item to the list (the callback will be asked for one less item)
* - gui_list : the list structure
*/
void gui_synclist_del_item(struct gui_synclist * gui_list)
{
if (gui_list->nb_items > 0)
{
if (gui_list->selected_item == gui_list->nb_items-1)
gui_list->selected_item--;
gui_list->nb_items--;
gui_synclist_select_item(gui_list, gui_list->selected_item);
}
}
void gui_list_screen_scroll_step(int ofs)
{
offset_step = ofs;
}
void gui_list_screen_scroll_out_of_view(bool enable)
{
offset_out_of_view = enable;
}
/*
* Set the title and title icon of the list. Setting title to NULL disables
* both the title and icon. Use NOICON if there is no icon.
*/
void gui_synclist_set_title(struct gui_synclist * gui_list,
char * title, enum themable_icons icon)
{
gui_list->title = title;
gui_list->title_icon = icon;
FOR_NB_SCREENS(i)
sb_set_title_text(title, icon, i);
send_event(GUI_EVENT_ACTIONUPDATE, (void*)1);
}
void gui_synclist_set_nb_items(struct gui_synclist * lists, int nb_items)
{
lists->nb_items = nb_items;
FOR_NB_SCREENS(i)
{
lists->offset_position[i] = 0;
}
}
int gui_synclist_get_nb_items(struct gui_synclist * lists)
{
return lists->nb_items;
}
int gui_synclist_get_sel_pos(struct gui_synclist * lists)
{
return lists->selected_item;
}
void gui_synclist_set_icon_callback(struct gui_synclist * lists,
list_get_icon icon_callback)
{
lists->callback_get_item_icon = icon_callback;
}
void gui_synclist_set_voice_callback(struct gui_synclist * lists,
list_speak_item voice_callback)
{
lists->callback_speak_item = voice_callback;
}
void gui_synclist_set_viewport_defaults(struct viewport *vp,
enum screen_type screen)
{
viewport_set_defaults(vp, screen);
}
#ifdef HAVE_LCD_COLOR
void gui_synclist_set_color_callback(struct gui_synclist * lists,
list_get_color color_callback)
{
lists->callback_get_item_color = color_callback;
}
void gui_synclist_set_sel_color(struct gui_synclist * lists,
struct list_selection_color *list_sel_color)
{
lists->selection_color = list_sel_color;
if(list_sel_color)
{
FOR_NB_SCREENS(i) /* might need to be only SCREEN_MAIN */
{
lists->parent[i]->fg_pattern = list_sel_color->fg_color;
lists->parent[i]->bg_pattern = list_sel_color->bg_color;
}
}
else
list_init_viewports(lists);
}
#endif
static void gui_synclist_select_next_page(struct gui_synclist * lists,
enum screen_type screen)
{
int nb_lines = list_get_nb_lines(lists, screen);
if (lists->selected_size > 1)
nb_lines = MAX(1, nb_lines/lists->selected_size);
gui_list_select_at_offset(lists, nb_lines);
}
static void gui_synclist_select_previous_page(struct gui_synclist * lists,
enum screen_type screen)
{
int nb_lines = list_get_nb_lines(lists, screen);
if (lists->selected_size > 1)
nb_lines = MAX(1, nb_lines/lists->selected_size);
gui_list_select_at_offset(lists, -nb_lines);
}
void gui_synclist_limit_scroll(struct gui_synclist * lists, bool scroll)
{
lists->limit_scroll = scroll;
}
/*
* Makes all the item in the list scroll by one step to the right.
* Should stop increasing the value when reaching the widest item value
* in the list.
*/
static void gui_synclist_scroll_right(struct gui_synclist * lists)
{
FOR_NB_SCREENS(i)
{
/* FIXME: This is a fake right boundry limiter. there should be some
* callback function to find the longest item on the list in pixels,
* to stop the list from scrolling past that point */
lists->offset_position[i] += offset_step;
if (lists->offset_position[i] > 1000)
lists->offset_position[i] = 1000;
}
}
/*
* Makes all the item in the list scroll by one step to the left.
* stops at starting position.
*/
static void gui_synclist_scroll_left(struct gui_synclist * lists)
{
FOR_NB_SCREENS(i)
{
lists->offset_position[i] -= offset_step;
if (lists->offset_position[i] < 0)
lists->offset_position[i] = 0;
}
}
bool gui_synclist_keyclick_callback(int action, void* data)
{
struct gui_synclist *lists = (struct gui_synclist *)data;
/* block the beep if we are at the end of the list and we are not wrapping.
* CAVEAT: mosts lists don't set limit_scroll untill it sees a repeat
* press at the end of the list so this can cause an extra beep.
*/
if (lists->limit_scroll == false)
return true;
if (lists->selected_item == 0)
return (action != ACTION_STD_PREV && action != ACTION_STD_PREVREPEAT);
if (lists->selected_item == lists->nb_items - lists->selected_size)
return (action != ACTION_STD_NEXT && action != ACTION_STD_NEXTREPEAT);
return action != ACTION_NONE;
}
/*
* Magic to make sure the list gets updated correctly if the skin does
* something naughty like a full screen update when we are in a button
* loop.
*
* The GUI_EVENT_NEED_UI_UPDATE event is registered for in list_do_action_timeout()
* and unregistered in gui_synclict_do_button(). This is done because
* if something is using the list UI they *must* be calling those
* two functions in the correct order or the list wont work.
*/
static struct gui_synclist *current_lists;
static bool ui_update_event_registered = false;
static void _lists_uiviewport_update_callback(unsigned short id, void *data)
{
(void)id;
(void)data;
if (current_lists)
gui_synclist_draw(current_lists);
}
bool gui_synclist_do_button(struct gui_synclist * lists,
int *actionptr, enum list_wrap wrap)
{
int action = *actionptr;
static bool pgleft_allow_cancel = false;
#ifdef HAVE_WHEEL_ACCELERATION
int next_item_modifier = button_apply_acceleration(get_action_data());
#else
static int next_item_modifier = 1;
static int last_accel_tick = 0;
if (action != ACTION_TOUCHSCREEN)
{
if (global_settings.list_accel_start_delay)
{
int start_delay = global_settings.list_accel_start_delay * HZ;
int accel_wait = global_settings.list_accel_wait * HZ;
if (get_action_statuscode(NULL)&ACTION_REPEAT)
{
if (!last_accel_tick)
last_accel_tick = current_tick + start_delay;
else if (TIME_AFTER(current_tick, last_accel_tick + accel_wait))
{
last_accel_tick = current_tick;
next_item_modifier++;
}
}
else if (last_accel_tick)
{
next_item_modifier = 1;
last_accel_tick = 0;
}
}
}
#endif
#if defined(HAVE_TOUCHSCREEN)
if (action == ACTION_TOUCHSCREEN)
action = *actionptr = gui_synclist_do_touchscreen(lists);
else if (action > ACTION_TOUCHSCREEN_MODE)
/* cancel kinetic if we got a normal button event */
_gui_synclist_stop_kinetic_scrolling(lists);
#endif
/* Disable the skin redraw callback */
current_lists = NULL;
switch (wrap)
{
case LIST_WRAP_ON:
gui_synclist_limit_scroll(lists, !global_settings.list_wraparound);
break;
case LIST_WRAP_OFF:
gui_synclist_limit_scroll(lists, true);
break;
case LIST_WRAP_UNLESS_HELD:
if (action == ACTION_STD_PREVREPEAT ||
action == ACTION_STD_NEXTREPEAT ||
action == ACTION_LISTTREE_PGUP ||
action == ACTION_LISTTREE_PGDOWN)
gui_synclist_limit_scroll(lists, true);
else gui_synclist_limit_scroll(lists, !global_settings.list_wraparound);
break;
};
switch (action)
{
case ACTION_REDRAW:
gui_synclist_draw(lists);
return true;
#ifdef HAVE_VOLUME_IN_LIST
case ACTION_LIST_VOLUP:
global_settings.volume += sound_steps(SOUND_VOLUME);
setvol();
return true;
case ACTION_LIST_VOLDOWN:
global_settings.volume -= sound_steps(SOUND_VOLUME);
setvol();
return true;
#endif
case ACTION_STD_PREV:
case ACTION_STD_PREVREPEAT:
gui_list_select_at_offset(lists, -next_item_modifier);
#ifndef HAVE_WHEEL_ACCELERATION
if (button_queue_count() < FRAMEDROP_TRIGGER)
#endif
gui_synclist_draw(lists);
yield();
*actionptr = ACTION_STD_PREV;
return true;
case ACTION_STD_NEXT:
case ACTION_STD_NEXTREPEAT:
gui_list_select_at_offset(lists, next_item_modifier);
#ifndef HAVE_WHEEL_ACCELERATION
if (button_queue_count() < FRAMEDROP_TRIGGER)
#endif
gui_synclist_draw(lists);
yield();
*actionptr = ACTION_STD_NEXT;
return true;
case ACTION_TREE_PGRIGHT:
gui_synclist_scroll_right(lists);
gui_synclist_draw(lists);
return true;
case ACTION_TREE_ROOT_INIT:
/* After this button press ACTION_TREE_PGLEFT is allowed
to skip to root. ACTION_TREE_ROOT_INIT must be defined in the
keymaps as a repeated button press (the same as the repeated
ACTION_TREE_PGLEFT) with the pre condition being the non-repeated
button press. Leave out ACTION_TREE_ROOT_INIT in your keymaps to
disable cancel action by PGLEFT key (e.g. if PGLEFT and CANCEL
are mapped to different keys) */
if (lists->offset_position[0] == 0)
{
pgleft_allow_cancel = true;
*actionptr = ACTION_STD_MENU;
return true;
}
*actionptr = ACTION_TREE_PGLEFT;
/* fallthrough */
case ACTION_TREE_PGLEFT:
if(pgleft_allow_cancel && (lists->offset_position[0] == 0))
{
*actionptr = ACTION_STD_CANCEL;
return false;
}
gui_synclist_scroll_left(lists);
gui_synclist_draw(lists);
pgleft_allow_cancel = false; /* stop ACTION_TREE_PAGE_LEFT
skipping to root */
return true;
/* for pgup / pgdown, we are obliged to have a different behaviour depending
* on the screen for which the user pressed the key since for example, remote
* and main screen doesn't have the same number of lines */
case ACTION_LISTTREE_PGUP:
{
int screen =
#ifdef HAVE_REMOTE_LCD
get_action_statuscode(NULL)&ACTION_REMOTE ?
SCREEN_REMOTE :
#endif
SCREEN_MAIN;
gui_synclist_select_previous_page(lists, screen);
gui_synclist_draw(lists);
yield();
*actionptr = ACTION_STD_NEXT;
}
return true;
case ACTION_LISTTREE_PGDOWN:
{
int screen =
#ifdef HAVE_REMOTE_LCD
get_action_statuscode(NULL)&ACTION_REMOTE ?
SCREEN_REMOTE :
#endif
SCREEN_MAIN;
gui_synclist_select_next_page(lists, screen);
gui_synclist_draw(lists);
yield();
*actionptr = ACTION_STD_PREV;
}
return true;
}
if(lists->scheduled_talk_tick
&& TIME_AFTER(current_tick, lists->scheduled_talk_tick))
/* scheduled postponed item announcement is due */
_gui_synclist_speak_item(lists);
return false;
}
int list_do_action_timeout(struct gui_synclist *lists, int timeout)
/* Returns the lowest of timeout or the delay until a postponed
scheduled announcement is due (if any). */
{
if (lists != current_lists)
{
if (!ui_update_event_registered)
ui_update_event_registered =
add_event(GUI_EVENT_NEED_UI_UPDATE, _lists_uiviewport_update_callback);
current_lists = lists;
}
if(lists->scheduled_talk_tick)
{
long delay = lists->scheduled_talk_tick -current_tick +1;
/* +1 because the trigger condition uses TIME_AFTER(), which
is implemented as strictly greater than. */
if(delay < 0)
delay = 0;
if(timeout > delay || timeout == TIMEOUT_BLOCK)
timeout = delay;
}
return timeout;
}
bool list_do_action(int context, int timeout,
struct gui_synclist *lists, int *action,
enum list_wrap wrap)
/* Combines the get_action() (with possibly overridden timeout) and
gui_synclist_do_button() calls. Returns the list action from
do_button, and places the action from get_action in *action. */
{
timeout = list_do_action_timeout(lists, timeout);
keyclick_set_callback(gui_synclist_keyclick_callback, lists);
*action = get_action(context, timeout);
return gui_synclist_do_button(lists, action, wrap);
}
bool gui_synclist_item_is_onscreen(struct gui_synclist *lists,
enum screen_type screen, int item)
{
int nb_lines = list_get_nb_lines(lists, screen);
return (unsigned)(item - lists->start_item[screen]) < (unsigned) nb_lines;
}
/* Simple use list implementation */
static int simplelist_line_count = 0, simplelist_line_remaining;
static int simplelist_line_pos;
static char simplelist_buffer[SIMPLELIST_MAX_LINES * SIMPLELIST_MAX_LINELENGTH];
static char *simplelist_text[SIMPLELIST_MAX_LINES];
/* set the amount of lines shown in the list */
void simplelist_set_line_count(int lines)
{
if (lines <= 0) {
simplelist_line_pos = 0;
simplelist_line_remaining = sizeof(simplelist_buffer);
simplelist_line_count = 0;
}
else if (lines < simplelist_line_count) {
char *end = simplelist_text[lines];
simplelist_line_pos = end - simplelist_buffer;
simplelist_line_remaining = sizeof(simplelist_buffer) - simplelist_line_pos;
simplelist_line_count = lines;
}
}
/* get the current amount of lines shown */
int simplelist_get_line_count(void)
{
return simplelist_line_count;
}
/* add/edit a line in the list.
if line_number > number of lines shown it adds the line,
else it edits the line */
void simplelist_addline(const char *fmt, ...)
{
va_list ap;
size_t len = simplelist_line_remaining;
int line_number = simplelist_line_count++;
simplelist_text[line_number] = &simplelist_buffer[simplelist_line_pos];
va_start(ap, fmt);
len = vsnprintf(simplelist_text[line_number], simplelist_line_remaining, fmt, ap);
va_end(ap);
len++;
simplelist_line_remaining -= len;
simplelist_line_pos += len;
}
static const char* simplelist_static_getname(int item,
void * data,
char *buffer,
size_t buffer_len)
{
(void)data; (void)buffer; (void)buffer_len;
return simplelist_text[item];
}
bool simplelist_show_list(struct simplelist_info *info)
{
struct gui_synclist lists;
int action, old_line_count = simplelist_line_count;
list_get_name *getname;
int wrap = global_settings.list_wraparound ? LIST_WRAP_UNLESS_HELD : LIST_WRAP_OFF;
if (info->get_name)
getname = info->get_name;
else
getname = simplelist_static_getname;
FOR_NB_SCREENS(i)
viewportmanager_theme_enable(i, !info->hide_theme, NULL);
gui_synclist_init(&lists, getname, info->callback_data,
info->scroll_all, info->selection_size, NULL);
if (info->title)
gui_synclist_set_title(&lists, info->title, info->title_icon);
if (info->get_icon)
gui_synclist_set_icon_callback(&lists, info->get_icon);
if (info->get_talk)
gui_synclist_set_voice_callback(&lists, info->get_talk);
#ifdef HAVE_LCD_COLOR
if (info->get_color)
gui_synclist_set_color_callback(&lists, info->get_color);
if (info->selection_color)
gui_synclist_set_sel_color(&lists, info->selection_color);
#endif
if (info->hide_selection)
{
gui_synclist_hide_selection_marker(&lists, true);
wrap = LIST_WRAP_OFF;
}
if (info->action_callback)
info->action_callback(ACTION_REDRAW, &lists);
if (info->get_name == NULL)
gui_synclist_set_nb_items(&lists,
simplelist_line_count*info->selection_size);
else
gui_synclist_set_nb_items(&lists, info->count*info->selection_size);
gui_synclist_select_item(&lists, info->selection);
gui_synclist_draw(&lists);
if (info->speak_onshow)
gui_synclist_speak_item(&lists);
while(1)
{
list_do_action(CONTEXT_LIST, info->timeout,
&lists, &action, wrap);
/* We must yield in this case or no other thread can run */
if (info->timeout == TIMEOUT_NOBLOCK)
yield();
if (info->action_callback)
{
bool stdok = action==ACTION_STD_OK;
action = info->action_callback(action, &lists);
if (stdok && action == ACTION_STD_CANCEL)
{
/* callback asked us to exit */
info->selection = gui_synclist_get_sel_pos(&lists);
break;
}
if (info->get_name == NULL)
gui_synclist_set_nb_items(&lists,
simplelist_line_count*info->selection_size);
}
if (action == ACTION_STD_CANCEL)
{
info->selection = -1;
break;
}
else if (action == ACTION_STD_OK)
{
info->selection = gui_synclist_get_sel_pos(&lists);
break;
}
else if ((action == ACTION_REDRAW) ||
(list_is_dirty(&lists)) ||
(old_line_count != simplelist_line_count))
{
if (info->get_name == NULL)
{
gui_synclist_set_nb_items(&lists,
simplelist_line_count*info->selection_size);
}
gui_synclist_draw(&lists);
old_line_count = simplelist_line_count;
}
else if(default_event_handler(action) == SYS_USB_CONNECTED)
return true;
}
talk_shutup();
#ifdef HAVE_LCD_COLOR
if (info->selection_color)
gui_synclist_set_sel_color(&lists, NULL);
#endif
FOR_NB_SCREENS(i)
viewportmanager_theme_undo(i, false);
return false;
}
void simplelist_info_init(struct simplelist_info *info, char* title,
int count, void* data)
{
info->title = title;
info->count = count;
info->selection_size = 1;
info->hide_selection = false;
info->scroll_all = false;
info->hide_theme = false;
info->speak_onshow = true;
info->timeout = HZ/10;
info->selection = 0;
info->action_callback = NULL;
info->title_icon = Icon_NOICON;
info->get_icon = NULL;
info->get_name = NULL;
info->get_talk = NULL;
#ifdef HAVE_LCD_COLOR
info->get_color = NULL;
info->selection_color = NULL;
#endif
info->callback_data = data;
simplelist_line_count = 0;
}
Reference in a new issue View git blame Copy permalink