1

/* $Id$ */

     2

     3

/** @file newgrf_spritegroup.cpp Handling of primarily NewGRF action 2. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "landscape.h"

     9

#include "oldpool.h"

    10

#include "newgrf.h"

    11

#include "newgrf_callbacks.h"

    12

#include "newgrf_spritegroup.h"

    13

#include "sprite.h"

    14

#include "date_func.h"

    15

#include "settings_type.h"

    16

    17

static void SpriteGroupPoolCleanBlock(uint start_item, uint end_item);

    18

    19

static uint _spritegroup_count = 0;

    20

STATIC_OLD_POOL(SpriteGroup, SpriteGroup, 9, 250, NULL, SpriteGroupPoolCleanBlock)

    21

    22

static void DestroySpriteGroup(SpriteGroup *group)

    23

{

    24

	/* Free dynamically allocated memory */

    25

	/* XXX Cast away the consts due to MSVC being buggy... */

    26

	switch (group->type) {

    27

		case SGT_REAL:

    28

			free((SpriteGroup**)group->g.real.loaded);

    29

			free((SpriteGroup**)group->g.real.loading);

    30

			break;

    31

    32

		case SGT_DETERMINISTIC:

    33

			free(group->g.determ.adjusts);

    34

			free(group->g.determ.ranges);

    35

			break;

    36

    37

		case SGT_RANDOMIZED:

    38

			free((SpriteGroup**)group->g.random.groups);

    39

			break;

    40

    41

		case SGT_TILELAYOUT:

    42

			free((void*)group->g.layout.dts->seq);

    43

			free(group->g.layout.dts);

    44

			break;

    45

    46

		default:

    47

			break;

    48

	}

    49

}

    50

    51

static void SpriteGroupPoolCleanBlock(uint start_item, uint end_item)

    52

{

    53

	uint i;

    54

    55

	for (i = start_item; i <= end_item; i++) {

    56

		DestroySpriteGroup(GetSpriteGroup(i));

    57

	}

    58

}

    59

    60

    61

/* Allocate a new SpriteGroup */

    62

SpriteGroup *AllocateSpriteGroup()

    63

{

    64

	/* This is totally different to the other pool allocators, as we never remove an item from the pool. */

    65

	if (_spritegroup_count == GetSpriteGroupPoolSize()) {

    66

		if (!_SpriteGroup_pool.AddBlockToPool()) return NULL;

    67

	}

    68

    69

	return GetSpriteGroup(_spritegroup_count++);

    70

}

    71

    72

    73

void InitializeSpriteGroupPool()

    74

{

    75

	_SpriteGroup_pool.CleanPool();

    76

    77

	_spritegroup_count = 0;

    78

}

    79

    80

TemporaryStorageArray<uint32, 0x110> _temp_store;

    81

    82

    83

static inline uint32 GetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available)

    84

{

    85

	/* First handle variables common with Action7/9/D */

    86

	uint32 value;

    87

	if (GetGlobalVariable(variable, &value)) return value;

    88

    89

	/* Non-common variable */

    90

	switch (variable) {

    91

		case 0x0C: return object->callback;

    92

		case 0x10: return object->callback_param1;

    93

		case 0x18: return object->callback_param2;

    94

		case 0x1C: return object->last_value;

    95

    96

		case 0x5F: return (object->GetRandomBits(object) << 8) | object->GetTriggers(object);

    97

    98

		case 0x7D: return _temp_store.Get(parameter);

    99

   100

		/* Not a common variable, so evalute the feature specific variables */

   101

		default: return object->GetVariable(object, variable, parameter, available);

   102

	}

   103

}

   104

   105

   106

/**

   107

 * Rotate val rot times to the right

   108

 * @param val the value to rotate

   109

 * @param rot the amount of times to rotate

   110

 * @return the rotated value

   111

 */

   112

static uint32 RotateRight(uint32 val, uint32 rot)

   113

