src/supertux/statistics.cpp

   1 //  SuperTux (Statistics module)
   2 //  Copyright (C) 2004 Ricardo Cruz <rick2@aeiou.pt>
   3 //  Copyright (C) 2006 Ondrej Hosek <ondra.hosek@gmail.com>
   4 //  Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
   5 //
   6 //  This program is free software: you can redistribute it and/or modify
   7 //  it under the terms of the GNU General Public License as published by
   8 //  the Free Software Foundation, either version 3 of the License, or
   9 //  (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, see <http://www.gnu.org/licenses/>.
  18
  19 #include "supertux/statistics.hpp"
  20
  21 #include <iomanip>
  22 #include <limits>
  23
  24 #include "scripting/squirrel_util.hpp"
  25 #include "supertux/globals.hpp"
  26 #include "supertux/resources.hpp"
  27 #include "util/gettext.hpp"
  28 #include "video/drawing_context.hpp"
  29
  30 namespace {
  31 const int nv_coins = std::numeric_limits<int>::min();
  32 const int nv_badguys = std::numeric_limits<int>::min();
  33 const float nv_time = std::numeric_limits<float>::max();
  34 const int nv_secrets = std::numeric_limits<int>::min();
  35 }
  36
  37 float WMAP_INFO_LEFT_X;
  38 float WMAP_INFO_RIGHT_X;
  39 float WMAP_INFO_TOP_Y1;
  40 float WMAP_INFO_TOP_Y2;
  41
  42 Statistics::Statistics() :
  43   coins(nv_coins),
  44   total_coins(nv_coins),
  45   badguys(nv_badguys),
  46   total_badguys(nv_badguys),
  47   time(nv_time),
  48   secrets(nv_secrets),
  49   total_secrets(nv_secrets),
  50   valid(true)
  51 {
  52   WMAP_INFO_LEFT_X = SCREEN_WIDTH - 32 - 256;
  53   WMAP_INFO_RIGHT_X = WMAP_INFO_LEFT_X + 256;
  54   WMAP_INFO_TOP_Y1 = SCREEN_HEIGHT - 100;
  55   WMAP_INFO_TOP_Y2 = WMAP_INFO_TOP_Y1 + 16;
  56 }
  57
  58 Statistics::~Statistics()
  59 {
  60 }
  61
  62 void
  63 Statistics::serialize_to_squirrel(HSQUIRRELVM vm)
  64 {
  65   // TODO: there's some bug in the unserialization routines that breaks stuff when an empty statistics table is written, so -- as a workaround -- let's make sure we will actually write something first
  66   if (!((coins != nv_coins) || (total_coins != nv_coins) || (badguys != nv_badguys) || (total_badguys != nv_badguys) || (time != nv_time) || (secrets != nv_secrets) || (total_secrets != nv_secrets))) return;
  67
  68   sq_pushstring(vm, "statistics", -1);
  69   sq_newtable(vm);
  70   if (coins != nv_coins) scripting::store_int(vm, "coins-collected", coins);
  71   if (total_coins != nv_coins) scripting::store_int(vm, "coins-collected-total", total_coins);
  72   if (badguys != nv_badguys) scripting::store_int(vm, "badguys-killed", badguys);
  73   if (total_badguys != nv_badguys) scripting::store_int(vm, "badguys-killed-total", total_badguys);
  74   if (time != nv_time) scripting::store_float(vm, "time-needed", time);
  75   if (secrets != nv_secrets) scripting::store_int(vm, "secrets-found", secrets);
  76   if (total_secrets != nv_secrets) scripting::store_int(vm, "secrets-found-total", total_secrets);
  77   sq_createslot(vm, -3);
  78 }
  79
  80 void
  81 Statistics::unserialize_from_squirrel(HSQUIRRELVM vm)
  82 {
  83   sq_pushstring(vm, "statistics", -1);
  84   if(SQ_FAILED(sq_get(vm, -2))) {
  85     return;
  86   }
  87   scripting::get_int(vm, "coins-collected", coins);
  88   scripting::get_int(vm, "coins-collected-total", total_coins);
  89   scripting::get_int(vm, "badguys-killed", badguys);
  90   scripting::get_int(vm, "badguys-killed-total", total_badguys);
  91   scripting::get_float(vm, "time-needed", time);
  92   scripting::get_int(vm, "secrets-found", secrets);
  93   scripting::get_int(vm, "secrets-found-total", total_secrets);
  94   sq_pop(vm, 1);
  95 }
  96
  97 void
  98 Statistics::draw_worldmap_info(DrawingContext& context, float target_time)
  99 {
 100   // skip draw if level was never played
 101   if (coins == nv_coins) return;
 102
 103   // skip draw if stats were declared invalid
 104   if (!valid) return;
 105
 106   // no sense drawing stats if there are none
 107   if (total_coins + total_badguys + total_secrets == 0) return;
 108
 109   // check to see if screen size has been changed
 110   if (!(WMAP_INFO_TOP_Y1 == SCREEN_HEIGHT - 100)) {
 111     WMAP_INFO_LEFT_X = SCREEN_WIDTH - 32 - 256;
 112     WMAP_INFO_RIGHT_X = WMAP_INFO_LEFT_X + 256;
 113     WMAP_INFO_TOP_Y1 = SCREEN_HEIGHT - 100;
 114     WMAP_INFO_TOP_Y2 = WMAP_INFO_TOP_Y1 + 16;
 115   }
 116
 117   context.draw_text(Resources::small_font, std::string("- ") + _("Best Level Statistics") + " -",
 118                     Vector((WMAP_INFO_LEFT_X + WMAP_INFO_RIGHT_X) / 2, WMAP_INFO_TOP_Y1),
 119                     ALIGN_CENTER, LAYER_HUD,Statistics::header_color);
 120
 121   std::string caption_buf;
 122   std::string stat_buf;
 123   float posy = WMAP_INFO_TOP_Y2;
 124   for (int stat_no = 0; stat_no < 5; stat_no++) {
 125     switch (stat_no)
 126     {
 127       case 0:
 128         caption_buf = _("Max coins collected:");
 129         stat_buf = coins_to_string(coins, total_coins);
 130         break;
 131       case 1:
 132         caption_buf = _("Max fragging:");
 133         stat_buf = frags_to_string(badguys, total_badguys);
 134         break;
 135       case 2:
 136         caption_buf = _("Max secrets found:");
 137         stat_buf = secrets_to_string(secrets, total_secrets);
 138         break;
 139       case 3:
 140         caption_buf = _("Best time completed:");
 141         stat_buf = time_to_string(time);
 142         break;
 143       case 4:
 144         if(target_time){ // display target time only if defined for level
 145           caption_buf = _("Level target time:");
 146           stat_buf = time_to_string(target_time);
 147         } else {
 148           caption_buf = "";
 149           stat_buf = "";
 150         }
 151       default:
 152         log_debug << "Invalid stat requested to be drawn" << std::endl;
 153         break;
 154     }
 155
 156     context.draw_text(Resources::small_font, caption_buf, Vector(WMAP_INFO_LEFT_X, posy), ALIGN_LEFT, LAYER_HUD, Statistics::header_color);
 157     context.draw_text(Resources::small_font, stat_buf, Vector(WMAP_INFO_RIGHT_X, posy), ALIGN_RIGHT, LAYER_HUD, Statistics::header_color);
 158     posy += Resources::small_font->get_height() + 2;
 159   }
 160
 161 }
 162
 163 void
 164 Statistics::draw_endseq_panel(DrawingContext& context, Statistics* best_stats, SurfacePtr backdrop)
 165 {
 166   // skip draw if stats were declared invalid
 167   if (!valid) return;
 168
 169   // abort if we have no backdrop
 170   if (!backdrop) return;
 171
 172   // no sense drawing stats if there are none
 173   if (total_coins + total_badguys + total_secrets == 0) return;
 174
 175   int box_w = 220+110+110;
 176   int box_h = 30+20+20+20;
 177   int box_x = (int)((SCREEN_WIDTH - box_w) / 2);
 178   int box_y = (int)(SCREEN_HEIGHT / 2) - box_h;
 179
 180   int bd_w = (int)backdrop->get_width();
 181   int bd_h = (int)backdrop->get_height();
 182   int bd_x = (int)((SCREEN_WIDTH - bd_w) / 2);
 183   int bd_y = box_y + (box_h / 2) - (bd_h / 2);
 184
 185   int col1_x = box_x;
 186   int col2_x = col1_x+200;
 187   int col3_x = col2_x+130;
 188
 189   int row1_y = box_y;
 190   int row2_y = row1_y+30;
 191   int row3_y = row2_y+20;
 192   int row4_y = row3_y+20;
 193   int row5_y = row4_y+20;
 194
 195   context.push_transform();
 196   context.set_alpha(0.5);
 197   context.draw_surface(backdrop, Vector(bd_x, bd_y), LAYER_HUD);
 198   context.pop_transform();
 199
 200   context.draw_text(Resources::normal_font, _("You"), Vector(col2_x, row1_y), ALIGN_LEFT, LAYER_HUD, Statistics::header_color);
 201   if (best_stats)
 202     context.draw_text(Resources::normal_font, _("Best"), Vector(col3_x, row1_y), ALIGN_LEFT, LAYER_HUD, Statistics::header_color);
 203
 204   context.draw_text(Resources::normal_font, _("Coins"), Vector(col2_x-16, row3_y), ALIGN_RIGHT, LAYER_HUD, Statistics::header_color);
 205   context.draw_text(Resources::normal_font, coins_to_string(coins, total_coins), Vector(col2_x, row3_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
 206   if (best_stats) {
 207     int coins_best = (best_stats->coins > coins) ? best_stats->coins : coins;
 208     int total_coins_best = (best_stats->total_coins > total_coins) ? best_stats->total_coins : total_coins;
 209     context.draw_text(Resources::normal_font, coins_to_string(coins_best, total_coins_best), Vector(col3_x, row3_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
 210   }
 211
 212   context.draw_text(Resources::normal_font, _("Badguys"), Vector(col2_x-16, row4_y), ALIGN_RIGHT, LAYER_HUD, Statistics::header_color);
 213   context.draw_text(Resources::normal_font, frags_to_string(badguys, total_badguys), Vector(col2_x, row4_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
 214   if (best_stats) {
 215         int badguys_best = (best_stats->badguys > badguys) ? best_stats->badguys : badguys;
 216         int total_badguys_best = (best_stats->total_badguys > total_badguys) ? best_stats->total_badguys : total_badguys;
 217         context.draw_text(Resources::normal_font, frags_to_string(badguys_best, total_badguys_best), Vector(col3_x, row4_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
 218   }
 219
 220   context.draw_text(Resources::normal_font, _("Secrets"), Vector(col2_x-16, row5_y), ALIGN_RIGHT, LAYER_HUD, Statistics::header_color);
 221   context.draw_text(Resources::normal_font, secrets_to_string(secrets, total_secrets), Vector(col2_x, row5_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
 222   if (best_stats) {
 223     int secrets_best = (best_stats->secrets > secrets) ? best_stats->secrets : secrets;
 224     int total_secrets_best = (best_stats->total_secrets > total_secrets) ? best_stats->total_secrets : total_secrets;
 225     context.draw_text(Resources::normal_font, secrets_to_string(secrets_best, total_secrets_best), Vector(col3_x, row5_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
 226   }
 227
 228   context.draw_text(Resources::normal_font, _("Time"), Vector(col2_x-16, row2_y), ALIGN_RIGHT, LAYER_HUD, Statistics::header_color);
 229   context.draw_text(Resources::normal_font, time_to_string(time), Vector(col2_x, row2_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
 230   if (best_stats) {
 231     float time_best = (best_stats->time < time) ? best_stats->time : time;
 232     context.draw_text(Resources::normal_font, time_to_string(time_best), Vector(col3_x, row2_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
 233   }
 234 }
 235
 236 void
 237 Statistics::zero()
 238 {
 239   reset();
 240   total_coins = 0;
 241   total_badguys = 0;
 242   total_secrets = 0;
 243 }
 244
 245 void
 246 Statistics::reset()
 247 {
 248   coins = 0;
 249   badguys = 0;
 250   time = 0;
 251   secrets = 0;
 252 }
 253
 254 void
 255 Statistics::merge(const Statistics& s2)
 256 {
 257   if (!s2.valid) return;
 258   coins = std::max(coins, s2.coins);
 259   total_coins = s2.total_coins;
 260   coins = std::min(coins, total_coins);
 261   badguys = std::max(badguys, s2.badguys);
 262   total_badguys = s2.total_badguys;
 263   badguys = std::min(badguys, total_badguys);
 264   time = std::min(time, s2.time);
 265   secrets = std::max(secrets, s2.secrets);
 266   total_secrets = s2.total_secrets;
 267   secrets = std::min(secrets, total_secrets);
 268 }
 269
 270 void
 271 Statistics::operator+=(const Statistics& s2)
 272 {
 273   if (!s2.valid) return;
 274   if (s2.coins != nv_coins) coins += s2.coins;
 275   if (s2.total_coins != nv_coins) total_coins += s2.total_coins;
 276   if (s2.badguys != nv_badguys) badguys += s2.badguys;
 277   if (s2.total_badguys != nv_badguys) total_badguys += s2.total_badguys;
 278   if (s2.time != nv_time) time += s2.time;
 279   if (s2.secrets != nv_secrets) secrets += s2.secrets;
 280   if (s2.total_secrets != nv_secrets) total_secrets += s2.total_secrets;
 281 }
 282
 283 bool
 284 Statistics::completed(const Statistics& stats, const float target_time)
 285 {
 286   return (stats.coins == stats.total_coins &&
 287       stats.badguys == stats.total_badguys &&
 288       stats.secrets == stats.total_secrets &&
 289       ((!target_time) || (stats.time <= target_time)));
 290 }
 291
 292 void
 293 Statistics::declare_invalid()
 294 {
 295   valid = false;
 296 }
 297
 298 std::string
 299 Statistics::coins_to_string(int coins, int total_coins) {
 300   std::ostringstream os;
 301   os << std::min(coins, 999) << "/" << std::min(total_coins, 999);
 302   return os.str();
 303 }
 304
 305 std::string
 306 Statistics::frags_to_string(int badguys, int total_badguys) {
 307   std::ostringstream os;
 308   os << std::min(badguys, 999) << "/" << std::min(total_badguys, 999);
 309   return os.str();
 310 }
 311
 312 std::string
 313 Statistics::time_to_string(float time) {
 314   int time_csecs = std::min(static_cast<int>(time * 100), 99 * 6000 + 9999);
 315   int mins = (time_csecs / 6000);
 316   int secs = (time_csecs % 6000) / 100;
 317   int cscs = (time_csecs % 6000) % 100;
 318
 319   std::ostringstream os;
 320   os << std::setw(2) << std::setfill('0') << mins << ":" << std::setw(2) << std::setfill('0') << secs << "." << std::setw(2) << std::setfill('0') << cscs;
 321   return os.str();
 322 }
 323
 324 std::string
 325 Statistics::secrets_to_string(int secrets, int total_secrets) {
 326   std::ostringstream os;
 327   os << std::min(secrets, 999) << "/" << std::min(total_secrets, 999);
 328   return os.str();
 329 }
 330
 331 /* EOF */