supertux/src/supertux/statistics.cpp

//  SuperTux (Statistics module)
//  Copyright (C) 2004 Ricardo Cruz <rick2@aeiou.pt>
//  Copyright (C) 2006 Ondrej Hosek <ondra.hosek@gmail.com>
//  Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
//
//  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 3 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program.  If not, see <http://www.gnu.org/licenses/>.

#include "supertux/statistics.hpp"

#include <algorithm>
#include <iomanip>
#include <limits>

#include "audio/sound_manager.hpp"
#include "math/util.hpp"
#include "squirrel/squirrel_util.hpp"
#include "supertux/globals.hpp"
#include "supertux/level.hpp"
#include "supertux/resources.hpp"
#include "util/gettext.hpp"
#include "util/log.hpp"
#include "video/drawing_context.hpp"
#include "video/surface.hpp"
#include "video/video_system.hpp"
#include "video/viewport.hpp"

Statistics::Statistics() :
  m_status(INVALID),
  m_total_coins(),
  m_total_badguys(),
  m_total_secrets(),
  m_coins(),
  m_badguys(),
  m_secrets(),
  m_time(),
  m_cleared_coins(false),
  m_cleared_badguys(false),
  m_cleared_secrets(false),
  m_coins_time(0.f),
  m_badguys_time(0.f),
  m_secrets_time(0.f),
  m_max_width(256),
  CAPTION_MAX_COINS(_("Max coins collected:")),
  CAPTION_MAX_FRAGGING(_("Max fragging:")),
  CAPTION_MAX_SECRETS(_("Max secrets found:")),
  CAPTION_BEST_TIME(_("Best time completed:")),
  CAPTION_TARGET_TIME(_("Level target time:")),
  WMAP_INFO_LEFT_X(),
  WMAP_INFO_RIGHT_X(),
  WMAP_INFO_TOP_Y1(),
  WMAP_INFO_TOP_Y2(),
  coin_icon(Surface::from_file("/images/engine/hud/coin-icon.png")),
  badguy_icon(Surface::from_file("/images/engine/hud/badguy-icon.png")),
  secret_icon(Surface::from_file("/images/engine/hud/secret-icon.png"))
{
  calculate_max_caption_length();
  WMAP_INFO_LEFT_X = static_cast<float>(SCREEN_WIDTH) - 32.0f - static_cast<float>(m_max_width);
  WMAP_INFO_RIGHT_X = WMAP_INFO_LEFT_X + static_cast<float>(m_max_width);
  WMAP_INFO_TOP_Y1 = static_cast<float>(SCREEN_HEIGHT) - 100.0f;
  WMAP_INFO_TOP_Y2 = WMAP_INFO_TOP_Y1 + 16.0f;
}

void
Statistics::calculate_max_caption_length()
{
  auto captions = {CAPTION_MAX_COINS, CAPTION_MAX_FRAGGING, CAPTION_MAX_SECRETS,
                   CAPTION_BEST_TIME, CAPTION_TARGET_TIME};

  m_max_width = 256;

  for (const auto& caption : captions)
  {
    auto font = Resources::small_font;
    // Add padding the size of lengthiest string:
    auto width = font->get_text_width(caption) +
                 font->get_text_width("XX:XX:XX");
    if (width >= static_cast<float>(m_max_width))
    {
      m_max_width = static_cast<int>(width);
    }
  }
}

void
Statistics::serialize_to_squirrel(SquirrelVM& vm) const
{
  if (m_status != FINAL) return;

  vm.begin_table("statistics");
  vm.store_int("coins-collected", m_coins);
  vm.store_int("badguys-killed", m_badguys);
  vm.store_int("secrets-found", m_secrets);
  vm.store_float("time-needed", m_time);
  vm.store_int("coins-collected-total", m_total_coins);
  vm.store_int("badguys-killed-total", m_total_badguys);
  vm.store_int("secrets-found-total", m_total_secrets);
  vm.end_table("statistics");
}

void
Statistics::unserialize_from_squirrel(SquirrelVM& vm)
{
  try
  {
    vm.get_table_entry("statistics");
    vm.get_int("coins-collected", m_coins);
    vm.get_int("badguys-killed", m_badguys);
    vm.get_int("secrets-found", m_secrets);
    vm.get_float("time-needed", m_time);
    vm.get_int("coins-collected-total", m_total_coins);
    vm.get_int("badguys-killed-total", m_total_badguys);
    vm.get_int("secrets-found-total", m_total_secrets);
    sq_pop(vm.get_vm(), 1);

    m_status = FINAL;
  }
  catch(const std::exception&)
  {
    // ignore non-existing or malformed statistics table
  }
}

