src/newgrf_spritegroup.cpp

   1 /* $Id$ */
   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
  10 /** @file newgrf_spritegroup.cpp Handling of primarily NewGRF action 2. */
  11
  12 #include "stdafx.h"
  13 #include "debug.h"
  14 #include "newgrf_spritegroup.h"
  15 #include "core/pool_func.hpp"
  16
  17 SpriteGroupPool _spritegroup_pool("SpriteGroup");
  18 INSTANTIATE_POOL_METHODS(SpriteGroup)
  19
  20 TemporaryStorageArray<int32, 0x110> _temp_store;
  21
  22
  23 /**
  24  * ResolverObject (re)entry point.
  25  * This cannot be made a call to a virtual function because virtual functions
  26  * do not like NULL and checking for NULL *everywhere* is more cumbersome than
  27  * this little helper function.
  28  * @param group the group to resolve for
  29  * @param object information needed to resolve the group
  30  * @param top_level true if this is a top-level SpriteGroup, false if used nested in another SpriteGroup.
  31  * @return the resolved group
  32  */
  33 /* static */ const SpriteGroup *SpriteGroup::Resolve(const SpriteGroup *group, ResolverObject &object, bool top_level)
  34 {
  35         if (group == NULL) return NULL;
  36         if (top_level) {
  37                 _temp_store.ClearChanges();
  38         }
  39         return group->Resolve(object);
  40 }
  41
  42 RealSpriteGroup::~RealSpriteGroup()
  43 {
  44         free(this->loaded);
  45         free(this->loading);
  46 }
  47
  48 DeterministicSpriteGroup::~DeterministicSpriteGroup()
  49 {
  50         free(this->adjusts);
  51         free(this->ranges);
  52 }
  53
  54 RandomizedSpriteGroup::~RandomizedSpriteGroup()
  55 {
  56         free(this->groups);
  57 }
  58
  59 static inline uint32 GetVariable(const ResolverObject &object, ScopeResolver *scope, byte variable, uint32 parameter, bool *available)
  60 {
  61         /* First handle variables common with Action7/9/D */
  62         uint32 value;
  63         if (GetGlobalVariable(variable, &value, object.grffile)) return value;
  64
  65         /* Non-common variable */
  66         switch (variable) {
  67                 case 0x0C: return object.callback;
  68                 case 0x10: return object.callback_param1;
  69                 case 0x18: return object.callback_param2;
  70                 case 0x1C: return object.last_value;
  71
  72                 case 0x5F: return (scope->GetRandomBits() << 8) | scope->GetTriggers();
  73
  74                 case 0x7D: return _temp_store.GetValue(parameter);
  75
  76                 case 0x7F:
  77                         if (object.grffile == NULL) return 0;
  78                         return object.grffile->GetParam(parameter);
  79
  80                 /* Not a common variable, so evaluate the feature specific variables */
  81                 default: return scope->GetVariable(variable, parameter, available);
  82         }
  83 }
  84
  85 ScopeResolver::ScopeResolver(ResolverObject &ro)
  86                 : ro(ro)
  87 {
  88 }
  89
  90 ScopeResolver::~ScopeResolver() {}
  91
  92 /**
  93  * Get a few random bits. Default implementation has no random bits.
  94  * @return Random bits.
  95  */
  96 /* virtual */ uint32 ScopeResolver::GetRandomBits() const
  97 {
  98         return 0;
  99 }
 100
 101 /**
 102  * Get the triggers. Base class returns \c 0 to prevent trouble.
 103  * @return The triggers.
 104  */
 105 /* virtual */ uint32 ScopeResolver::GetTriggers() const
 106 {
 107         return 0;
 108 }
 109
 110 /**
 111  * Set the triggers. Base class implementation does nothing.
 112  * @param triggers Triggers to set.
 113  */
 114 /* virtual */ void ScopeResolver::SetTriggers(int triggers) const {}
 115
 116 /**
 117  * Get a variable value. Default implementation has no available variables.
 118  * @param variable Variable to read
 119  * @param parameter Parameter for 60+x variables
 120  * @param[out] available Set to false, in case the variable does not exist.
 121  * @return Value
 122  */
 123 /* virtual */ uint32 ScopeResolver::GetVariable(byte variable, uint32 parameter, bool *available) const
 124 {
 125         DEBUG(grf, 1, "Unhandled scope variable 0x%X", variable);
 126         *available = false;
 127         return UINT_MAX;
 128 }
 129
 130 /**
 131  * Store a value into the persistent storage area (PSA). Default implementation does nothing (for newgrf classes without storage).
 132  * @param pos Position to store into.
 133  * @param value Value to store.
 134  */
 135 /* virtual */ void ScopeResolver::StorePSA(uint reg, int32 value) {}
 136
 137 /**
 138  * Resolver constructor.
 139  * @param grffile NewGRF file associated with the object (or \c NULL if none).
 140  * @param callback Callback code being resolved (default value is #CBID_NO_CALLBACK).
 141  * @param callback_param1 First parameter (var 10) of the callback (only used when \a callback is also set).
 142  * @param callback_param2 Second parameter (var 18) of the callback (only used when \a callback is also set).
 143  */
 144 ResolverObject::ResolverObject(const GRFFile *grffile, CallbackID callback, uint32 callback_param1, uint32 callback_param2)
 145                 : default_scope(*this)
 146 {
 147         this->callback = callback;
 148         this->callback_param1 = callback_param1;
 149         this->callback_param2 = callback_param2;
 150         this->ResetState();
 151
 152         this->grffile = grffile;
 153 }
 154
 155 ResolverObject::~ResolverObject() {}
 156
 157 /**
 158  * Get the real sprites of the grf.
 159  * @param group Group to get.
 160  * @return The available sprite group.
 161  */
 162 /* virtual */ const SpriteGroup *ResolverObject::ResolveReal(const RealSpriteGroup *group) const
 163 {
 164         return NULL;
 165 }
 166
 167 /**
 168  * Get a resolver for the \a scope.
 169  * @param scope Scope to return.
 170  * @param relative Additional parameter for #VSG_SCOPE_RELATIVE.
 171  * @return The resolver for the requested scope.
 172  */
 173 /* virtual */ ScopeResolver *ResolverObject::GetScope(VarSpriteGroupScope scope, byte relative)
 174 {
 175         return &this->default_scope;
 176 }
 177
 178 /**
 179  * Rotate val rot times to the right
 180  * @param val the value to rotate
 181  * @param rot the amount of times to rotate
 182  * @return the rotated value
 183  */
 184 static uint32 RotateRight(uint32 val, uint32 rot)
 185 {
 186         /* Do not rotate more than necessary */
 187         rot %= 32;
 188
 189         return (val >> rot) | (val << (32 - rot));
 190 }
 191
 192
 193 /* Evaluate an adjustment for a variable of the given size.
 194  * U is the unsigned type and S is the signed type to use. */
 195 template <typename U, typename S>
 196 static U EvalAdjustT(const DeterministicSpriteGroupAdjust *adjust, ScopeResolver *scope, U last_value, uint32 value)
 197 {
 198         value >>= adjust->shift_num;
 199         value  &= adjust->and_mask;
 200
 201         if (adjust->type != DSGA_TYPE_NONE) value += (S)adjust->add_val;
 202
 203         switch (adjust->type) {
 204                 case DSGA_TYPE_DIV:  value /= (S)adjust->divmod_val; break;
 205                 case DSGA_TYPE_MOD:  value %= (U)adjust->divmod_val; break;
 206                 case DSGA_TYPE_NONE: break;
 207         }
 208
 209         switch (adjust->operation) {
 210                 case DSGA_OP_ADD:  return last_value + value;
 211                 case DSGA_OP_SUB:  return last_value - value;
 212                 case DSGA_OP_SMIN: return min((S)last_value, (S)value);
 213                 case DSGA_OP_SMAX: return max((S)last_value, (S)value);
 214                 case DSGA_OP_UMIN: return min((U)last_value, (U)value);
 215                 case DSGA_OP_UMAX: return max((U)last_value, (U)value);
 216                 case DSGA_OP_SDIV: return value == 0 ? (S)last_value : (S)last_value / (S)value;
 217                 case DSGA_OP_SMOD: return value == 0 ? (S)last_value : (S)last_value % (S)value;
 218                 case DSGA_OP_UDIV: return value == 0 ? (U)last_value : (U)last_value / (U)value;
 219                 case DSGA_OP_UMOD: return value == 0 ? (U)last_value : (U)last_value % (U)value;
 220                 case DSGA_OP_MUL:  return last_value * value;
 221                 case DSGA_OP_AND:  return last_value & value;
 222                 case DSGA_OP_OR:   return last_value | value;
 223                 case DSGA_OP_XOR:  return last_value ^ value;
 224                 case DSGA_OP_STO:  _temp_store.StoreValue((U)value, (S)last_value); return last_value;
 225                 case DSGA_OP_RST:  return value;
 226                 case DSGA_OP_STOP: scope->StorePSA((U)value, (S)last_value); return last_value;
 227                 case DSGA_OP_ROR:  return RotateRight(last_value, value);
 228                 case DSGA_OP_SCMP: return ((S)last_value == (S)value) ? 1 : ((S)last_value < (S)value ? 0 : 2);
 229                 case DSGA_OP_UCMP: return ((U)last_value == (U)value) ? 1 : ((U)last_value < (U)value ? 0 : 2);
 230                 case DSGA_OP_SHL:  return (U)last_value << ((U)value & 0x1F); // mask 'value' to 5 bits, which should behave the same on all architectures.
 231                 case DSGA_OP_SHR:  return (U)last_value >> ((U)value & 0x1F);
 232                 case DSGA_OP_SAR:  return (S)last_value >> ((U)value & 0x1F);
 233                 default:           return value;
 234         }
 235 }
 236
 237
 238 const SpriteGroup *DeterministicSpriteGroup::Resolve(ResolverObject &object) const
 239 {
 240         uint32 last_value = 0;
 241         uint32 value = 0;
 242         uint i;
 243
 244         ScopeResolver *scope = object.GetScope(this->var_scope);
 245
 246         for (i = 0; i < this->num_adjusts; i++) {
 247                 DeterministicSpriteGroupAdjust *adjust = &this->adjusts[i];
 248
 249                 /* Try to get the variable. We shall assume it is available, unless told otherwise. */
 250                 bool available = true;
 251                 if (adjust->variable == 0x7E) {
 252                         const SpriteGroup *subgroup = SpriteGroup::Resolve(adjust->subroutine, object, false);
 253                         if (subgroup == NULL) {
 254                                 value = CALLBACK_FAILED;
 255                         } else {
 256                                 value = subgroup->GetCallbackResult();
 257                         }
 258
 259                         /* Note: 'last_value' and 'reseed' are shared between the main chain and the procedure */
 260                 } else if (adjust->variable == 0x7B) {
 261                         value = GetVariable(object, scope, adjust->parameter, last_value, &available);
 262                 } else {
 263                         value = GetVariable(object, scope, adjust->variable, adjust->parameter, &available);
 264                 }
 265
 266                 if (!available) {
 267                         /* Unsupported variable: skip further processing and return either
 268                          * the group from the first range or the default group. */
 269                         return SpriteGroup::Resolve(this->num_ranges > 0 ? this->ranges[0].group : this->default_group, object, false);
 270                 }
 271
 272                 switch (this->size) {
 273                         case DSG_SIZE_BYTE:  value = EvalAdjustT<uint8,  int8> (adjust, scope, last_value, value); break;
 274                         case DSG_SIZE_WORD:  value = EvalAdjustT<uint16, int16>(adjust, scope, last_value, value); break;
 275                         case DSG_SIZE_DWORD: value = EvalAdjustT<uint32, int32>(adjust, scope, last_value, value); break;
 276                         default: NOT_REACHED();
 277                 }
 278                 last_value = value;
 279         }
 280
 281         object.last_value = last_value;
 282
 283         if (this->num_ranges == 0) {
 284                 /* nvar == 0 is a special case -- we turn our value into a callback result */
 285                 if (value != CALLBACK_FAILED) value = GB(value, 0, 15);
 286                 static CallbackResultSpriteGroup nvarzero(0, true);
 287                 nvarzero.result = value;
 288                 return &nvarzero;
 289         }
 290
 291         for (i = 0; i < this->num_ranges; i++) {
 292                 if (this->ranges[i].low <= value && value <= this->ranges[i].high) {
 293                         return SpriteGroup::Resolve(this->ranges[i].group, object, false);
 294                 }
 295         }
 296
 297         return SpriteGroup::Resolve(this->default_group, object, false);
 298 }
 299
 300
 301 const SpriteGroup *RandomizedSpriteGroup::Resolve(ResolverObject &object) const
 302 {
 303         ScopeResolver *scope = object.GetScope(this->var_scope, this->count);
 304         if (object.trigger != 0) {
 305                 /* Handle triggers */
 306                 /* Magic code that may or may not do the right things... */
 307                 byte waiting_triggers = scope->GetTriggers();
 308                 byte match = this->triggers & (waiting_triggers | object.trigger);
 309                 bool res = (this->cmp_mode == RSG_CMP_ANY) ? (match != 0) : (match == this->triggers);
 310
 311                 if (res) {
 312                         waiting_triggers &= ~match;
 313                         object.reseed[this->var_scope] |= (this->num_groups - 1) << this->lowest_randbit;
 314                 } else {
 315                         waiting_triggers |= object.trigger;
 316                 }
 317
 318                 scope->SetTriggers(waiting_triggers);
 319         }
 320
 321         uint32 mask  = (this->num_groups - 1) << this->lowest_randbit;
 322         byte index = (scope->GetRandomBits() & mask) >> this->lowest_randbit;
 323
 324         return SpriteGroup::Resolve(this->groups[index], object, false);
 325 }
 326
 327
 328 const SpriteGroup *RealSpriteGroup::Resolve(ResolverObject &object) const
 329 {
 330         return object.ResolveReal(this);
 331 }
 332
 333 /**
 334  * Process registers and the construction stage into the sprite layout.
 335  * The passed construction stage might get reset to zero, if it gets incorporated into the layout
 336  * during the preprocessing.
 337  * @param [in, out] stage Construction stage (0-3), or NULL if not applicable.
 338  * @return sprite layout to draw.
 339  */
 340 const DrawTileSprites *TileLayoutSpriteGroup::ProcessRegisters(uint8 *stage) const
 341 {
 342         if (!this->dts.NeedsPreprocessing()) {
 343                 if (stage != NULL && this->dts.consistent_max_offset > 0) *stage = GetConstructionStageOffset(*stage, this->dts.consistent_max_offset);
 344                 return &this->dts;
 345         }
 346
 347         static DrawTileSprites result;
 348         uint8 actual_stage = stage != NULL ? *stage : 0;
 349         this->dts.PrepareLayout(0, 0, 0, actual_stage, false);
 350         this->dts.ProcessRegisters(0, 0, false);
 351         result.seq = this->dts.GetLayout(&result.ground);
 352
 353         /* Stage has been processed by PrepareLayout(), set it to zero. */
 354         if (stage != NULL) *stage = 0;
 355
 356         return &result;
 357 }