1

/* $Id$ */

     2

     3

/** @file newgrf_spritegroup.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "landscape.h"

     9

#include "oldpool.h"

    10

#include "newgrf_callbacks.h"

    11

#include "newgrf_spritegroup.h"

    12

#include "sprite.h"

    15

    16

static void SpriteGroupPoolCleanBlock(uint start_item, uint end_item);

    17

    18

static uint _spritegroup_count = 0;

    19

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

    20

    21

static void DestroySpriteGroup(SpriteGroup *group)

    22

{

    23

	/* Free dynamically allocated memory */

    24

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

    25

	switch (group->type) {

    26

		case SGT_REAL:

    27

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

    28

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

    29

			break;

    30

    31

		case SGT_DETERMINISTIC:

    32

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

    33

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

    34

			break;

    35

    36

		case SGT_RANDOMIZED:

    37

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

    38

			break;

    39

    40

		case SGT_TILELAYOUT:

    41

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

    42

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

    43

			break;

    44

    45

		default:

    46

			break;

    47

	}

    48

}

    49

    50

static void SpriteGroupPoolCleanBlock(uint start_item, uint end_item)

    51

{

    52

	uint i;

    53

    54

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

    55

		DestroySpriteGroup(GetSpriteGroup(i));

    56

	}

    57

}

    58

    59

    60

/* Allocate a new SpriteGroup */

    61

SpriteGroup *AllocateSpriteGroup()

    62

{

    63

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

    64

	if (_spritegroup_count == GetSpriteGroupPoolSize()) {

    65

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

    66

	}

    67

    68

	return GetSpriteGroup(_spritegroup_count++);

    69

}

    70

    71

    72

void InitializeSpriteGroupPool()

    73

{

    74

	_SpriteGroup_pool.CleanPool();

    75

    76

	_spritegroup_count = 0;

    77

}

    78

    79

TemporaryStorageArray<uint32, 0x110> _temp_store;

    80

    81

    82

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

    83

{

    84

	/* Return common variables */

    85

	switch (variable) {

    86

		case 0x00: return max(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0);

    87

		case 0x01: return Clamp(_cur_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR;

    88

		case 0x02: return _cur_month;

    89

		case 0x03: return _opt.landscape;

    90

		case 0x09: return _date_fract;

    91

		case 0x0A: return _tick_counter;

    92

		case 0x0C: return object->callback;

    93

		case 0x10: return object->callback_param1;

    94

		case 0x11: return 0;

    95

		case 0x18: return object->callback_param2;

    96

		case 0x1A: return UINT_MAX;

    97

		case 0x1B: return GB(_display_opt, 0, 6);

    98

		case 0x1C: return object->last_value;

    99

		case 0x20: return _opt.landscape == LT_ARCTIC ? GetSnowLine() : 0xFF;

   100

   101

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

   102

   103

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

   104

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

   105

	}

   106

}

   107

   108

   109

/**

   110

 * Rotate val rot times to the right

   111

 * @param val the value to rotate

   112

 * @param rot the amount of times to rotate

   113

 * @return the rotated value

   114

 */

   115

static uint32 RotateRight(uint32 val, uint32 rot)

   116

{

   117

	/* Do not rotate more than necessary */

   118

	rot %= 32;

   119

   120

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

   121

}

   122

   123

   124

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

   125

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

   126

template <typename U, typename S>

   127

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

   128

{

   129

	value >>= adjust->shift_num;

   130

	value  &= adjust->and_mask;

   131

   132

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

   133

   134

	switch (adjust->type) {

   135

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

   136

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

   137

		case DSGA_TYPE_NONE: break;

   138

	}

   139

   140

	switch (adjust->operation) {

   141

		case DSGA_OP_ADD:  return last_value + value;

   142

		case DSGA_OP_SUB:  return last_value - value;

   143

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

   144

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

   145

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

   146

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

   147

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

   148

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

   149

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

   150

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

   151

		case DSGA_OP_MUL:  return last_value * value;

   152

		case DSGA_OP_AND:  return last_value & value;

   153

		case DSGA_OP_OR:   return last_value | value;

   154

		case DSGA_OP_XOR:  return last_value ^ value;

   155

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

   156

		case DSGA_OP_RST:  return value;

   157

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

   158

		case DSGA_OP_ROR:  return RotateRight(last_value, value);

   159

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

   160

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

   161

		default:           return value;

   162

	}

   163

}

   164

   165

   166

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

   167

{

   168

	static SpriteGroup nvarzero;

   169

	uint32 last_value = 0;

   170

	uint32 value = 0;

   171

	uint i;

   172

   173

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

   174

   175

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

   176

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

   177

   178

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

   179

		bool available = true;

   180

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

   181

			ResolverObject subobject = *object;

   182

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

   183

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

   184

				value = CALLBACK_FAILED;

   185

			} else {

   186

				value = subgroup->g.callback.result;

   187

			}

   188

		} else {

   189

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

   190

		}

   191

   192

		if (!available) {

   193

			/* Unsupported property: skip further processing and return either

   194

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

   195

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

   196

		}

   197

   198

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

   199

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

   200

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

   201

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

   202

			default: NOT_REACHED(); break;

   203

		}

   204

		last_value = value;

   205

	}

   206

   207

	object->last_value = last_value;

   208

   209

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

   210

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

   211

		nvarzero.type = SGT_CALLBACK;

   212

		switch (object->callback) {

   213

			/* All these functions are 15 bit callbacks */

   214

			case CBID_VEHICLE_REFIT_CAPACITY:

   215

			case CBID_HOUSE_COLOUR:

   216

			case CBID_HOUSE_CARGO_ACCEPTANCE:

   217

			case CBID_INDUSTRY_LOCATION:

   218

			case CBID_INDTILE_CARGO_ACCEPTANCE:

   219

			case CBID_VEHICLE_COLOUR_MAPPING:

   220

			case CBID_HOUSE_PRODUCE_CARGO:

   221

			case CBID_VEHICLE_SOUND_EFFECT:

   222

			case CBID_SOUNDS_AMBIENT_EFFECT:

   223

				nvarzero.g.callback.result = GB(value, 0, 15);

   224

				break;

   225

   226

			/* The rest is a 8 bit callback, which should be truncated properly */

   227

			default:

   228

				nvarzero.g.callback.result = GB(value, 0, 8);

   229

				break;

   230

		}

   231

		return &nvarzero;

   232

	}

   233

   234

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

   235

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

   236

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

   237

		}

   238

	}

   239

   240

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

   241

}

   242

   243

   244

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

   245

{

   246

	uint32 mask;

   247

	byte index;

   248

   249

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

   250

   251

	if (object->trigger != 0) {

   252

		/* Handle triggers */

   253

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

   254

		byte waiting_triggers = object->GetTriggers(object);

   255

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

   256

		bool res;

   257

   258

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

   259

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

   260

   261

		if (res) {

   262

			waiting_triggers &= ~match;

   263

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

   264

		} else {

   265

			waiting_triggers |= object->trigger;

   266

		}

   267

   268

		object->SetTriggers(object, waiting_triggers);

   269

	}

   270

   271

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

   272

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

   273

   274

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

   275

}

   276

   277

   278

/* ResolverObject (re)entry point */

   279

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

   280

{

   281

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

   282

	if (group == NULL) return NULL;

   283

   284

	switch (group->type) {

   285

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

   286

		case SGT_DETERMINISTIC: return ResolveVariable(group, object);

   287

		case SGT_RANDOMIZED:    return ResolveRandom(group, object);

   288

		default:                return group;

   289

	}

   290

}