OpenTTD Source 20241224-master-gf74b0cf984
newgrf_storage.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 "newgrf_storage.h"
12#include "core/pool_func.hpp"
13#include "core/endian_func.hpp"
14#include "debug.h"
15
16#include "safeguards.h"
17
18PersistentStoragePool _persistent_storage_pool("PersistentStorage");
20
21
23
24bool BasePersistentStorageArray::gameloop;
25bool BasePersistentStorageArray::command;
26bool BasePersistentStorageArray::testmode;
27
35
46
54/* static */ void BasePersistentStorageArray::SwitchMode(PersistentStorageMode mode, [[maybe_unused]] bool ignore_prev_mode)
55{
56 switch (mode) {
58 assert(ignore_prev_mode || !gameloop);
59 assert(!command && !testmode);
60 gameloop = true;
61 break;
62
64 assert(ignore_prev_mode || gameloop);
65 assert(!command && !testmode);
66 gameloop = false;
67 break;
68
70 assert((ignore_prev_mode || !command) && !testmode);
71 command = true;
72 break;
73
75 assert(ignore_prev_mode || command);
76 command = false;
77 break;
78
80 assert(!command && (ignore_prev_mode || !testmode));
81 testmode = true;
82 break;
83
85 assert(ignore_prev_mode || testmode);
86 testmode = false;
87 break;
88
89 default: NOT_REACHED();
90 }
91
92 /* Discard all temporary changes */
93 for (auto &it : *_changed_storage_arrays) {
94 Debug(desync, 2, "warning: discarding persistent storage changes: Feature {}, GrfID {:08X}, Tile {}", it->feature, BSWAP32(it->grfid), it->tile);
95 it->ClearChanges();
96 }
98}
static uint32_t BSWAP32(uint32_t x)
Perform a 32 bits endianness bitswap on x.
Functions related to debugging.
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
Definition debug.h:37
Function to handling different endian machines.
void AddChangedPersistentStorage(BasePersistentStorageArray *storage)
Add the changed storage array to the list of changed arrays.
static std::set< BasePersistentStorageArray * > * _changed_storage_arrays
The changed storage arrays.
Functionality related to the temporary and persistent storage arrays for NewGRFs.
PersistentStorageMode
Mode switches to the behaviour of persistent storage array.
@ PSM_ENTER_GAMELOOP
Enter the gameloop, changes will be permanent.
@ PSM_LEAVE_TESTMODE
Leave command test mode, revert to previous mode.
@ PSM_LEAVE_COMMAND
Leave command scope, revert to previous mode.
@ PSM_LEAVE_GAMELOOP
Leave the gameloop, changes will be temporary.
@ PSM_ENTER_COMMAND
Enter command scope, changes will be permanent.
@ PSM_ENTER_TESTMODE
Enter command test mode, changes will be temporary.
Some methods of Pool are placed here in order to reduce compilation time and binary size.
#define INSTANTIATE_POOL_METHODS(name)
Force instantiation of pool methods so we don't get linker errors.
A number of safeguards to prevent using unsafe methods.
Definition of base types and functions in a cross-platform compatible way.
Base class for all persistent NewGRF storage arrays.
static void SwitchMode(PersistentStorageMode mode, bool ignore_prev_mode=false)
Clear temporary changes made since the last call to SwitchMode, and set whether subsequent changes sh...
Class for pooled persistent storage of data.
Base class for all pools.
Definition pool_type.hpp:80