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     std::auto_ptr<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, 40);
  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_surface(background.get(), Vector(0,0), 0);
 122
 123   float y = SCREEN_HEIGHT - scroll;
 124   for(size_t i = 0; i < lines.size(); i++) {
 125     lines[i]->draw(context, Vector(LEFT_BORDER, y), LAYER_GUI);
 126     y += lines[i]->get_height();
 127   }
 128
 129   if(y < 0 && !fading ) {
 130     fading = true;
 131     main_loop->exit_screen(new FadeOut(0.5));
 132   }
 133 }
 134
 135 InfoBox::InfoBox(const std::string& text)
 136   : firstline(0)
 137 {
 138   // Split text string lines into a vector
 139   lines = InfoBoxLine::split(text, 23);
 140
 141   try
 142   {
 143     // get the arrow sprites
 144     arrow_scrollup   = new Surface("images/engine/menu/scroll-up.png");
 145     arrow_scrolldown = new Surface("images/engine/menu/scroll-down.png");
 146   }
 147   catch (std::exception& e)
 148   {
 149     log_warning << "Could not load scrolling images: " << e.what() << std::endl;
 150     arrow_scrollup = 0;
 151     arrow_scrolldown = 0;
 152   }
 153 }
 154
 155 InfoBox::~InfoBox()
 156 {
 157   for(std::vector<InfoBoxLine*>::iterator i = lines.begin();
 158       i != lines.end(); i++)
 159     delete *i;
 160   delete arrow_scrollup;
 161   delete arrow_scrolldown;
 162 }
 163
 164 void
 165 InfoBox::draw(DrawingContext& context)
 166 {
 167   float x1 = 200;
 168   float y1 = 100;
 169   float width = 400;
 170   float height = 200;
 171
 172   context.draw_filled_rect(Vector(x1, y1), Vector(width, height),
 173       Color(0.6f, 0.7f, 0.8f, 0.5f), LAYER_GUI-1);
 174
 175   float y = y1;
 176   for(size_t i = firstline; i < lines.size(); ++i) {
 177     if(y >= y1 + height) break;
 178
 179     lines[i]->draw(context, Vector(x1, y), LAYER_GUI);
 180     y += lines[i]->get_height();
 181
 182     // draw the scrolling arrows
 183     if (arrow_scrollup && firstline > 0)
 184       context.draw_surface(arrow_scrollup,
 185       Vector( x1 + width  - arrow_scrollup->get_width(),  // top-right corner of box
 186               y1), LAYER_GUI);
 187
 188     if (arrow_scrolldown && firstline < lines.size()-1)
 189       context.draw_surface(arrow_scrolldown,
 190       Vector( x1 + width  - arrow_scrolldown->get_width(),  // bottom-light corner of box
 191               y1 + height - arrow_scrolldown->get_height()),
 192               LAYER_GUI);
 193   }
 194 }
 195
 196 void
 197 InfoBox::scrollup()
 198 {
 199   if(firstline > 0)
 200     firstline--;
 201 }
 202
 203 void
 204 InfoBox::scrolldown()
 205 {
 206   if(firstline < lines.size()-1)
 207     firstline++;
 208 }
 209
 210 void
 211 InfoBox::pageup()
 212 {
 213 }
 214
 215 void
 216 InfoBox::pagedown()
 217 {
 218 }
 219
 220 InfoBoxLine::InfoBoxLine(char format_char, const std::string& text) : lineType(NORMAL), font(white_text), text(text), image(0)
 221 {
 222   switch(format_char)
 223   {
 224     case ' ':
 225       lineType = SMALL;
 226       font = white_small_text;
 227       break;
 228     case '\t':
 229       lineType = NORMAL;
 230       font = white_text;
 231       break;
 232     case '-':
 233       lineType = HEADING;
 234       font = white_big_text;
 235       break;
 236     case '*':
 237       lineType = REFERENCE;
 238       font = blue_text;
 239       break;
 240     case '#':
 241       lineType = NORMAL_LEFT;
 242       font = white_text;
 243       break;
 244     case '!':
 245       lineType = IMAGE;
 246       image = new Surface(text);
 247       break;
 248     default:
 249       log_warning << "Unknown format_char: '" << format_char << "'" << std::endl;
 250       break;
 251   }
 252 }
 253
 254 InfoBoxLine::~InfoBoxLine()
 255 {
 256   delete image;
 257 }
 258
 259 const std::vector<InfoBoxLine*>
 260 InfoBoxLine::split(const std::string& text, int line_length)
 261 {
 262   std::vector<InfoBoxLine*> lines;
 263
 264   std::string::size_type i = 0;
 265   std::string::size_type l;
 266   char format_char = '#';
 267   while(i < text.size()) {
 268     // take care of empty lines - represent them as blank lines of normal text
 269     if (text[i] == '\n') {
 270       lines.push_back(new InfoBoxLine('\t', ""));
 271       i++;
 272       continue;
 273     }
 274
 275     // extract the format_char
 276     format_char = text[i];
 277     i++;
 278     if (i >= text.size()) break;
 279
 280     // extract one line
 281     l = text.find("\n", i);
 282     if (l == std::string::npos) l=text.size();
 283     std::string s = text.substr(i, l-i);
 284     i = l+1;
 285
 286     // if we are dealing with an image, just store the line
 287     if (format_char == '!') {
 288       lines.push_back(new InfoBoxLine(format_char, s));
 289       continue;
 290     }
 291
 292     // append wrapped parts of line into list
 293     std::string overflow;
 294     do {
 295       lines.push_back(new InfoBoxLine(format_char, Font::wrap_to_chars(s, line_length, &overflow)));
 296       s = overflow;
 297     } while (s.length() > 0);
 298
 299   }
 300
 301   return lines;
 302 }
 303
 304 void
 305 InfoBoxLine::draw(DrawingContext& context, const Vector& position, int layer)
 306 {
 307   switch (lineType) {
 308     case IMAGE:
 309       context.draw_surface(image, Vector( (SCREEN_WIDTH - image->get_width()) / 2, position.y), layer);
 310       break;
 311     case NORMAL_LEFT:
 312       context.draw_text(font, text, Vector(position.x, position.y), LEFT_ALLIGN, layer);
 313       break;
 314     default:
 315       context.draw_text(font, text, Vector(SCREEN_WIDTH/2, position.y), CENTER_ALLIGN, layer);
 316       break;
 317   }
 318 }
 319
 320 float
 321 InfoBoxLine::get_height()
 322 {
 323   switch (lineType) {
 324     case IMAGE:
 325       return image->get_height() + ITEMS_SPACE;
 326     case NORMAL_LEFT:
 327       return font->get_height() + ITEMS_SPACE;
 328     default:
 329       return font->get_height() + ITEMS_SPACE;
 330   }
 331 }