src/newgrf_spritegroup.h

   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
   8 /** @file newgrf_spritegroup.h Action 2 handling. */
   9
  10 #ifndef NEWGRF_SPRITEGROUP_H
  11 #define NEWGRF_SPRITEGROUP_H
  12
  13 #include "town_type.h"
  14 #include "engine_type.h"
  15 #include "house_type.h"
  16 #include "industry_type.h"
  17
  18 #include "newgrf_callbacks.h"
  19 #include "newgrf_generic.h"
  20 #include "newgrf_storage.h"
  21 #include "newgrf_commons.h"
  22
  23 /**
  24  * Gets the value of a so-called newgrf "register".
  25  * @param i index of the register
  26  * @pre i < 0x110
  27  * @return the value of the register
  28  */
  29 static inline uint32 GetRegister(uint i)
  30 {
  31         extern TemporaryStorageArray<int32, 0x110> _temp_store;
  32         return _temp_store.GetValue(i);
  33 }
  34
  35 /* List of different sprite group types */
  36 enum SpriteGroupType {
  37         SGT_REAL,
  38         SGT_DETERMINISTIC,
  39         SGT_RANDOMIZED,
  40         SGT_CALLBACK,
  41         SGT_RESULT,
  42         SGT_TILELAYOUT,
  43         SGT_INDUSTRY_PRODUCTION,
  44 };
  45
  46 struct SpriteGroup;
  47 typedef uint32 SpriteGroupID;
  48 struct ResolverObject;
  49
  50 /* SPRITE_WIDTH is 24. ECS has roughly 30 sprite groups per real sprite.
  51  * Adding an 'extra' margin would be assuming 64 sprite groups per real
  52  * sprite. 64 = 2^6, so 2^30 should be enough (for now) */
  53 typedef Pool<SpriteGroup, SpriteGroupID, 1024, 1 << 30, PT_DATA> SpriteGroupPool;
  54 extern SpriteGroupPool _spritegroup_pool;
  55
  56 /* Common wrapper for all the different sprite group types */
  57 struct SpriteGroup : SpriteGroupPool::PoolItem<&_spritegroup_pool> {
  58 protected:
  59         SpriteGroup(SpriteGroupType type) : nfo_line(0), type(type) {}
  60         /** Base sprite group resolver */
  61         virtual const SpriteGroup *Resolve(ResolverObject &object) const { return this; };
  62
  63 public:
  64         virtual ~SpriteGroup() {}
  65
  66         uint32 nfo_line;
  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. */
  79 struct RealSpriteGroup : SpriteGroup {
  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;       ///< Number of loaded groups
  91         byte num_loading;      ///< Number of loading groups
  92         const SpriteGroup **loaded;  ///< List of loaded groups (can be SpriteIDs or Callback results)
  93         const SpriteGroup **loading; ///< List of loading groups (can be SpriteIDs or Callback results)
  94
  95 protected:
  96         const SpriteGroup *Resolve(ResolverObject &object) const;
  97 };
  98
  99 /* Shared by deterministic and random groups. */
 100 enum VarSpriteGroupScope {
 101         VSG_BEGIN,
 102
 103         VSG_SCOPE_SELF = VSG_BEGIN, ///< Resolved object itself
 104         VSG_SCOPE_PARENT,           ///< Related object of the resolved one
 105         VSG_SCOPE_RELATIVE,         ///< Relative position (vehicles only)
 106
 107         VSG_END
 108 };
 109 DECLARE_POSTFIX_INCREMENT(VarSpriteGroupScope)
 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
 123 enum DeterministicSpriteGroupAdjustOperation {
 124         DSGA_OP_ADD,  ///< a + b
 125         DSGA_OP_SUB,  ///< a - b
 126         DSGA_OP_SMIN, ///< (signed) min(a, b)
 127         DSGA_OP_SMAX, ///< (signed) max(a, b)
 128         DSGA_OP_UMIN, ///< (unsigned) min(a, b)
 129         DSGA_OP_UMAX, ///< (unsigned) max(a, b)
 130         DSGA_OP_SDIV, ///< (signed) a / b
 131         DSGA_OP_SMOD, ///< (signed) a % b
 132         DSGA_OP_UDIV, ///< (unsigned) a / b
 133         DSGA_OP_UMOD, ///< (unsigned) a & b
 134         DSGA_OP_MUL,  ///< a * b
 135         DSGA_OP_AND,  ///< a & b
 136         DSGA_OP_OR,   ///< a | b
 137         DSGA_OP_XOR,  ///< a ^ b
 138         DSGA_OP_STO,  ///< store a into temporary storage, indexed by b. return a
 139         DSGA_OP_RST,  ///< return b
 140         DSGA_OP_STOP, ///< store a into persistent storage, indexed by b, return a
 141         DSGA_OP_ROR,  ///< rotate a b positions to the right
 142         DSGA_OP_SCMP, ///< (signed) comparison (a < b -> 0, a == b = 1, a > b = 2)
 143         DSGA_OP_UCMP, ///< (unsigned) comparison (a < b -> 0, a == b = 1, a > b = 2)
 144         DSGA_OP_SHL,  ///< a << b
 145         DSGA_OP_SHR,  ///< (unsigned) a >> b
 146         DSGA_OP_SAR,  ///< (signed) a >> b
 147 };
 148
 149
 150 struct DeterministicSpriteGroupAdjust {
 151         DeterministicSpriteGroupAdjustOperation operation;
 152         DeterministicSpriteGroupAdjustType type;
 153         byte variable;
 154         byte parameter; ///< Used for variables between 0x60 and 0x7F inclusive.
 155         byte shift_num;
 156         uint32 and_mask;
 157         uint32 add_val;
 158         uint32 divmod_val;
 159         const SpriteGroup *subroutine;
 160 };
 161
 162
 163 struct DeterministicSpriteGroupRange {
 164         const SpriteGroup *group;
 165         uint32 low;
 166         uint32 high;
 167 };
 168
 169
 170 struct DeterministicSpriteGroup : SpriteGroup {
 171         DeterministicSpriteGroup() : SpriteGroup(SGT_DETERMINISTIC) {}
 172         ~DeterministicSpriteGroup();
 173
 174         VarSpriteGroupScope var_scope;
 175         DeterministicSpriteGroupSize size;
 176         uint num_adjusts;
 177         uint num_ranges;
 178         bool calculated_result;
 179         DeterministicSpriteGroupAdjust *adjusts;
 180         DeterministicSpriteGroupRange *ranges; // Dynamically allocated
 181
 182         /* Dynamically allocated, this is the sole owner */
 183         const SpriteGroup *default_group;
 184
 185         const SpriteGroup *error_group; // was first range, before sorting ranges
 186
 187 protected:
 188         const SpriteGroup *Resolve(ResolverObject &object) const;
 189 };
 190
 191 enum RandomizedSpriteGroupCompareMode {
 192         RSG_CMP_ANY,
 193         RSG_CMP_ALL,
 194 };
 195
 196 struct RandomizedSpriteGroup : SpriteGroup {
 197         RandomizedSpriteGroup() : SpriteGroup(SGT_RANDOMIZED) {}
 198         ~RandomizedSpriteGroup();
 199
 200         VarSpriteGroupScope var_scope;  ///< Take this object:
 201
 202         RandomizedSpriteGroupCompareMode cmp_mode; ///< Check for these triggers:
 203         byte triggers;
 204         byte count;
 205
 206         byte lowest_randbit; ///< Look for this in the per-object randomized bitmask:
 207         byte num_groups; ///< must be power of 2
 208
 209         const SpriteGroup **groups; ///< Take the group with appropriate index:
 210
 211 protected:
 212         const SpriteGroup *Resolve(ResolverObject &object) const;
 213 };
 214
 215
 216 /* This contains a callback result. A failed callback has a value of
 217  * CALLBACK_FAILED */
 218 struct CallbackResultSpriteGroup : SpriteGroup {
 219         /**
 220          * Creates a spritegroup representing a callback result
 221          * @param value The value that was used to represent this callback result
 222          * @param grf_version8 True, if we are dealing with a new NewGRF which uses GRF version >= 8.
 223          */
 224         CallbackResultSpriteGroup(uint16 value, bool grf_version8) :
 225                 SpriteGroup(SGT_CALLBACK),
 226                 result(value)
 227         {
 228                 /* Old style callback results (only valid for version < 8) have the highest byte 0xFF so signify it is a callback result.
 229                  * New style ones only have the highest bit set (allows 15-bit results, instead of just 8) */
 230                 if (!grf_version8 && (this->result >> 8) == 0xFF) {
 231                         this->result &= ~0xFF00;
 232                 } else {
 233                         this->result &= ~0x8000;
 234                 }
 235         }
 236
 237         uint16 result;
 238         uint16 GetCallbackResult() const { return this->result; }
 239 };
 240
 241
 242 /* A result sprite group returns the first SpriteID and the number of
 243  * sprites in the set */
 244 struct ResultSpriteGroup : SpriteGroup {
 245         /**
 246          * Creates a spritegroup representing a sprite number result.
 247          * @param sprite The sprite number.
 248          * @param num_sprites The number of sprites per set.
 249          * @return A spritegroup representing the sprite number result.
 250          */
 251         ResultSpriteGroup(SpriteID sprite, byte num_sprites) :
 252                 SpriteGroup(SGT_RESULT),
 253                 sprite(sprite),
 254                 num_sprites(num_sprites)
 255         {
 256         }
 257
 258         SpriteID sprite;
 259         byte num_sprites;
 260         SpriteID GetResult() const { return this->sprite; }
 261         byte GetNumResults() const { return this->num_sprites; }
 262 };
 263
 264 /**
 265  * Action 2 sprite layout for houses, industry tiles, objects and airport tiles.
 266  */
 267 struct TileLayoutSpriteGroup : SpriteGroup {
 268         TileLayoutSpriteGroup() : SpriteGroup(SGT_TILELAYOUT) {}
 269         ~TileLayoutSpriteGroup() {}
 270
 271         NewGRFSpriteLayout dts;
 272
 273         const DrawTileSprites *ProcessRegisters(uint8 *stage) const;
 274 };
 275
 276 struct IndustryProductionSpriteGroup : SpriteGroup {
 277         IndustryProductionSpriteGroup() : SpriteGroup(SGT_INDUSTRY_PRODUCTION) {}
 278
 279         uint8 version;                              ///< Production callback version used, or 0xFF if marked invalid
 280         uint8 num_input;                            ///< How many subtract_input values are valid
 281         int16 subtract_input[INDUSTRY_NUM_INPUTS];  ///< Take this much of the input cargo (can be negative, is indirect in cb version 1+)
 282         CargoID cargo_input[INDUSTRY_NUM_INPUTS];   ///< Which input cargoes to take from (only cb version 2)
 283         uint8 num_output;                           ///< How many add_output values are valid
 284         uint16 add_output[INDUSTRY_NUM_OUTPUTS];    ///< Add this much output cargo when successful (unsigned, is indirect in cb version 1+)
 285         CargoID cargo_output[INDUSTRY_NUM_OUTPUTS]; ///< Which output cargoes to add to (only cb version 2)
 286         uint8 again;
 287
 288 };
 289
 290 /**
 291  * Interface to query and set values specific to a single #VarSpriteGroupScope (action 2 scope).
 292  *
 293  * Multiple of these interfaces are combined into a #ResolverObject to allow access
 294  * to different game entities from a #SpriteGroup-chain (action 1-2-3 chain).
 295  */
 296 struct ScopeResolver {
 297         ResolverObject &ro; ///< Surrounding resolver object.
 298
 299         ScopeResolver(ResolverObject &ro) : ro(ro) {}
 300         virtual ~ScopeResolver() {}
 301
 302         virtual uint32 GetRandomBits() const;
 303         virtual uint32 GetTriggers() const;
 304
 305         virtual uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
 306         virtual void StorePSA(uint reg, int32 value);
 307 };
 308
 309 /**
 310  * Interface for #SpriteGroup-s to access the gamestate.
 311  *
 312  * Using this interface #SpriteGroup-chains (action 1-2-3 chains) can be resolved,
 313  * to get the results of callbacks, rerandomisations or normal sprite lookups.
 314  */
 315 struct ResolverObject {
 316         /**
 317          * Resolver constructor.
 318          * @param grffile NewGRF file associated with the object (or \c nullptr if none).
 319          * @param callback Callback code being resolved (default value is #CBID_NO_CALLBACK).
 320          * @param callback_param1 First parameter (var 10) of the callback (only used when \a callback is also set).
 321          * @param callback_param2 Second parameter (var 18) of the callback (only used when \a callback is also set).
 322          */
 323         ResolverObject(const GRFFile *grffile, CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0)
 324                 : default_scope(*this), callback(callback), callback_param1(callback_param1), callback_param2(callback_param2), grffile(grffile), root_spritegroup(nullptr)
 325         {
 326                 this->ResetState();
 327         }
 328
 329         virtual ~ResolverObject() {}
 330
 331         ScopeResolver default_scope; ///< Default implementation of the grf scope.
 332
 333         CallbackID callback;        ///< Callback being resolved.
 334         uint32 callback_param1;     ///< First parameter (var 10) of the callback.
 335         uint32 callback_param2;     ///< Second parameter (var 18) of the callback.
 336
 337         uint32 last_value;          ///< Result of most recent DeterministicSpriteGroup (including procedure calls)
 338
 339         uint32 waiting_triggers;    ///< Waiting triggers to be used by any rerandomisation. (scope independent)
 340         uint32 used_triggers;       ///< Subset of cur_triggers, which actually triggered some rerandomisation. (scope independent)
 341         uint32 reseed[VSG_END];     ///< Collects bits to rerandomise while triggering triggers.
 342
 343         const GRFFile *grffile;     ///< GRFFile the resolved SpriteGroup belongs to
 344         const SpriteGroup *root_spritegroup; ///< Root SpriteGroup to use for resolving
 345
 346         /**
 347          * Resolve SpriteGroup.
 348          * @return Result spritegroup.
 349          */
 350         const SpriteGroup *Resolve()
 351         {
 352                 return SpriteGroup::Resolve(this->root_spritegroup, *this);
 353         }
 354
 355         /**
 356          * Resolve callback.
 357          * @return Callback result.
 358          */
 359         uint16 ResolveCallback()
 360         {
 361                 const SpriteGroup *result = Resolve();
 362                 return result != nullptr ? result->GetCallbackResult() : CALLBACK_FAILED;
 363         }
 364
 365         virtual const SpriteGroup *ResolveReal(const RealSpriteGroup *group) const;
 366
 367         virtual ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0);
 368
 369         /**
 370          * Returns the waiting triggers that did not trigger any rerandomisation.
 371          */
 372         uint32 GetRemainingTriggers() const
 373         {
 374                 return this->waiting_triggers & ~this->used_triggers;
 375         }
 376
 377         /**
 378          * Returns the OR-sum of all bits that need reseeding
 379          * independent of the scope they were accessed with.
 380          * @return OR-sum of the bits.
 381          */
 382         uint32 GetReseedSum() const
 383         {
 384                 uint32 sum = 0;
 385                 for (VarSpriteGroupScope vsg = VSG_BEGIN; vsg < VSG_END; vsg++) {
 386                         sum |= this->reseed[vsg];
 387                 }
 388                 return sum;
 389         }
 390
 391         /**
 392          * Resets the dynamic state of the resolver object.
 393          * To be called before resolving an Action-1-2-3 chain.
 394          */
 395         void ResetState()
 396         {
 397                 this->last_value = 0;
 398                 this->waiting_triggers = 0;
 399                 this->used_triggers = 0;
 400                 memset(this->reseed, 0, sizeof(this->reseed));
 401         }
 402
 403         /**
 404          * Get the feature number being resolved for.
 405          * This function is mainly intended for the callback profiling feature.
 406          */
 407         virtual GrfSpecFeature GetFeature() const { return GSF_INVALID; }
 408         /**
 409          * Get an identifier for the item being resolved.
 410          * This function is mainly intended for the callback profiling feature,
 411          * and should return an identifier recognisable by the NewGRF developer.
 412          */
 413         virtual uint32 GetDebugID() const { return 0; }
 414 };
 415
 416 #endif /* NEWGRF_SPRITEGROUP_H */