rockbox/apps/gui/viewport.c
Jonathan Gordon 0aa035d73e * code police on a macro which has no reason for being
* add the TOKEN_RTC_PRESENT value to the skin debugger listing
* Allow the width and height of a viewport to be negative values (so width -50 means extend to 50pixels inside from the right edge)


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@23393 a1c6a512-1295-4272-9138-f99709370657
2009-10-29 03:27:13 +00:00

497 lines
14 KiB
C

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2008 by Jonathan Gordon
*
* 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 <stdlib.h>
#include "config.h"
#include "lcd.h"
#include "lcd-remote.h"
#include "font.h"
#include "viewport.h"
#include "screen_access.h"
#include "settings.h"
#include "misc.h"
/*some short cuts for fg/bg/line selector handling */
#ifdef HAVE_LCD_COLOR
#define FG_FALLBACK global_settings.fg_color
#define BG_FALLBACK global_settings.bg_color
#else
#define FG_FALLBACK LCD_DEFAULT_FG
#define BG_FALLBACK LCD_DEFAULT_BG
#endif
/* all below isn't needed for pc tools (i.e. checkwps/wps editor)
* only viewport_parse_viewport() is */
#ifndef __PCTOOL__
#include "sprintf.h"
#include "string.h"
#include "kernel.h"
#include "system.h"
#include "statusbar.h"
#include "appevents.h"
#ifdef HAVE_LCD_BITMAP
#include "language.h"
#endif
#include "statusbar-skinned.h"
#include "debug.h"
static int statusbar_enabled = 0;
#ifdef HAVE_LCD_BITMAP
static void set_default_align_flags(struct viewport *vp);
static struct {
struct viewport* vp;
int active[NB_SCREENS];
} ui_vp_info;
static struct viewport custom_vp[NB_SCREENS];
/* callbacks for GUI_EVENT_* events */
static void viewportmanager_ui_vp_changed(void *param);
static void statusbar_toggled(void* param);
static unsigned viewport_init_ui_vp(void);
#endif
static void viewportmanager_redraw(void* data);
int viewport_get_nb_lines(const struct viewport *vp)
{
#ifdef HAVE_LCD_BITMAP
return vp->height/font_get(vp->font)->height;
#else
(void)vp;
return 2;
#endif
}
static bool showing_bars(enum screen_type screen)
{
if (statusbar_enabled & VP_SB_ONSCREEN(screen))
{
#ifdef HAVE_LCD_BITMAP
int ignore;
ignore = statusbar_enabled & VP_SB_IGNORE_SETTING(screen);
return ignore || (statusbar_position(screen) != STATUSBAR_OFF);
#else
return true;
#endif
}
return false;
}
void viewport_set_fullscreen(struct viewport *vp,
const enum screen_type screen)
{
vp->x = 0;
vp->width = screens[screen].lcdwidth;
#ifdef HAVE_LCD_BITMAP
struct viewport *sb_skin_vp = sb_skin_get_info_vp(screen);
if (sb_skin_vp && sb_skin_get_state(screen)
&& statusbar_enabled & VP_SB_ONSCREEN(screen))
{
*vp = *sb_skin_vp;
}
else
{
if (statusbar_position(screen) != STATUSBAR_BOTTOM && showing_bars(screen))
vp->y = STATUSBAR_HEIGHT;
else
vp->y = 0;
#else
{
vp->y = 0;
#endif
vp->height = screens[screen].lcdheight
- (showing_bars(screen)?STATUSBAR_HEIGHT:0);
}
#ifdef HAVE_LCD_BITMAP
set_default_align_flags(vp);
vp->font = FONT_UI; /* default to UI to discourage SYSFONT use */
vp->drawmode = DRMODE_SOLID;
#if LCD_DEPTH > 1
#ifdef HAVE_REMOTE_LCD
/* We only need this test if there is a remote LCD */
if (screen == SCREEN_MAIN)
#endif
{
vp->fg_pattern = FG_FALLBACK;
vp->bg_pattern = BG_FALLBACK;
#ifdef HAVE_LCD_COLOR
vp->lss_pattern = global_settings.lss_color;
vp->lse_pattern = global_settings.lse_color;
vp->lst_pattern = global_settings.lst_color;
#endif
}
#endif
#if defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1
if (screen == SCREEN_REMOTE)
{
vp->fg_pattern = LCD_REMOTE_DEFAULT_FG;
vp->bg_pattern = LCD_REMOTE_DEFAULT_BG;
}
#endif
#endif
}
void viewport_set_defaults(struct viewport *vp,
const enum screen_type screen)
{
#ifdef HAVE_LCD_BITMAP
if (ui_vp_info.active[screen])
*vp = ui_vp_info.vp[screen];
else
#endif
viewport_set_fullscreen(vp, screen);
}
void viewportmanager_init(void)
{
#ifdef HAVE_LCD_BITMAP
int retval, i;
add_event(GUI_EVENT_STATUSBAR_TOGGLE, false, statusbar_toggled);
retval = viewport_init_ui_vp();
FOR_NB_SCREENS(i)
ui_vp_info.active[i] = retval & BIT_N(i);
ui_vp_info.vp = custom_vp;
#endif
viewportmanager_set_statusbar(VP_SB_ALLSCREENS);
}
int viewportmanager_get_statusbar(void)
{
return statusbar_enabled;
}
int viewportmanager_set_statusbar(const int enabled)
{
int old = statusbar_enabled;
int i;
statusbar_enabled = enabled;
FOR_NB_SCREENS(i)
{
if (showing_bars(i)
&& statusbar_position(i) != STATUSBAR_CUSTOM)
{
add_event(GUI_EVENT_ACTIONUPDATE, false, viewportmanager_redraw);
gui_statusbar_draw(&statusbars.statusbars[i], true);
}
else
remove_event(GUI_EVENT_ACTIONUPDATE, viewportmanager_redraw);
}
#ifdef HAVE_LCD_BITMAP
FOR_NB_SCREENS(i)
{
sb_skin_set_state(showing_bars(i)
&& statusbar_position(i) == STATUSBAR_CUSTOM, i);
}
#endif
return old;
}
static void viewportmanager_redraw(void* data)
{
int i;
FOR_NB_SCREENS(i)
{
if (showing_bars(i)
&& statusbar_position(i) != STATUSBAR_CUSTOM)
gui_statusbar_draw(&statusbars.statusbars[i], NULL != data);
}
}
#ifdef HAVE_LCD_BITMAP
static void statusbar_toggled(void* param)
{
(void)param;
/* update vp manager for the new setting and reposition vps
* if necessary */
viewportmanager_theme_changed(THEME_STATUSBAR);
}
void viewportmanager_theme_changed(const int which)
{
int i;
#ifdef HAVE_BUTTONBAR
if (which & THEME_BUTTONBAR)
{ /* don't handle further, the custom ui viewport ignores the buttonbar,
* as does viewport_set_defaults(), since only lists use it*/
screens[SCREEN_MAIN].has_buttonbar = global_settings.buttonbar;
}
#endif
if (which & THEME_UI_VIEWPORT)
{
int retval = viewport_init_ui_vp();
/* reset the ui viewport */
FOR_NB_SCREENS(i)
ui_vp_info.active[i] = retval & BIT_N(i);
/* and point to it */
ui_vp_info.vp = custom_vp;
}
else if (which & THEME_LANGUAGE)
{ /* THEME_UI_VIEWPORT handles rtl already */
FOR_NB_SCREENS(i)
set_default_align_flags(&custom_vp[i]);
}
if (which & THEME_STATUSBAR)
{
statusbar_enabled = 0;
FOR_NB_SCREENS(i)
{
if (statusbar_position(i) != STATUSBAR_OFF)
statusbar_enabled |= VP_SB_ONSCREEN(i);
}
viewportmanager_set_statusbar(statusbar_enabled);
/* reposition viewport to fit statusbar, only if not using the ui vp */
FOR_NB_SCREENS(i)
{
if (!ui_vp_info.active[i])
viewport_set_fullscreen(&custom_vp[i], i);
}
}
int event_add = 0;
FOR_NB_SCREENS(i)
{
event_add |= ui_vp_info.active[i];
event_add |= (statusbar_position(i) == STATUSBAR_CUSTOM);
}
if (event_add)
add_event(GUI_EVENT_REFRESH, false, viewportmanager_ui_vp_changed);
else
remove_event(GUI_EVENT_REFRESH, viewportmanager_ui_vp_changed);
send_event(GUI_EVENT_THEME_CHANGED, NULL);
}
static void viewportmanager_ui_vp_changed(void *param)
{
/* if the user changed the theme, we need to initiate a full redraw */
int i;
/* cast param to a function */
void (*draw_func)(void) = ((void(*)(void))param);
/* start with clearing the screen */
FOR_NB_SCREENS(i)
screens[i].clear_display();
/* redraw the statusbar if it was enabled */
send_event(GUI_EVENT_ACTIONUPDATE, (void*)true);
/* call the passed function which will redraw the content of
* the current screen */
if (draw_func != NULL)
draw_func();
FOR_NB_SCREENS(i)
screens[i].update();
}
void viewport_set_current_vp(struct viewport* vp)
{
if (vp != NULL)
ui_vp_info.vp = vp;
else
ui_vp_info.vp = custom_vp;
/* must be done after the assignment above or event handler get old vps */
send_event(GUI_EVENT_THEME_CHANGED, NULL);
}
struct viewport* viewport_get_current_vp(void)
{
return ui_vp_info.vp;
}
bool viewport_ui_vp_get_state(enum screen_type screen)
{
return ui_vp_info.active[screen];
}
/*
* (re)parse the UI vp from the settings
* - Returns
* 0 if no UI vp is used at all
* else the bit for the screen (1<<screen) is set
*/
static unsigned viewport_init_ui_vp(void)
{
int screen;
unsigned ret = 0;
char *setting;
FOR_NB_SCREENS(screen)
{
#ifdef HAVE_REMOTE_LCD
if ((screen == SCREEN_REMOTE))
setting = global_settings.remote_ui_vp_config;
else
#endif
setting = global_settings.ui_vp_config;
if (!(viewport_parse_viewport(&custom_vp[screen], screen,
setting, ',')))
viewport_set_fullscreen(&custom_vp[screen], screen);
else
ret |= BIT_N(screen);
}
return ret;
}
#ifdef HAVE_TOUCHSCREEN
/* check if a point (x and y coordinates) are within a viewport */
bool viewport_point_within_vp(const struct viewport *vp,
const int x, const int y)
{
bool is_x = (x >= vp->x && x < (vp->x + vp->width));
bool is_y = (y >= vp->y && y < (vp->y + vp->height));
return (is_x && is_y);
}
#endif /* HAVE_TOUCHSCREEN */
#endif /* HAVE_LCD_BITMAP */
#endif /* __PCTOOL__ */
#ifdef HAVE_LCD_COLOR
#define ARG_STRING(_depth) ((_depth) == 2 ? "dddddgg":"dddddcc")
#else
#define ARG_STRING(_depth) "dddddgg"
#endif
#ifdef HAVE_LCD_BITMAP
static void set_default_align_flags(struct viewport *vp)
{
vp->flags &= ~VP_FLAG_ALIGNMENT_MASK;
#ifndef __PCTOOL__
if (UNLIKELY(lang_is_rtl()))
vp->flags |= VP_FLAG_ALIGN_RIGHT;
#endif
}
const char* viewport_parse_viewport(struct viewport *vp,
enum screen_type screen,
const char *bufptr,
const char separator)
{
/* parse the list to the viewport struct */
const char *ptr = bufptr;
int depth;
uint32_t set = 0;
enum {
PL_X = 0,
PL_Y,
PL_WIDTH,
PL_HEIGHT,
PL_FONT,
PL_FG,
PL_BG,
};
/* Work out the depth of this display */
depth = screens[screen].depth;
#if (LCD_DEPTH == 1) || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH == 1)
if (depth == 1)
{
if (!(ptr = parse_list("ddddd", &set, separator, ptr,
&vp->x, &vp->y, &vp->width, &vp->height, &vp->font)))
return NULL;
}
else
#endif
#if (LCD_DEPTH > 1) || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1)
if (depth >= 2)
{
if (!(ptr = parse_list(ARG_STRING(depth), &set, separator, ptr,
&vp->x, &vp->y, &vp->width, &vp->height, &vp->font,
&vp->fg_pattern,&vp->bg_pattern)))
return NULL;
}
else
#endif
{}
#undef ARG_STRING
/* X and Y *must* be set */
if (!LIST_VALUE_PARSED(set, PL_X) || !LIST_VALUE_PARSED(set, PL_Y))
return NULL;
/* check for negative values */
if (vp->x < 0)
vp->x += screens[screen].lcdwidth;
if (vp->y < 0)
vp->y += screens[screen].lcdheight;
/* fix defaults,
* and negative width/height which means "extend to edge minus value */
if (!LIST_VALUE_PARSED(set, PL_WIDTH))
vp->width = screens[screen].lcdwidth - vp->x;
else if (vp->width < 0)
vp->width = (vp->width + screens[screen].lcdwidth) - vp->x;
if (!LIST_VALUE_PARSED(set, PL_HEIGHT))
vp->height = screens[screen].lcdheight - vp->y;
else if (vp->height < 0)
vp->height = (vp->height + screens[screen].lcdheight) - vp->y;
#if (LCD_DEPTH > 1) || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1)
if (!LIST_VALUE_PARSED(set, PL_FG))
vp->fg_pattern = FG_FALLBACK;
if (!LIST_VALUE_PARSED(set, PL_BG))
vp->bg_pattern = BG_FALLBACK;
#endif /* LCD_DEPTH > 1 || LCD_REMOTE_DEPTH > 1 */
#ifdef HAVE_LCD_COLOR
vp->lss_pattern = global_settings.lss_color;
vp->lse_pattern = global_settings.lse_color;
vp->lst_pattern = global_settings.lst_color;
#endif
/* Validate the viewport dimensions - we know that the numbers are
non-negative integers, ignore bars and assume the viewport takes them
* into account */
if ((vp->x >= screens[screen].lcdwidth) ||
((vp->x + vp->width) > screens[screen].lcdwidth) ||
(vp->y >= screens[screen].lcdheight) ||
((vp->y + vp->height) > screens[screen].lcdheight))
{
return NULL;
}
/* Default to using the user font if the font was an invalid number or '-'*/
if (((vp->font != FONT_SYSFIXED) && (vp->font != FONT_UI))
|| !LIST_VALUE_PARSED(set, PL_FONT)
)
vp->font = FONT_UI;
/* Set the defaults for fields not user-specified */
vp->drawmode = DRMODE_SOLID;
set_default_align_flags(vp);
return ptr;
}
#endif