{

   114

	/* Do not rotate more than necessary */

   115

	rot %= 32;

   116

   117

	return (val >> rot) | (val << (32 - rot));

   118

}

   119

   120

   121

/* Evaluate an adjustment for a variable of the given size.

   122

* U is the unsigned type and S is the signed type to use. */

   123

template <typename U, typename S>

   124

static U EvalAdjustT(const DeterministicSpriteGroupAdjust *adjust, ResolverObject *object, U last_value, uint32 value)

   125

{

   126

	value >>= adjust->shift_num;

   127

	value  &= adjust->and_mask;

   128

   129

	if (adjust->type != DSGA_TYPE_NONE) value += (S)adjust->add_val;

   130

   131

	switch (adjust->type) {

   132

		case DSGA_TYPE_DIV:  value /= (S)adjust->divmod_val; break;

   133

		case DSGA_TYPE_MOD:  value %= (U)adjust->divmod_val; break;

   134

		case DSGA_TYPE_NONE: break;

   135

	}

   136

   137

	switch (adjust->operation) {

   138

		case DSGA_OP_ADD:  return last_value + value;

   139

		case DSGA_OP_SUB:  return last_value - value;

   140

		case DSGA_OP_SMIN: return min((S)last_value, (S)value);

   141

		case DSGA_OP_SMAX: return max((S)last_value, (S)value);

   142

		case DSGA_OP_UMIN: return min((U)last_value, (U)value);

   143

		case DSGA_OP_UMAX: return max((U)last_value, (U)value);

   144

		case DSGA_OP_SDIV: return value == 0 ? (S)last_value : (S)last_value / (S)value;

   145

		case DSGA_OP_SMOD: return value == 0 ? (S)last_value : (S)last_value % (S)value;

   146

		case DSGA_OP_UDIV: return value == 0 ? (U)last_value : (U)last_value / (U)value;

   147

		case DSGA_OP_UMOD: return value == 0 ? (U)last_value : (U)last_value % (U)value;

   148

		case DSGA_OP_MUL:  return last_value * value;

   149

		case DSGA_OP_AND:  return last_value & value;

   150

		case DSGA_OP_OR:   return last_value | value;

   151

		case DSGA_OP_XOR:  return last_value ^ value;

   152

		case DSGA_OP_STO:  _temp_store.Store(value, last_value); return last_value;

   153

		case DSGA_OP_RST:  return value;

   154

		case DSGA_OP_STOP: if (object->psa != NULL) object->psa->Store(value, last_value); return last_value;

   155

		case DSGA_OP_ROR:  return RotateRight(last_value, value);

   156

		case DSGA_OP_SCMP: return ((S)last_value == (S)value) ? 1 : ((S)last_value < (S)value ? 0 : 2);

   157

		case DSGA_OP_UCMP: return ((U)last_value == (U)value) ? 1 : ((U)last_value < (U)value ? 0 : 2);

   158

		default:           return value;

   159

	}

   160

}

   161

   162

   163

static inline const SpriteGroup *ResolveVariable(const SpriteGroup *group, ResolverObject *object)

   164

