OpenTTD Source: src/newgrf_spritegroup.cpp Source File

OpenTTD Source 15.0-beta1

newgrf_spritegroup.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 "debug.h"
12#include "newgrf_spritegroup.h"
13#include "newgrf_profiling.h"
14#include "core/pool_func.hpp"
15
16#include "safeguards.h"
17
18 SpriteGroupPool _spritegroup_pool("SpriteGroup");
19 INSTANTIATE_POOL_METHODS(SpriteGroup)
20
21 TemporaryStorageArray<int32_t, 0x110> _temp_store;
22
23
34/* static */ const SpriteGroup *SpriteGroup::Resolve(const SpriteGroup *group, ResolverObject &object, bool top_level)
35{
36 if (group == nullptr) return nullptr;
37
38 const GRFFile *grf = object.grffile;
39 auto profiler = std::ranges::find(_newgrf_profilers, grf, &NewGRFProfiler::grffile);
40
41 if (profiler == _newgrf_profilers.end() || !profiler->active) {
42 if (top_level) _temp_store.ClearChanges();
43 return group->Resolve(object);
44 } else if (top_level) {
45 profiler->BeginResolve(object);
46 _temp_store.ClearChanges();
47 const SpriteGroup *result = group->Resolve(object);
48 profiler->EndResolve(result);
49 return result;
50 } else {
51 profiler->RecursiveResolve();
52 return group->Resolve(object);
53 }
54}
55
56static inline uint32_t GetVariable(const ResolverObject &object, ScopeResolver *scope, uint8_t variable, uint32_t parameter, bool &available)
57{
58 uint32_t value;
59 switch (variable) {
60 case 0x0C: return object.callback;
61 case 0x10: return object.callback_param1;
62 case 0x18: return object.callback_param2;
63 case 0x1C: return object.last_value;
64
65 case 0x5F: return (scope->GetRandomBits() << 8) | scope->GetTriggers();
66
67 case 0x7D: return _temp_store.GetValue(parameter);
68
69 case 0x7F:
70 if (object.grffile == nullptr) return 0;
71 return object.grffile->GetParam(parameter);
72
73 default:
74 /* First handle variables common with Action7/9/D */
75 if (variable < 0x40 && GetGlobalVariable(variable, &value, object.grffile)) return value;
76 /* Not a common variable, so evaluate the feature specific variables */
77 return scope->GetVariable(variable, parameter, available);
78 }
79}
80
85/* virtual */ uint32_t ScopeResolver::GetRandomBits() const
86{
87 return 0;
88}
89
94/* virtual */ uint32_t ScopeResolver::GetTriggers() const
95{
96 return 0;
97}
98
106/* virtual */ uint32_t ScopeResolver::GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const
107{
108 Debug(grf, 1, "Unhandled scope variable 0x{:X}", variable);
109 available = false;
110 return UINT_MAX;
111}
112
116/* virtual */ void ScopeResolver::StorePSA(uint, int32_t) {}
117
123/* virtual */ const SpriteGroup *ResolverObject::ResolveReal(const RealSpriteGroup *group) const
124{
125 if (!group->loaded.empty()) return group->loaded[0];
126 if (!group->loading.empty()) return group->loading[0];
127
128 return nullptr;
129}
130
135/* virtual */ ScopeResolver *ResolverObject::GetScope(VarSpriteGroupScope, uint8_t)
136{
137 return &this->default_scope;
138}
139
140/* Evaluate an adjustment for a variable of the given size.
141 * U is the unsigned type and S is the signed type to use. */
142template <typename U, typename S>
143static U EvalAdjustT(const DeterministicSpriteGroupAdjust &adjust, ScopeResolver *scope, U last_value, uint32_t value)
144{
145 value >>= adjust.shift_num;
146 value &= adjust.and_mask;
147
148 switch (adjust.type) {
149 case DSGA_TYPE_DIV: value = ((S)value + (S)adjust.add_val) / (S)adjust.divmod_val; break;
150 case DSGA_TYPE_MOD: value = ((S)value + (S)adjust.add_val) % (S)adjust.divmod_val; break;
151 case DSGA_TYPE_NONE: break;
152 }
153
154 switch (adjust.operation) {
155 case DSGA_OP_ADD: return last_value + value;
156 case DSGA_OP_SUB: return last_value - value;
157 case DSGA_OP_SMIN: return std::min<S>(last_value, value);
158 case DSGA_OP_SMAX: return std::max<S>(last_value, value);
159 case DSGA_OP_UMIN: return std::min<U>(last_value, value);
160 case DSGA_OP_UMAX: return std::max<U>(last_value, value);
161 case DSGA_OP_SDIV: return value == 0 ? (S)last_value : (S)last_value / (S)value;
162 case DSGA_OP_SMOD: return value == 0 ? (S)last_value : (S)last_value % (S)value;
163 case DSGA_OP_UDIV: return value == 0 ? (U)last_value : (U)last_value / (U)value;
164 case DSGA_OP_UMOD: return value == 0 ? (U)last_value : (U)last_value % (U)value;
165 case DSGA_OP_MUL: return last_value * value;
166 case DSGA_OP_AND: return last_value & value;
167 case DSGA_OP_OR: return last_value | value;
168 case DSGA_OP_XOR: return last_value ^ value;
169 case DSGA_OP_STO: _temp_store.StoreValue((U)value, (S)last_value); return last_value;
170 case DSGA_OP_RST: return value;
171 case DSGA_OP_STOP: scope->StorePSA((U)value, (S)last_value); return last_value;
172 case DSGA_OP_ROR: return std::rotr<uint32_t>((U)last_value, (U)value & 0x1F); // mask 'value' to 5 bits, which should behave the same on all architectures.
173 case DSGA_OP_SCMP: return ((S)last_value == (S)value) ? 1 : ((S)last_value < (S)value ? 0 : 2);
174 case DSGA_OP_UCMP: return ((U)last_value == (U)value) ? 1 : ((U)last_value < (U)value ? 0 : 2);
175 case DSGA_OP_SHL: return (uint32_t)(U)last_value << ((U)value & 0x1F); // Same behaviour as in ParamSet, mask 'value' to 5 bits, which should behave the same on all architectures.
176 case DSGA_OP_SHR: return (uint32_t)(U)last_value >> ((U)value & 0x1F);
177 case DSGA_OP_SAR: return (int32_t)(S)last_value >> ((U)value & 0x1F);
178 default: return value;
179 }
180}
181
182
183static bool RangeHighComparator(const DeterministicSpriteGroupRange &range, uint32_t value)
184{
185 return range.high < value;
186}
187
188 const SpriteGroup *DeterministicSpriteGroup::Resolve(ResolverObject &object) const
189{
190 uint32_t last_value = 0;
191 uint32_t value = 0;
192
193 ScopeResolver *scope = object.GetScope(this->var_scope);
194
195 for (const auto &adjust : this->adjusts) {
196 /* Try to get the variable. We shall assume it is available, unless told otherwise. */
197 bool available = true;
198 if (adjust.variable == 0x7E) {
199 const SpriteGroup *subgroup = SpriteGroup::Resolve(adjust.subroutine, object, false);
200 if (subgroup == nullptr) {
201 value = CALLBACK_FAILED;
202 } else {
203 value = subgroup->GetCallbackResult();
204 }
205
206 /* Note: 'last_value' and 'reseed' are shared between the main chain and the procedure */
207 } else if (adjust.variable == 0x7B) {
208 value = GetVariable(object, scope, adjust.parameter, last_value, available);
209 } else {
210 value = GetVariable(object, scope, adjust.variable, adjust.parameter, available);
211 }
212
213 if (!available) {
214 /* Unsupported variable: skip further processing and return either
215 * the group from the first range or the default group. */
216 return SpriteGroup::Resolve(this->error_group, object, false);
217 }
218
219 switch (this->size) {
220 case DSG_SIZE_BYTE: value = EvalAdjustT<uint8_t, int8_t> (adjust, scope, last_value, value); break;
221 case DSG_SIZE_WORD: value = EvalAdjustT<uint16_t, int16_t>(adjust, scope, last_value, value); break;
222 case DSG_SIZE_DWORD: value = EvalAdjustT<uint32_t, int32_t>(adjust, scope, last_value, value); break;
223 default: NOT_REACHED();
224 }
225 last_value = value;
226 }
227
228 object.last_value = last_value;
229
230 if (this->calculated_result) {
231 /* nvar == 0 is a special case -- we turn our value into a callback result */
232 if (value != CALLBACK_FAILED) value = GB(value, 0, 15);
233 static CallbackResultSpriteGroup nvarzero(0);
234 nvarzero.result = value;
235 return &nvarzero;
236 }
237
238 if (this->ranges.size() > 4) {
239 const auto &lower = std::lower_bound(this->ranges.begin(), this->ranges.end(), value, RangeHighComparator);
240 if (lower != this->ranges.end() && lower->low <= value) {
241 assert(lower->low <= value && value <= lower->high);
242 return SpriteGroup::Resolve(lower->group, object, false);
243 }
244 } else {
245 for (const auto &range : this->ranges) {
246 if (range.low <= value && value <= range.high) {
247 return SpriteGroup::Resolve(range.group, object, false);
248 }
249 }
250 }
251
252 return SpriteGroup::Resolve(this->default_group, object, false);
253}
254
255
256 const SpriteGroup *RandomizedSpriteGroup::Resolve(ResolverObject &object) const
257{
258 ScopeResolver *scope = object.GetScope(this->var_scope, this->count);
259 if (object.callback == CBID_RANDOM_TRIGGER) {
260 /* Handle triggers */
261 uint8_t match = this->triggers & object.waiting_triggers;
262 bool res = (this->cmp_mode == RSG_CMP_ANY) ? (match != 0) : (match == this->triggers);
263
264 if (res) {
265 object.used_triggers |= match;
266 object.reseed[this->var_scope] |= (this->groups.size() - 1) << this->lowest_randbit;
267 }
268 }
269
270 uint32_t mask = ((uint)this->groups.size() - 1) << this->lowest_randbit;
271 uint8_t index = (scope->GetRandomBits() & mask) >> this->lowest_randbit;
272
273 return SpriteGroup::Resolve(this->groups[index], object, false);
274}
275
276
277 const SpriteGroup *RealSpriteGroup::Resolve(ResolverObject &object) const
278{
279 return object.ResolveReal(this);
280}
281
289 const DrawTileSprites *TileLayoutSpriteGroup::ProcessRegisters(uint8_t *stage) const
290{
291 if (!this->dts.NeedsPreprocessing()) {
292 if (stage != nullptr && this->dts.consistent_max_offset > 0) *stage = GetConstructionStageOffset(*stage, this->dts.consistent_max_offset);
293 return &this->dts;
294 }
295
296 static DrawTileSprites result;
297 uint8_t actual_stage = stage != nullptr ? *stage : 0;
298 this->dts.PrepareLayout(0, 0, 0, actual_stage, false);
299 this->dts.ProcessRegisters(0, 0, false);
300 result.seq = this->dts.GetLayout(&result.ground);
301
302 /* Stage has been processed by PrepareLayout(), set it to zero. */
303 if (stage != nullptr) *stage = 0;
304
305 return &result;
306}
GB
debug_inline static constexpr 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
debug.h
Functions related to debugging.
Debug
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
Definition debug.h:37
GetGlobalVariable
bool GetGlobalVariable(uint8_t param, uint32_t *value, const GRFFile *grffile)
Reads a variable common to VarAction2 and Action7/9/D.
Definition newgrf.cpp:6584
CBID_RANDOM_TRIGGER
@ CBID_RANDOM_TRIGGER
Set when calling a randomizing trigger (almost undocumented).
Definition newgrf_callbacks.h:25
CALLBACK_FAILED
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
Definition newgrf_callbacks.h:427
GetConstructionStageOffset
uint GetConstructionStageOffset(uint construction_stage, uint num_sprites)
Determines which sprite to use from a spriteset for a specific construction stage.
Definition newgrf_commons.h:74
newgrf_profiling.h
Profiling of NewGRF action 2 handling.
newgrf_spritegroup.h
Action 2 handling.
DSGA_OP_OR
@ DSGA_OP_OR
a | b
Definition newgrf_spritegroup.h:133
DSGA_OP_XOR
@ DSGA_OP_XOR
a ^ b
Definition newgrf_spritegroup.h:134
DSGA_OP_SUB
@ DSGA_OP_SUB
a - b
Definition newgrf_spritegroup.h:122
DSGA_OP_STOP
@ DSGA_OP_STOP
store a into persistent storage, indexed by b, return a
Definition newgrf_spritegroup.h:137
DSGA_OP_ROR
@ DSGA_OP_ROR
rotate a b positions to the right
Definition newgrf_spritegroup.h:138
DSGA_OP_SHL
@ DSGA_OP_SHL
a << b
Definition newgrf_spritegroup.h:141
DSGA_OP_UCMP
@ DSGA_OP_UCMP
(unsigned) comparison (a < b -> 0, a == b = 1, a > b = 2)
Definition newgrf_spritegroup.h:140
DSGA_OP_MUL
@ DSGA_OP_MUL
a * b
Definition newgrf_spritegroup.h:131
DSGA_OP_SAR
@ DSGA_OP_SAR
(signed) a >> b
Definition newgrf_spritegroup.h:143
DSGA_OP_STO
@ DSGA_OP_STO
store a into temporary storage, indexed by b. return a
Definition newgrf_spritegroup.h:135
DSGA_OP_SMOD
@ DSGA_OP_SMOD
(signed) a % b
Definition newgrf_spritegroup.h:128
DSGA_OP_UDIV
@ DSGA_OP_UDIV
(unsigned) a / b
Definition newgrf_spritegroup.h:129
DSGA_OP_UMAX
@ DSGA_OP_UMAX
(unsigned) max(a, b)
Definition newgrf_spritegroup.h:126
DSGA_OP_SMIN
@ DSGA_OP_SMIN
(signed) min(a, b)
Definition newgrf_spritegroup.h:123
DSGA_OP_ADD
@ DSGA_OP_ADD
a + b
Definition newgrf_spritegroup.h:121
DSGA_OP_UMOD
@ DSGA_OP_UMOD
(unsigned) a & b
Definition newgrf_spritegroup.h:130
DSGA_OP_SHR
@ DSGA_OP_SHR
(unsigned) a >> b
Definition newgrf_spritegroup.h:142
DSGA_OP_RST
@ DSGA_OP_RST
return b
Definition newgrf_spritegroup.h:136
DSGA_OP_AND
@ DSGA_OP_AND
a & b
Definition newgrf_spritegroup.h:132
DSGA_OP_SDIV
@ DSGA_OP_SDIV
(signed) a / b
Definition newgrf_spritegroup.h:127
DSGA_OP_SCMP
@ DSGA_OP_SCMP
(signed) comparison (a < b -> 0, a == b = 1, a > b = 2)
Definition newgrf_spritegroup.h:139
DSGA_OP_UMIN
@ DSGA_OP_UMIN
(unsigned) min(a, b)
Definition newgrf_spritegroup.h:125
DSGA_OP_SMAX
@ DSGA_OP_SMAX
(signed) max(a, b)
Definition newgrf_spritegroup.h:124
VarSpriteGroupScope
VarSpriteGroupScope
Definition newgrf_spritegroup.h:97
pool_func.hpp
Some methods of Pool are placed here in order to reduce compilation time and binary size.
INSTANTIATE_POOL_METHODS
#define INSTANTIATE_POOL_METHODS(name)
Force instantiation of pool methods so we don't get linker errors.
Definition pool_func.hpp:237
safeguards.h
A number of safeguards to prevent using unsafe methods.
stdafx.h
Definition of base types and functions in a cross-platform compatible way.
CallbackResultSpriteGroup
Definition newgrf_spritegroup.h:210
DeterministicSpriteGroupAdjust
Definition newgrf_spritegroup.h:147
DeterministicSpriteGroupAdjust::parameter
uint8_t parameter
Used for variables between 0x60 and 0x7F inclusive.
Definition newgrf_spritegroup.h:151
DeterministicSpriteGroupRange
Definition newgrf_spritegroup.h:160
DeterministicSpriteGroup::Resolve
const SpriteGroup * Resolve(ResolverObject &object) const override
Base sprite group resolver.
Definition newgrf_spritegroup.cpp:188
DrawTileSprites
Ground palette sprite of a tile, together with its sprite layout.
Definition sprite.h:58
DrawTileSprites::seq
const DrawTileSeqStruct * seq
Array of child sprites. Terminated with a terminator entry.
Definition sprite.h:60
DrawTileSprites::ground
PalSpriteID ground
Palette and sprite for the ground.
Definition sprite.h:59
GRFFile
Dynamic data of a loaded NewGRF.
Definition newgrf.h:108
NewGRFProfiler::grffile
const GRFFile * grffile
Which GRF is being profiled.
Definition newgrf_profiling.h:52
NewGRFSpriteLayout::PrepareLayout
uint32_t PrepareLayout(uint32_t orig_offset, uint32_t newgrf_ground_offset, uint32_t newgrf_offset, uint constr_stage, bool separate_ground) const
Prepares a sprite layout before resolving action-1-2-3 chains.
Definition newgrf_commons.cpp:645
NewGRFSpriteLayout::consistent_max_offset
uint consistent_max_offset
Number of sprites in all referenced spritesets.
Definition newgrf_commons.h:119
NewGRFSpriteLayout::ProcessRegisters
void ProcessRegisters(uint8_t resolved_var10, uint32_t resolved_sprite, bool separate_ground) const
Evaluates the register modifiers and integrates them into the preprocessed sprite layout.
Definition newgrf_commons.cpp:716
NewGRFSpriteLayout::NeedsPreprocessing
bool NeedsPreprocessing() const
Tests whether this spritelayout needs preprocessing by PrepareLayout() and ProcessRegisters(),...
Definition newgrf_commons.h:149
NewGRFSpriteLayout::GetLayout
const DrawTileSeqStruct * GetLayout(PalSpriteID *ground) const
Returns the result spritelayout after preprocessing.
Definition newgrf_commons.h:162
Pool::PoolItem<&_spritegroup_pool >::index
Tindex index
Index of this pool item.
Definition pool_type.hpp:238
Pool
Base class for all pools.
Definition pool_type.hpp:80
RandomizedSpriteGroup::lowest_randbit
uint8_t lowest_randbit
Look for this in the per-object randomized bitmask:
Definition newgrf_spritegroup.h:199
RandomizedSpriteGroup::var_scope
VarSpriteGroupScope var_scope
Take this object:
Definition newgrf_spritegroup.h:193
RandomizedSpriteGroup::Resolve
const SpriteGroup * Resolve(ResolverObject &object) const override
Base sprite group resolver.
Definition newgrf_spritegroup.cpp:256
RandomizedSpriteGroup::groups
std::vector< const SpriteGroup * > groups
Take the group with appropriate index:
Definition newgrf_spritegroup.h:201
RandomizedSpriteGroup::cmp_mode
RandomizedSpriteGroupCompareMode cmp_mode
Check for these triggers:
Definition newgrf_spritegroup.h:195
RealSpriteGroup
Definition newgrf_spritegroup.h:79
RealSpriteGroup::loaded
std::vector< const SpriteGroup * > loaded
List of loaded groups (can be SpriteIDs or Callback results)
Definition newgrf_spritegroup.h:89
RealSpriteGroup::loading
std::vector< const SpriteGroup * > loading
List of loading groups (can be SpriteIDs or Callback results)
Definition newgrf_spritegroup.h:90
RealSpriteGroup::Resolve
const SpriteGroup * Resolve(ResolverObject &object) const override
Base sprite group resolver.
Definition newgrf_spritegroup.cpp:277
ResolverObject
Interface for SpriteGroup-s to access the gamestate.
Definition newgrf_spritegroup.h:296
ResolverObject::ResolveReal
virtual const SpriteGroup * ResolveReal(const RealSpriteGroup *group) const
Get the real sprites of the grf.
Definition newgrf_spritegroup.cpp:123
ResolverObject::default_scope
ScopeResolver default_scope
Default implementation of the grf scope.
Definition newgrf_spritegroup.h:312
ResolverObject::GetScope
virtual ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0)
Get a resolver for the scope.
Definition newgrf_spritegroup.cpp:135
ScopeResolver
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope).
Definition newgrf_spritegroup.h:277
ScopeResolver::StorePSA
virtual void StorePSA(uint reg, int32_t value)
Store a value into the persistent storage area (PSA).
Definition newgrf_spritegroup.cpp:116
ScopeResolver::GetTriggers
virtual uint32_t GetTriggers() const
Get the triggers.
Definition newgrf_spritegroup.cpp:94
ScopeResolver::GetVariable
virtual uint32_t GetVariable(uint8_t variable, uint32_t parameter, bool &available) const
Get a variable value.
Definition newgrf_spritegroup.cpp:106
ScopeResolver::GetRandomBits
virtual uint32_t GetRandomBits() const
Get a few random bits.
Definition newgrf_spritegroup.cpp:85
SpriteGroup
Definition newgrf_spritegroup.h:57
SpriteGroup::Resolve
virtual const SpriteGroup * Resolve(ResolverObject &object) const
Base sprite group resolver.
Definition newgrf_spritegroup.h:61
TemporaryStorageArray
Class for temporary storage of data.
Definition newgrf_storage.h:133
TileLayoutSpriteGroup::ProcessRegisters
const DrawTileSprites * ProcessRegisters(uint8_t *stage) const
Process registers and the construction stage into the sprite layout.
Definition newgrf_spritegroup.cpp:289