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

		case 0x7F:

   101

			if (object == NULL || object->grffile == NULL || parameter >= object->grffile->param_end) return 0;

   102

			return object->grffile->param[parameter];

   103

   104

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

   105

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

   106

	}

   107

}

   108

   109

   110

/**

   111

 * Rotate val rot times to the right

   112

 * @param val the value to rotate

   113

 * @param rot the amount of times to rotate

   114

 * @return the rotated value

   115

 */

   116

static uint32 RotateRight(uint32 val, uint32 rot)

   117

{

   118

	/* Do not rotate more than necessary */

   119

	rot %= 32;

   120

   121

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

   122

}

   123

   124

   125

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

   126

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

   127

template <typename U, typename S>

   128

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

   129

{

   130

	value >>= adjust->shift_num;

   131

	value  &= adjust->and_mask;

   132

   133

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

   134

   135

	switch (adjust->type) {

   136

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

   137

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

   138

		case DSGA_TYPE_NONE: break;

   139

	}

   140

   141

	switch (adjust->operation) {

   142

		case DSGA_OP_ADD:  return last_value + value;

   143

		case DSGA_OP_SUB:  return last_value - value;

   144

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

   145

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

   146

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

   147

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

   148

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

   149

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

   150

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

   151

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

   152

		case DSGA_OP_MUL:  return last_value * value;

   153

		case DSGA_OP_AND:  return last_value & value;

   154

		case DSGA_OP_OR:   return last_value | value;

   155

		case DSGA_OP_XOR:  return last_value ^ value;

   156

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

   157

		case DSGA_OP_RST:  return value;

   158

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

   159

		case DSGA_OP_ROR:  return RotateRight(last_value, value);

   160

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

   161

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

   162

		default:           return value;

   163

	}

   164

}

   165

   166

   167

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

   168

{

   169

	static SpriteGroup nvarzero;

   170

	uint32 last_value = 0;

   171

	uint32 value = 0;

   172

	uint i;

   173

   174

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

   175

   176

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

   177

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

   178

   179

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

   180

		bool available = true;

   181

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

   182

			ResolverObject subobject = *object;

   183

			subobject.procedure_call = true;

   184

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

   185

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

   186

				value = CALLBACK_FAILED;

   187

			} else {

   188

				value = subgroup->g.callback.result;

   189

			}

   190

		} else {

   191

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

   192

		}

   193

   194

		if (!available) {

   195

			/* Unsupported property: skip further processing and return either

   196

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

   197

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

   198

		}

   199

   200

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

   201

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

   202

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

   203

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

   204

			default: NOT_REACHED(); break;

   205

		}

   206

		last_value = value;

   207

	}

   208

   209

	object->last_value = last_value;

   210

   211

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

   212

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

   213

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

   214

		nvarzero.type = SGT_CALLBACK;

   215

		nvarzero.g.callback.result = value;

   216

		return &nvarzero;

   217

	}

   218

   219

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

   220

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

   221

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

   222

		}

   223

	}

   224

   225

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

   226

}

   227

   228

   229

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

   230

{

   231

	uint32 mask;

   232

	byte index;

   233

   234

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

   235

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

   236

   237

	if (object->trigger != 0) {

   238

		/* Handle triggers */

   239

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

   240

		byte waiting_triggers = object->GetTriggers(object);

   241

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

   242

		bool res;

   243

   244

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

   245

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

   246

   247

		if (res) {

   248

			waiting_triggers &= ~match;

   249

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

   250

		} else {

   251

			waiting_triggers |= object->trigger;

   252

		}

   253

   254

		object->SetTriggers(object, waiting_triggers);

   255

	}

   256

   257

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

   258

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

   259

   260

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

   261

}

   262

   263

   264

/* ResolverObject (re)entry point */

   265

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

   266

{

   267

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

   268

	if (group == NULL) return NULL;

   269

   270

	switch (group->type) {

   271

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

   272

		case SGT_DETERMINISTIC: return ResolveVariable(group, object);

   273

		case SGT_RANDOMIZED:    return ResolveRandom(group, object);

   274

		default:                return group;

   275

	}

   276

}