{

   165

	static SpriteGroup nvarzero;

   166

	uint32 last_value = 0;

   167

	uint32 value = 0;

   168

	uint i;

   169

   170

	object->scope = group->g.determ.var_scope;

   171

   172

	for (i = 0; i < group->g.determ.num_adjusts; i++) {

   173

		DeterministicSpriteGroupAdjust *adjust = &group->g.determ.adjusts[i];

   174

   175

		/* Try to get the variable. We shall assume it is available, unless told otherwise. */

   176

		bool available = true;

   177

		if (adjust->variable == 0x7E) {

   178

			ResolverObject subobject = *object;

   179

			subobject.procedure_call = true;

   180

			const SpriteGroup *subgroup = Resolve(adjust->subroutine, &subobject);

   181

			if (subgroup == NULL || subgroup->type != SGT_CALLBACK) {

   182

				value = CALLBACK_FAILED;

   183

			} else {

   184

				value = subgroup->g.callback.result;

   185

			}

   186

		} else {

   187

			value = GetVariable(object, adjust->variable, adjust->parameter, &available);

   188

		}

   189

   190

		if (!available) {

   191

			/* Unsupported property: skip further processing and return either

   192

			 * the group from the first range or the default group. */

   193

			return Resolve(group->g.determ.num_ranges > 0 ? group->g.determ.ranges[0].group : group->g.determ.default_group, object);

   194

		}

   195

   196

		switch (group->g.determ.size) {

   197

			case DSG_SIZE_BYTE:  value = EvalAdjustT<uint8,  int8> (adjust, object, last_value, value); break;

   198

			case DSG_SIZE_WORD:  value = EvalAdjustT<uint16, int16>(adjust, object, last_value, value); break;

   199

			case DSG_SIZE_DWORD: value = EvalAdjustT<uint32, int32>(adjust, object, last_value, value); break;

   200

			default: NOT_REACHED(); break;

   201

		}

   202

		last_value = value;

   203

	}

   204

   205

	object->last_value = last_value;

   206

   207

	if (group->g.determ.num_ranges == 0) {

   208

		/* nvar == 0 is a special case -- we turn our value into a callback result */

   209

		if (value != CALLBACK_FAILED) value = GB(value, 0, 15);

   210

		nvarzero.type = SGT_CALLBACK;

   211

		nvarzero.g.callback.result = value;

   212

		return &nvarzero;

   213

	}

   214

   215

	for (i = 0; i < group->g.determ.num_ranges; i++) {

   216

		if (group->g.determ.ranges[i].low <= value && value <= group->g.determ.ranges[i].high) {

   217

			return Resolve(group->g.determ.ranges[i].group, object);

   218

		}

   219

	}

   220

   221

	return Resolve(group->g.determ.default_group, object);

   222

}

   223

   224

   225

static inline const SpriteGroup *ResolveRandom(const SpriteGroup *group, ResolverObject *object)

   226

{

   227

	uint32 mask;

   228

	byte index;

   229

   230

	object->scope = group->g.random.var_scope;

   231

	object->count = group->g.random.count;

   232

   233

	if (object->trigger != 0) {

   234

		/* Handle triggers */

   235

		/* Magic code that may or may not do the right things... */

   236

		byte waiting_triggers = object->GetTriggers(object);

   237

		byte match = group->g.random.triggers & (waiting_triggers | object->trigger);

   238

		bool res;

   239

   240

		res = (group->g.random.cmp_mode == RSG_CMP_ANY) ?

   241

			(match != 0) : (match == group->g.random.triggers);

   242

   243

		if (res) {

   244

			waiting_triggers &= ~match;

   245

			object->reseed |= (group->g.random.num_groups - 1) << group->g.random.lowest_randbit;

   246

		} else {

   247

			waiting_triggers |= object->trigger;

   248

		}

   249

   250

		object->SetTriggers(object, waiting_triggers);

   251

	}

   252

   253

	mask  = (group->g.random.num_groups - 1) << group->g.random.lowest_randbit;

   254

	index = (object->GetRandomBits(object) & mask) >> group->g.random.lowest_randbit;

   255

   256

	return Resolve(group->g.random.groups[index], object);

   257

}

   258

   259

   260

/* ResolverObject (re)entry point */

   261

const SpriteGroup *Resolve(const SpriteGroup *group, ResolverObject *object)

   262

{

   263

	/* We're called even if there is no group, so quietly return nothing */

   264

	if (group == NULL) return NULL;

   265

   266

	switch (group->type) {

   267

		case SGT_REAL:          return object->ResolveReal(object, group);

   268

		case SGT_DETERMINISTIC: return ResolveVariable(group, object);

   269

		case SGT_RANDOMIZED:    return ResolveRandom(group, object);

   270

		default:                return group;

   271

	}

   272

}