apps/plugins/text_viewer/tv_display.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2010 Yoshihisa Uchida
  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 #include "tv_display.h"
  22 #include "tv_preferences.h"
  23
  24 /*
  25  * display layout
  26  *
  27  * when is defined HAVE_LCD_BITMAP
  28  * +-------------------------+
  29  * |statusbar (1)            |
  30  * +-------------------------+
  31  * |filename  (2)            |
  32  * +---+---------------------+
  33  * |s  |                     |
  34  * |c  |                     |
  35  * |r  | draw area           |
  36  * |o  |                     |
  37  * |l  |                     |
  38  * |l  |                     |
  39  * |b  |                     |
  40  * |a  |                     |
  41  * |r  |                     |
  42  * |(3)|                     |
  43  * +---+---------------------+
  44  * |   |scrollbar (4)        |
  45  * +---+---------------------+
  46  * |page (5)                 |
  47  * +-------------------------+
  48  * |statusbar (6)            |
  49  * +-------------------------+
  50  *
  51  * (1) displays when rb->global_settings->statusbar == STATUSBAR_TOP.
  52  * (2) displays when preferences->header_mode is HD_PATH.
  53  * (3) displays when preferences->vertical_scrollbar is SB_ON.
  54  * (4) displays when preferences->horizontal_scrollbar is SB_ON.
  55  * (5) displays when preferences->footer_mode is FT_PAGE.
  56  * (6) displays when rb->global_settings->statusbar == STATUSBAR_BOTTOM.
  57  *
  58  *
  59  * when isn't defined HAVE_LCD_BITMAP
  60  * +---+---------------------+
  61  * |   |                     |
  62  * |(7)| draw area           |
  63  * |   |                     |
  64  * +---+---------------------+
  65  * (7) bookmark
  66  */
  67
  68 #define TV_SCROLLBAR_WIDTH  rb->global_settings->scrollbar_width
  69 #define TV_SCROLLBAR_HEIGHT 4
  70
  71 #ifndef HAVE_LCD_BITMAP
  72 #define TV_BOOKMARK_ICON 0xe101
  73 #endif
  74
  75 struct tv_rect {
  76     int x;
  77     int y;
  78     int w;
  79     int h;
  80 };
  81
  82 static struct viewport vp_info;
  83 static bool is_initialized_vp = false;
  84
  85 static struct screen* display;
  86
  87 #ifdef HAVE_LCD_BITMAP
  88 static int drawmode = DRMODE_SOLID;
  89 #endif
  90
  91 /* layout */
  92 #ifdef HAVE_LCD_BITMAP
  93 static struct tv_rect header;
  94 static struct tv_rect footer;
  95 static struct tv_rect horizontal_scrollbar;
  96 static struct tv_rect vertical_scrollbar;
  97 #else
  98 static struct tv_rect bookmark;
  99 #endif
 100 static struct tv_rect drawarea;
 101
 102 static bool show_vertical_scrollbar;
 103
 104 static int display_columns;
 105 static int display_rows;
 106
 107 static int col_width  = 1;
 108 static int row_height = 1;
 109
 110 static int totalsize;
 111
 112 #ifdef HAVE_LCD_BITMAP
 113
 114 static void tv_show_header(void)
 115 {
 116     unsigned header_mode = header_mode;
 117
 118     if (preferences->header_mode == HD_PATH)
 119         display->putsxy(header.x, header.y, preferences->file_name);
 120 }
 121
 122 static void tv_show_footer(const struct tv_screen_pos *pos)
 123 {
 124     unsigned char buf[12];
 125     unsigned footer_mode = preferences->footer_mode;
 126
 127     if (footer_mode == FT_PAGE)
 128     {
 129         if (pos->line == 0)
 130             rb->snprintf(buf, sizeof(buf), "%d", pos->page + 1);
 131         else
 132             rb->snprintf(buf, sizeof(buf), "%d - %d", pos->page + 1, pos->page + 2);
 133         display->putsxy(footer.x, footer.y + 1, buf);
 134     }
 135 }
 136
 137 static void tv_show_scrollbar(int window, int col, off_t cur_pos, int size)
 138 {
 139     int items;
 140     int min_shown;
 141     int max_shown;
 142
 143     if (preferences->horizontal_scrollbar)
 144     {
 145         items     = preferences->windows * display_columns;
 146         min_shown = window * display_columns + col;
 147         max_shown = min_shown + display_columns;
 148
 149         rb->gui_scrollbar_draw(display,
 150                                horizontal_scrollbar.x, horizontal_scrollbar.y + 1,
 151                                horizontal_scrollbar.w, TV_SCROLLBAR_HEIGHT,
 152                                items, min_shown, max_shown, HORIZONTAL);
 153     }
 154
 155     if (show_vertical_scrollbar)
 156     {
 157         items     = (int) totalsize;
 158         min_shown = (int) cur_pos;
 159         max_shown = min_shown + size;
 160
 161         rb->gui_scrollbar_draw(display,
 162                                vertical_scrollbar.x, vertical_scrollbar.y,
 163                                TV_SCROLLBAR_WIDTH, vertical_scrollbar.h,
 164                                items, min_shown, max_shown, VERTICAL);
 165     }
 166 }
 167
 168 #endif
 169
 170 void tv_init_scrollbar(off_t total, bool show_scrollbar)
 171 {
 172     totalsize = total;
 173     show_vertical_scrollbar = show_scrollbar;
 174 }
 175
 176 void tv_show_bookmarks(const int *rows, int count)
 177 {
 178 #ifdef HAVE_LCD_BITMAP
 179     rb->lcd_set_drawmode(DRMODE_COMPLEMENT);
 180 #endif
 181
 182     while (count--)
 183     {
 184 #ifdef HAVE_LCD_BITMAP
 185         display->fillrect(drawarea.x, drawarea.y + rows[count] * row_height,
 186                           drawarea.w, row_height);
 187 #else
 188         display->putchar(bookmark.x, drawarea.y + rows[count], TV_BOOKMARK_ICON);
 189 #endif
 190     }
 191 }
 192
 193 void tv_update_extra(int window, int col, const struct tv_screen_pos *pos, int size)
 194 {
 195 #ifdef HAVE_LCD_BITMAP
 196     tv_show_scrollbar(window, col, pos->file_pos, size);
 197     tv_show_header();
 198     tv_show_footer(pos);
 199 #else
 200     (void)window;
 201     (void)col;
 202     (void)pos;
 203     (void)size;
 204 #endif
 205 }
 206
 207 void tv_draw_text(int row, const unsigned char *text, int offset)
 208 {
 209     int xpos = -offset * col_width;
 210     int text_width;
 211
 212     if (row < 0 || row >= display_rows)
 213         return;
 214
 215     if (preferences->alignment == AL_RIGHT)
 216     {
 217         display->getstringsize(text, &text_width, NULL);
 218         xpos += ((offset > 0)? drawarea.w * 2 : drawarea.w) - text_width;
 219     }
 220
 221 #ifdef HAVE_LCD_BITMAP
 222     display->putsxy(drawarea.x + xpos, drawarea.y + row * row_height, text);
 223 #else
 224     display->puts(drawarea.x + xpos, drawarea.y + row, text);
 225 #endif
 226 }
 227
 228 void tv_start_display(void)
 229 {
 230     display->set_viewport(&vp_info);
 231 #ifdef HAVE_LCD_BITMAP
 232     drawmode = rb->lcd_get_drawmode();
 233     rb->lcd_set_drawmode(DRMODE_SOLID);
 234 #endif
 235
 236 #if LCD_DEPTH > 1
 237     rb->lcd_set_backdrop(NULL);
 238 #endif
 239     display->clear_viewport();
 240 }
 241
 242 void tv_end_display(void)
 243 {
 244     display->update_viewport();
 245
 246 #ifdef HAVE_LCD_BITMAP
 247     rb->lcd_set_drawmode(drawmode);
 248 #endif
 249
 250     display->set_viewport(NULL);
 251 }
 252
 253 void tv_set_layout(bool show_scrollbar)
 254 {
 255 #ifdef HAVE_LCD_BITMAP
 256     int scrollbar_width  = (show_scrollbar)?                    TV_SCROLLBAR_WIDTH  + 1 : 0;
 257     int scrollbar_height = (preferences->horizontal_scrollbar)? TV_SCROLLBAR_HEIGHT + 1 : 0;
 258
 259     row_height = preferences->font->height;
 260
 261     header.x = 0;
 262     header.y = 1;
 263     header.w = vp_info.width;
 264     header.h = (preferences->header_mode == HD_PATH)? row_height + 1 : 0;
 265
 266     footer.x = 0;
 267     footer.w = vp_info.width;
 268     footer.h = (preferences->footer_mode == FT_PAGE)? row_height + 1 : 0;
 269     footer.y = vp_info.height - 1 - footer.h;
 270
 271     drawarea.x = scrollbar_width;
 272     drawarea.y = header.y + header.h;
 273     drawarea.w = vp_info.width - scrollbar_width;
 274     drawarea.h = footer.y - drawarea.y - scrollbar_height;
 275
 276     horizontal_scrollbar.x = drawarea.x;
 277     horizontal_scrollbar.y = footer.y - scrollbar_height;
 278     horizontal_scrollbar.w = drawarea.w;
 279     horizontal_scrollbar.h = scrollbar_height;
 280
 281     vertical_scrollbar.x = 0;
 282     vertical_scrollbar.y = drawarea.y;
 283     vertical_scrollbar.w = scrollbar_width;
 284     vertical_scrollbar.h = drawarea.h;
 285 #else
 286     (void) show_scrollbar;
 287
 288     row_height = 1;
 289
 290     bookmark.x = 0;
 291     bookmark.y = 0;
 292     bookmark.w = 1;
 293     bookmark.h = vp_info.height;
 294
 295     drawarea.x = 1;
 296     drawarea.y = 0;
 297     drawarea.w = vp_info.width - 1;
 298     drawarea.h = vp_info.height;
 299 #endif
 300
 301     display_columns = drawarea.w / col_width;
 302     display_rows    = drawarea.h / row_height;
 303 }
 304
 305 void tv_get_drawarea_info(int *width, int *cols, int *rows)
 306 {
 307     *width = drawarea.w;
 308     *cols  = display_columns;
 309     *rows  = display_rows;
 310 }
 311
 312 static void tv_change_viewport(void)
 313 {
 314 #ifdef HAVE_LCD_BITMAP
 315     struct viewport vp;
 316
 317     if (is_initialized_vp)
 318         rb->viewportmanager_theme_undo(SCREEN_MAIN, false);
 319     else
 320         is_initialized_vp = true;
 321
 322     rb->viewportmanager_theme_enable(SCREEN_MAIN, preferences->statusbar, &vp);
 323     vp_info = vp;
 324     vp_info.flags &= ~VP_FLAG_ALIGNMENT_MASK;
 325 #else
 326     if (!is_initialized_vp)
 327     {
 328         rb->viewport_set_defaults(&vp_info, SCREEN_MAIN);
 329         is_initialized_vp = true;
 330     }
 331 #endif
 332 }
 333
 334 #ifdef HAVE_LCD_BITMAP
 335 static bool tv_set_font(const unsigned char *font)
 336 {
 337     unsigned char path[MAX_PATH];
 338
 339     if (font != NULL && *font != '\0')
 340     {
 341         rb->snprintf(path, MAX_PATH, "%s/%s.fnt", FONT_DIR, font);
 342         if (rb->font_load(NULL, path) < 0)
 343         {
 344             rb->splash(HZ/2, "font load failed");
 345             return false;
 346         }
 347     }
 348     return true;
 349 }
 350 #endif
 351
 352 static void tv_change_preferences(const struct tv_preferences *oldp)
 353 {
 354 #ifdef HAVE_LCD_BITMAP
 355     static bool font_changing = false;
 356     const unsigned char *font_str;
 357     struct tv_preferences new_prefs;
 358
 359     font_str = (oldp && !font_changing)? oldp->font_name : rb->global_settings->font_file;
 360
 361     /* change font */
 362     if (font_changing || rb->strcmp(font_str, preferences->font_name))
 363     {
 364         if (!tv_set_font(preferences->font_name))
 365         {
 366             font_changing = true;
 367             tv_copy_preferences(&new_prefs);
 368             rb->strlcpy(new_prefs.font_name, font_str, MAX_PATH);
 369             tv_set_preferences(&new_prefs);
 370         }
 371         col_width = 2 * rb->font_get_width(preferences->font, ' ');
 372         font_changing = false;
 373     }
 374 #else
 375     (void)oldp;
 376 #endif
 377     tv_change_viewport();
 378 }
 379
 380 bool tv_init_display(unsigned char **buf, size_t *size)
 381 {
 382     (void)buf;
 383     (void)size;
 384
 385     display = rb->screens[SCREEN_MAIN];
 386     display->clear_viewport();
 387
 388     tv_add_preferences_change_listner(tv_change_preferences);
 389
 390     return true;
 391 }
 392
 393 void tv_finalize_display(void)
 394 {
 395 #ifdef HAVE_LCD_BITMAP
 396     /* restore font */
 397     if (rb->strcmp(rb->global_settings->font_file, preferences->font_name))
 398     {
 399         tv_set_font(rb->global_settings->font_file);
 400     }
 401
 402     /* undo viewport */
 403     rb->viewportmanager_theme_undo(SCREEN_MAIN, false);
 404 #endif
 405 }
 406
 407 bool tv_exist_scrollbar(void)
 408 {
 409 #ifdef HAVE_LCD_BITMAP
 410     return true;
 411 #else
 412     return false;
 413 #endif
 414 }