void
Statistics::draw_worldmap_info(DrawingContext& context, float target_time)
{
  if (m_status != FINAL) return;

  // check to see if screen size has been changed
  if (!(WMAP_INFO_TOP_Y1 == static_cast<float>(SCREEN_HEIGHT - 100))) {
    calculate_max_caption_length();
    WMAP_INFO_LEFT_X = context.get_width() - 32.f - static_cast<float>(m_max_width);
    WMAP_INFO_RIGHT_X = WMAP_INFO_LEFT_X + static_cast<float>(m_max_width);
    WMAP_INFO_TOP_Y1 = static_cast<float>(SCREEN_HEIGHT - 100);
    WMAP_INFO_TOP_Y2 = WMAP_INFO_TOP_Y1 + 16;
  }

  context.color().draw_text(
    Resources::small_font, "- " + _("Best Level Statistics") + " -",
    Vector((WMAP_INFO_LEFT_X + WMAP_INFO_RIGHT_X) / 2, WMAP_INFO_TOP_Y1),
    ALIGN_CENTER, LAYER_HUD,Statistics::header_color);

  std::string caption_buf;
  std::string stat_buf;
  float posy = WMAP_INFO_TOP_Y2;
  Color tcolor;

  for (int stat_no = 0; stat_no < 5; stat_no++) {
    tcolor = Statistics::header_color;
    switch (stat_no)
    {
      case 0:
        caption_buf = CAPTION_MAX_COINS;
        stat_buf = coins_to_string(m_coins, m_total_coins);
        if (m_coins >= m_total_coins)
          tcolor = Statistics::perfect_color;
        break;
      case 1:
        caption_buf = CAPTION_MAX_FRAGGING;
        stat_buf = frags_to_string(m_badguys, m_total_badguys);
        if (m_badguys >= m_total_badguys)
          tcolor = Statistics::perfect_color;
        break;
      case 2:
        caption_buf = CAPTION_MAX_SECRETS;
        stat_buf = secrets_to_string(m_secrets, m_total_secrets);
        if (m_secrets >= m_total_secrets)
          tcolor = Statistics::perfect_color;
        break;
      case 3:
        caption_buf = CAPTION_BEST_TIME;
        stat_buf = time_to_string(m_time);
        if ((m_time < target_time) || (target_time == 0.0f))
          tcolor = Statistics::perfect_color;
        break;
      case 4:
        if (target_time != 0.0f) { // display target time only if defined for level
          caption_buf = CAPTION_TARGET_TIME;
          stat_buf = time_to_string(target_time);
          if ((m_time < target_time) || (target_time == 0.0f))
            tcolor = Statistics::perfect_color;
        } else {
          caption_buf = "";
          stat_buf = "";
        }
        break;
      default:
        log_debug << "Invalid stat requested to be drawn" << std::endl;
        break;
    }

    context.color().draw_text(Resources::small_font, caption_buf, Vector(WMAP_INFO_LEFT_X, posy), ALIGN_LEFT, LAYER_HUD, Statistics::header_color);
    context.color().draw_text(Resources::small_font, stat_buf, Vector(WMAP_INFO_RIGHT_X, posy), ALIGN_RIGHT, LAYER_HUD, tcolor);
    posy += Resources::small_font->get_height() + 2;
  }
}

