OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

newgrf_spritegroup.cpp
Go to the documentation of this file.
1 /* $Id: newgrf_spritegroup.cpp 27928 2017-10-25 15:38:14Z frosch $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
9
12 #include "stdafx.h"
13 #include "debug.h"
14 #include "newgrf_spritegroup.h"
15 #include "core/pool_func.hpp"
16
17 #include "safeguards.h"
18
19 SpriteGroupPool _spritegroup_pool("SpriteGroup");
20 INSTANTIATE_POOL_METHODS(SpriteGroup)
21
22 TemporaryStorageArray<int32, 0x110> _temp_store;
23
24
35 /* static */ const SpriteGroup *SpriteGroup::Resolve(const SpriteGroup *group, ResolverObject &object, bool top_level)
36 {
37 if (group == NULL) return NULL;
38 if (top_level) {
39 _temp_store.ClearChanges();
40 }
41 return group->Resolve(object);
42 }
43
44 RealSpriteGroup::~RealSpriteGroup()
45 {
46 free(this->loaded);
47 free(this->loading);
48 }
49
50 DeterministicSpriteGroup::~DeterministicSpriteGroup()
51 {
52 free(this->adjusts);
53 free(this->ranges);
54 }
55
56 RandomizedSpriteGroup::~RandomizedSpriteGroup()
57 {
58 free(this->groups);
59 }
60
61 static inline uint32 GetVariable(const ResolverObject &object, ScopeResolver *scope, byte variable, uint32 parameter, bool *available)
62 {
63 /* First handle variables common with Action7/9/D */
64 uint32 value;
65 if (GetGlobalVariable(variable, &value, object.grffile)) return value;
66
67 /* Non-common variable */
68 switch (variable) {
69 case 0x0C: return object.callback;
70 case 0x10: return object.callback_param1;
71 case 0x18: return object.callback_param2;
72 case 0x1C: return object.last_value;
73
74 case 0x5F: return (scope->GetRandomBits() << 8) | scope->GetTriggers();
75
76 case 0x7D: return _temp_store.GetValue(parameter);
77
78 case 0x7F:
79 if (object.grffile == NULL) return 0;
80 return object.grffile->GetParam(parameter);
81
82 /* Not a common variable, so evaluate the feature specific variables */
83 default: return scope->GetVariable(variable, parameter, available);
84 }
85 }
86
87 ScopeResolver::ScopeResolver(ResolverObject &ro)
88 : ro(ro)
89 {
90 }
91
92 ScopeResolver::~ScopeResolver() {}
93
98 /* virtual */ uint32 ScopeResolver::GetRandomBits() const
99 {
100 return 0;
101 }
102
107 /* virtual */ uint32 ScopeResolver::GetTriggers() const
108 {
109 return 0;
110 }
111
119 /* virtual */ uint32 ScopeResolver::GetVariable(byte variable, uint32 parameter, bool *available) const
120 {
121 DEBUG(grf, 1, "Unhandled scope variable 0x%X", variable);
122 *available = false;
123 return UINT_MAX;
124 }
125
131 /* virtual */ void ScopeResolver::StorePSA(uint reg, int32 value) {}
132
140 ResolverObject::ResolverObject(const GRFFile *grffile, CallbackID callback, uint32 callback_param1, uint32 callback_param2)
141 : default_scope(*this)
142 {
143 this->callback = callback;
144 this->callback_param1 = callback_param1;
145 this->callback_param2 = callback_param2;
146 this->ResetState();
147
148 this->grffile = grffile;
149 this->root_spritegroup = NULL;
150 }
151
152 ResolverObject::~ResolverObject() {}
153
159 /* virtual */ const SpriteGroup *ResolverObject::ResolveReal(const RealSpriteGroup *group) const
160 {
161 return NULL;
162 }
163
170 /* virtual */ ScopeResolver *ResolverObject::GetScope(VarSpriteGroupScope scope, byte relative)
171 {
172 return &this->default_scope;
173 }
174
181 static uint32 RotateRight(uint32 val, uint32 rot)
182 {
183 /* Do not rotate more than necessary */
184 rot %= 32;
185
186 return (val >> rot) | (val << (32 - rot));
187 }
188
189
190 /* Evaluate an adjustment for a variable of the given size.
191 * U is the unsigned type and S is the signed type to use. */
192 template <typename U, typename S>
193 static U EvalAdjustT(const DeterministicSpriteGroupAdjust *adjust, ScopeResolver *scope, U last_value, uint32 value)
194 {
195 value >>= adjust->shift_num;
196 value &= adjust->and_mask;
197
198 if (adjust->type != DSGA_TYPE_NONE) value += (S)adjust->add_val;
199
200 switch (adjust->type) {
201 case DSGA_TYPE_DIV: value = (S)value / (S)adjust->divmod_val; break;
202 case DSGA_TYPE_MOD: value = (S)value % (S)adjust->divmod_val; break;
203 case DSGA_TYPE_NONE: break;
204 }
205
206 switch (adjust->operation) {
207 case DSGA_OP_ADD: return last_value + value;
208 case DSGA_OP_SUB: return last_value - value;
209 case DSGA_OP_SMIN: return min((S)last_value, (S)value);
210 case DSGA_OP_SMAX: return max((S)last_value, (S)value);
211 case DSGA_OP_UMIN: return min((U)last_value, (U)value);
212 case DSGA_OP_UMAX: return max((U)last_value, (U)value);
213 case DSGA_OP_SDIV: return value == 0 ? (S)last_value : (S)last_value / (S)value;
214 case DSGA_OP_SMOD: return value == 0 ? (S)last_value : (S)last_value % (S)value;
215 case DSGA_OP_UDIV: return value == 0 ? (U)last_value : (U)last_value / (U)value;
216 case DSGA_OP_UMOD: return value == 0 ? (U)last_value : (U)last_value % (U)value;
217 case DSGA_OP_MUL: return last_value * value;
218 case DSGA_OP_AND: return last_value & value;
219 case DSGA_OP_OR: return last_value | value;
220 case DSGA_OP_XOR: return last_value ^ value;
221 case DSGA_OP_STO: _temp_store.StoreValue((U)value, (S)last_value); return last_value;
222 case DSGA_OP_RST: return value;
223 case DSGA_OP_STOP: scope->StorePSA((U)value, (S)last_value); return last_value;
224 case DSGA_OP_ROR: return RotateRight(last_value, value);
225 case DSGA_OP_SCMP: return ((S)last_value == (S)value) ? 1 : ((S)last_value < (S)value ? 0 : 2);
226 case DSGA_OP_UCMP: return ((U)last_value == (U)value) ? 1 : ((U)last_value < (U)value ? 0 : 2);
227 case DSGA_OP_SHL: return (uint32)(U)last_value << ((U)value & 0x1F); // Same behaviour as in ParamSet, mask 'value' to 5 bits, which should behave the same on all architectures.
228 case DSGA_OP_SHR: return (uint32)(U)last_value >> ((U)value & 0x1F);
229 case DSGA_OP_SAR: return (int32)(S)last_value >> ((U)value & 0x1F);
230 default: return value;
231 }
232 }
233
234
235 const SpriteGroup *DeterministicSpriteGroup::Resolve(ResolverObject &object) const
236 {
237 uint32 last_value = 0;
238 uint32 value = 0;
239 uint i;
240
241 ScopeResolver *scope = object.GetScope(this->var_scope);
242
243 for (i = 0; i < this->num_adjusts; i++) {
244 DeterministicSpriteGroupAdjust *adjust = &this->adjusts[i];
245
246 /* Try to get the variable. We shall assume it is available, unless told otherwise. */
247 bool available = true;
248 if (adjust->variable == 0x7E) {
249 const SpriteGroup *subgroup = SpriteGroup::Resolve(adjust->subroutine, object, false);
250 if (subgroup == NULL) {
251 value = CALLBACK_FAILED;
252 } else {
253 value = subgroup->GetCallbackResult();
254 }
255
256 /* Note: 'last_value' and 'reseed' are shared between the main chain and the procedure */
257 } else if (adjust->variable == 0x7B) {
258 value = GetVariable(object, scope, adjust->parameter, last_value, &available);
259 } else {
260 value = GetVariable(object, scope, adjust->variable, adjust->parameter, &available);
261 }
262
263 if (!available) {
264 /* Unsupported variable: skip further processing and return either
265 * the group from the first range or the default group. */
266 return SpriteGroup::Resolve(this->num_ranges > 0 ? this->ranges[0].group : this->default_group, object, false);
267 }
268
269 switch (this->size) {
270 case DSG_SIZE_BYTE: value = EvalAdjustT<uint8, int8> (adjust, scope, last_value, value); break;
271 case DSG_SIZE_WORD: value = EvalAdjustT<uint16, int16>(adjust, scope, last_value, value); break;
272 case DSG_SIZE_DWORD: value = EvalAdjustT<uint32, int32>(adjust, scope, last_value, value); break;
273 default: NOT_REACHED();
274 }
275 last_value = value;
276 }
277
278 object.last_value = last_value;
279
280 if (this->num_ranges == 0) {
281 /* nvar == 0 is a special case -- we turn our value into a callback result */
282 if (value != CALLBACK_FAILED) value = GB(value, 0, 15);
283 static CallbackResultSpriteGroup nvarzero(0, true);
284 nvarzero.result = value;
285 return &nvarzero;
286 }
287
288 for (i = 0; i < this->num_ranges; i++) {
289 if (this->ranges[i].low <= value && value <= this->ranges[i].high) {
290 return SpriteGroup::Resolve(this->ranges[i].group, object, false);
291 }
292 }
293
294 return SpriteGroup::Resolve(this->default_group, object, false);
295 }
296
297
298 const SpriteGroup *RandomizedSpriteGroup::Resolve(ResolverObject &object) const
299 {
300 ScopeResolver *scope = object.GetScope(this->var_scope, this->count);
301 if (object.callback == CBID_RANDOM_TRIGGER) {
302 /* Handle triggers */
303 byte match = this->triggers & object.waiting_triggers;
304 bool res = (this->cmp_mode == RSG_CMP_ANY) ? (match != 0) : (match == this->triggers);
305
306 if (res) {
307 object.used_triggers |= match;
308 object.reseed[this->var_scope] |= (this->num_groups - 1) << this->lowest_randbit;
309 }
310 }
311
312 uint32 mask = (this->num_groups - 1) << this->lowest_randbit;
313 byte index = (scope->GetRandomBits() & mask) >> this->lowest_randbit;
314
315 return SpriteGroup::Resolve(this->groups[index], object, false);
316 }
317
318
319 const SpriteGroup *RealSpriteGroup::Resolve(ResolverObject &object) const
320 {
321 return object.ResolveReal(this);
322 }
323
331 const DrawTileSprites *TileLayoutSpriteGroup::ProcessRegisters(uint8 *stage) const
332 {
333 if (!this->dts.NeedsPreprocessing()) {
334 if (stage != NULL && this->dts.consistent_max_offset > 0) *stage = GetConstructionStageOffset(*stage, this->dts.consistent_max_offset);
335 return &this->dts;
336 }
337
338 static DrawTileSprites result;
339 uint8 actual_stage = stage != NULL ? *stage : 0;
340 this->dts.PrepareLayout(0, 0, 0, actual_stage, false);
341 this->dts.ProcessRegisters(0, 0, false);
342 result.seq = this->dts.GetLayout(&result.ground);
343
344 /* Stage has been processed by PrepareLayout(), set it to zero. */
345 if (stage != NULL) *stage = 0;
346
347 return &result;
348 }