src/textscroller.cpp

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   5 //
   6 //  This program is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU General Public License
   8 //  as published by the Free Software Foundation; either version 2
   9 //  of the License, or (at your option) any later version.
  10 //
  11 //  This program is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //  GNU General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU General Public License
  17 //  along with this program; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 //  02111-1307, USA.
  20 #include <config.h>
  21
  22 #include "textscroller.hpp"
  23
  24 #include <stdexcept>
  25 #include "log.hpp"
  26 #include "mainloop.hpp"
  27 #include "resources.hpp"
  28 #include "video/font.hpp"
  29 #include "video/drawing_context.hpp"
  30 #include "video/surface.hpp"
  31 #include "gui/menu.hpp"
  32 #include "lisp/parser.hpp"
  33 #include "lisp/lisp.hpp"
  34 #include "audio/sound_manager.hpp"
  35 #include "main.hpp"
  36 #include "fadeout.hpp"
  37 #include "control/joystickkeyboardcontroller.hpp"
  38
  39 static const float DEFAULT_SPEED = 20;
  40 static const float LEFT_BORDER = 50;
  41 static const float SCROLL = 60;
  42 static const float ITEMS_SPACE = 4;
  43
  44 TextScroller::TextScroller(const std::string& filename)
  45 {
  46   defaultspeed = DEFAULT_SPEED;
  47   speed = defaultspeed;
  48
  49   std::string text;
  50   std::string background_file;
  51
  52   lisp::Parser parser;
  53   try {
  54     const lisp::Lisp* root = parser.parse(filename);
  55
  56     const lisp::Lisp* text_lisp = root->get_lisp("supertux-text");
  57     if(!text_lisp)
  58       throw std::runtime_error("File isn't a supertux-text file");
  59
  60     if(!text_lisp->get("text", text))
  61       throw std::runtime_error("file doesn't contain a text field");
  62     if(!text_lisp->get("background", background_file))
  63       throw std::runtime_error("file doesn't contain a background file");
  64     text_lisp->get("speed", defaultspeed);
  65     text_lisp->get("music", music);
  66   } catch(std::exception& e) {
  67     std::ostringstream msg;
  68     msg << "Couldn't load file '" << filename << "': " << e.what() << std::endl;
  69     throw std::runtime_error(msg.str());
  70   }
  71
  72   // Split text string lines into a vector
  73   lines = InfoBoxLine::split(text, SCREEN_WIDTH - 2*LEFT_BORDER);
  74
  75   // load background image
  76   background.reset(new Surface("images/background/" + background_file));
  77
  78   scroll = 0;
  79   fading = false;
  80 }
  81
  82 TextScroller::~TextScroller()
  83 {
  84   for(std::vector<InfoBoxLine*>::iterator i = lines.begin(); i != lines.end(); i++) delete *i;
  85 }
  86
  87 void
  88 TextScroller::setup()
  89 {
  90   sound_manager->play_music(music);
  91   Menu::set_current(NULL);
  92 }
  93
  94 void
  95 TextScroller::update(float elapsed_time)
  96 {
  97   if(main_controller->hold(Controller::UP)) {
  98     speed = -defaultspeed*5;
  99   } else if(main_controller->hold(Controller::DOWN)) {
 100     speed = defaultspeed*5;
 101   } else {
 102     speed = defaultspeed;
 103   }
 104   if(main_controller->pressed(Controller::JUMP)
 105       || main_controller->pressed(Controller::ACTION)
 106       || main_controller->pressed(Controller::MENU_SELECT))
 107     scroll += SCROLL;
 108   if(main_controller->pressed(Controller::PAUSE_MENU)) {
 109     main_loop->exit_screen(new FadeOut(0.5));
 110   }
 111
 112   scroll += speed * elapsed_time;
 113
 114   if(scroll < 0)
 115     scroll = 0;
 116 }
 117
 118 void
 119 TextScroller::draw(DrawingContext& context)
 120 {
 121   context.draw_filled_rect(Vector(0, 0), Vector(SCREEN_WIDTH, SCREEN_HEIGHT),
 122       Color(0.6f, 0.7f, 0.8f, 0.5f), 0);
 123   context.draw_surface(background.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 , SCREEN_HEIGHT/2 - background->get_height()/2), 0);
 124
 125   float y = SCREEN_HEIGHT - scroll;
 126   for(size_t i = 0; i < lines.size(); i++) {
 127     lines[i]->draw(context, Rect(LEFT_BORDER, y, SCREEN_WIDTH - 2*LEFT_BORDER, y), LAYER_GUI);
 128     y += lines[i]->get_height();
 129   }
 130
 131   if(y < 0 && !fading ) {
 132     fading = true;
 133     main_loop->exit_screen(new FadeOut(0.5));
 134   }
 135 }
 136
 137 InfoBox::InfoBox(const std::string& text)
 138   : firstline(0)
 139 {
 140   // Split text string lines into a vector
 141   lines = InfoBoxLine::split(text, 400);
 142
 143   try
 144   {
 145     // get the arrow sprites
 146     arrow_scrollup   = new Surface("images/engine/menu/scroll-up.png");
 147     arrow_scrolldown = new Surface("images/engine/menu/scroll-down.png");
 148   }
 149   catch (std::exception& e)
 150   {
 151     log_warning << "Could not load scrolling images: " << e.what() << std::endl;
 152     arrow_scrollup = 0;
 153     arrow_scrolldown = 0;
 154   }
 155 }
 156
 157 InfoBox::~InfoBox()
 158 {
 159   for(std::vector<InfoBoxLine*>::iterator i = lines.begin();
 160       i != lines.end(); i++)
 161     delete *i;
 162   delete arrow_scrollup;
 163   delete arrow_scrolldown;
 164 }
 165
 166 void
 167 InfoBox::draw(DrawingContext& context)
 168 {
 169   float x1 = SCREEN_WIDTH/2-200;
 170   float y1 = SCREEN_HEIGHT/2-200;
 171   float width = 400;
 172   float height = 200;
 173
 174   context.draw_filled_rect(Vector(x1, y1), Vector(width, height),
 175       Color(0.6f, 0.7f, 0.8f, 0.5f), LAYER_GUI-1);
 176
 177   float y = y1;
 178   bool linesLeft = false;
 179   for(size_t i = firstline; i < lines.size(); ++i) {
 180     if(y >= y1 + height) {
 181       linesLeft = true;
 182       break;
 183     }
 184
 185     lines[i]->draw(context, Rect(x1, y, x1+width, y), LAYER_GUI);
 186     y += lines[i]->get_height();
 187   }
 188
 189   {
 190     // draw the scrolling arrows
 191     if (arrow_scrollup && firstline > 0)
 192       context.draw_surface(arrow_scrollup,
 193       Vector( x1 + width  - arrow_scrollup->get_width(),  // top-right corner of box
 194               y1), LAYER_GUI);
 195
 196     if (arrow_scrolldown && linesLeft && firstline < lines.size()-1)
 197       context.draw_surface(arrow_scrolldown,
 198       Vector( x1 + width  - arrow_scrolldown->get_width(),  // bottom-light corner of box
 199               y1 + height - arrow_scrolldown->get_height()),
 200               LAYER_GUI);
 201   }
 202 }
 203
 204 void
 205 InfoBox::scrollup()
 206 {
 207   if(firstline > 0)
 208     firstline--;
 209 }
 210
 211 void
 212 InfoBox::scrolldown()
 213 {
 214   if(firstline < lines.size()-1)
 215     firstline++;
 216 }
 217
 218 void
 219 InfoBox::pageup()
 220 {
 221 }
 222
 223 void
 224 InfoBox::pagedown()
 225 {
 226 }
 227
 228 namespace {
 229 Font* get_font_by_format_char(char format_char) {
 230   switch(format_char)
 231   {
 232     case ' ':
 233       return small_font;
 234       break;
 235     case '-':
 236       return big_font;
 237       break;
 238     case '\t':
 239     case '*':
 240     case '#':
 241     case '!':
 242       return normal_font;
 243       break;
 244     default:
 245       return normal_font;
 246       log_warning << "Unknown format_char: '" << format_char << "'" << std::endl;
 247       break;
 248   }
 249 }
 250
 251 Color get_color_by_format_char(char format_char) {
 252   switch(format_char)
 253   {
 254     case ' ':
 255       return TextScroller::small_color;
 256       break;
 257     case '-':
 258       return TextScroller::heading_color;
 259       break;
 260     case '*':
 261       return TextScroller::reference_color;
 262     case '\t':
 263     case '#':
 264     case '!':
 265       return TextScroller::normal_color;
 266       break;
 267     default:
 268       return Color(0,0,0);
 269       log_warning << "Unknown format_char: '" << format_char << "'" << std::endl;
 270       break;
 271   }
 272 }
 273
 274 InfoBoxLine::LineType get_linetype_by_format_char(char format_char) {
 275   switch(format_char)
 276   {
 277     case ' ':
 278       return InfoBoxLine::SMALL;
 279       break;
 280     case '\t':
 281       return InfoBoxLine::NORMAL;
 282       break;
 283     case '-':
 284       return InfoBoxLine::HEADING;
 285       break;
 286     case '*':
 287       return InfoBoxLine::REFERENCE;
 288       break;
 289     case '#':
 290       return InfoBoxLine::NORMAL_LEFT;
 291       break;
 292     case '!':
 293       return InfoBoxLine::IMAGE;
 294       break;
 295     default:
 296       return InfoBoxLine::SMALL;
 297       log_warning << "Unknown format_char: '" << format_char << "'" << std::endl;
 298       break;
 299   }
 300 }
 301 }
 302
 303 InfoBoxLine::InfoBoxLine(char format_char, const std::string& text) : lineType(NORMAL), font(normal_font), text(text), image(0)
 304 {
 305   font = get_font_by_format_char(format_char);
 306   lineType = get_linetype_by_format_char(format_char);
 307   color = get_color_by_format_char(format_char);
 308   if (lineType == IMAGE) image = new Surface(text);
 309 }
 310
 311 InfoBoxLine::~InfoBoxLine()
 312 {
 313   delete image;
 314 }
 315
 316 const std::vector<InfoBoxLine*>
 317 InfoBoxLine::split(const std::string& text, float width)
 318 {
 319   std::vector<InfoBoxLine*> lines;
 320
 321   std::string::size_type i = 0;
 322   std::string::size_type l;
 323   char format_char = '#';
 324   while(i < text.size()) {
 325     // take care of empty lines - represent them as blank lines of normal text
 326     if (text[i] == '\n') {
 327       lines.push_back(new InfoBoxLine('\t', ""));
 328       i++;
 329       continue;
 330     }
 331
 332     // extract the format_char
 333     format_char = text[i];
 334     i++;
 335     if (i >= text.size()) break;
 336
 337     // extract one line
 338     l = text.find("\n", i);
 339     if (l == std::string::npos) l=text.size();
 340     std::string s = text.substr(i, l-i);
 341     i = l+1;
 342
 343     // if we are dealing with an image, just store the line
 344     if (format_char == '!') {
 345       lines.push_back(new InfoBoxLine(format_char, s));
 346       continue;
 347     }
 348
 349     // append wrapped parts of line into list
 350     std::string overflow;
 351     do {
 352       Font* font = get_font_by_format_char(format_char);
 353       std::string s2 = s;
 354       if (font) s2 = font->wrap_to_width(s2, width, &overflow);
 355       lines.push_back(new InfoBoxLine(format_char, s2));
 356       s = overflow;
 357     } while (s.length() > 0);
 358   }
 359
 360   return lines;
 361 }
 362
 363 void
 364 InfoBoxLine::draw(DrawingContext& context, const Rect& bbox, int layer)
 365 {
 366   Vector position = bbox.p1;
 367   switch (lineType) {
 368     case IMAGE:
 369       context.draw_surface(image, Vector( (bbox.p1.x + bbox.p2.x - image->get_width()) / 2, position.y), layer);
 370       break;
 371     case NORMAL_LEFT:
 372       context.draw_text(font, text, Vector(position.x, position.y), ALIGN_LEFT, layer, color);
 373       break;
 374     default:
 375       context.draw_text(font, text, Vector((bbox.p1.x + bbox.p2.x) / 2, position.y), ALIGN_CENTER, layer, color);
 376       break;
 377   }
 378 }
 379
 380 float
 381 InfoBoxLine::get_height()
 382 {
 383   switch (lineType) {
 384     case IMAGE:
 385       return image->get_height() + ITEMS_SPACE;
 386     case NORMAL_LEFT:
 387       return font->get_height() + ITEMS_SPACE;
 388     default:
 389       return font->get_height() + ITEMS_SPACE;
 390   }
 391 }