void
Statistics::draw_endseq_panel(DrawingContext& context, Statistics* best_stats, const SurfacePtr& backdrop, float target_time)
{
  if (m_status != FINAL) return;

  int box_w = 220+110+110;
  int box_h = 30+20+20+20;
  int box_x = static_cast<int>((static_cast<int>(context.get_width()) - box_w) / 2);
  int box_y = static_cast<int>(SCREEN_HEIGHT / 2) - box_h;

  int bd_w = static_cast<int>(backdrop->get_width());
  int bd_h = static_cast<int>(backdrop->get_height());
  int bd_x = static_cast<int>((static_cast<int>(context.get_width()) - bd_w) / 2);
  int bd_y = box_y + (box_h / 2) - (bd_h / 2);

  float col1_x = static_cast<float>(box_x);
  float col2_x = col1_x + 200.0f;
  float col3_x = col2_x + 130.0f;

  float row1_y = static_cast<float>(box_y);
  float row2_y = row1_y + 30.0f;
  float row3_y = row2_y + 20.0f;
  float row4_y = row3_y + 20.0f;
  float row5_y = row4_y + 20.0f;

  context.push_transform();
  context.set_alpha(0.5f);
  context.color().draw_surface(backdrop, Vector(static_cast<float>(bd_x), static_cast<float>(bd_y)), LAYER_HUD);
  context.pop_transform();

  context.color().draw_text(Resources::normal_font, _("You"), Vector(col2_x, row1_y), ALIGN_LEFT, LAYER_HUD, Statistics::header_color);
  if (best_stats)
    context.color().draw_text(Resources::normal_font, _("Best"), Vector(col3_x, row1_y), ALIGN_LEFT, LAYER_HUD, Statistics::header_color);

  context.color().draw_text(Resources::normal_font, _("Coins"), Vector(col2_x - 16.0f, static_cast<float>(row3_y)), ALIGN_RIGHT, LAYER_HUD, Statistics::header_color);

  Color tcolor;
  if (m_coins >= m_total_coins)
    tcolor = Statistics::perfect_color;
  else
    tcolor = Statistics::text_color;
  context.color().draw_text(Resources::normal_font, coins_to_string(m_coins, m_total_coins), Vector(col2_x, static_cast<float>(row3_y)), ALIGN_LEFT, LAYER_HUD, tcolor);

  if (best_stats) {
    int coins_best = (best_stats->m_coins > m_coins) ? best_stats->m_coins : m_coins;
    int total_coins_best = (best_stats->m_total_coins > m_total_coins) ? best_stats->m_total_coins : m_total_coins;
    if (coins_best >= total_coins_best)
      tcolor = Statistics::perfect_color;
    else
      tcolor = Statistics::text_color;
    context.color().draw_text(Resources::normal_font, coins_to_string(coins_best, total_coins_best), Vector(col3_x, static_cast<float>(row3_y)), ALIGN_LEFT, LAYER_HUD, tcolor);
  }

  if (m_badguys >= m_total_badguys)
    tcolor = Statistics::perfect_color;
  else
    tcolor = Statistics::text_color;
  context.color().draw_text(Resources::normal_font, _("Badguys"), Vector(col2_x - 16.0f, static_cast<float>(row4_y)), ALIGN_RIGHT, LAYER_HUD, Statistics::header_color);
  context.color().draw_text(Resources::normal_font, frags_to_string(m_badguys, m_total_badguys), Vector(col2_x, static_cast<float>(row4_y)), ALIGN_LEFT, LAYER_HUD, tcolor);
  if (best_stats) {
	int badguys_best = (best_stats->m_badguys > m_badguys) ? best_stats->m_badguys : m_badguys;
	int total_badguys_best = (best_stats->m_total_badguys > m_total_badguys) ? best_stats->m_total_badguys : m_total_badguys;
        if (badguys_best >= total_badguys_best)
          tcolor = Statistics::perfect_color;
        else
          tcolor = Statistics::text_color;
	context.color().draw_text(Resources::normal_font, frags_to_string(badguys_best, total_badguys_best), Vector(col3_x, row4_y), ALIGN_LEFT, LAYER_HUD, tcolor);
  }

  if (m_secrets >= m_total_secrets)
    tcolor = Statistics::perfect_color;
  else
    tcolor = Statistics::text_color;
  context.color().draw_text(Resources::normal_font, _("Secrets"), Vector(col2_x-16, row5_y), ALIGN_RIGHT, LAYER_HUD, Statistics::header_color);
  context.color().draw_text(Resources::normal_font, secrets_to_string(m_secrets, m_total_secrets), Vector(col2_x, row5_y), ALIGN_LEFT, LAYER_HUD, tcolor);
  if (best_stats) {
    int secrets_best = (best_stats->m_secrets > m_secrets) ? best_stats->m_secrets : m_secrets;
    int total_secrets_best = (best_stats->m_total_secrets > m_total_secrets) ? best_stats->m_total_secrets : m_total_secrets;
    if (secrets_best >= total_secrets_best)
      tcolor = Statistics::perfect_color;
    else
      tcolor = Statistics::text_color;
    context.color().draw_text(Resources::normal_font, secrets_to_string(secrets_best, total_secrets_best), Vector(col3_x, row5_y), ALIGN_LEFT, LAYER_HUD, tcolor);
  }

  tcolor = Statistics::text_color;
  if (target_time == 0.0f || (m_time != 0.0f && m_time < target_time))
    tcolor = Statistics::perfect_color;

  context.color().draw_text(Resources::normal_font, _("Time"), Vector(col2_x - 16, row2_y), ALIGN_RIGHT, LAYER_HUD, Statistics::header_color);
  context.color().draw_text(Resources::normal_font, time_to_string(m_time), Vector(col2_x, row2_y), ALIGN_LEFT, LAYER_HUD, tcolor);
  if (best_stats) {
    float time_best = (best_stats->m_time < m_time && best_stats->m_time > 0.0f) ? best_stats->m_time : m_time;
    if (target_time == 0.0f || (time_best != 0.0f && time_best < target_time))
      tcolor = Statistics::perfect_color;
    else
      tcolor = Statistics::text_color;
    context.color().draw_text(Resources::normal_font, time_to_string(time_best), Vector(col3_x, row2_y), ALIGN_LEFT, LAYER_HUD, tcolor);
  }
}

