OpenTTD Source: src/saveload/strings_sl.cpp Source File

OpenTTD Source 13.2.1

strings_sl.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 <http://www.gnu.org/licenses/>.
6 */
7
10 #include "../stdafx.h"
11 #include "../string_func.h"
12 #include "../strings_func.h"
13 #include "saveload_internal.h"
14 #include <sstream>
15
16 #include "table/strings.h"
17
18 #include "../safeguards.h"
19
20 static const int NUM_OLD_STRINGS = 512;
21 static const int LEN_OLD_STRINGS = 32;
22 static const int LEN_OLD_STRINGS_TTO = 24;
23
29 StringID RemapOldStringID(StringID s)
30 {
31 switch (s) {
32 case 0x0006: return STR_SV_EMPTY;
33 case 0x7000: return STR_SV_UNNAMED;
34 case 0x70E4: return SPECSTR_COMPANY_NAME_START;
35 case 0x70E9: return SPECSTR_COMPANY_NAME_START;
36 case 0x8864: return STR_SV_TRAIN_NAME;
37 case 0x902B: return STR_SV_ROAD_VEHICLE_NAME;
38 case 0x9830: return STR_SV_SHIP_NAME;
39 case 0xA02F: return STR_SV_AIRCRAFT_NAME;
40
41 default:
42 if (IsInsideMM(s, 0x300F, 0x3030)) {
43 return s - 0x300F + STR_SV_STNAME;
44 } else {
45 return s;
46 }
47 }
48 }
49
51 char *_old_name_array = nullptr;
52
60 std::string CopyFromOldName(StringID id)
61 {
62 /* Is this name an (old) custom name? */
63 if (GetStringTab(id) != TEXT_TAB_OLD_CUSTOM) return std::string();
64
65 if (IsSavegameVersionBefore(SLV_37)) {
66 uint offs = _savegame_type == SGT_TTO ? LEN_OLD_STRINGS_TTO * GB(id, 0, 8) : LEN_OLD_STRINGS * GB(id, 0, 9);
67 const char *strfrom = &_old_name_array[offs];
68
69 std::ostringstream tmp;
70 std::ostreambuf_iterator<char> strto(tmp);
71 for (; *strfrom != '\0'; strfrom++) {
72 WChar c = (byte)*strfrom;
73
74 /* Map from non-ISO8859-15 characters to UTF-8. */
75 switch (c) {
76 case 0xA4: c = 0x20AC; break; // Euro
77 case 0xA6: c = 0x0160; break; // S with caron
78 case 0xA8: c = 0x0161; break; // s with caron
79 case 0xB4: c = 0x017D; break; // Z with caron
80 case 0xB8: c = 0x017E; break; // z with caron
81 case 0xBC: c = 0x0152; break; // OE ligature
82 case 0xBD: c = 0x0153; break; // oe ligature
83 case 0xBE: c = 0x0178; break; // Y with diaeresis
84 default: break;
85 }
86
87 Utf8Encode(strto, c);
88 }
89
90 return tmp.str();
91 } else {
92 /* Name will already be in UTF-8. */
93 return std::string(&_old_name_array[LEN_OLD_STRINGS * GB(id, 0, 9)]);
94 }
95 }
96
101 void ResetOldNames()
102 {
103 free(_old_name_array);
104 _old_name_array = nullptr;
105 }
106
110 void InitializeOldNames()
111 {
112 free(_old_name_array);
113 _old_name_array = CallocT<char>(NUM_OLD_STRINGS * LEN_OLD_STRINGS); // 200 * 24 would be enough for TTO savegames
114 }
115
116 struct NAMEChunkHandler : ChunkHandler {
117 NAMEChunkHandler() : ChunkHandler('NAME', CH_READONLY) {}
118
119 void Load() const override
120 {
121 int index;
122
123 while ((index = SlIterateArray()) != -1) {
124 if (index >= NUM_OLD_STRINGS) SlErrorCorrupt("Invalid old name index");
125 if (SlGetFieldLength() > (uint)LEN_OLD_STRINGS) SlErrorCorrupt("Invalid old name length");
126
127 SlCopy(&_old_name_array[LEN_OLD_STRINGS * index], SlGetFieldLength(), SLE_UINT8);
128 /* Make sure the old name is null terminated */
129 _old_name_array[LEN_OLD_STRINGS * index + LEN_OLD_STRINGS - 1] = '\0';
130 }
131 }
132 };
133
134 static const NAMEChunkHandler NAME;
135 static const ChunkHandlerRef name_chunk_handlers[] = {
136 NAME,
137 };
138
139 extern const ChunkHandlerTable _name_chunk_handlers(name_chunk_handlers);
IsInsideMM
static constexpr bool IsInsideMM(const T x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
Definition: math_func.hpp:230
GetStringTab
static StringTab GetStringTab(StringID str)
Extract the StringTab from a StringID.
Definition: strings_func.h:23
WChar
char32_t WChar
Type for wide characters, i.e.
Definition: string_type.h:36
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
NAMEChunkHandler::Load
void Load() const override
Load the chunk.
Definition: strings_sl.cpp:119
ChunkHandlerRef
std::reference_wrapper< const ChunkHandler > ChunkHandlerRef
A reference to ChunkHandler.
Definition: saveload.h:449
SlCopy
void SlCopy(void *object, size_t length, VarType conv)
Copy a list of SL_VARs to/from a savegame.
Definition: saveload.cpp:1152
Utf8Encode
size_t Utf8Encode(T buf, WChar c)
Encode a unicode character and place it in the buffer.
Definition: string.cpp:635
ChunkHandler
Handlers and description of chunk.
Definition: saveload.h:412
CopyFromOldName
std::string CopyFromOldName(StringID id)
Copy and convert old custom names to UTF-8.
Definition: strings_sl.cpp:60
_savegame_type
SavegameType _savegame_type
type of savegame we are loading
Definition: saveload.cpp:62
InitializeOldNames
void InitializeOldNames()
Initialize the old names table memory.
Definition: strings_sl.cpp:110
span
A trimmed down version of what std::span will be in C++20.
Definition: span_type.hpp:60
CH_READONLY
@ CH_READONLY
Chunk is never saved.
Definition: saveload.h:408
SGT_TTO
@ SGT_TTO
TTO savegame.
Definition: saveload.h:378
IsSavegameVersionBefore
static bool IsSavegameVersionBefore(SaveLoadVersion major, byte minor=0)
Checks whether the savegame is below major.
Definition: saveload.h:1030
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
SlGetFieldLength
size_t SlGetFieldLength()
Get the length of the current object.
Definition: saveload.cpp:793
SlErrorCorrupt
void NORETURN SlErrorCorrupt(const char *msg)
Error handler for corrupt savegames.
Definition: saveload.cpp:365
_old_name_array
char * _old_name_array
Location to load the old names to.
Definition: strings_sl.cpp:51
NUM_OLD_STRINGS
static const int NUM_OLD_STRINGS
The number of custom strings stored in old savegames.
Definition: strings_sl.cpp:20
saveload_internal.h
RemapOldStringID
StringID RemapOldStringID(StringID s)
Remap a string ID from the old format to the new format.
Definition: strings_sl.cpp:29
LEN_OLD_STRINGS_TTO
static const int LEN_OLD_STRINGS_TTO
The number of characters per string in TTO savegames.
Definition: strings_sl.cpp:22
free
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: stdafx.h:470
NAMEChunkHandler
Definition: strings_sl.cpp:116
LEN_OLD_STRINGS
static const int LEN_OLD_STRINGS
The number of characters per string.
Definition: strings_sl.cpp:21
SlIterateArray
int SlIterateArray()
Iterate through the elements of an array and read the whole thing.
Definition: saveload.cpp:671
SLV_37
@ SLV_37
37 7182
Definition: saveload.h:91
ResetOldNames
void ResetOldNames()
Free the memory of the old names array.
Definition: strings_sl.cpp:101