OpenTTD
newgrf_spritegroup.h
Go to the documentation of this file.
1 /* $Id: newgrf_spritegroup.h 26388 2014-03-03 20:02:31Z 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 #ifndef NEWGRF_SPRITEGROUP_H
13 #define NEWGRF_SPRITEGROUP_H
14 
15 #include "town_type.h"
16 #include "engine_type.h"
17 #include "house_type.h"
18 
19 #include "newgrf_callbacks.h"
20 #include "newgrf_generic.h"
21 #include "newgrf_storage.h"
22 #include "newgrf_commons.h"
23 
30 static inline uint32 GetRegister(uint i)
31 {
32  extern TemporaryStorageArray<int32, 0x110> _temp_store;
33  return _temp_store.GetValue(i);
34 }
35 
36 /* List of different sprite group types */
37 enum SpriteGroupType {
38  SGT_REAL,
39  SGT_DETERMINISTIC,
40  SGT_RANDOMIZED,
41  SGT_CALLBACK,
42  SGT_RESULT,
43  SGT_TILELAYOUT,
44  SGT_INDUSTRY_PRODUCTION,
45 };
46 
47 struct SpriteGroup;
48 typedef uint32 SpriteGroupID;
49 struct ResolverObject;
50 
51 /* SPRITE_WIDTH is 24. ECS has roughly 30 sprite groups per real sprite.
52  * Adding an 'extra' margin would be assuming 64 sprite groups per real
53  * sprite. 64 = 2^6, so 2^30 should be enough (for now) */
55 extern SpriteGroupPool _spritegroup_pool;
56 
57 /* Common wrapper for all the different sprite group types */
58 struct SpriteGroup : SpriteGroupPool::PoolItem<&_spritegroup_pool> {
59 protected:
60  SpriteGroup(SpriteGroupType type) : type(type) {}
62  virtual const SpriteGroup *Resolve(ResolverObject &object) const { return this; };
63 
64 public:
65  virtual ~SpriteGroup() {}
66 
67  SpriteGroupType type;
68 
69  virtual SpriteID GetResult() const { return 0; }
70  virtual byte GetNumResults() const { return 0; }
71  virtual uint16 GetCallbackResult() const { return CALLBACK_FAILED; }
72 
73  static const SpriteGroup *Resolve(const SpriteGroup *group, ResolverObject &object, bool top_level = true);
74 };
75 
76 
77 /* 'Real' sprite groups contain a list of other result or callback sprite
78  * groups. */
80  RealSpriteGroup() : SpriteGroup(SGT_REAL) {}
81  ~RealSpriteGroup();
82 
83  /* Loaded = in motion, loading = not moving
84  * Each group contains several spritesets, for various loading stages */
85 
86  /* XXX: For stations the meaning is different - loaded is for stations
87  * with small amount of cargo whilst loading is for stations with a lot
88  * of da stuff. */
89 
90  byte num_loaded;
91  byte num_loading;
92  const SpriteGroup **loaded;
93  const SpriteGroup **loading;
94 
95 protected:
96  const SpriteGroup *Resolve(ResolverObject &object) const;
97 };
98 
99 /* Shared by deterministic and random groups. */
101  VSG_BEGIN,
102 
103  VSG_SCOPE_SELF = VSG_BEGIN,
106 
107  VSG_END
108 };
110 
111 enum DeterministicSpriteGroupSize {
112  DSG_SIZE_BYTE,
113  DSG_SIZE_WORD,
114  DSG_SIZE_DWORD,
115 };
116 
117 enum DeterministicSpriteGroupAdjustType {
118  DSGA_TYPE_NONE,
119  DSGA_TYPE_DIV,
120  DSGA_TYPE_MOD,
121 };
122 
147 };
148 
149 
152  DeterministicSpriteGroupAdjustType type;
153  byte variable;
154  byte parameter;
155  byte shift_num;
156  uint32 and_mask;
157  uint32 add_val;
158  uint32 divmod_val;
159  const SpriteGroup *subroutine;
160 };
161 
162 
164  const SpriteGroup *group;
165  uint32 low;
166  uint32 high;
167 };
168 
169 
171  DeterministicSpriteGroup() : SpriteGroup(SGT_DETERMINISTIC) {}
173 
174  VarSpriteGroupScope var_scope;
175  DeterministicSpriteGroupSize size;
176  uint num_adjusts;
177  byte num_ranges;
179  DeterministicSpriteGroupRange *ranges; // Dynamically allocated
180 
181  /* Dynamically allocated, this is the sole owner */
182  const SpriteGroup *default_group;
183 
184 protected:
185  const SpriteGroup *Resolve(ResolverObject &object) const;
186 };
187 
188 enum RandomizedSpriteGroupCompareMode {
189  RSG_CMP_ANY,
190  RSG_CMP_ALL,
191 };
192 
194  RandomizedSpriteGroup() : SpriteGroup(SGT_RANDOMIZED) {}
196 
198 
199  RandomizedSpriteGroupCompareMode cmp_mode;
200  byte triggers;
201  byte count;
202 
204  byte num_groups;
205 
206  const SpriteGroup **groups;
207 
208 protected:
209  const SpriteGroup *Resolve(ResolverObject &object) const;
210 };
211 
212 
213 /* This contains a callback result. A failed callback has a value of
214  * CALLBACK_FAILED */
221  CallbackResultSpriteGroup(uint16 value, bool grf_version8) :
222  SpriteGroup(SGT_CALLBACK),
223  result(value)
224  {
225  /* Old style callback results (only valid for version < 8) have the highest byte 0xFF so signify it is a callback result.
226  * New style ones only have the highest bit set (allows 15-bit results, instead of just 8) */
227  if (!grf_version8 && (this->result >> 8) == 0xFF) {
228  this->result &= ~0xFF00;
229  } else {
230  this->result &= ~0x8000;
231  }
232  }
233 
234  uint16 result;
235  uint16 GetCallbackResult() const { return this->result; }
236 };
237 
238 
239 /* A result sprite group returns the first SpriteID and the number of
240  * sprites in the set */
248  ResultSpriteGroup(SpriteID sprite, byte num_sprites) :
249  SpriteGroup(SGT_RESULT),
250  sprite(sprite),
251  num_sprites(num_sprites)
252  {
253  }
254 
255  SpriteID sprite;
256  byte num_sprites;
257  SpriteID GetResult() const { return this->sprite; }
258  byte GetNumResults() const { return this->num_sprites; }
259 };
260 
265  TileLayoutSpriteGroup() : SpriteGroup(SGT_TILELAYOUT) {}
267 
268  NewGRFSpriteLayout dts;
269 
270  const DrawTileSprites *ProcessRegisters(uint8 *stage) const;
271 };
272 
274  IndustryProductionSpriteGroup() : SpriteGroup(SGT_INDUSTRY_PRODUCTION) {}
275 
276  uint8 version;
277  int16 subtract_input[3]; // signed
278  uint16 add_output[2]; // unsigned
279  uint8 again;
280 };
281 
290 
292  virtual ~ScopeResolver();
293 
294  virtual uint32 GetRandomBits() const;
295  virtual uint32 GetTriggers() const;
296  virtual void SetTriggers(int triggers) const;
297 
298  virtual uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
299  virtual void StorePSA(uint reg, int32 value);
300 };
301 
310  virtual ~ResolverObject();
311 
313 
317 
318  byte trigger;
319 
320  uint32 last_value;
321  uint32 reseed[VSG_END];
322 
323  const GRFFile *grffile;
325 
331  {
332  return SpriteGroup::Resolve(this->root_spritegroup, *this);
333  }
334 
340  {
341  const SpriteGroup *result = Resolve();
342  return result != NULL ? result->GetCallbackResult() : CALLBACK_FAILED;
343  }
344 
345  virtual const SpriteGroup *ResolveReal(const RealSpriteGroup *group) const;
346 
347  virtual ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0);
348 
354  uint32 GetReseedSum() const
355  {
356  uint32 sum = 0;
357  for (VarSpriteGroupScope vsg = VSG_BEGIN; vsg < VSG_END; vsg++) {
358  sum |= this->reseed[vsg];
359  }
360  return sum;
361  }
362 
367  void ResetState()
368  {
369  this->last_value = 0;
370  this->trigger = 0;
371  memset(this->reseed, 0, sizeof(this->reseed));
372  }
373 };
374 
375 #endif /* NEWGRF_SPRITEGROUP_H */