void
Statistics::draw_ingame_stats(DrawingContext& context, bool on_pause_menu)
{
  if (on_pause_menu || (m_cleared_coins && m_coins_time < 5.f))
  {
    std::string text(coins_to_string(m_coins, m_total_coins));
    float width = Resources::normal_font->get_text_width(text),
          height = Resources::normal_font->get_height(),
          x_offset = width + 75.f;

    if (!on_pause_menu)
      x_offset *= std::min(1.f, -std::abs(m_coins_time - 2.5f) + 2.5f);

    Vector pos(context.get_width() - x_offset,
               context.get_height() - height * 6.f - 20.f - 16.f);

    context.color().draw_filled_rect(Rectf(pos.x, pos.y, pos.x + width + 37.f,
                                           pos.y + height).grown(5.f),
                                     Color(0.f, 0.f, 0.f, 0.5f),
                                     10.f, LAYER_HUD - 1);
    context.color().draw_text(Resources::normal_font, text, pos,
                              FontAlignment::ALIGN_LEFT, LAYER_HUD,
                              (m_coins < m_total_coins)
                                    ? Statistics::text_color
                                    : Statistics::perfect_color
                              );
    context.color().draw_surface_scaled(coin_icon,
                                        Rectf(Vector(pos.x + width + 3.f, pos.y - 5.f), Sizef(32.f, 32.f)),
                                        LAYER_HUD);
  }

  if (on_pause_menu || (m_cleared_badguys && m_badguys_time < 5.f))
  {
    std::string text(frags_to_string(m_badguys, m_total_badguys));
    float width = Resources::normal_font->get_text_width(text),
          height = Resources::normal_font->get_height(),
          x_offset = width + 75.f;

    if (!on_pause_menu)
      x_offset *= std::min(1.f, -std::abs(m_badguys_time - 2.5f) + 2.5f);

    Vector pos(context.get_width() - x_offset,
               context.get_height() - height * 5.f - 10.f - 8.f);

    context.color().draw_filled_rect(Rectf(pos.x, pos.y, pos.x + width + 37.f,
                                           pos.y + height).grown(5.f),
                                     Color(0.f, 0.f, 0.f, 0.5f),
                                     10.f, LAYER_HUD - 1);
    context.color().draw_text(Resources::normal_font, text, pos,
                              FontAlignment::ALIGN_LEFT, LAYER_HUD,
                              (m_badguys < m_total_badguys)
                                    ? Statistics::text_color
                                    : Statistics::perfect_color
                              );
    context.color().draw_surface_scaled(badguy_icon,
                                        Rectf(Vector(pos.x + width + 3.f, pos.y - 5.f), Sizef(32.f, 32.f)),
                                        LAYER_HUD);
  }

  if (on_pause_menu || (m_cleared_secrets && m_secrets_time < 5.f))
  {
    std::string text(secrets_to_string(m_secrets, m_total_secrets));
    float width = Resources::normal_font->get_text_width(text),
          height = Resources::normal_font->get_height(),
          x_offset = width + 75.f;

    if (!on_pause_menu)
      x_offset *= std::min(1.f, -std::abs(m_secrets_time - 2.5f) + 2.5f);

    Vector pos(context.get_width() - x_offset,
               context.get_height() - height * 4.f);

    context.color().draw_filled_rect(Rectf(pos.x, pos.y, pos.x + width + 37.f,
                                           pos.y + height).grown(5.f),
                                     Color(0.f, 0.f, 0.f, 0.5f),
                                     10.f, LAYER_HUD - 1);
    context.color().draw_text(Resources::normal_font, text, pos,
                              FontAlignment::ALIGN_LEFT, LAYER_HUD,
                              (m_secrets < m_total_secrets)
                                    ? Statistics::text_color
                                    : Statistics::perfect_color
                              );
    context.color().draw_surface_scaled(secret_icon,
                                        Rectf(Vector(pos.x + width + 3.f, pos.y - 5.f), Sizef(32.f, 32.f)),
                                        LAYER_HUD);
  }
}

