peter1138@3595: /* $Id$ */ peter1138@3595: rubidium@10455: /** @file newgrf_spritegroup.cpp Handling of primarily NewGRF action 2. */ glx@9505: peter1138@3595: #include "stdafx.h" peter1138@3595: #include "openttd.h" peter1138@3677: #include "variables.h" glx@9505: #include "landscape.h" matthijs@5216: #include "oldpool.h" glx@9732: #include "newgrf.h" maedhros@5868: #include "newgrf_callbacks.h" peter1138@3677: #include "newgrf_spritegroup.h" truelight@9476: #include "sprite.h" rubidium@9723: #include "date_func.h" rubidium@9724: #include "settings_type.h" peter1138@3595: tron@4971: static void SpriteGroupPoolCleanBlock(uint start_item, uint end_item); peter1138@3595: peter1138@3595: static uint _spritegroup_count = 0; peter1138@5725: STATIC_OLD_POOL(SpriteGroup, SpriteGroup, 9, 250, NULL, SpriteGroupPoolCleanBlock) peter1138@3595: tron@5022: static void DestroySpriteGroup(SpriteGroup *group) truelight@4402: { truelight@4402: /* Free dynamically allocated memory */ peter1138@4894: /* XXX Cast away the consts due to MSVC being buggy... */ truelight@4402: switch (group->type) { truelight@4402: case SGT_REAL: peter1138@4894: free((SpriteGroup**)group->g.real.loaded); peter1138@4894: free((SpriteGroup**)group->g.real.loading); truelight@4402: break; truelight@4402: truelight@4402: case SGT_DETERMINISTIC: truelight@4402: free(group->g.determ.adjusts); truelight@4402: free(group->g.determ.ranges); truelight@4402: break; truelight@4402: truelight@4402: case SGT_RANDOMIZED: peter1138@4894: free((SpriteGroup**)group->g.random.groups); truelight@4402: break; truelight@4402: truelight@9476: case SGT_TILELAYOUT: truelight@9476: free((void*)group->g.layout.dts->seq); truelight@9476: free(group->g.layout.dts); truelight@9476: break; truelight@9476: truelight@4402: default: truelight@4402: break; truelight@4402: } truelight@4402: } peter1138@3595: peter1138@3595: static void SpriteGroupPoolCleanBlock(uint start_item, uint end_item) peter1138@3595: { peter1138@3595: uint i; peter1138@3595: peter1138@3595: for (i = start_item; i <= end_item; i++) { tron@4971: DestroySpriteGroup(GetSpriteGroup(i)); peter1138@3595: } peter1138@3595: } peter1138@3595: peter1138@3595: peter1138@3595: /* Allocate a new SpriteGroup */ rubidium@6573: SpriteGroup *AllocateSpriteGroup() peter1138@3595: { peter1138@3595: /* This is totally different to the other pool allocators, as we never remove an item from the pool. */ tron@4971: if (_spritegroup_count == GetSpriteGroupPoolSize()) { rubidium@9694: if (!_SpriteGroup_pool.AddBlockToPool()) return NULL; peter1138@3595: } peter1138@3595: tron@4971: return GetSpriteGroup(_spritegroup_count++); peter1138@3595: } peter1138@3595: peter1138@3595: rubidium@6573: void InitializeSpriteGroupPool() peter1138@3595: { rubidium@9694: _SpriteGroup_pool.CleanPool(); peter1138@3595: peter1138@3595: _spritegroup_count = 0; peter1138@3595: } peter1138@3677: rubidium@9703: TemporaryStorageArray _temp_store; rubidium@9601: peter1138@3677: peter1138@3893: static inline uint32 GetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available) peter1138@3677: { glx@9732: /* First handle variables common with Action7/9/D */ glx@9732: uint32 value; glx@9732: if (GetGlobalVariable(variable, &value)) return value; glx@9732: glx@9732: /* Non-common variable */ peter1138@3677: switch (variable) { peter1138@3677: case 0x0C: return object->callback; peter1138@3677: case 0x10: return object->callback_param1; peter1138@3677: case 0x18: return object->callback_param2; peter1138@3677: case 0x1C: return object->last_value; peter1138@3677: rubidium@11044: case 0x5F: return (object->GetRandomBits(object) << 8) | object->GetTriggers(object); rubidium@11044: rubidium@9703: case 0x7D: return _temp_store.Get(parameter); rubidium@9601: peter1138@3677: /* Not a common variable, so evalute the feature specific variables */ peter1138@3893: default: return object->GetVariable(object, variable, parameter, available); peter1138@3677: } peter1138@3677: } peter1138@3677: peter1138@3677: rubidium@9703: /** rubidium@9703: * Rotate val rot times to the right rubidium@9703: * @param val the value to rotate rubidium@9703: * @param rot the amount of times to rotate rubidium@9703: * @return the rotated value rubidium@9703: */ rubidium@9703: static uint32 RotateRight(uint32 val, uint32 rot) rubidium@9703: { rubidium@9703: /* Do not rotate more than necessary */ rubidium@9703: rot %= 32; rubidium@9703: rubidium@9703: return (val >> rot) | (val << (32 - rot)); rubidium@9703: } rubidium@9703: rubidium@9703: peter1138@5851: /* Evaluate an adjustment for a variable of the given size. peter1138@5851: * U is the unsigned type and S is the signed type to use. */ peter1138@5851: template rubidium@9703: static U EvalAdjustT(const DeterministicSpriteGroupAdjust *adjust, ResolverObject *object, U last_value, uint32 value) peter1138@5851: { peter1138@5851: value >>= adjust->shift_num; peter1138@5851: value &= adjust->and_mask; peter1138@5851: peter1138@5851: if (adjust->type != DSGA_TYPE_NONE) value += (S)adjust->add_val; peter1138@5851: peter1138@5851: switch (adjust->type) { peter1138@5851: case DSGA_TYPE_DIV: value /= (S)adjust->divmod_val; break; peter1138@5851: case DSGA_TYPE_MOD: value %= (U)adjust->divmod_val; break; peter1138@5851: case DSGA_TYPE_NONE: break; peter1138@5851: } peter1138@5851: peter1138@5851: switch (adjust->operation) { peter1138@5851: case DSGA_OP_ADD: return last_value + value; peter1138@5851: case DSGA_OP_SUB: return last_value - value; celestar@5852: case DSGA_OP_SMIN: return min((S)last_value, (S)value); celestar@5852: case DSGA_OP_SMAX: return max((S)last_value, (S)value); peter1138@5851: case DSGA_OP_UMIN: return min((U)last_value, (U)value); peter1138@5851: case DSGA_OP_UMAX: return max((U)last_value, (U)value); glx@9624: case DSGA_OP_SDIV: return value == 0 ? (S)last_value : (S)last_value / (S)value; glx@9624: case DSGA_OP_SMOD: return value == 0 ? (S)last_value : (S)last_value % (S)value; glx@9624: case DSGA_OP_UDIV: return value == 0 ? (U)last_value : (U)last_value / (U)value; glx@9624: case DSGA_OP_UMOD: return value == 0 ? (U)last_value : (U)last_value % (U)value; peter1138@5851: case DSGA_OP_MUL: return last_value * value; peter1138@5851: case DSGA_OP_AND: return last_value & value; peter1138@5851: case DSGA_OP_OR: return last_value | value; peter1138@5851: case DSGA_OP_XOR: return last_value ^ value; rubidium@9703: case DSGA_OP_STO: _temp_store.Store(value, last_value); return last_value; rubidium@9601: case DSGA_OP_RST: return value; rubidium@9703: case DSGA_OP_STOP: if (object->psa != NULL) object->psa->Store(value, last_value); return last_value; rubidium@9703: case DSGA_OP_ROR: return RotateRight(last_value, value); rubidium@9703: case DSGA_OP_SCMP: return ((S)last_value == (S)value) ? 1 : ((S)last_value < (S)value ? 0 : 2); rubidium@9703: case DSGA_OP_UCMP: return ((U)last_value == (U)value) ? 1 : ((U)last_value < (U)value ? 0 : 2); peter1138@5851: default: return value; peter1138@5851: } peter1138@3677: } peter1138@3677: peter1138@3677: peter1138@3686: static inline const SpriteGroup *ResolveVariable(const SpriteGroup *group, ResolverObject *object) peter1138@3677: { peter1138@3677: static SpriteGroup nvarzero; peter1138@5858: uint32 last_value = 0; peter1138@5857: uint32 value = 0; peter1138@3677: uint i; peter1138@3677: peter1138@3677: object->scope = group->g.determ.var_scope; peter1138@3677: peter1138@3677: for (i = 0; i < group->g.determ.num_adjusts; i++) { peter1138@3677: DeterministicSpriteGroupAdjust *adjust = &group->g.determ.adjusts[i]; peter1138@3893: peter1138@3893: /* Try to get the variable. We shall assume it is available, unless told otherwise. */ peter1138@3893: bool available = true; maedhros@5868: if (adjust->variable == 0x7E) { peter1138@5873: ResolverObject subobject = *object; rubidium@9826: subobject.procedure_call = true; peter1138@5873: const SpriteGroup *subgroup = Resolve(adjust->subroutine, &subobject); maedhros@5868: if (subgroup == NULL || subgroup->type != SGT_CALLBACK) { maedhros@5868: value = CALLBACK_FAILED; maedhros@5868: } else { maedhros@5868: value = subgroup->g.callback.result; maedhros@5868: } maedhros@5868: } else { maedhros@5868: value = GetVariable(object, adjust->variable, adjust->parameter, &available); maedhros@5868: } peter1138@3893: peter1138@3893: if (!available) { peter1138@3893: /* Unsupported property: skip further processing and return either peter1138@3893: * the group from the first range or the default group. */ peter1138@3893: return Resolve(group->g.determ.num_ranges > 0 ? group->g.determ.ranges[0].group : group->g.determ.default_group, object); peter1138@3893: } peter1138@3893: peter1138@3677: switch (group->g.determ.size) { rubidium@9703: case DSG_SIZE_BYTE: value = EvalAdjustT (adjust, object, last_value, value); break; rubidium@9703: case DSG_SIZE_WORD: value = EvalAdjustT(adjust, object, last_value, value); break; rubidium@9703: case DSG_SIZE_DWORD: value = EvalAdjustT(adjust, object, last_value, value); break; peter1138@3677: default: NOT_REACHED(); break; peter1138@3677: } peter1138@3677: last_value = value; peter1138@3677: } peter1138@3677: peter1138@5858: object->last_value = last_value; peter1138@5858: peter1138@3893: if (group->g.determ.num_ranges == 0) { peter1138@3893: /* nvar == 0 is a special case -- we turn our value into a callback result */ rubidium@10455: if (value != CALLBACK_FAILED) value = GB(value, 0, 15); peter1138@3893: nvarzero.type = SGT_CALLBACK; glx@10294: nvarzero.g.callback.result = value; peter1138@3893: return &nvarzero; peter1138@3893: } peter1138@3677: peter1138@3893: for (i = 0; i < group->g.determ.num_ranges; i++) { peter1138@5857: if (group->g.determ.ranges[i].low <= value && value <= group->g.determ.ranges[i].high) { peter1138@3893: return Resolve(group->g.determ.ranges[i].group, object); peter1138@3677: } peter1138@3677: } peter1138@3677: peter1138@3893: return Resolve(group->g.determ.default_group, object); peter1138@3677: } peter1138@3677: peter1138@3677: peter1138@3686: static inline const SpriteGroup *ResolveRandom(const SpriteGroup *group, ResolverObject *object) peter1138@3677: { peter1138@3753: uint32 mask; peter1138@3677: byte index; peter1138@3677: peter1138@3677: object->scope = group->g.random.var_scope; rubidium@9826: object->count = group->g.random.count; peter1138@3677: peter1138@3677: if (object->trigger != 0) { peter1138@3677: /* Handle triggers */ peter1138@3677: /* Magic code that may or may not do the right things... */ peter1138@3677: byte waiting_triggers = object->GetTriggers(object); peter1138@3677: byte match = group->g.random.triggers & (waiting_triggers | object->trigger); peter1138@3677: bool res; peter1138@3677: peter1138@3677: res = (group->g.random.cmp_mode == RSG_CMP_ANY) ? peter1138@3677: (match != 0) : (match == group->g.random.triggers); peter1138@3677: peter1138@3677: if (res) { peter1138@3677: waiting_triggers &= ~match; peter1138@3677: object->reseed |= (group->g.random.num_groups - 1) << group->g.random.lowest_randbit; peter1138@3677: } else { peter1138@3677: waiting_triggers |= object->trigger; peter1138@3677: } peter1138@3677: peter1138@3677: object->SetTriggers(object, waiting_triggers); peter1138@3677: } peter1138@3677: peter1138@3677: mask = (group->g.random.num_groups - 1) << group->g.random.lowest_randbit; peter1138@3677: index = (object->GetRandomBits(object) & mask) >> group->g.random.lowest_randbit; peter1138@3677: peter1138@3677: return Resolve(group->g.random.groups[index], object); peter1138@3677: } peter1138@3677: peter1138@3677: peter1138@3677: /* ResolverObject (re)entry point */ peter1138@3677: const SpriteGroup *Resolve(const SpriteGroup *group, ResolverObject *object) peter1138@3677: { peter1138@3677: /* We're called even if there is no group, so quietly return nothing */ peter1138@3677: if (group == NULL) return NULL; peter1138@3677: peter1138@3677: switch (group->type) { peter1138@3734: case SGT_REAL: return object->ResolveReal(object, group); peter1138@3677: case SGT_DETERMINISTIC: return ResolveVariable(group, object); peter1138@3677: case SGT_RANDOMIZED: return ResolveRandom(group, object); peter1138@3677: default: return group; peter1138@3677: } peter1138@3677: }