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

OpenTTD Source 14.0-RC3

cargomonitor_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
12 #include "saveload.h"
13 #include "compat/cargomonitor_sl_compat.h"
14
15 #include "../cargomonitor.h"
16
17 #include "../safeguards.h"
18
20 struct TempStorage {
21 CargoMonitorID number;
22 uint32_t amount;
23 };
24
26 static const SaveLoad _cargomonitor_pair_desc[] = {
27 SLE_VAR(TempStorage, number, SLE_UINT32),
28 SLE_VAR(TempStorage, amount, SLE_UINT32),
29 };
30
31 static CargoMonitorID FixupCargoMonitor(CargoMonitorID number)
32 {
33 /* Between SLV_EXTEND_CARGOTYPES and SLV_FIX_CARGO_MONITOR, the
34 * CargoMonitorID structure had insufficient packing for more
35 * than 32 cargo types. Here we have to shuffle bits to account
36 * for the change.
37 * Company moved from bits 24-31 to 25-28.
38 * Cargo type increased from bits 19-23 to 19-24.
39 */
40 SB(number, 25, 4, GB(number, 24, 4));
41 SB(number, 29, 3, 0);
42 ClrBit(number, 24);
43 return number;
44 }
45
47 struct CMDLChunkHandler : ChunkHandler {
48 CMDLChunkHandler() : ChunkHandler('CMDL', CH_TABLE) {}
49
50 void Save() const override
51 {
52 SlTableHeader(_cargomonitor_pair_desc);
53
54 TempStorage storage;
55
56 int i = 0;
57 CargoMonitorMap::const_iterator iter = _cargo_deliveries.begin();
58 while (iter != _cargo_deliveries.end()) {
59 storage.number = iter->first;
60 storage.amount = iter->second;
61
62 SlSetArrayIndex(i);
63 SlObject(&storage, _cargomonitor_pair_desc);
64
65 i++;
66 iter++;
67 }
68 }
69
70 void Load() const override
71 {
72 const std::vector<SaveLoad> slt = SlCompatTableHeader(_cargomonitor_pair_desc, _cargomonitor_pair_sl_compat);
73
74 TempStorage storage;
75 bool fix = IsSavegameVersionBefore(SLV_FIX_CARGO_MONITOR);
76
77 ClearCargoDeliveryMonitoring();
78 for (;;) {
79 if (SlIterateArray() < 0) break;
80 SlObject(&storage, slt);
81
82 if (fix) storage.number = FixupCargoMonitor(storage.number);
83
84 std::pair<CargoMonitorID, uint32_t> p(storage.number, storage.amount);
85 _cargo_deliveries.insert(p);
86 }
87 }
88 };
89
91 struct CMPUChunkHandler : ChunkHandler {
92 CMPUChunkHandler() : ChunkHandler('CMPU', CH_TABLE) {}
93
94 void Save() const override
95 {
96 SlTableHeader(_cargomonitor_pair_desc);
97
98 TempStorage storage;
99
100 int i = 0;
101 CargoMonitorMap::const_iterator iter = _cargo_pickups.begin();
102 while (iter != _cargo_pickups.end()) {
103 storage.number = iter->first;
104 storage.amount = iter->second;
105
106 SlSetArrayIndex(i);
107 SlObject(&storage, _cargomonitor_pair_desc);
108
109 i++;
110 iter++;
111 }
112 }
113
114 void Load() const override
115 {
116 const std::vector<SaveLoad> slt = SlCompatTableHeader(_cargomonitor_pair_desc, _cargomonitor_pair_sl_compat);
117
118 TempStorage storage;
119 bool fix = IsSavegameVersionBefore(SLV_FIX_CARGO_MONITOR);
120
121 ClearCargoPickupMonitoring();
122 for (;;) {
123 if (SlIterateArray() < 0) break;
124 SlObject(&storage, slt);
125
126 if (fix) storage.number = FixupCargoMonitor(storage.number);
127
128 std::pair<CargoMonitorID, uint32_t> p(storage.number, storage.amount);
129 _cargo_pickups.insert(p);
130 }
131 }
132 };
133
135 static const CMDLChunkHandler CMDL;
136 static const CMPUChunkHandler CMPU;
137 static const ChunkHandlerRef cargomonitor_chunk_handlers[] = {
138 CMDL,
139 CMPU,
140 };
141
142 extern const ChunkHandlerTable _cargomonitor_chunk_handlers(cargomonitor_chunk_handlers);
CMDLChunkHandler::Load
void Load() const override
Load the chunk.
Definition: cargomonitor_sl.cpp:70
_cargomonitor_pair_sl_compat
const SaveLoadCompat _cargomonitor_pair_sl_compat[]
Original field order for _cargomonitor_pair_desc.
Definition: cargomonitor_sl_compat.h:16
CMDLChunkHandler
_cargo_deliveries monitoring map.
Definition: cargomonitor_sl.cpp:47
ClearCargoDeliveryMonitoring
void ClearCargoDeliveryMonitoring(CompanyID company)
Clear all delivery cargo monitors.
Definition: cargomonitor.cpp:57
ChunkHandlerRef
std::reference_wrapper< const ChunkHandler > ChunkHandlerRef
A reference to ChunkHandler.
Definition: saveload.h:491
GB
constexpr static debug_inline uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
saveload.h
_cargomonitor_pair_desc
static const SaveLoad _cargomonitor_pair_desc[]
Description of the TempStorage structure for the purpose of load and save.
Definition: cargomonitor_sl.cpp:26
ChunkHandler
Handlers and description of chunk.
Definition: saveload.h:445
IsSavegameVersionBefore
bool IsSavegameVersionBefore(SaveLoadVersion major, byte minor=0)
Checks whether the savegame is below major.
Definition: saveload.h:1215
_cargo_pickups
CargoMonitorMap _cargo_pickups
Map of monitored pick-ups to the amount since last query/activation.
Definition: cargomonitor.cpp:16
CMDLChunkHandler::Save
void Save() const override
Save the chunk.
Definition: cargomonitor_sl.cpp:50
TempStorage
Temporary storage of cargo monitoring data for loading or saving it.
Definition: cargomonitor_sl.cpp:20
CMPUChunkHandler::Save
void Save() const override
Save the chunk.
Definition: cargomonitor_sl.cpp:94
_cargo_deliveries
CargoMonitorMap _cargo_deliveries
Map of monitored deliveries to the amount since last query/activation.
Definition: cargomonitor.cpp:17
SLE_VAR
#define SLE_VAR(base, variable, type)
Storage of a variable in every version of a savegame.
Definition: saveload.h:952
SLV_FIX_CARGO_MONITOR
@ SLV_FIX_CARGO_MONITOR
207 PR#7175 v1.9 Cargo monitor data packing fix to support 64 cargotypes.
Definition: saveload.h:292
ClearCargoPickupMonitoring
void ClearCargoPickupMonitoring(CompanyID company)
Clear all pick-up cargo monitors.
Definition: cargomonitor.cpp:47
ChunkHandlerTable
std::span< const ChunkHandlerRef > ChunkHandlerTable
A table of ChunkHandler entries.
Definition: saveload.h:494
CMPUChunkHandler
_cargo_pickups monitoring map.
Definition: cargomonitor_sl.cpp:91
CMDL
static const CMDLChunkHandler CMDL
Chunk definition of the cargomonitoring maps.
Definition: cargomonitor_sl.cpp:135
SlCompatTableHeader
std::vector< SaveLoad > SlCompatTableHeader(const SaveLoadTable &slt, const SaveLoadCompatTable &slct)
Load a table header in a savegame compatible way.
Definition: saveload.cpp:1852
SB
constexpr T SB(T &x, const uint8_t s, const uint8_t n, const U d)
Set n bits in x starting at bit s to d.
Definition: bitmath_func.hpp:58
SlObject
void SlObject(void *object, const SaveLoadTable &slt)
Main SaveLoad function.
Definition: saveload.cpp:1661
SlTableHeader
std::vector< SaveLoad > SlTableHeader(const SaveLoadTable &slt)
Save or Load a table header.
Definition: saveload.cpp:1714
SaveLoad
SaveLoad type struct.
Definition: saveload.h:697
ClrBit
constexpr T ClrBit(T &x, const uint8_t y)
Clears a bit in a variable.
Definition: bitmath_func.hpp:151
cargomonitor_sl_compat.h
CargoMonitorID
uint32_t CargoMonitorID
Unique number for a company / cargo type / (town or industry).
Definition: cargomonitor.h:19
SlIterateArray
int SlIterateArray()
Iterate through the elements of an array and read the whole thing.
Definition: saveload.cpp:656
CMPUChunkHandler::Load
void Load() const override
Load the chunk.
Definition: cargomonitor_sl.cpp:114