void
Statistics::update_timers(float dt_sec)
{
  if (m_cleared_coins)
    m_coins_time += dt_sec;

  if (m_cleared_badguys)
    m_badguys_time += dt_sec;

  if (m_cleared_secrets)
    m_secrets_time += dt_sec;
}

void
Statistics::init(const Level& level)
{
  m_status = ACCUMULATING;

  m_coins = 0;
  m_badguys = 0;
  m_secrets = 0;

  m_total_coins = level.get_total_coins();
  m_total_badguys = level.get_total_badguys();
  m_total_secrets = level.get_total_secrets();
}

void
Statistics::finish(float time)
{
  m_status = FINAL;
  m_time = time;
}

void
Statistics::invalidate()
{
  m_status = INVALID;
}

void
Statistics::update(const Statistics& other)
{
  if (other.m_status != FINAL) return;

  m_coins = std::max(m_coins, other.m_coins);
  m_badguys = std::max(m_badguys, other.m_badguys);
  m_secrets = std::max(m_secrets, other.m_secrets);
  if (m_time == 0)
    m_time = other.m_time;
  else
    m_time = std::min(m_time, other.m_time);

  m_total_coins = other.m_total_coins;
  m_total_badguys = other.m_total_badguys;
  m_total_secrets = other.m_total_secrets;

  m_coins = math::clamp(m_coins, 0, m_total_coins);
  m_badguys = math::clamp(m_badguys, 0, m_total_badguys);
  m_secrets = math::clamp(m_secrets, 0, m_total_secrets);
  m_status = FINAL;
}

bool
Statistics::completed(const Statistics& stats, const float target_time) const
{
  return (stats.m_coins == stats.m_total_coins &&
          stats.m_badguys == stats.m_total_badguys &&
          stats.m_secrets == stats.m_total_secrets &&
          ((target_time == 0.0f) || (stats.m_time <= target_time)));
}

std::string
Statistics::coins_to_string(int coins, int total_coins)
{
  std::ostringstream os;
  os << std::min(std::min(coins, total_coins), 999) << "/" << std::min(total_coins, 999);
  return os.str();
}

std::string
Statistics::frags_to_string(int badguys, int total_badguys)
{
  std::ostringstream os;
  os << std::min(std::min(badguys, total_badguys), 999) << "/" << std::min(total_badguys, 999);
  return os.str();
}

std::string
Statistics::time_to_string(float time)
{
  std::ostringstream os;
  if (time == 0.0f)
  {
    os << "--:--:--";
  }
  else
  {
    int time_csecs = static_cast<int>(time * 100);
    int mins = (time_csecs / 6000);
    int secs = (time_csecs % 6000) / 100;
    int cscs = (time_csecs % 6000) % 100;
    os << std::setw(2) << std::setfill('0') << mins << ":" << std::setw(2) << std::setfill('0') << secs << "." << std::setw(2) << std::setfill('0') << cscs;
  }

  return os.str();
}

void
Statistics::check_coins()
{
  if (m_cleared_coins)
    return;

  if (m_coins >= m_total_coins)
  {
    m_cleared_coins = true;
    SoundManager::current()->play("/sounds/coins_cleared.ogg", 0.5f);
  }
}

void
Statistics::check_badguys()
{
  if (m_cleared_badguys)
    return;

  if (m_badguys >= m_total_badguys)
  {
    m_cleared_badguys = true;
    SoundManager::current()->play("/sounds/retro_fall.wav", 0.5f);
  }
}

void
Statistics::check_secrets()
{
  if (m_cleared_secrets)
    return;

  if (m_secrets >= m_total_secrets)
  {
    m_cleared_secrets = true;
    SoundManager::current()->play("/sounds/tada.ogg", 0.5f);
  }
}

std::string
Statistics::secrets_to_string(int secrets, int total_secrets)
{
  std::ostringstream os;
  os << std::min(secrets, 999) << "/" << std::min(total_secrets, 999);
  return os.str();
}

/* EOF */