Files
@ r12194:be89dc048e69
Branch filter:
Location: cpp/openttd-patchpack/source/src/newgrf_storage.h - annotation
r12194:be89dc048e69
4.8 KiB
text/x-c
(svn r16618) -Fix (r16614): Silence a warning.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 | r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r8130:bece2e5c7460 r8130:bece2e5c7460 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7610:6031d09c03ef r7610:6031d09c03ef r7610:6031d09c03ef r7610:6031d09c03ef r7610:6031d09c03ef r7610:6031d09c03ef r7610:6031d09c03ef r7610:6031d09c03ef r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7610:6031d09c03ef r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7610:6031d09c03ef r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7610:6031d09c03ef r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7610:6031d09c03ef r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 r7609:2e734c4aad38 | /* $Id$ */
/** @file newgrf_storage.h Functionality related to the temporary and persistent storage arrays for NewGRFs. */
#ifndef NEWGRF_STORAGE_H
#define NEWGRF_STORAGE_H
#include "core/alloc_func.hpp"
/**
* Base class for all NewGRF storage arrays. Nothing fancy, only here
* so we have a generalised class to use.
*/
struct BaseStorageArray
{
/** The needed destructor */
virtual ~BaseStorageArray() {}
/**
* Clear the changes made since the last ClearChanges.
* This can be done in two ways:
* - saving the changes permanently
* - reverting to the previous version
* @param keep_changes do we save or revert the changes since the last ClearChanges?
*/
virtual void ClearChanges(bool keep_changes) = 0;
/**
* Stores some value at a given position.
* @param pos the position to write at
* @param value the value to write
*/
virtual void Store(uint pos, uint32 value) = 0;
};
/**
* Class for persistent storage of data.
* On ClearChanges that data is either reverted or saved.
* @param TYPE the type of variable to store.
* @param SIZE the size of the array.
*/
template <typename TYPE, uint SIZE>
struct PersistentStorageArray : BaseStorageArray {
TYPE storage[SIZE]; ///< Memory to for the storage array
TYPE *prev_storage; ///< Memory to store "old" states so we can revert them on the performance of test cases for commands etc.
/** Simply construct the array */
PersistentStorageArray() : prev_storage(NULL)
{
memset(this->storage, 0, sizeof(this->storage));
}
/** And free all data related to it */
~PersistentStorageArray()
{
free(this->prev_storage);
}
/**
* Stores some value at a given position.
* If there is no backup of the data that backup is made and then
* we write the data.
* @param pos the position to write at
* @param value the value to write
*/
void Store(uint pos, uint32 value)
{
/* Out of the scope of the array */
if (pos >= SIZE) return;
/* The value hasn't changed, so we pretend nothing happened.
* Saves a few cycles and such and it's pretty easy to check. */
if (this->storage[pos] == value) return;
/* We do not have made a backup; lets do so */
if (this->prev_storage != NULL) {
this->prev_storage = MallocT<TYPE>(SIZE);
memcpy(this->prev_storage, this->storage, sizeof(this->storage));
/* We only need to register ourselves when we made the backup
* as that is the only time something will have changed */
AddChangedStorage(this);
}
this->storage[pos] = value;
}
/**
* Gets the value from a given position.
* @param pos the position to get the data from
* @return the data from that position
*/
TYPE Get(uint pos) const
{
/* Out of the scope of the array */
if (pos >= SIZE) return 0;
return this->storage[pos];
}
void ClearChanges(bool keep_changes)
{
assert(this->prev_storage != NULL);
if (!keep_changes) {
memcpy(this->storage, this->prev_storage, sizeof(this->storage));
}
free(this->prev_storage);
}
};
/**
* Class for temporary storage of data.
* On ClearChanges that data is always zero-ed.
* @param TYPE the type of variable to store.
* @param SIZE the size of the array.
*/
template <typename TYPE, uint SIZE>
struct TemporaryStorageArray : BaseStorageArray {
TYPE storage[SIZE]; ///< Memory to for the storage array
/** Simply construct the array */
TemporaryStorageArray()
{
memset(this->storage, 0, sizeof(this->storage));
}
/**
* Stores some value at a given position.
* @param pos the position to write at
* @param value the value to write
*/
void Store(uint pos, uint32 value)
{
/* Out of the scope of the array */
if (pos >= SIZE) return;
this->storage[pos] = value;
AddChangedStorage(this);
}
/**
* Gets the value from a given position.
* @param pos the position to get the data from
* @return the data from that position
*/
TYPE Get(uint pos) const
{
/* Out of the scope of the array */
if (pos >= SIZE) return 0;
return this->storage[pos];
}
void ClearChanges(bool keep_changes)
{
memset(this->storage, 0, sizeof(this->storage));
}
};
/**
* Add the changed storage array to the list of changed arrays.
* This is done so we only have to revert/save the changed
* arrays, which saves quite a few clears, etc. after callbacks.
* @param storage the array that has changed
*/
void AddChangedStorage(BaseStorageArray *storage);
/**
* Clear the changes made since the last ClearStorageChanges.
* This is done for *all* storages that have been registered to with
* AddChangedStorage since the previous ClearStorageChanges.
*
* This can be done in two ways:
* - saving the changes permanently
* - reverting to the previous version
* @param keep_changes do we save or revert the changes since the last ClearChanges?
*/
void ClearStorageChanges(bool keep_changes);
#endif /* NEWGRF_STORAGE_H */
|