highscore.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD 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, version 2.
 * OpenTTD 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 OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */
 
#include "stdafx.h"
#include "highscore.h"
#include "company_base.h"
#include "company_func.h"
#include "cheat_func.h"
#include "fileio_func.h"
#include "string_func.h"
#include "strings_func.h"
#include "debug.h"
 
#include "table/strings.h"
 
#include "safeguards.h"
 
HighScoresTable _highscore_table; 
std::string _highscore_file; 
 
static const StringID _endgame_perf_titles[] = {
  STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
  STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
  STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
  STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
  STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
  STR_HIGHSCORE_PERFORMANCE_TITLE_ENTREPRENEUR,
  STR_HIGHSCORE_PERFORMANCE_TITLE_ENTREPRENEUR,
  STR_HIGHSCORE_PERFORMANCE_TITLE_INDUSTRIALIST,
  STR_HIGHSCORE_PERFORMANCE_TITLE_INDUSTRIALIST,
  STR_HIGHSCORE_PERFORMANCE_TITLE_CAPITALIST,
  STR_HIGHSCORE_PERFORMANCE_TITLE_CAPITALIST,
  STR_HIGHSCORE_PERFORMANCE_TITLE_MAGNATE,
  STR_HIGHSCORE_PERFORMANCE_TITLE_MAGNATE,
  STR_HIGHSCORE_PERFORMANCE_TITLE_MOGUL,
  STR_HIGHSCORE_PERFORMANCE_TITLE_MOGUL,
  STR_HIGHSCORE_PERFORMANCE_TITLE_TYCOON_OF_THE_CENTURY
};
 
StringID EndGameGetPerformanceTitleFromValue(uint value)
{
  value = std::min<uint>(value / 64, lengthof(_endgame_perf_titles) - 1);
 
  return _endgame_perf_titles[value];
}
 
int8_t SaveHighScoreValue(const Company *c)
{
  auto &highscores = _highscore_table[SP_CUSTOM];
  uint16_t score = c->old_economy[0].performance_history;
 
  auto it = std::ranges::find_if(highscores, [&score](auto &highscore) { return highscore.score <= score; });
 
  /* If we cannot find it, our score is not high enough. */
  if (it == highscores.end()) return -1;
 
  /* Move all elements one down starting from the replaced one */
  std::move_backward(it, highscores.end() - 1, highscores.end());
 
  /* Fill the elements. */
  it->name = GetString(STR_HIGHSCORE_NAME, c->index, c->index); // get manager/company name string
  it->score = score;
  it->title = EndGameGetPerformanceTitleFromValue(score);
  return std::distance(highscores.begin(), it);
}
 
static bool HighScoreSorter(const Company * const &a, const Company * const &b)
{
  return b->old_economy[0].performance_history < a->old_economy[0].performance_history;
}
 
int8_t SaveHighScoreValueNetwork()
{
  std::vector<const Company *> cl;
  int8_t local_company_place = -1;
 
  /* Sort all active companies with the highest score first */
  for (const Company *c : Company::Iterate()) cl.push_back(c);
 
  std::ranges::sort(cl, HighScoreSorter);
 
  /* Clear the high scores from the previous network game. */
  auto &highscores = _highscore_table[SP_MULTIPLAYER];
  std::fill(highscores.begin(), highscores.end(), HighScore{});
 
  for (size_t i = 0; i < cl.size() && i < highscores.size(); i++) {
    const Company *c = cl[i];
    auto &highscore = highscores[i];
    highscore.name = GetString(STR_HIGHSCORE_NAME, c->index, c->index); // get manager/company name string
    highscore.score = c->old_economy[0].performance_history;
    highscore.title = EndGameGetPerformanceTitleFromValue(highscore.score);
 
    if (c->index == _local_company) local_company_place = static_cast<int8_t>(i);
  }
 
  return local_company_place;
}
 
void SaveToHighScore()
{
  auto ofp = FileHandle::Open(_highscore_file, "wb");
  if (!ofp.has_value()) return;
  auto &fp = *ofp;
 
  /* Does not iterate through the complete array!. */
  for (int i = 0; i < SP_SAVED_HIGHSCORE_END; i++) {
    for (HighScore &hs : _highscore_table[i]) {
      /* This code is weird and old fashioned to keep compatibility with the old high score files. */
      uint8_t name_length = ClampTo<uint8_t>(hs.name.size());
      if (fwrite(&name_length, sizeof(name_length), 1, fp) != 1 || // Write the string length of the name
          fwrite(hs.name.data(), name_length, 1, fp) > 1 || // Yes... could be 0 bytes too
          fwrite(&hs.score, sizeof(hs.score), 1, fp) != 1 ||
          fwrite("  ", 2, 1, fp) != 1) { // Used to be hs.title, not saved anymore; compatibility
        Debug(misc, 1, "Could not save highscore.");
        return;
      }
    }
  }
}
 
void LoadFromHighScore()
{
  std::fill(_highscore_table.begin(), _highscore_table.end(), HighScores{});
 
  auto ofp = FileHandle::Open(_highscore_file, "rb");
  if (!ofp.has_value()) return;
  auto &fp = *ofp;
 
  /* Does not iterate through the complete array!. */
  for (int i = 0; i < SP_SAVED_HIGHSCORE_END; i++) {
    for (HighScore &hs : _highscore_table[i]) {
      /* This code is weird and old fashioned to keep compatibility with the old high score files. */
      uint8_t name_length;
      char buffer[std::numeric_limits<decltype(name_length)>::max() + 1];
 
      if (fread(&name_length, sizeof(name_length), 1, fp) !=  1 ||
          fread(buffer, name_length, 1, fp) > 1 || // Yes... could be 0 bytes too
          fread(&hs.score, sizeof(hs.score), 1, fp) !=  1 ||
          fseek(fp, 2, SEEK_CUR) == -1) { // Used to be hs.title, not saved anymore; compatibility
        Debug(misc, 1, "Highscore corrupted");
        return;
      }
      hs.name = StrMakeValid(std::string_view(buffer, name_length));
      hs.title = EndGameGetPerformanceTitleFromValue(hs.score);
    }
  }
}