OpenTTD Source 20261112-master-gbcbec5e63f
highscore.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#include "stdafx.h"
11#include "highscore.h"
12#include "company_base.h"
13#include "company_func.h"
14#include "fileio_type.h"
15#include "string_func.h"
16#include "strings_func.h"
17#include "debug.h"
18
19#include "table/strings.h"
20
21#include "safeguards.h"
22
24std::string _highscore_file;
25
26static const StringID _endgame_perf_titles[] = {
27 STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
28 STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
29 STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
30 STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
31 STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
32 STR_HIGHSCORE_PERFORMANCE_TITLE_ENTREPRENEUR,
33 STR_HIGHSCORE_PERFORMANCE_TITLE_ENTREPRENEUR,
34 STR_HIGHSCORE_PERFORMANCE_TITLE_INDUSTRIALIST,
35 STR_HIGHSCORE_PERFORMANCE_TITLE_INDUSTRIALIST,
36 STR_HIGHSCORE_PERFORMANCE_TITLE_CAPITALIST,
37 STR_HIGHSCORE_PERFORMANCE_TITLE_CAPITALIST,
38 STR_HIGHSCORE_PERFORMANCE_TITLE_MAGNATE,
39 STR_HIGHSCORE_PERFORMANCE_TITLE_MAGNATE,
40 STR_HIGHSCORE_PERFORMANCE_TITLE_MOGUL,
41 STR_HIGHSCORE_PERFORMANCE_TITLE_MOGUL,
42 STR_HIGHSCORE_PERFORMANCE_TITLE_TYCOON_OF_THE_CENTURY
43};
44
45StringID EndGameGetPerformanceTitleFromValue(uint value)
46{
47 value = std::min<uint>(value / 64, lengthof(_endgame_perf_titles) - 1);
48
49 return _endgame_perf_titles[value];
50}
51
58{
59 auto &highscores = _highscore_table[SP_CUSTOM];
60 uint16_t score = c->old_economy[0].performance_history;
61
62 auto it = std::ranges::find_if(highscores, [&score](auto &highscore) { return highscore.score <= score; });
63
64 /* If we cannot find it, our score is not high enough. */
65 if (it == highscores.end()) return -1;
66
67 /* Move all elements one down starting from the replaced one */
68 std::move_backward(it, highscores.end() - 1, highscores.end());
69
70 /* Fill the elements. */
71 it->name = GetString(STR_HIGHSCORE_NAME, c->index, c->index); // get manager/company name string
72 it->score = score;
73 it->title = EndGameGetPerformanceTitleFromValue(score);
74 return std::distance(highscores.begin(), it);
75}
76
78static bool HighScoreSorter(const Company * const &a, const Company * const &b)
79{
80 return b->old_economy[0].performance_history < a->old_economy[0].performance_history;
81}
82
88{
89 std::vector<const Company *> cl;
90 int8_t local_company_place = -1;
91
92 /* Sort all active companies with the highest score first */
93 for (const Company *c : Company::Iterate()) cl.push_back(c);
94
95 std::ranges::sort(cl, HighScoreSorter);
96
97 /* Clear the high scores from the previous network game. */
98 auto &highscores = _highscore_table[SP_MULTIPLAYER];
99 std::fill(highscores.begin(), highscores.end(), HighScore{});
100
101 for (size_t i = 0; i < cl.size() && i < highscores.size(); i++) {
102 const Company *c = cl[i];
103 auto &highscore = highscores[i];
104 highscore.name = GetString(STR_HIGHSCORE_NAME, c->index, c->index); // get manager/company name string
105 highscore.score = c->old_economy[0].performance_history;
106 highscore.title = EndGameGetPerformanceTitleFromValue(highscore.score);
107
108 if (c->index == _local_company) local_company_place = static_cast<int8_t>(i);
109 }
110
111 return local_company_place;
112}
113
116{
117 auto ofp = FileHandle::Open(_highscore_file, "wb");
118 if (!ofp.has_value()) return;
119 auto &fp = *ofp;
120
121 /* Does not iterate through the complete array!. */
123 for (HighScore &hs : _highscore_table[i]) {
124 /* This code is weird and old fashioned to keep compatibility with the old high score files. */
125 uint8_t name_length = ClampTo<uint8_t>(hs.name.size());
126 if (fwrite(&name_length, sizeof(name_length), 1, fp) != 1 || // Write the string length of the name
127 fwrite(hs.name.data(), name_length, 1, fp) > 1 || // Yes... could be 0 bytes too
128 fwrite(&hs.score, sizeof(hs.score), 1, fp) != 1 ||
129 fwrite(" ", 2, 1, fp) != 1) { // Used to be hs.title, not saved anymore; compatibility
130 Debug(Facility::Misc, Severity::Error, "Could not save highscore.");
131 return;
132 }
133 }
134 }
135}
136
139{
140 std::fill(_highscore_table.begin(), _highscore_table.end(), HighScores{});
141
142 auto ofp = FileHandle::Open(_highscore_file, "rb");
143 if (!ofp.has_value()) return;
144 auto &fp = *ofp;
145
146 /* Does not iterate through the complete array!. */
148 for (HighScore &hs : _highscore_table[i]) {
149 /* This code is weird and old fashioned to keep compatibility with the old high score files. */
150 uint8_t name_length;
151 char buffer[std::numeric_limits<decltype(name_length)>::max() + 1];
152
153 if (fread(&name_length, sizeof(name_length), 1, fp) != 1 ||
154 fread(buffer, name_length, 1, fp) > 1 || // Yes... could be 0 bytes too
155 fread(&hs.score, sizeof(hs.score), 1, fp) != 1 ||
156 fseek(fp, 2, SEEK_CUR) == -1) { // Used to be hs.title, not saved anymore; compatibility
157 Debug(Facility::Misc, Severity::Error, "Highscore corrupted");
158 return;
159 }
160 hs.name = StrMakeValid(std::string_view(buffer, name_length));
161 hs.title = EndGameGetPerformanceTitleFromValue(hs.score);
162 }
163 }
164}
Iterate a range of enum values.
static std::optional< FileHandle > Open(const std::string &filename, std::string_view mode)
Open an RAII file handle if possible.
Definition fileio.cpp:1218
Definition of stuff that is very close to a company, like the company struct itself.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Functions related to companies.
Functions related to debugging.
#define Debug(facility, severity, format_string,...)
Output a line of debugging information.
Definition debug.h:36
@ Misc
Misc message facility.
Definition debug_type.h:32
@ Error
Error, but we are recovering.
Definition debug_type.h:16
std::string _highscore_file
The file to store the highscore data in.
Definition highscore.cpp:24
Types for standard in/out file operations.
void LoadFromHighScore()
Initialize the highscore table to 0 and if any file exists, load in values.
int8_t SaveHighScoreValueNetwork()
Save the highscores in a network game when it has ended.
Definition highscore.cpp:87
void SaveToHighScore()
Save HighScore table to file.
static bool HighScoreSorter(const Company *const &a, const Company *const &b)
Sort all companies given their performance.
Definition highscore.cpp:78
HighScoresTable _highscore_table
Table with all the high scores.
Definition highscore.cpp:23
int8_t SaveHighScoreValue(const Company *c)
Save the highscore for the company.
Definition highscore.cpp:57
Declaration of functions and types defined in highscore.h and highscore_gui.h.
std::array< HighScores, SP_HIGHSCORE_END > HighScoresTable
Record high score for each of the difficulty levels.
Definition highscore.h:24
std::array< HighScore, 5 > HighScores
Record 5 high scores.
Definition highscore.h:23
constexpr To ClampTo(From value)
Clamp the given value down to lie within the requested type.
A number of safeguards to prevent using unsafe methods.
SettingsProfile
Settings profiles and highscore tables.
@ SP_CUSTOM
No profile, special "custom" highscore.
@ SP_MULTIPLAYER
Special "multiplayer" highscore. Not saved, always specific to the current game.
@ SP_SAVED_HIGHSCORE_END
End of saved highscore tables.
Definition of base types and functions in a cross-platform compatible way.
#define lengthof(array)
Return the length of an fixed size array.
Definition stdafx.h:261
static void StrMakeValid(Builder &builder, StringConsumer &consumer, StringValidationSettings settings)
Copies the valid (UTF-8) characters from consumer to the builder.
Definition string.cpp:118
Functions related to low-level strings.
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:423
Functions related to OTTD's strings.
StrongType::Typedef< uint32_t, struct StringIDTag, StrongType::Compare, StrongType::Integer > StringID
Numeric value that represents a string, independent of the selected language.
std::array< CompanyEconomyEntry, MAX_HISTORY_QUARTERS > old_economy
Economic data of the company of the last MAX_HISTORY_QUARTERS quarters.
static Pool::IterateWrapper< Company > Iterate(size_t from=0)